summaryrefslogtreecommitdiffabout
path: root/doc
authorSergey Poznyakoff <gray@gnu.org.ua>2013-12-25 09:31:59 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2013-12-25 09:31:59 (GMT)
commit46e182da4c8a338db22199e003fc2149ee3b1b81 (patch) (side-by-side diff)
treea7b382936a61ced77d284a6092d450c73e124e73 /doc
parent05fa76dfce5311161abbc64c12acbaf56f298e97 (diff)
downloadgdbm-46e182da4c8a338db22199e003fc2149ee3b1b81.tar.gz
gdbm-46e182da4c8a338db22199e003fc2149ee3b1b81.tar.bz2
Minor changes.
* src/gdbm_load.c: New options: --mmap, --cache-size and --block-size. * doc/gdbm.texinfo: Document new gdbm_load options. * doc/gdbm_load.1: Likewise. * src/gdbmdelete.c: Stylistic changes. * src/gdbmstore.c: Likewise.
Diffstat (limited to 'doc') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/gdbm.texinfo29
-rw-r--r--doc/gdbm_load.118
2 files changed, 36 insertions, 11 deletions
diff --git a/doc/gdbm.texinfo b/doc/gdbm.texinfo
index 5c962d5..201f01c 100644
--- a/doc/gdbm.texinfo
+++ b/doc/gdbm.texinfo
@@ -1892,21 +1892,21 @@ be set in a startup script file (@pxref{startup files}).
@xref{-q option}.
@end deftypevr
@anchor{open parameters}
The following variables control how the database is opened:
+@deftypevr {gdbmtool variable} numeric blocksize
+Sets the block size. @xref{Open, block_size}. Unset by default.
+@end deftypevr
+
@deftypevr {gdbmtool variable} numeric cachesize
Sets the cache size. @xref{Options, GDBM_SETCACHESIZE}.
By default this variable is not set.
@end deftypevr
-@deftypevr {gdbmtool variable} numeric blocksize
-Sets the block size. @xref{Open, block_size}. Unset by default.
-@end deftypevr
-
@anchor{openvar}
@deftypevr {gdbmtool variable} string open
Open mode. The following values are allowed:
@table @asis
@item newdb
@@ -2367,13 +2367,13 @@ $ gdbm_dump file.db file.dump
@end example
By default the utility creates dumps in ASCII format (@pxref{Flat
files,ASCII}). Another format can be requested using the
@option{--format} (@option{-H}) option.
-The @command{gdbm_load} utility understands the following command line
+The @command{gdbm_dump} utility understands the following command line
options:
@table @option
@item -H @var{fmt}
@itemx --format=@var{fmt}
Select output format. Valid values for @var{fmt} are: @samp{binary}
@@ -2402,24 +2402,37 @@ file. The utility requires at least one argument: the name of the
input flat file. If it is @samp{-}, the standard input will be read.
The format of the input file is detected automatically.
By default the utility attempts to restore the database under its
original name, as stored in the input file. It will fail to do so if
the input is in binary format. In that case, the name of the database
-to create can be given as the second argument.
+must be given as the second argument.
-In general, if two arguments are given, the second one is treated as
+In general, if two arguments are given the second one is treated as
the name of the database to create, overriding the file name specified
in the flat file.
The utility understands the following command line arguments:
@table @option
+
+@item -b @var{num}
+@itemx --block-size=@var{num}
+Sets block size. @xref{Open, block_size}.
+
+@item -c @var{num}
+@itemx --cache-size=@var{num}
+Sets cache size. @xref{Options, GDBM_SETCACHESIZE}.
+
+@item -M
+@itemx --mmap
+Use memory mapping.
+
@item -m @var{mode}
@item --mode=@var{mode}
-Set file mode. The argument is the desired file mode in octal.
+Sets the file mode. The argument is the desired file mode in octal.
@item -n
@itemx --no-meta
Do not restore file meta-data (ownership and mode) from the flat file.
@item -r
diff --git a/doc/gdbm_load.1 b/doc/gdbm_load.1
index 00aaac0..8b0e77c 100644
--- a/doc/gdbm_load.1
+++ b/doc/gdbm_load.1
@@ -1,7 +1,7 @@
-.\" This file is part of GDBM.
+.\" This file is part of GDBM. -*- nroff -*-
.\" Copyright (C) 2011, 2013 Free Software Foundation, Inc.
.\"
.\" GDBM is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3, or (at your option)
.\" any later version.
@@ -10,18 +10,21 @@
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with GDBM. If not, see <http://www.gnu.org/licenses/>. */
-.TH GDBM_LOAD 1 "May 8, 2013" "GDBM" "GDBM User Reference"
+.TH GDBM_LOAD 1 "December 25, 2013" "GDBM" "GDBM User Reference"
.SH NAME
gdbm_load \- re-create a GDBM database from a dump file.
.SH SYNOPSIS
-\fBgdbm_load\fR [\fB\-nr\fR] [\fB\-m\fR \fIMODE\fR]\
+\fBgdbm_load\fR [\fB\-Mnr\fR] [\fB\-b\fR \fINUM\fR] [\fB\-c\fR \fINUM]\
+ [\fB\-m\fR \fIMODE\fR]\
[\fB\-u\fR \fINAME\fR|\fIUID\fR[:\fINAME\fR|\fIGID\fR]]
+ [\fB\-\-block\-size\fR=\fINUM\fR] [\fB\-\-cache\-size\fR=\fINUM\fR]\
+ [\fB\-\-mmap\fR=\fINUM\fR]
[\fB\-\-mode\fR=\fIMODE\fR]\
[\fB\-\-no\-meta\fR] [\fB\-\-replace\fR]
[\fB\-\-user\fR=\fINAME\fR|\fIUID\fR[:\fINAME\fR|\fIGID\fR]]\
\fIFILE\fR [\fIDB_FILE\fR]
.sp
@@ -39,12 +42,21 @@ argument is not supplied, output the created database to the standard error.
.PP
If the input file is in ASCII dump format, the mode and ownership of
the created database are restored from the information in the dump.
This can be overridden using the command line options (see below).
.SH OPTIONS
.TP
+\fB\-b\fR, \fB\-\-block\-size\fR=\fINUM\fR
+Sets block size.
+.TP
+\fB\-c\fR, \fB\-\-cache\-size\fR=\fINUM\fR
+Sets cache size.
+.TP
+\fB\-M\fR, \fB\-\-mmap\fR
+Use memory mapping.
+.TP
\fB\-m\fR, \fB\-\-mode\fR=\fIMODE\fR
Set database file mode (octal number).
.TP
\fB\-n\fR, \fB\-\-no\-meta\fR
Do not attempt to restore database meta-data (mode and ownership).
.TP

Return to:

Send suggestions and report system problems to the System administrator.