diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-11-12 22:40:14 +0000 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-11-12 22:40:14 +0000 |
commit | 15145ee0455e4d86805d3ebf580c0f2eb070587c (patch) | |
tree | ceafd008c2a4091bd73e5b77852efe566a524e11 /doc | |
parent | 3f4a68cdaec79e1ae22287ad11954a60afcc5ac7 (diff) | |
download | gdbm-15145ee0455e4d86805d3ebf580c0f2eb070587c.tar.gz gdbm-15145ee0455e4d86805d3ebf580c0f2eb070587c.tar.bz2 |
Update the docs.
* NEWS: Update.
* doc/gdbm.texinfo: Update.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gdbm.texinfo | 27 |
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 @@ -1031,47 +1031,48 @@ many command verbs also have single-letter forms, called @dfn{command letters}. An argument is any sequence of non-whitespace characters. Notice, that currently there is no way to enter arguments containing white space. This limitation will be removed in future releases. -Each command letter takes at most two @dfn{formal parameters}, which can be +Each command takes at most two @dfn{formal parameters}, which can be optional or mandatory. If the number of actual arguments is less than the number of mandatory parameters, @command{testgdbm} will prompt you to -supply missing arguments. For example, the @samp{s} command takes two +supply missing arguments. For example, the @samp{store} command takes two mandatory parameters, so if you invoked it with no arguments, you would be prompted twice to supply the necessary data, as shown in example below: @example -testgdbm> @kbd{s} +testgdbm> @kbd{store} key> @kbd{three} data> @kbd{3} @end example However, such prompting is possible only in interactive mode. In non-interactive mode (e.g. when running a script), all arguments must -be supplied with each command, otherwise @command{testgdbm} reports an -error and exits immediately. +be supplied with each command, otherwise @command{testgdbm} will report an +error and exit immediately. @anchor{pager} @cindex pager, @command{testgdbm} @cindex @env{PAGER} Some commands produce excessive amounts of output. To help you follow -it, @command{testgdbm} will use a pager utility to display such +it, @command{testgdbm} uses a pager utility to display such output. The name of the pager utility is taken from the environment variable @env{PAGER}. The pager is invoked only in interactive mode and only if the estimated number of output lines is greater then the number of lines on your screen. @anchor{nul-termination} Many of the @command{testgdbm} commands operate on database key and data values. The utility assumes that both keys and data are @acronym{ASCII} strings, either nul-terminated or not. By default, it is assumed that strings are nul-terminated. You can change this -by using @code{z} (for keys) and @code{Z} (for data) commands. +by using @code{z} (@code{key-zero}, for keys) and @code{Z} +(@code{data-zero}, for data) commands. The following table summarizes all available commands: @deffn {command verb} count @deffnx {command abbrev} co @deffnx {command letter} c @@ -1526,12 +1527,24 @@ Set by the @code{gdbm_export} function if supplied an invalid @item GDBM_FILE_STAT_ERROR Getting information about a disk file failed. The system @code{errno} will give more details about the error. This error can be set by the following functions: @code{gdbm_open}, @code{gdbm_reorganize}. + +@kwindex GDBM_FILE_EOF +@item GDBM_FILE_EOF +End of file was encountered where more data was expected to be +present. This error can occur when fetching data from the database +and usually means that the database is truncated or otherwise corrupted. + +This error can be set by any GDBM function that does I/O. Some of +these functions are: @code{gdbm_delete}, @code{gdbm_exists}, +@code{gdbm_fetch}, @code{gdbm_export}, @code{gdbm_import}, +@code{gdbm_reorganize}, @code{gdbm_firstkey}, @code{gdbm_nextkey}, +@code{gdbm_store}. @end table @node Compatibility @chapter Compatibility with standard @code{dbm} and @code{ndbm}. @cindex compatibility layer |