Copyright (c) 2002-2008 The NetBSD Foundation, Inc.
All rights reserved.
This code is derived from software contributed to The NetBSD Foundation
by Luke Mewburn of Wasabi Systems.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
.Dd September 5, 2008 .Dt DB 1 .Os . .Sh NAME .Nm db .Nd manipulate .Xr db 3 Ns 's .Xr btree 3 and .Xr hash 3 databases . .Sh SYNOPSIS .Nm .Op Fl KiNqV .Op Fl E Ar endian .Op Fl f Ar infile .Op Fl O Ar outsep .Op Fl S Ar visitem .Op Fl T Ar visspec .Op Fl X Ar extravis .Ar type .Ar dbfile .Op Ar key Op Ar ... . .Nm .Fl d .Op Fl iNq .Op Fl E Ar endian .Op Fl f Ar infile .Op Fl T Ar visspec .Op Fl U Ar unvisitem .Ar type .Ar dbfile .Op Ar key Op Ar ... . .Nm .Fl w .Op Fl CDiNqR .Op Fl E Ar endian .Op Fl F Ar insep .Op Fl f Ar infile .Op Fl m Ar mode .Op Fl P Ar pagesize .Op Fl T Ar visspec .Op Fl U Ar unvisitem .Ar type .Ar dbfile .Op Ar key Ar value Op Ar ... . .Sh DESCRIPTION .Nm allows manipulation of .Xr btree 3 and .Xr hash 3
q Xr db 3 databases.
p .Nm has three modes of operation to perform upon .Ar dbfile : l -tag -width "delete" -offset indent t read Displays the given .Ar key Ns s , and keys described in .Ar infile . If no keys and no .Ar infile is specified, the entire database is displayed. This is the default mode of operation. t delete Enabled with .Fl d . Deletes the given .Ar key Ns s , and keys described in .Ar infile . t write Enabled with .Fl w . Writes the given .Ar key Ns s and .Ar value Ns s , and keys and values described in .Ar infile (in the latter case, entries are separated by .Ar insep ) . .El
p There are two mandatory arguments: .Ar type is the database type; either .Sq Sy btree or .Sq Sy hash , and .Ar dbfile is the database file to manipulate.
p Options valid for all modes are: l -tag -width Fl -offset indent . t Fl E Ar endian Set the endianness of the database. .Ar endian may be one of: l -tag -width 1n -offset indent -compact t Sy B Big endian t Sy H Host endian t Sy L Little endian .El Defaults to .Sq H (host endian). . t Fl f Ar infile Contains a list of keys (for read and delete), or .Ar insep separated keys and values (for write) to be used as arguments to the given mode. If .Ar infile is .Sq Sy - , .Dv stdin is used. . t Fl i Keys are converted to lower case before manipulation. . t Fl N Do not include the NUL byte at the end of the key or value. . t Fl q Quiet operation. In read mode, missing keys are not considered to be an error. In delete
q Fl d and write
q Fl w modes, the result of various operations is suppressed. . t Fl T Ar visspec Control how the items specified by the .Fl S option are encoded and .Fl U option are decoded. The .Ar visspec option-argument is a string specifying .Xr strsvisx 3 flags. The string consists of one or more characters: l -tag -width 2n -offset indent -compact t Sy b .Dv VIS_NOSLASH t Sy c .Dv VIS_CSTYLE . Overrides .Sy h and .Sy o . t Sy h .Dv VIS_HTTPSTYLE . Overrides .Sy c and .Sy o . t Sy o .Dv VIS_OCTAL . Overrides .Sy c and .Sy h . t Sy s .Dv VIS_SAFE t Sy t .Dv VIS_TAB t Sy w .Dv VIS_WHITE .El
p .Fl U only supports .Fl T .Sy h .
p See .Xr vis 1 Ns 's corresponding options for the meaning of these characters, and .Xr strsvisx 3 for more detail on the flags. . .El .
p Read mode specific options are: . l -tag -width Fl -offset indent t Fl K Display key. . t Fl O Ar outsep Field separator string between key and value. Defaults to a single tab
q Sq \et . . t Fl S Ar visitem Specify items to .Xr strsvisx 3 encode. The .Ar visitem option-argument is a character specifying if the key
q Ar k , the value
q Ar v or both
q Ar b should be encoded. . . t Fl V Display value. . t Fl X Ar extravis When encoding items with .Fl S option also encode characters in .Ar extravis , per .Xr strsvisx 3 . . .El
p d -ragged -offset indent (If neither of .Fl K or .Fl V is given, both options are enabled.) .Ed .
p Write mode specific options are: l -tag -width Fl -offset indent . t Fl C Create new database, and truncate existing databases. . t Fl D Allow duplicate entries. (Requires .Fl R to be useful.) . t Fl F Ar insep Input field separator string between key and value used when parsing .Ar infile . Defaults to a single space
q Sq . . t Fl m Ar mode Octal mode of created database. Defaults to .Sq 0644 . . t Fl P Ar pagesize Set the page size of the table to .Ar pagesize bytes. If set to .Sq 0 , a database-specific default is determined, based on the block-size of the underlying file-system. Defaults to .Sq 4096 . . t Fl R Overwrite existing entries. If not specified, writing to an existing entry raises an error. . .El
p Write and delete mode specific options are: l -tag -width Fl -offset indent . t Fl U Ar unvisitem Specify items to .Xr strunvisx 3 decode. The .Ar unvisitem option-argument is a character specifying if the key
q Ar k , the value
q Ar v or both
q Ar b
should be decoded.
.
.El
.
.Sh SEE ALSO
.Xr vis 1 ,
.Xr btree 3 ,
.Xr db 3 ,
.Xr hash 3 ,
.Xr strsvisx 3 ,
.Xr strunvisx 3
.Xr makemap 8
.
.Sh HISTORY
The
.Nm
command appeared in
.Nx 2.0 .
.
.Sh AUTHORS
.An Luke Mewburn
.Aq lukem (at] NetBSD.org .
Indexes created Tue Oct 28 12:10:06 GMT 2025