NBDBTOOL(8)

NAME
nbdbtool - Netboot database management tool

SYNOPSIS

nbdbtool [OPTIONS]

DESCRIPTION
nbdbtool is a simple program to view and delete entries in the netboot systems database. Each utility program in the netboot package is able to write it's parameters into this database, and with this tool it is possible to show a list of these database entries, to print an individual database entry or to delete an entry.

OPTIONS

-C, --config-file FILE
    Specifies the pathname of the configuration file. If this option is not given, the value of the NETBOOT_CONFIG environment variable or a compiled-in default will be used.

-c, --clone FILE|DBSPEC
    This action clones all records from a database file or database specification into the systems database.

-D, --database FILE|DBSPEC
    Pathname of database file (or database specification) on which the program is to act on. If this option is not given, the value of the NETBOOT_DATABASE environment variable or a compiled-in default will be used. See the netboot(5) man page for a further explanation of different ways to specify a database.

-d, --delete NAME
    Name of database entry to delete

-F, --logfile
    Name of log file to write debugging output to. The default is to print all verbose output to stdout.

-f, --filter FILTER
    Print a list of database entries based on a filter string. This filter string can contain wildcard characters. A '*' character matches any number of characters in the database entry name, and a '?' character matches exactly one character in the database entry name. If the filter string contains any of these wildcard characters, the whole string has to be enclosed into single quotes on a standard UNIX shell so that the wildcard characters don't get interpreted by the shell. The database record list gets printed onto standard output.

-H, --home-dir
    Specifies the home directory. If this command line option is not given, either the homedir configuration file parameter or the current user's home directory will be used.

-h, --help
    Print short usage information.

-L, --libdir DIR
    Pathname of the non-shared-data directory. If this option is not given, the value of the NETBOOT_LIB environment variable or a compiled-in default will be used.

-l, --list
    Print all record names contained within the systems database onto standard output.

-N, --datadir DIR
    Pathname of the shared-data directory. If this option is not given, the value of the NETBOOT_DATA environment variable or a compiled-in default will be used.

-o, --outfile FILE
    This option will print the output of the --print or --list action into a file rather than on stdout.

-p, --print NAME
    Print the contents of a specific database record. This will print all values contained in this record onto standard output.

-q, --quiet
    Don't print any error messages. If an error occurred, it is possible to find out about the cause of the error by inspecting the error code returned by nbdbtool.

-r, --raw
    With the print action, this option prints all parameters as they appear in the database, even if they are duplicate or empty.

-v, --version
    Print version information.

-x, --verbose
    Verbose output to let you know what nbdbtool is doing. Each -x increases the verbosity level.

DATABASE RECORD NAMES
The systems database can contain various records, with each record giving definitions for a specific netboot program and client system. The record names are constructed like this: <program name>:<system name>. The same record name can appear multiple times in a database. Usually, when a netboot program uses such a record name, it scans all entries and uses the last one found within the database. This is also the way the --print option works. However, the --delete option will delete all records for a given record name.

ENVIRONMENT VARIABLES
See the netboot(5) man page for a description of all environment variables used by nbdbtool.

BUGS
None known yet

SEE ALSO
netboot(5), netboot.config(5)

AUTHOR
nbdbtool was written by Gero Kuhlmann <gero@gkminix.han.de>.