summaryrefslogtreecommitdiffabout
path: root/doc
authorSergey Poznyakoff <gray@gnu.org.ua>2011-11-12 22:40:14 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2011-11-12 22:40:14 (GMT)
commit15145ee0455e4d86805d3ebf580c0f2eb070587c (patch) (unidiff)
treeceafd008c2a4091bd73e5b77852efe566a524e11 /doc
parent3f4a68cdaec79e1ae22287ad11954a60afcc5ac7 (diff)
downloadgdbm-15145ee0455e4d86805d3ebf580c0f2eb070587c.tar.gz
gdbm-15145ee0455e4d86805d3ebf580c0f2eb070587c.tar.bz2
Update the docs.
* NEWS: Update. * doc/gdbm.texinfo: Update.
Diffstat (limited to 'doc') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/gdbm.texinfo27
1 files changed, 20 insertions, 7 deletions
diff --git a/doc/gdbm.texinfo b/doc/gdbm.texinfo
index f676dcd..efd8cb5 100644
--- a/doc/gdbm.texinfo
+++ b/doc/gdbm.texinfo
@@ -1034,30 +1034,30 @@ An argument is any sequence of non-whitespace characters. Notice,
1034that currently there is no way to enter arguments containing white 1034that currently there is no way to enter arguments containing white
1035space. This limitation will be removed in future releases. 1035space. This limitation will be removed in future releases.
1036 1036
1037Each command letter takes at most two @dfn{formal parameters}, which can be 1037Each command takes at most two @dfn{formal parameters}, which can be
1038optional or mandatory. If the number of actual arguments is less than the 1038optional or mandatory. If the number of actual arguments is less than the
1039number of mandatory parameters, @command{testgdbm} will prompt you to 1039number of mandatory parameters, @command{testgdbm} will prompt you to
1040supply missing arguments. For example, the @samp{s} command takes two 1040supply missing arguments. For example, the @samp{store} command takes two
1041mandatory parameters, so if you invoked it with no arguments, you 1041mandatory parameters, so if you invoked it with no arguments, you
1042would be prompted twice to supply the necessary data, as shown in 1042would be prompted twice to supply the necessary data, as shown in
1043example below: 1043example below:
1044 1044
1045@example 1045@example
1046testgdbm> @kbd{s} 1046testgdbm> @kbd{store}
1047key> @kbd{three} 1047key> @kbd{three}
1048data> @kbd{3} 1048data> @kbd{3}
1049@end example 1049@end example
1050 1050
1051However, such prompting is possible only in interactive mode. In 1051However, such prompting is possible only in interactive mode. In
1052non-interactive mode (e.g. when running a script), all arguments must 1052non-interactive mode (e.g. when running a script), all arguments must
1053be supplied with each command, otherwise @command{testgdbm} reports an 1053be supplied with each command, otherwise @command{testgdbm} will report an
1054error and exits immediately. 1054error and exit immediately.
1055 1055
1056@anchor{pager} 1056@anchor{pager}
1057@cindex pager, @command{testgdbm} 1057@cindex pager, @command{testgdbm}
1058@cindex @env{PAGER} 1058@cindex @env{PAGER}
1059Some commands produce excessive amounts of output. To help you follow 1059Some commands produce excessive amounts of output. To help you follow
1060it, @command{testgdbm} will use a pager utility to display such 1060it, @command{testgdbm} uses a pager utility to display such
1061output. The name of the pager utility is taken from the environment 1061output. The name of the pager utility is taken from the environment
1062variable @env{PAGER}. The pager is invoked only in interactive mode 1062variable @env{PAGER}. The pager is invoked only in interactive mode
1063and only if the estimated number of output lines is greater then the 1063and only if the estimated number of output lines is greater then the
@@ -1068,7 +1068,8 @@ Many of the @command{testgdbm} commands operate on database key and
1068data values. The utility assumes that both keys and data are 1068data values. The utility assumes that both keys and data are
1069@acronym{ASCII} strings, either nul-terminated or not. By default, 1069@acronym{ASCII} strings, either nul-terminated or not. By default,
1070it is assumed that strings are nul-terminated. You can change this 1070it is assumed that strings are nul-terminated. You can change this
1071by using @code{z} (for keys) and @code{Z} (for data) commands. 1071by using @code{z} (@code{key-zero}, for keys) and @code{Z}
1072(@code{data-zero}, for data) commands.
1072 1073
1073The following table summarizes all available commands: 1074The following table summarizes all available commands:
1074 1075
@@ -1529,6 +1530,18 @@ will give more details about the error.
1529 1530
1530This error can be set by the following functions: @code{gdbm_open}, 1531This error can be set by the following functions: @code{gdbm_open},
1531@code{gdbm_reorganize}. 1532@code{gdbm_reorganize}.
1533
1534@kwindex GDBM_FILE_EOF
1535@item GDBM_FILE_EOF
1536End of file was encountered where more data was expected to be
1537present. This error can occur when fetching data from the database
1538and usually means that the database is truncated or otherwise corrupted.
1539
1540This error can be set by any GDBM function that does I/O. Some of
1541these functions are: @code{gdbm_delete}, @code{gdbm_exists},
1542@code{gdbm_fetch}, @code{gdbm_export}, @code{gdbm_import},
1543@code{gdbm_reorganize}, @code{gdbm_firstkey}, @code{gdbm_nextkey},
1544@code{gdbm_store}.
1532@end table 1545@end table
1533 1546
1534@node Compatibility 1547@node Compatibility

Return to:

Send suggestions and report system problems to the System administrator.