summaryrefslogtreecommitdiffabout
path: root/doc
authorSergey Poznyakoff <gray@gnu.org.ua>2013-05-08 16:27:01 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2013-05-08 16:27:01 (GMT)
commit6658f41e38fec9e007a0fbd0883e030f6337e28d (patch) (unidiff)
treed7ecc0b72b23a01a2bfa10e8a7bb184d704269dc /doc
parentc0cba983ab0c0bc1de630a200f902189ddddff09 (diff)
downloadgdbm-6658f41e38fec9e007a0fbd0883e030f6337e28d.tar.gz
gdbm-6658f41e38fec9e007a0fbd0883e030f6337e28d.tar.bz2
Rename testgdbm to gdbmtool. Improve documentation.
* configure.ac: Fix a typo. * src/.cvsignore: Add gdbmtool * src/Makefile.am: Rename testgdbm to gdbmtool. Source file not renamed because of CVS deficiency. * src/gdbm_dump.c: Enable NLS. * src/gdbm_load.c: Likewise. * src/testgdbm.c: New option -q (--quiet). New command: prompt. * doc/Makefile.am (man_MANS): Add new manpages. * doc/gdbmtool.1: New file. * doc/gdbm_load.1: New file. * doc/gdbm_dump.1: New file. * doc/gdbm.3: Update. * doc/gdbm.texinfo: Update.
Diffstat (limited to 'doc') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/gdbm.329
-rw-r--r--doc/gdbm.texinfo134
-rw-r--r--doc/gdbm_dump.188
-rw-r--r--doc/gdbm_load.196
-rw-r--r--doc/gdbmtool.1245
6 files changed, 510 insertions, 84 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index f4059d0..223c892 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -22,3 +22,3 @@ gdbm_TEXINFOS=\
22 22
23man_MANS = gdbm.3 23man_MANS = gdbm.3 gdbm_dump.1 gdbm_load.1 gdbmtool.1
24EXTRA_DIST = $(man_MANS) 24EXTRA_DIST = $(man_MANS)
diff --git a/doc/gdbm.3 b/doc/gdbm.3
index e3b90d4..c08ece3 100644
--- a/doc/gdbm.3
+++ b/doc/gdbm.3
@@ -1,3 +1,3 @@
1.\" This file is part of GDBM. 1.\" This file is part of GDBM.
2.\" Copyright (C) 2011 Free Software Foundation, Inc. 2.\" Copyright (C) 2011, 2013 Free Software Foundation, Inc.
3.\" 3.\"
@@ -15,7 +15,6 @@
15.\" along with GDBM. If not, see <http://www.gnu.org/licenses/>. */ 15.\" along with GDBM. If not, see <http://www.gnu.org/licenses/>. */
16.TH GDBM 3 "August 9, 2011" "GDBM" "GDBM User Reference" 16.TH GDBM 3 "May 8, 2013" "GDBM" "GDBM User Reference"
17.ds ve 1.9
18.SH NAME 17.SH NAME
19GDBM - The GNU database manager. Includes \fBdbm\fR and \fBndbm\fR 18GDBM \- The GNU database manager. Includes \fBdbm\fR and \fBndbm\fR
20compatability. (Version \*(ve.) 19compatibility.
21.SH SYNOPSIS 20.SH SYNOPSIS
@@ -202,3 +201,3 @@ Replace contents if key exists.
202.PP 201.PP
203If a reader calls \fBgdbm_store\fR, the return value will be -1. 202If a reader calls \fBgdbm_store\fR, the return value will be \-1.
204If called with \fBGDBM_INSERT\fR and \fIkey\fR is in the database, the return 203If called with \fBGDBM_INSERT\fR and \fIkey\fR is in the database, the return
@@ -247,3 +246,3 @@ key data.
247 246
248The return value is -1 if the item is not present or the requester is a reader. 247The return value is \-1 if the item is not present or the requester is a reader.
249The return value is 0 if there was a successful delete. 248The return value is 0 if there was a successful delete.
@@ -355,3 +354,3 @@ especially if used in conjunction with \fBGDBM_CENTFREE\fR. \fIvalue\fR
355pointer. \fIsize\fR is the size of the data pointed to by \fIvalue\fR. 354pointer. \fIsize\fR is the size of the data pointed to by \fIvalue\fR.
356The return value will be -1 upon failure, or 0 upon success. The global 355The return value will be \-1 upon failure, or 0 upon success. The global
357variable \fIgdbm_errno\fR will be set upon failure. 356variable \fIgdbm_errno\fR will be set upon failure.
@@ -401,3 +400,3 @@ treated as static pointers (as standard UNIX \fBdbm\fR does).
401.SH LINKING 400.SH LINKING
402This library is accessed by specifying \fI-lgdbm\fR as the last 401This library is accessed by specifying \fI\-lgdbm\fR as the last
403parameter to the compile line, e.g.: 402parameter to the compile line, e.g.:
@@ -406,3 +405,3 @@ parameter to the compile line, e.g.:
406.in +5 405.in +5
407gcc -o prog prog.c -lgdbm 406gcc \-o prog prog.c \-lgdbm
408.in 407.in
@@ -415,3 +414,3 @@ you must link in the \fIgdbm_compat\fR library as well. For example:
415.in +5 414.in +5
416gcc -o prog proc.c -lgdbm -lgdbm_compat 415gcc \-o prog proc.c \-lgdbm \-lgdbm_compat
417.in 416.in
@@ -421,6 +420,8 @@ gcc -o prog proc.c -lgdbm -lgdbm_compat
421.SH "BUG REPORTS" 420.SH "BUG REPORTS"
422Send bug reports to <bug-gdbm@gnu.org>. 421Send bug reports to <bug\-gdbm@gnu.org>.
423.SH "SEE ALSO" 422.SH "SEE ALSO"
424dbm, ndbm 423.BR gdbm_dump (1),
425.SH AUTHOR 424.BR gdbm_load (1),
425.BR gdbmtool (1).
426.SH AUTHORS
426by Philip A. Nelson, Jason Downs and Sergey Poznyakoff. 427by Philip A. Nelson, Jason Downs and Sergey Poznyakoff.
diff --git a/doc/gdbm.texinfo b/doc/gdbm.texinfo
index 9f0af5b..17f47f9 100644
--- a/doc/gdbm.texinfo
+++ b/doc/gdbm.texinfo
@@ -120,3 +120,3 @@ Programs
120 120
121* testgdbm:: Test and modify a GDBM database. 121* gdbmtool:: Examine and modify a GDBM database.
122* gdbm_dump:: Dump the database into a flat file. 122* gdbm_dump:: Dump the database into a flat file.
@@ -1619,10 +1619,10 @@ never free it.
1619 1619
1620@node testgdbm 1620@node gdbmtool
1621@chapter Test and modify a GDBM database. 1621@chapter Examine and modify a GDBM database.
1622@prindex testgdbm 1622@prindex gdbmtool
1623 1623
1624The @command{testgdbm} utility allows you to view and modify an 1624The @command{gdbmtool} utility allows you to view and modify an
1625existing @acronym{GDBM} database or to create a new one. 1625existing @acronym{GDBM} database or to create a new one.
1626 1626
1627@cindex default database, @command{testgdbm} 1627@cindex default database, @command{gdbmtool}
1628@flindex junk.gdbm 1628@flindex junk.gdbm
@@ -1631,11 +1631,11 @@ When invoked without arguments, it tries to open a database file called
1631change this default by supplying the name of the database to use as 1631change this default by supplying the name of the database to use as
1632the only argument to @command{testgdbm}, e.g.: 1632the only argument to @command{gdbmtool}, e.g.:
1633 1633
1634@example 1634@example
1635$ testgdbm file.db 1635$ gdbmtool file.db
1636@end example 1636@end example
1637 1637
1638@cindex read-only mode, @command{testgdbm} 1638@cindex read-only mode, @command{gdbmtool}
1639@cindex @option{-r}, @command{testgdbm} option 1639@cindex @option{-r}, @command{gdbmtool} option
1640@cindex @option{--read-only}, @command{testgdbm} option 1640@cindex @option{--read-only}, @command{gdbmtool} option
1641The database will be opened in read-write mode, unless the 1641The database will be opened in read-write mode, unless the
@@ -1644,6 +1644,6 @@ it will be opened only for reading.
1644 1644
1645@cindex creating a database, @command{testgdbm} 1645@cindex creating a database, @command{gdbmtool}
1646@cindex @option{-n}, @command{testgdbm} option 1646@cindex @option{-n}, @command{gdbmtool} option
1647@cindex @option{--newdb}, @command{testgdbm} option 1647@cindex @option{--newdb}, @command{gdbmtool} option
1648If the database does not exist, @command{testgdbm} will create it. 1648If the database does not exist, @command{gdbmtool} will create it.
1649There is a special option @option{-n} (@option{--newdb}, which 1649There is a special option @option{-n} (@option{--newdb}, which
@@ -1658,6 +1658,6 @@ the database already exists, it will be deleted, so use it sparingly.
1658@node invocation 1658@node invocation
1659@section testgdbm invocation 1659@section gdbmtool invocation
1660@cindex command line options, @command{testgdbm} 1660@cindex command line options, @command{gdbmtool}
1661 1661
1662The following table summarizes all @command{testgdbm} command line 1662The following table summarizes all @command{gdbmtool} command line
1663options: 1663options:
@@ -1683,2 +1683,5 @@ Disable file locking.
1683Disable mmap. 1683Disable mmap.
1684@item -q
1685@itemx --quiet
1686Don't print the usual welcome banner at startup.
1684@item -r 1687@item -r
@@ -1698,9 +1701,9 @@ command line options.
1698@node shell 1701@node shell
1699@section testgdbm interactive mode 1702@section gdbmtool interactive mode
1700@cindex interactive mode, @command{testgdbm} 1703@cindex interactive mode, @command{gdbmtool}
1701 1704
1702After successful startup, @command{testgdbm} starts a loop, in which 1705After successful startup, @command{gdbmtool} starts a loop, in which
1703it reads commands from the user, executes them and prints the results 1706it reads commands from the user, executes them and prints the results
1704on the standard output. If the standard input is attached to a console, 1707on the standard output. If the standard input is attached to a console,
1705@command{testgdbm} runs in interactive mode, which is indicated by its 1708@command{gdbmtool} runs in interactive mode, which is indicated by its
1706@dfn{prompt}: 1709@dfn{prompt}:
@@ -1708,3 +1711,3 @@ on the standard output. If the standard input is attached to a console,
1708@example 1711@example
1709testgdbm> _ 1712gdbmtool> _
1710@end example 1713@end example
@@ -1714,3 +1717,3 @@ detects end-of-file on its standard input, whichever occurs first.
1714 1717
1715A @command{testgdbm} command consists of a @dfn{command verb}, 1718A @command{gdbmtool} command consists of a @dfn{command verb},
1716optionally followed by one or two @dfn{arguments}, separated by any 1719optionally followed by one or two @dfn{arguments}, separated by any
@@ -1729,3 +1732,3 @@ Each command takes at most two @dfn{formal parameters}, which can be
1729optional or mandatory. If the number of actual arguments is less than the 1732optional or mandatory. If the number of actual arguments is less than the
1730number of mandatory parameters, @command{testgdbm} will prompt you to 1733number of mandatory parameters, @command{gdbmtool} will prompt you to
1731supply missing arguments. For example, the @samp{store} command takes two 1734supply missing arguments. For example, the @samp{store} command takes two
@@ -1736,3 +1739,3 @@ example below:
1736@example 1739@example
1737testgdbm> @kbd{store} 1740gdbmtool> @kbd{store}
1738key> @kbd{three} 1741key> @kbd{three}
@@ -1743,3 +1746,3 @@ However, such prompting is possible only in interactive mode. In
1743non-interactive mode (e.g.@: when running a script), all arguments must 1746non-interactive mode (e.g.@: when running a script), all arguments must
1744be supplied with each command, otherwise @command{testgdbm} will report an 1747be supplied with each command, otherwise @command{gdbmtool} will report an
1745error and exit immediately. 1748error and exit immediately.
@@ -1747,6 +1750,6 @@ error and exit immediately.
1747@anchor{pager} 1750@anchor{pager}
1748@cindex pager, @command{testgdbm} 1751@cindex pager, @command{gdbmtool}
1749@cindex @env{PAGER} 1752@cindex @env{PAGER}
1750Some commands produce excessive amounts of output. To help you follow 1753Some commands produce excessive amounts of output. To help you follow
1751it, @command{testgdbm} uses a pager utility to display such 1754it, @command{gdbmtool} uses a pager utility to display such
1752output. The name of the pager utility is taken from the environment 1755output. The name of the pager utility is taken from the environment
@@ -1757,3 +1760,3 @@ number of lines on your screen.
1757@anchor{nul-termination} 1760@anchor{nul-termination}
1758Many of the @command{testgdbm} commands operate on database key and 1761Many of the @command{gdbmtool} commands operate on database key and
1759data values. The utility assumes that both keys and data are 1762data values. The utility assumes that both keys and data are
@@ -1767,3 +1770,2 @@ The following table summarizes all available commands:
1767@deffn {command verb} count 1770@deffn {command verb} count
1768@deffnx {command abbrev} co
1769@deffnx {command letter} c 1771@deffnx {command letter} c
@@ -1773,16 +1775,15 @@ Print the number of entries in the database.
1773@deffn {command verb} delete @var{key} 1775@deffn {command verb} delete @var{key}
1774@deffnx {command abbrev} de @var{key}
1775@deffnx {command letter} d @var{key} 1776@deffnx {command letter} d @var{key}
1776Delete entry with a given @var{key} 1777Delete entry with the given @var{key}
1777@end deffn 1778@end deffn
1778 1779
1779@anchor{testgdbm export} 1780@anchor{gdbmtool export}
1780@deffn {command verb} export @var{file-name} [truncate] [binary|ascii] 1781@deffn {command verb} export @var{file-name} [truncate] [binary|ascii]
1781@deffnx {command abbrev} e @var{file-name} [truncate] [binary|ascii] 1782@deffnx {command letter} e @var{file-name} [truncate] [binary|ascii]
1782Export the database to the flat file @var{file-name}. @xref{Flat files}, 1783Export the database to the flat file @var{file-name}. @xref{Flat files},
1783for a description of the flat file format and its purposes. This 1784for a description of the flat file format and its purposes. This
1784command will not overwrite an existing file, unless the argument 1785command will not overwrite an existing file, unless the
1785@samp{truncate} is also given. Another optional argument determines 1786@samp{truncate} parameter is also given. Another optional argument
1786the type of dump (@pxref{Flat files}). By default, ASCII dump is 1787determines the type of the dump (@pxref{Flat files}). By default, ASCII
1787created. 1788dump is created.
1788 1789
@@ -1792,10 +1793,9 @@ See also @ref{gdbmexport}.
1792@deffn {command verb} fetch @var{key} 1793@deffn {command verb} fetch @var{key}
1793@deffnx {command abbrev} fe @var{key}
1794@deffnx {command letter} f @var{key} 1794@deffnx {command letter} f @var{key}
1795Fetch and display a record with the given @var{key}. 1795Fetch and display the record with the given @var{key}.
1796@end deffn 1796@end deffn
1797 1797
1798@anchor{testgdbm import} 1798@anchor{gdbmtool import}
1799@deffn {command verb} import @var{file-name} [replace] [nometa] 1799@deffn {command verb} import @var{file-name} [replace] [nometa]
1800@deffnx {command abbrev} i @var{file-name} [replace] [nometa] 1800@deffnx {command letter} i @var{file-name} [replace] [nometa]
1801Import data from a flat dump file @var{file-name} 1801Import data from a flat dump file @var{file-name}
@@ -1808,3 +1808,3 @@ restoring meta-information from the dump file.
1808@deffn {command verb} list 1808@deffn {command verb} list
1809@deffnx {command abbrev} l 1809@deffnx {command letter} l
1810List the contents of the database (@pxref{pager}). 1810List the contents of the database (@pxref{pager}).
@@ -1813,7 +1813,5 @@ List the contents of the database (@pxref{pager}).
1813@deffn {command verb} next [@var{key}] 1813@deffn {command verb} next [@var{key}]
1814@deffnx {command abbrev} n [@var{key}] 1814@deffnx {command letter} n [@var{key}]
1815Sequential access: fetch and display a next record. If @var{key} is 1815Sequential access: fetch and display the next record. If the @var{key} is
1816given, a record following one with this key will be fetched. 1816given, the record following the one with this key will be fetched.
1817Otherwise, the key supplied by the latest @code{1}, @code{2} or
1818@var{n} command will be used.
1819 1817
@@ -1824,4 +1822,17 @@ See also @code{first}, below.
1824 1822
1823@deffn {command verb} prompt @var{text}
1824Changes the command prompt to the string @var{text}. The string can
1825contain @dfn{escape sequences}, the special entities consisting of the
1826@samp{%} character followed by another character. These sequences are
1827replaced in the generated prompt as follows:
1828
1829@multitable @columnfractions 0.4 0.5
1830@headitem Sequence @tab Expansion
1831@item %f @tab name of the db file
1832@item %% @tab %
1833@end multitable
1834@end deffn
1835
1825@deffn {command verb} quit 1836@deffn {command verb} quit
1826@deffnx {command abbrev} q 1837@deffnx {command letter} q
1827Close the database and quit the utility. 1838Close the database and quit the utility.
@@ -1830,3 +1841,2 @@ Close the database and quit the utility.
1830@deffn {command verb} store @var{key} @var{data} 1841@deffn {command verb} store @var{key} @var{data}
1831@deffnx {command abbrev} sto @var{key} @var{data}
1832@deffnx {command letter} s @var{key} @var{data} 1842@deffnx {command letter} s @var{key} @var{data}
@@ -1837,6 +1847,5 @@ already exists, its data will be replaced.
1837@deffn {command verb} first 1847@deffn {command verb} first
1838@deffnx {command abbrev} fi
1839@deffnx {command letter} 1 1848@deffnx {command letter} 1
1840Fetch and display the first record in the database. Subsequent 1849Fetch and display the first record in the database. Subsequent
1841records can be fetched using @code{next} command (see above). 1850records can be fetched using the @code{next} command (see above).
1842@xref{Sequential}, for more information on sequential access. 1851@xref{Sequential}, for more information on sequential access.
@@ -1845,7 +1854,6 @@ records can be fetched using @code{next} command (see above).
1845@deffn {command verb} read @var{file} [replace] 1854@deffn {command verb} read @var{file} [replace]
1846@deffnx {command abbrev} rea @var{file} [replace]
1847@deffnx {command letter} < @var{file} [replace] 1855@deffnx {command letter} < @var{file} [replace]
1848Read entries from @var{file} and store them in the database. If the 1856Read entries from @var{file} and store them in the database. If the
1849word @samp{replace} is given as the second argument, any existing 1857@samp{replace} parameter is given, any existing records with matching
1850records with matching keys will be replaced. 1858keys will be replaced.
1851@end deffn 1859@end deffn
@@ -1853,3 +1861,2 @@ records with matching keys will be replaced.
1853@deffn {command verb} reorganize 1861@deffn {command verb} reorganize
1854@deffnx {command abbrev} reo
1855@deffnx {command letter} r 1862@deffnx {command letter} r
@@ -1859,3 +1866,2 @@ Reorganize the database (@pxref{Reorganization}).
1859@deffn {command verb} key-zero 1866@deffn {command verb} key-zero
1860@deffnx {command abbrev} k
1861@deffnx {command letter} z 1867@deffnx {command letter} z
@@ -1866,3 +1872,2 @@ state. @xref{nul-termination}.
1866@deffn {command verb} avail 1872@deffn {command verb} avail
1867@deffnx {command abbrev} a
1868@deffnx {command letter} A 1873@deffnx {command letter} A
@@ -1872,3 +1877,2 @@ Print the @dfn{avail list}.
1872@deffn {command verb} bucket 1877@deffn {command verb} bucket
1873@deffnx {command abbrev} b
1874@deffnx {command letter} B 1878@deffnx {command letter} B
@@ -1878,3 +1882,2 @@ Print the bucket number @var{num}.
1878@deffn {command verb} current 1882@deffn {command verb} current
1879@deffnx {command abbrev} cu
1880@deffnx {command letter} C 1883@deffnx {command letter} C
@@ -1884,3 +1887,2 @@ Print the current bucket.
1884@deffn {command verb} dir 1887@deffn {command verb} dir
1885@deffnx {command abbrev} di
1886@deffnx {command letter} D 1888@deffnx {command letter} D
@@ -1890,3 +1892,2 @@ Print hash directory.
1890@deffn {command verb} header 1892@deffn {command verb} header
1891@deffnx {command abbrev} hea
1892@deffnx {command letter} F 1893@deffnx {command letter} F
@@ -1896,3 +1897,2 @@ Print file header.
1896@deffn {command verb} hash @var{key} 1897@deffn {command verb} hash @var{key}
1897@deffnx {command abbrev} ha @var{key}
1898@deffnx {command letter} H @var{key} 1898@deffnx {command letter} H @var{key}
@@ -1902,3 +1902,2 @@ Compute and display the hash value for the given @var{key}.
1902@deffn {command verb} cache 1902@deffn {command verb} cache
1903@deffnx {command abbrev} ca
1904@deffnx {command letter} K 1903@deffnx {command letter} K
@@ -1908,3 +1907,2 @@ Print the bucket cache.
1908@deffn {command verb} status 1907@deffn {command verb} status
1909@deffnx {command abbrev} sta
1910@deffnx {command letter} S 1908@deffnx {command letter} S
@@ -1921,3 +1919,3 @@ Zero terminated data: yes
1921@deffn {command verb} version 1919@deffn {command verb} version
1922@deffnx {command abbrev} v 1920@deffnx {command letter} v
1923Print the version of @command{gdbm}. 1921Print the version of @command{gdbm}.
@@ -1926,3 +1924,2 @@ Print the version of @command{gdbm}.
1926@deffn {command verb} data-zero 1924@deffn {command verb} data-zero
1927@deffnx {command abbrev} da
1928@deffnx {command letter} Z 1925@deffnx {command letter} Z
@@ -1935,3 +1932,2 @@ status.
1935@deffn {command verb} help 1932@deffn {command verb} help
1936@deffnx {command abbrev} hel
1937@deffnx {command letter} ? 1933@deffnx {command letter} ?
diff --git a/doc/gdbm_dump.1 b/doc/gdbm_dump.1
new file mode 100644
index 0000000..bf68683
--- a/dev/null
+++ b/doc/gdbm_dump.1
@@ -0,0 +1,88 @@
1.\" This file is part of GDBM.
2.\" Copyright (C) 2013 Free Software Foundation, Inc.
3.\"
4.\" GDBM is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by
6.\" the Free Software Foundation; either version 3, or (at your option)
7.\" any later version.
8.\"
9.\" GDBM is distributed in the hope that it will be useful,
10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12.\" GNU General Public License for more details.
13.\"
14.\" You should have received a copy of the GNU General Public License
15.\" along with GDBM. If not, see <http://www.gnu.org/licenses/>. */
16.TH GDBM_DUMP 1 "May 8, 2013" "GDBM" "GDBM User Reference"
17.SH NAME
18gdbm_dump \- dump a GDBM database to a file
19.SH SYNOPSIS
20\fBgdbm_dump\fR [\fB\-H \fIFMT\fR] [\fB\-\-format\fR=\fIFMT\fR] \fIDB_FILE\fR [\fIFILE\fR]
21.sp
22\fBgdbm_dump\fR [\fB\-Vh\fR] [\fB\-\-help\fR] [\fB\-\-usage\fR] [\fB\-\-version\fR]
23.SH DESCRIPTION
24The
25.B gdbm_dump
26utility creates a dump of the specified
27.BR gdbm (3)
28database file. The name for the output dump file is supplied by the
29second argument (\fIFILE\fR). If not specified, the output goes to
30the standard error.
31.PP
32The created dump can be given as argument to the
33.BR gdbm_load (1)
34utility in order to re-create an exact copy of the \fIDB_FILE\fR.
35.SH OPTIONS
36.TP
37\fB\-H\fR, \fB\-\-format\fR=\fIFMT\fR
38Select dump format. The value \fBbinary\fR (or \fB0\fR) instructs
39.B gdbm_dump
40to produce a binary dump, compatible with earlier
41.B gdbm
42versions (up to version 1.9). The value \fBascii\fR (or \fB1\fR)
43instructs it to create an ASCII dump (this is the default). The
44latter is preferred because, apart from the actual data, it also
45contains meta-information which will allow
46.BR gdbm_load (1)
47to recreate an exact copy of the file.
48.TP
49\fB\-h\fR, \fB\-\-help\fR
50Print a short usage summary.
51.TP
52\fB\-\-usage\fR
53Print a list of available options.
54.TP
55\fB\-V\fR, \fB\-\-version\fR
56Print program version
57.SH "SEE ALSO"
58.BR gdbm_load (1),
59.BR gdbmtool (1),
60.BR gdbm (3).
61.PP
62For a detailed description of
63.B gdbm_dump
64and other
65.B gdbm
66utilities, refer to the \fBGDBM Manual\fR available in
67Texinfo format. To access it, run:
68
69 \fBinfo gdbm\fR
70
71.SH "REPORTING BUGS"
72Report bugs to <bug\-gdbm@gnu.org>.
73.SH COPYRIGHT
74Copyright \(co 2013 Free Software Foundation, Inc
75.br
76.na
77License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
78.br
79.ad
80This is free software: you are free to change and redistribute it.
81There is NO WARRANTY, to the extent permitted by law.
82.\" Local variables:
83.\" eval: (add-hook 'write-file-hooks 'time-stamp)
84.\" time-stamp-start: ".TH GDBM[A-Z_-]* 1 \""
85.\" time-stamp-format: "%:B %:d, %:y"
86.\" time-stamp-end: "\""
87.\" time-stamp-line-limit: 20
88.\" end:
diff --git a/doc/gdbm_load.1 b/doc/gdbm_load.1
new file mode 100644
index 0000000..00aaac0
--- a/dev/null
+++ b/doc/gdbm_load.1
@@ -0,0 +1,96 @@
1.\" This file is part of GDBM.
2.\" Copyright (C) 2011, 2013 Free Software Foundation, Inc.
3.\"
4.\" GDBM is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by
6.\" the Free Software Foundation; either version 3, or (at your option)
7.\" any later version.
8.\"
9.\" GDBM is distributed in the hope that it will be useful,
10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12.\" GNU General Public License for more details.
13.\"
14.\" You should have received a copy of the GNU General Public License
15.\" along with GDBM. If not, see <http://www.gnu.org/licenses/>. */
16.TH GDBM_LOAD 1 "May 8, 2013" "GDBM" "GDBM User Reference"
17.SH NAME
18gdbm_load \- re-create a GDBM database from a dump file.
19.SH SYNOPSIS
20\fBgdbm_load\fR [\fB\-nr\fR] [\fB\-m\fR \fIMODE\fR]\
21 [\fB\-u\fR \fINAME\fR|\fIUID\fR[:\fINAME\fR|\fIGID\fR]]
22 [\fB\-\-mode\fR=\fIMODE\fR]\
23 [\fB\-\-no\-meta\fR] [\fB\-\-replace\fR]
24 [\fB\-\-user\fR=\fINAME\fR|\fIUID\fR[:\fINAME\fR|\fIGID\fR]]\
25 \fIFILE\fR [\fIDB_FILE\fR]
26
27.sp
28\fBgdbm_load\fR [\fB\-Vh\fR] [\fB\-\-help\fR] [\fB\-\-usage\fR] [\fB\-\-version\fR]
29.SH DESCRIPTION
30Create a
31.B gdbm
32database file
33.I DB_FILE
34from the dump file
35.IR FILE .
36If the
37.I FILE
38argument is not supplied, output the created database to the standard error.
39.PP
40If the input file is in ASCII dump format, the mode and ownership of
41the created database are restored from the information in the dump.
42This can be overridden using the command line options (see below).
43.SH OPTIONS
44.TP
45\fB\-m\fR, \fB\-\-mode\fR=\fIMODE\fR
46Set database file mode (octal number).
47.TP
48\fB\-n\fR, \fB\-\-no\-meta\fR
49Do not attempt to restore database meta-data (mode and ownership).
50.TP
51\fB\-r\fR, \fB\-\-replace\fR
52If the database exists, replace records in it.
53.TP
54\fB\-u\fR, \fB\-\-user\fR=\fINAME\fR|\fIUID\fR[:\fINAME\fR|\fIGID\fR]
55Set file ownership.
56.TP
57\fB\-h\fR, \fB\-\-help\fR
58Print a short usage summary.
59.TP
60\fB\-\-usage\fR
61Print a list of available options.
62.TP
63\fB\-V\fR, \fB\-\-version\fR
64Print program version
65.SH "SEE ALSO"
66.BR gdbm_dump (1),
67.BR gdbmtool (1),
68.BR gdbm (3).
69.PP
70For a detailed description of
71.B gdbm_load
72and other
73.B gdbm
74utilities, refer to the \fBGDBM Manual\fR available in
75Texinfo format. To access it, run:
76
77 \fBinfo gdbm\fR
78
79.SH "REPORTING BUGS"
80Report bugs to <bug\-gdbm@gnu.org>.
81.SH COPYRIGHT
82Copyright \(co 2013 Free Software Foundation, Inc
83.br
84.na
85License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
86.br
87.ad
88This is free software: you are free to change and redistribute it.
89There is NO WARRANTY, to the extent permitted by law.
90.\" Local variables:
91.\" eval: (add-hook 'write-file-hooks 'time-stamp)
92.\" time-stamp-start: ".TH GDBM[A-Z_-]* 1 \""
93.\" time-stamp-format: "%:B %:d, %:y"
94.\" time-stamp-end: "\""
95.\" time-stamp-line-limit: 20
96.\" end:
diff --git a/doc/gdbmtool.1 b/doc/gdbmtool.1
new file mode 100644
index 0000000..e6a8f2a
--- a/dev/null
+++ b/doc/gdbmtool.1
@@ -0,0 +1,245 @@
1.\" This file is part of GDBM.
2.\" Copyright (C) 2013 Free Software Foundation, Inc.
3.\"
4.\" GDBM is free software; you can redistribute it and/or modify
5.\" it under the terms of the GNU General Public License as published by
6.\" the Free Software Foundation; either version 3, or (at your option)
7.\" any later version.
8.\"
9.\" GDBM is distributed in the hope that it will be useful,
10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12.\" GNU General Public License for more details.
13.\"
14.\" You should have received a copy of the GNU General Public License
15.\" along with GDBM. If not, see <http://www.gnu.org/licenses/>. */
16.TH GDBM_DUMP 1 "May 8, 2013" "GDBM" "GDBM User Reference"
17.SH NAME
18gdbmtool \- examine and modify a GDBM database
19.SH SYNOPSIS
20\fBgdbmtool\fR [\fB\-lmnqrs\fR] [\fB\-b\fR \fISIZE\fR] [\fB\-c\fR \fISIZE\fR]\
21 [\fB\-g\fR \fIFILE\fR] [\fB\-\-block\-size\fR=\fISIZE\fR]
22 [\fB\-\-cache\-size\fR=\fISIZE\fR] [\fB\-\-newdb\fR]\
23 [\fB\-\-no\-lock\fR] [\fB\-\-no\-mmap\fR]
24 [\fB\-\-quiet\fR] [\fB\-\-read\-only\fR] [\fB\-\-synchronize\fR]\
25 [\fIDBFILE\fR]
26.sp
27\fBgdbmtool\fR [\fB\-Vh\fR] ][\fB\-\-help\fR] [\fB\-\-usage\fR] [\fB\-\-version\fR]
28.SH DESCRIPTION
29The
30.B gdbmtool
31utility allows you to view and modify an existing GDBM database or to
32create a new one.
33.PP
34The \fIDBFILE\fR argument supplies the name of the database to open.
35If not supplied, the default name
36.B junk.gdbm
37is used instead.
38If the named database does not exist, it will be created. An existing
39database can be cleared (i.e. all records removed from it) using the
40\fB\-\-newdb\fR option (see below).
41.PP
42After successful startup,
43.B gdbmtool
44starts a loop, in which it reads
45commands from the user, executes them and prints the results on the
46standard output. If the standard input is attached to a console,
47the program runs in interactive mode.
48.PP
49The program terminates when the
50.B quit
51command is given, or end-of-file is detected on its standard input.
52.PP
53A
54.B gdbmtool
55command consists of a command verb, optionally
56followed by one or more arguments, separated by any amount of white
57space. A command verb can be entered either in full or in an
58abbreviated form, as long as that abbreviation does not match any other
59verb. Many command verbs have also one-letter abbreviation which can
60be used instead.
61.SH OPTIONS
62.TP
63\fB\-b\fR, \fB\-\-block\-size\fR=\fISIZE\fR
64Set block size.
65.TP
66\fB\-c\fR, \fB\-\-cache\-size\fR=\fISIZE\fR
67Set cache size.
68.TP
69\fB\-l\fR, \fB\-\-no\-lock\fR
70Disable file locking.
71.TP
72\fB\-m\fR, \fB\-\-no\-mmap\fR
73Do not use
74.BR mmap (2).
75.TP
76\fB\-n\fR, \fB\-\-newdb\fR
77Create the database, truncating it if it already exists.
78.TP
79\fB\-q\fR, \fB\-\-quiet\fR
80Don't print initial banner.
81.TP
82\fB\-r\fR, \fB\-\-read\-only\fR
83Open database in read-only mode.
84.TP
85\fB\-s\fR, \fB\-\-synchronize\fR
86Synchronize to disk after each write.
87.TP
88\fB\-h\fR, \fB\-\-help\fR
89Print a short usage summary.
90.TP
91\fB\-\-usage\fR
92Print a list of available options.
93.TP
94\fB\-V\fR, \fB\-\-version\fR
95Print program version
96.SH SHELL COMMANDS
97For command verbs that have single-letter abbreviations, these are
98printed after a comma. Either command verb or its abbreviation must
99be used, but not both.
100.TP
101.BR avail ", " A
102Print the "
103.BR "avail list" .
104.TP
105\fBbucket\fR, \fBB\fR \fINUM\fR
106Print the bucket number \fINUM\fR.
107.TP
108.BR cache ", " K
109Print the bucket cache.
110.TP
111.BR count ", " c
112Print the number of entries in the database.
113.TP
114.BR current ", " C
115Print the current bucket.
116.TP
117.BR data-zero ", " Z
118Toggle data nul-termination. Use
119.B status
120to examine the current status.
121.TP
122\fBdelete\fR, \fBd\fR \fIKEY\fR
123Delete entry with the given \fIKEY\fR.
124.TP
125.BR dir ", " D
126Print hash directory.
127.TP
128\fBexport\fR, \fBe\fR \fIFILE\-NAME\fR [\fBtruncate\fR] [\fBbinary\fR|\fBascii\fR]
129Export the database to the flat file \fIFILE\-NAME\fR. This is equivalent to
130.BR gdbm_dump (1).
131
132This command will not overwrite an existing file, unless the
133.B truncate
134parameter is also given. Another optional parameter determines the type of
135the dump (*note Flat files::). By default, ASCII dump will be created.
136.TP
137\fBfetch\fR, \fBf\fR \fIKEY\fR
138Fetch and display the record with the given \fIKEY\fR.
139.TP
140.BR first ", " 1
141Fetch and display the first record in the database. Subsequent
142records can be fetched using the
143.B next
144command (see below).
145.TP
146\fBhash\fR, \fBH\fR \fIKEY\fR
147Compute and display hash value for the given \fIKEY\fR.
148.TP
149.BR header ", " F
150Print file header.
151.TP
152.BR help ", " ?
153Print a concise command summary, showing each command letter and
154verb with its parameters and a short description of what it does.
155Optional arguments are enclosed in square brackets.
156.TP
157\fBimport\fR, \fBi\fR \fIFILE\-NAME\fR [\fBreplace\fR] [\fBnometa\fR]
158Import data from a flat dump file \fIFILE\-NAME\fR.
159If the
160.B replace
161argument is given, any records with the same keys as the already
162existing ones will replace them. The
163.B nometa
164argument turns off restoring meta-information from the dump file.
165.TP
166.BR key-zero ", " z
167Toggle key nul-termination. Use
168.B status
169to inspect the current state.
170.TP
171\fBlist\fR, \fBl\fR
172List the contents of the database.
173.TP
174\fBnext\fR, \fBn\fR [\fIKEY\fR]
175Sequential access: fetch and display the next record. If the \fIKEY\fR is
176given, the record following the one with this key will be fetched.
177.TP
178\fBprompt\fR \fITEXT\fR
179Changes the command prompt to the string \fITEXT\fR. The string can
180contain
181.BR "escape sequences" ,
182the special entities consisting of the
183.B %
184character followed by another character. These sequences are
185replaced in the generated prompt as follows:
186.sp
187.nf
188.ta 8n 20n
189.ul
190 SequenceExpansion
191 \fB%f\fRname of the db file
192 \fB%%\fR\fB%\fR
193.fi
194.TP
195.BR quit ", " q
196Close the database and quit the utility.
197.TP
198\fBread\fR, \fB<\fR \fIFILE\fR [\fBreplace\fR]
199Read entries from \fIFILE\fR and store them in the database. If the
200.B replace
201parameter is given, any existing records with matching keys will be replaced.
202.TP
203.BR reorganize ", " r
204Reorganize the database.
205.TP
206.BR status ", " S
207Print current program status. The following example shows the
208information displayed:
209.sp
210.nf
211.if +2
212Database file: junk.gdbm
213Zero terminated keys: yes
214Zero terminated data: yes
215.fi
216.TP
217\fBstore\fR, \fBs\fR \fIKEY\fR \fIDATA\fR
218Store the \fIDATA\fR with the given \fIKEY\fR in the database. If the
219\fIKEY\fR already exists, its data will be replaced.
220.TP
221.BR version ", " v
222Print the version of
223.BR gdbm .
224.SH "SEE ALSO"
225.BR gdbm_dump (1),
226.BR gdbm_load (1),
227.BR gdbm (3).
228.SH "REPORTING BUGS"
229Report bugs to <bug\-gdbm@gnu.org>.
230.SH COPYRIGHT
231Copyright \(co 2013 Free Software Foundation, Inc
232.br
233.na
234License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
235.br
236.ad
237This is free software: you are free to change and redistribute it.
238There is NO WARRANTY, to the extent permitted by law.
239.\" Local variables:
240.\" eval: (add-hook 'write-file-hooks 'time-stamp)
241.\" time-stamp-start: ".TH GDBM[A-Z_-]* 1 \""
242.\" time-stamp-format: "%:B %:d, %:y"
243.\" time-stamp-end: "\""
244.\" time-stamp-line-limit: 20
245.\" end:

Return to:

Send suggestions and report system problems to the System administrator.