aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2013-05-08 16:27:01 +0000
committerSergey Poznyakoff <gray@gnu.org.ua>2013-05-08 16:27:01 +0000
commit6658f41e38fec9e007a0fbd0883e030f6337e28d (patch)
treed7ecc0b72b23a01a2bfa10e8a7bb184d704269dc
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.
-rw-r--r--ChangeLog19
-rw-r--r--configure.ac2
-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
-rw-r--r--src/.cvsignore1
-rw-r--r--src/Makefile.am5
-rw-r--r--src/gdbm_dump.c8
-rw-r--r--src/gdbm_load.c6
-rw-r--r--src/testgdbm.c107
13 files changed, 636 insertions, 106 deletions
diff --git a/ChangeLog b/ChangeLog
index e7f1637..02cbe9d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,8 +1,27 @@
12013-05-08 Sergey Poznyakoff <gray@gnu.org.ua> 12013-05-08 Sergey Poznyakoff <gray@gnu.org.ua>
2 2
3 Rename testgdbm to gdbmtool. Improve documentation.
4
5 * configure.ac: Fix a typo.
6 * src/.cvsignore: Add gdbmtool
7 * src/Makefile.am: Rename testgdbm to gdbmtool. Source
8 file not renamed because of CVS deficiency.
9 * src/gdbm_dump.c: Enable NLS.
10 * src/gdbm_load.c: Likewise.
11 * src/testgdbm.c: New option -q (--quiet).
12 New command: prompt.
13 * doc/Makefile.am (man_MANS): Add new manpages.
14 * doc/gdbmtool.1: New file.
15 * doc/gdbm_load.1: New file.
16 * doc/gdbm_dump.1: New file.
17 * doc/gdbm.3: Update.
18 * doc/gdbm.texinfo: Update.
19
202013-05-08 Sergey Poznyakoff <gray@gnu.org.ua>
21
3 * configure.ac: (AC_INIT): Add webpage URL. 22 * configure.ac: (AC_INIT): Add webpage URL.
4 23
52013-05-08 Sergey Poznyakoff <gray@gnu.org.ua> 242013-05-08 Sergey Poznyakoff <gray@gnu.org.ua>
6 25
7 Improve testgdbm; install some more bugfixes. 26 Improve testgdbm; install some more bugfixes.
8 27
diff --git a/configure.ac b/configure.ac
index e43bc53..ce00344 100644
--- a/configure.ac
+++ b/configure.ac
@@ -19,13 +19,13 @@ m4_define([_GDBM_VERSION_MINOR], 10)
19m4_define([_GDBM_VERSION_PATCH], 90) 19m4_define([_GDBM_VERSION_PATCH], 90)
20 20
21AC_INIT([gdbm], 21AC_INIT([gdbm],
22 _GDBM_VERSION_MAJOR._GDBM_VERSION_MINOR[]m4_ifdef([_GDBM_VERSION_PATCH],._GDBM_VERSION_PATCH), 22 _GDBM_VERSION_MAJOR._GDBM_VERSION_MINOR[]m4_ifdef([_GDBM_VERSION_PATCH],._GDBM_VERSION_PATCH),
23 [bug-gdbm@gnu.org],, 23 [bug-gdbm@gnu.org],,
24 [http://www.gnu.org/software/gdbm]) 24 [http://www.gnu.org/software/gdbm])
25AC_PREREQ(2.69)a 25AC_PREREQ(2.69)
26AC_CONFIG_SRCDIR([src/gdbmdefs.h]) 26AC_CONFIG_SRCDIR([src/gdbmdefs.h])
27AC_CONFIG_AUX_DIR([build-aux]) 27AC_CONFIG_AUX_DIR([build-aux])
28AC_CONFIG_HEADERS([autoconf.h]) 28AC_CONFIG_HEADERS([autoconf.h])
29AC_CONFIG_MACRO_DIR([m4]) 29AC_CONFIG_MACRO_DIR([m4])
30AM_INIT_AUTOMAKE([gnits 1.11 std-options silent-rules]) 30AM_INIT_AUTOMAKE([gnits 1.11 std-options silent-rules])
31 31
diff --git a/doc/Makefile.am b/doc/Makefile.am
index f4059d0..223c892 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -17,13 +17,13 @@
17# Documentation 17# Documentation
18 18
19info_TEXINFOS = gdbm.texinfo 19info_TEXINFOS = gdbm.texinfo
20gdbm_TEXINFOS=\ 20gdbm_TEXINFOS=\
21 fdl.texi 21 fdl.texi
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)
25 25
26GENDOCS=gendocs.sh 26GENDOCS=gendocs.sh
27 27
28TEXI2DVI=texi2dvi -E 28TEXI2DVI=texi2dvi -E
29 29
diff --git a/doc/gdbm.3 b/doc/gdbm.3
index e3b90d4..c08ece3 100644
--- a/doc/gdbm.3
+++ b/doc/gdbm.3
@@ -1,8 +1,8 @@
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.\"
4.\" GDBM is free software; you can redistribute it and/or modify 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 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) 6.\" the Free Software Foundation; either version 3, or (at your option)
7.\" any later version. 7.\" any later version.
8.\" 8.\"
@@ -10,17 +10,16 @@
10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of 10.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12.\" GNU General Public License for more details. 12.\" GNU General Public License for more details.
13.\" 13.\"
14.\" You should have received a copy of the GNU General Public License 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/>. */ 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
22.nf 21.nf
23.B #include <gdbm.h> 22.B #include <gdbm.h>
24.sp 23.sp
25.BI "extern gdbm_error" " gdbm_errno"; 24.BI "extern gdbm_error" " gdbm_errno";
26.br 25.br
@@ -197,13 +196,13 @@ key data. \fIContent\fR is the data to be associated with the \fIkey\fR.
197.B GDBM_INSERT 196.B GDBM_INSERT
198Insert only, generate an error if key exists; 197Insert only, generate an error if key exists;
199.TP 198.TP
200.B GDBM_REPLACE 199.B GDBM_REPLACE
201Replace contents if key exists. 200Replace 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
205value will be 1. Otherwise, the return value is 0. 204value will be 1. Otherwise, the return value is 0.
206 205
207\fINOTICE: If you store data for a key that is already in the data base, 206\fINOTICE: If you store data for a key that is already in the data base,
208\fBgdbm\fI replaces the old data with the new data if called with \fBGDBM_REPLACE\fI. 207\fBgdbm\fI replaces the old data with the new data if called with \fBGDBM_REPLACE\fI.
209You do not get two data items for the same key and you do not get an 208You do not get two data items for the same key and you do not get an
@@ -242,13 +241,13 @@ To remove some data from the database:
242 241
243.BI "int gdbm_delete (GDBM_FILE " dbf ", datum " key ); 242.BI "int gdbm_delete (GDBM_FILE " dbf ", datum " key );
244 243
245\fIDbf\fR is the pointer returned by \fBgdbm_open\fR. \fIKey\fR is the 244\fIDbf\fR is the pointer returned by \fBgdbm_open\fR. \fIKey\fR is the
246key data. 245key 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.
250 249
251The next two routines allow for accessing all items in the database. This 250The next two routines allow for accessing all items in the database. This
252access is not key sequential, but it is guaranteed to visit every key in 251access is not key sequential, but it is guaranteed to visit every key in
253the database once. (The order has to do with the hash values.) 252the database once. (The order has to do with the hash values.)
254 253
@@ -350,13 +349,13 @@ to be merged. This can become a CPU expensive process with time, though,
350especially if used in conjunction with \fBGDBM_CENTFREE\fR. \fIvalue\fR 349especially if used in conjunction with \fBGDBM_CENTFREE\fR. \fIvalue\fR
351(see below) should be set to either TRUE or FALSE. 350(see below) should be set to either TRUE or FALSE.
352\fINOTICE: This feature is still under study.\fR 351\fINOTICE: This feature is still under study.\fR
353.PP 352.PP
354\fIvalue\fR is the value to set \fIoption\fR to, specified as an integer 353\fIvalue\fR is the value to set \fIoption\fR to, specified as an integer
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.
358 357
359For instance, to set a database to use a cache of 10, after opening it 358For instance, to set a database to use a cache of 10, after opening it
360with \fBgdbm_open\fR, but prior to accessing it in any way, the following 359with \fBgdbm_open\fR, but prior to accessing it in any way, the following
361code could be used: 360code could be used:
362.sp 361.sp
@@ -396,36 +395,38 @@ required by the programmer, and only one file may be opened at a time.
396All users in compatibility mode are assumed to be writers. If the 395All users in compatibility mode are assumed to be writers. If the
397\fBgdbm\fR file is a read only, it will fail as a writer, but will 396\fBgdbm\fR file is a read only, it will fail as a writer, but will
398also try to open it as a reader. All returned pointers in datum 397also try to open it as a reader. All returned pointers in datum
399structures point to data that \fBgdbm\fR WILL free. They should be 398structures point to data that \fBgdbm\fR WILL free. They should be
400treated as static pointers (as standard UNIX \fBdbm\fR does). 399treated 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.:
404.sp 403.sp
405.nf 404.nf
406.in +5 405.in +5
407gcc -o prog prog.c -lgdbm 406gcc \-o prog prog.c \-lgdbm
408.in 407.in
409.fi 408.fi
410.PP 409.PP
411If you wish to use the \fBdbm\fR or \fBndbm\fR compatibility routines, 410If you wish to use the \fBdbm\fR or \fBndbm\fR compatibility routines,
412you must link in the \fIgdbm_compat\fR library as well. For example: 411you must link in the \fIgdbm_compat\fR library as well. For example:
413.sp 412.sp
414.nf 413.nf
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
418.fi 417.fi
419.\" .SH BUGS 418.\" .SH BUGS
420 419
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"