NAME

beacon - beacon command line client

SYNOPSIS

beacon [ <options> ] [ <command> ] [ <file> ]

ARGUMENTS

-file <name>   specify a file (use '-' for stdin)

-links       only print links, without meta fields
-quiet       suppress all error messages
-test        enable test mode (no stored beacon is modified)
-help        brief help message
-pre <file>  start with meta fields from a given beacon file
-man         full documentation with examples

about <name>    show meta information about a file or stored beacon
parse <file>    parse a full beacon file and print meta information
dump <name>     parse a beacon file or dump a stored beacon
links <name>    same as dump, but omit meta fields
expand <name>   parse and expand a beacon file or dump a stored beacon

The following options and commands are not fully implemented yet, but planned to support storing and modifying beacons in a database or other store.

-config <file> specify config file
-name <name>   specify a name (for stored beacons)

init           initialize beacon store
list           list names of all stored beacons
insert <name> <file>  insert a new beacon from file to a store
update <name> <file>  replace a beacon from file to a store
delete <name>         remove a beacon from a store

query <name> <id>     query a beacon (stored of file) for an id

DESCRIPTION

This command line script manages beacon files. You can use it for parsing, validating, expanding, and storing beacon files in a database (the latter not implemented yet).

The first command line argument is treated as command or as [file] name. To simply show the meta fields of a beacon file (command 'about', you can use any one of the following:

beacon myfile
beacon -file myfile
beacon -file myfile about
beacon about myfile

NOTE

The command name 'beacon' clashes with a tool of same name from the ax25-tools package (http://www.linux-ax25.org/. If you need to use beacon together with hamradio, you need to rename one of the two scripts.

AUTHOR

Jakob Voss <jakob.voss@gbv.de>

LICENSE

Copyright (C) 2007-2010 by Verbundzentrale Goettingen (VZG) and Jakob Voss

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.