diff options
Diffstat (limited to 'doc/gdbm.3')
-rw-r--r-- | doc/gdbm.3 | 29 |
1 files changed, 15 insertions, 14 deletions
@@ -1,8 +1,8 @@ .\" This file is part of GDBM. -.\" Copyright (C) 2011 Free Software Foundation, Inc. +.\" 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,17 +10,16 @@ .\" 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 3 "August 9, 2011" "GDBM" "GDBM User Reference" -.ds ve 1.9 +.TH GDBM 3 "May 8, 2013" "GDBM" "GDBM User Reference" .SH NAME -GDBM - The GNU database manager. Includes \fBdbm\fR and \fBndbm\fR -compatability. (Version \*(ve.) +GDBM \- The GNU database manager. Includes \fBdbm\fR and \fBndbm\fR +compatibility. .SH SYNOPSIS .nf .B #include <gdbm.h> .sp .BI "extern gdbm_error" " gdbm_errno"; .br @@ -197,13 +196,13 @@ key data. \fIContent\fR is the data to be associated with the \fIkey\fR. .B GDBM_INSERT Insert only, generate an error if key exists; .TP .B GDBM_REPLACE Replace contents if key exists. .PP -If a reader calls \fBgdbm_store\fR, the return value will be -1. +If a reader calls \fBgdbm_store\fR, the return value will be \-1. If called with \fBGDBM_INSERT\fR and \fIkey\fR is in the database, the return value will be 1. Otherwise, the return value is 0. \fINOTICE: If you store data for a key that is already in the data base, \fBgdbm\fI replaces the old data with the new data if called with \fBGDBM_REPLACE\fI. You 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: .BI "int gdbm_delete (GDBM_FILE " dbf ", datum " key ); \fIDbf\fR is the pointer returned by \fBgdbm_open\fR. \fIKey\fR is the key data. -The return value is -1 if the item is not present or the requester is a reader. +The return value is \-1 if the item is not present or the requester is a reader. The return value is 0 if there was a successful delete. The next two routines allow for accessing all items in the database. This access is not key sequential, but it is guaranteed to visit every key in the database once. (The order has to do with the hash values.) @@ -350,13 +349,13 @@ to be merged. This can become a CPU expensive process with time, though, especially if used in conjunction with \fBGDBM_CENTFREE\fR. \fIvalue\fR (see below) should be set to either TRUE or FALSE. \fINOTICE: This feature is still under study.\fR .PP \fIvalue\fR is the value to set \fIoption\fR to, specified as an integer pointer. \fIsize\fR is the size of the data pointed to by \fIvalue\fR. -The return value will be -1 upon failure, or 0 upon success. The global +The return value will be \-1 upon failure, or 0 upon success. The global variable \fIgdbm_errno\fR will be set upon failure. For instance, to set a database to use a cache of 10, after opening it with \fBgdbm_open\fR, but prior to accessing it in any way, the following code could be used: .sp @@ -396,36 +395,38 @@ required by the programmer, and only one file may be opened at a time. All users in compatibility mode are assumed to be writers. If the \fBgdbm\fR file is a read only, it will fail as a writer, but will also try to open it as a reader. All returned pointers in datum structures point to data that \fBgdbm\fR WILL free. They should be treated as static pointers (as standard UNIX \fBdbm\fR does). .SH LINKING -This library is accessed by specifying \fI-lgdbm\fR as the last +This library is accessed by specifying \fI\-lgdbm\fR as the last parameter to the compile line, e.g.: .sp .nf .in +5 -gcc -o prog prog.c -lgdbm +gcc \-o prog prog.c \-lgdbm .in .fi .PP If you wish to use the \fBdbm\fR or \fBndbm\fR compatibility routines, you must link in the \fIgdbm_compat\fR library as well. For example: .sp .nf .in +5 -gcc -o prog proc.c -lgdbm -lgdbm_compat +gcc \-o prog proc.c \-lgdbm \-lgdbm_compat .in .fi .\" .SH BUGS .SH "BUG REPORTS" -Send bug reports to <bug-gdbm@gnu.org>. +Send bug reports to <bug\-gdbm@gnu.org>. .SH "SEE ALSO" -dbm, ndbm -.SH AUTHOR +.BR gdbm_dump (1), +.BR gdbm_load (1), +.BR gdbmtool (1). +.SH AUTHORS by Philip A. Nelson, Jason Downs and Sergey Poznyakoff. .SH COPYRIGHT Copyright \(co 1990 - 2011 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 |