summaryrefslogtreecommitdiffstats
path: root/lib/libc/db/man
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2002-12-19 09:40:28 +0000
committerru <ru@FreeBSD.org>2002-12-19 09:40:28 +0000
commit51fe7c1a888747c57136cc34ec54a93a0487b745 (patch)
treef0781cb8e5be3a35234a6d0c123d6ae11ba70e40 /lib/libc/db/man
parent3424a53ebeadf7ab320c37cf93702953cee94efe (diff)
downloadFreeBSD-src-51fe7c1a888747c57136cc34ec54a93a0487b745.zip
FreeBSD-src-51fe7c1a888747c57136cc34ec54a93a0487b745.tar.gz
mdoc(7) police: "The .Fa argument.".
Diffstat (limited to 'lib/libc/db/man')
-rw-r--r--lib/libc/db/man/btree.37
-rw-r--r--lib/libc/db/man/dbm.36
-rw-r--r--lib/libc/db/man/dbopen.328
-rw-r--r--lib/libc/db/man/hash.319
-rw-r--r--lib/libc/db/man/mpool.38
5 files changed, 46 insertions, 22 deletions
diff --git a/lib/libc/db/man/btree.3 b/lib/libc/db/man/btree.3
index 99b2b15..b861aeb 100644
--- a/lib/libc/db/man/btree.3
+++ b/lib/libc/db/man/btree.3
@@ -172,7 +172,9 @@ is
(no comparison function is specified), the keys are compared
lexically, with shorter keys considered less than longer keys.
.It Va prefix
-.Va Prefix
+The
+.Va prefix
+element
is the prefix comparison function.
If specified, this routine must return the number of bytes of the second key
argument which are necessary to determine that it is greater than the first
@@ -206,10 +208,11 @@ is 0 (no order is specified) the current host order is used.
If the file already exists (and the
.Dv O_TRUNC
flag is not specified), the
-values specified for the parameters
+values specified for the
.Va flags , lorder
and
.Va psize
+arguments
are ignored
in favor of the values used when the tree was created.
.Pp
diff --git a/lib/libc/db/man/dbm.3 b/lib/libc/db/man/dbm.3
index a78d35a..1fd4d85 100644
--- a/lib/libc/db/man/dbm.3
+++ b/lib/libc/db/man/dbm.3
@@ -77,7 +77,9 @@ The
.Fn dbm_open base flags mode
function
opens or creates a database.
+The
.Fa base
+argument
is the basename of the file containing
the database; the actual database has a
.Pa .db
@@ -88,9 +90,11 @@ is
.Qq Li /home/me/mystuff
then the actual database is in the file
.Pa /home/me/mystuff.db .
+The
.Fa flags
and
.Fa mode
+arguments
are passed to
.Xr open 2 .
.Pq Dv O_RDWR | O_CREAT
@@ -129,7 +133,9 @@ The
.Fn dbm_store db key data flags
function
inserts or replaces an entry in the database.
+The
.Fa flags
+argument
is either
.Dv DBM_INSERT
or
diff --git a/lib/libc/db/man/dbopen.3 b/lib/libc/db/man/dbopen.3
index 44ff657..e67fc29 100644
--- a/lib/libc/db/man/dbopen.3
+++ b/lib/libc/db/man/dbopen.3
@@ -69,7 +69,9 @@ opens
.Fa file
for reading and/or writing.
Files never intended to be preserved on disk may be created by setting
-the file parameter to
+the
+.Fa file
+argument to
.Dv NULL .
.Pp
The
@@ -180,15 +182,16 @@ with a
or
.Va sync
function may result in inconsistent or lost information.
-.Va Close
+.Va close
routines return -1 on error (setting
.Va errno )
and 0 on success.
.It Va del
A pointer to a routine to remove key/data pairs from the database.
.Pp
-The parameter
+The
.Fa flags
+argument
may be set to the following value:
.Bl -tag -width indent
.It Dv R_CURSOR
@@ -196,7 +199,7 @@ Delete the record referenced by the cursor.
The cursor must have previously been initialized.
.El
.Pp
-.Va Delete
+.Va delete
routines return -1 on error (setting
.Va errno ) ,
0 on success, and 1 if the specified
@@ -230,7 +233,7 @@ The address and length of the data associated with the specified
.Fa key
are returned in the structure referenced by
.Fa data .
-.Va Get
+.Va get
routines return -1 on error (setting
.Va errno ) ,
0 on success, and 1 if the
@@ -239,8 +242,9 @@ was not in the file.
.It Va put
A pointer to a routine to store key/data pairs in the database.
.Pp
-The parameter
+The
.Fa flags
+argument
may be set to one of the following values:
.Bl -tag -width indent
.It Dv R_CURSOR
@@ -302,7 +306,7 @@ The default behavior of the
routines is to enter the new key/data pair, replacing any previously
existing key.
.Pp
-.Va Put
+.Va put
routines return -1 on error (setting
.Va errno ) ,
0 on success, and 1 if the
@@ -336,7 +340,7 @@ while records inserted in front of the cursor will be returned.
.Pp
The
.Fa flags
-value
+argument
.Em must
be set to one of the following values:
.Bl -tag -width indent
@@ -390,7 +394,7 @@ and
access methods because they each imply that the keys have an inherent
order which does not change.
.Pp
-.Va Seq
+.Va seq
routines return -1 on error (setting
.Va errno ) ,
0 on success and 1 if there are no key/data pairs less than or greater
@@ -410,7 +414,7 @@ routine has no effect and will always succeed.
.Pp
The
.Fa flags
-value may be set to the following value:
+argument may be set to the following value:
.Bl -tag -width indent
.It Dv R_RECNOSYNC
If the
@@ -427,7 +431,7 @@ field of the
manual page for more information.)
.El
.Pp
-.Va Sync
+.Va sync
routines return -1 on error (setting
.Va errno )
and 0 on success.
@@ -471,7 +475,7 @@ or the following:
.It Bq Er EFTYPE
A file is incorrectly formatted.
.It Bq Er EINVAL
-A parameter has been specified (hash function, pad byte etc.) that is
+An argument has been specified (hash function, pad byte etc.) that is
incompatible with the current file specification or which is not
meaningful for the function (for example, use of the cursor without
prior initialization) or there is a mismatch between the version
diff --git a/lib/libc/db/man/hash.3 b/lib/libc/db/man/hash.3
index 4ed6df9..527f59f 100644
--- a/lib/libc/db/man/hash.3
+++ b/lib/libc/db/man/hash.3
@@ -77,14 +77,18 @@ typedef struct {
The elements of this structure are as follows:
.Bl -tag -width indent
.It Va bsize
-.Va Bsize
+The
+.Va bsize
+element
defines the
.Nm
table bucket size, and is, by default, 256 bytes.
It may be preferable to increase the page size for disk-resident tables
and tables with large data items.
.It Va ffactor
-.Va Ffactor
+The
+.Va ffactor
+element
indicates a desired density within the
.Nm
table.
@@ -94,7 +98,9 @@ one bucket, determining when the
table grows or shrinks.
The default value is 8.
.It Va nelem
-.Va Nelem
+The
+.Va nelem
+element
is an estimate of the final size of the
.Nm
table.
@@ -110,7 +116,9 @@ This value is
advisory, and the access method will allocate more memory rather
than fail.
.It Va hash
-.Va Hash
+The
+.Va hash
+element
is a user defined
.Nm
function.
@@ -141,10 +149,11 @@ value specified when the tree was created is used.
If the file already exists (and the
.Dv O_TRUNC
flag is not specified), the
-values specified for the parameters
+values specified for the
.Va bsize , ffactor , lorder
and
.Va nelem
+arguments
are
ignored and the values specified when the tree was created are used.
.Pp
diff --git a/lib/libc/db/man/mpool.3 b/lib/libc/db/man/mpool.3
index 26333b8..965be55 100644
--- a/lib/libc/db/man/mpool.3
+++ b/lib/libc/db/man/mpool.3
@@ -146,20 +146,22 @@ is returned and
is set.
The
.Fa flags
-parameter is not currently used.
+argument is not currently used.
.Pp
The function
.Fn mpool_put
unpins the page referenced by
.Fa pgaddr .
-.Fa Pgaddr
+The
+.Fa pgaddr
+argument
must be an address previously returned by
.Fn mpool_get
or
.Fn mpool_new .
The
.Fa flags
-value is specified by
+argument is specified by
.Em or Ns 'ing
any of the following values:
.Bl -tag -width indent
OpenPOWER on IntegriCloud