DB(1)                   NetBSD General Commands Manual                   DB(1)

NAME
     db -- manipulate db(3)'s btree(3) and hash(3) databases

SYNOPSIS
     db [-KiNqV] [-E endian] [-f infile] [-O str] [-S chr] [-T str] [-X str]
        type database [key [...]]
     db -d [-iNq] [-E endian] [-f infile] [-U chr] type database [key [...]]
     db -w [-CDiNqR] [-E endian] [-F sep] [-f infile] [-m mode] [-U chr] type
        database [key value [...]]

DESCRIPTION
     db allows manipulation of btree(3) and hash(3) (db(3)) databases.

     db has three modes of operation:

           read    Displays the given keys, and keys described in infile.  If
                   no keys and no infile is specified, the entire database is
                   displayed.  This is the default mode of operation.

           delete  Enabled with -d.  Deletes the given keys, and keys
                   described in infile.

           write   Enabled with -w.  Writes the given keys and values, and
                   keys and values described in infile (in the latter case,
                   entries are separated by sep).

     There are two mandatory arguments: type is the database type; either
     `btree' or `hash', and database is the database file to manipulate.

     Options valid for all modes are:

           -E endian   Set the endianness of the database.  endian may be one
                       of:
                             B  Big endian
                             H  Host endian
                             L  Little endian
                       Defaults to `H' (host endian).

           -f infile   Contains a list of keys (for read and delete), or sep
                       separated keys and values (for write) to be used as
                       arguments to the given mode.  If infile is `-', stdin
                       is used.

           -i          Keys are converted to lower case before manipulation.

           -N          Do not include the NUL byte at the end of the key or
                       value.

           -q          Quiet operation.  In read mode, missing keys are not
                       considered to be an error.  In delete (-d) and write
                       (-w) modes, the result of various operations is sup-
                       pressed.

     Read mode specific options are:

           -K          Display key.

           -O str      Field separator string between key and value.  Defaults
                       to a single tab (`\t').

           -S chr      Specify items to strvis(3) encode.  The chr option-
                       argument is a character specifying if the key (k), the
                       value (v) or both (b) should be encoded.

           -T str      Control how the items specified by the -S option are
                       encoded.  The str option-argument is a string specify-
                       ing strvis(3) options.  The string consists of the
                       specification characters b, c, o, s, t, and w.  See
                       vis(1)'s corresponding options for the meaning of these
                       characters.

           -V          Display value.

           -X str      When encoding items with -S option also encode charac-
                       ters in str, per svis(3).

           (If neither of -K or -V is given, both options are enabled.)

     Write mode specific options are:

           -C          Create new database, and truncate existing databases.

           -D          Allow duplicate entries.  (Requires -R to be useful.)

           -F sep      Field separator between key and value used when parsing
                       infile.  Defaults to a single space (` ').

           -m mode     Octal mode of created database.  Defaults to `0644'.

           -R          Overwrite existing entries.  If not specified, writing
                       to an existing entry raises an error.

     Write and delete mode specific options are:

           -U chr      Specify items to strunvis(3) decode.  The chr option-
                       argument is a character specifying if the key (k), the
                       value (v) or both (b) should be decoded.

SEE ALSO
     vis(1), btree(3), db(3), hash(3), strunvis(3), strvis(3), svis(3),
     makemap(8)

HISTORY
     The db command appeared in NetBSD 2.0.

AUTHORS
     Luke Mewburn <lukem@NetBSD.org>.

NetBSD 3.1                       May 19, 2003                       NetBSD 3.1