BSD 4_4_Lite1 release

[unix-history] / usr / src / lib / libc / db / man / btree.3

diff --git a/usr/src/lib/libc/db/man/btree.3 b/usr/src/lib/libc/db/man/btree.3
index 8d3df3d..a51e1e5 100644 (file)
--- a/usr/src/lib/libc/db/man/btree.3
+++ b/usr/src/lib/libc/db/man/btree.3
@@ -29,9 +29,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"

-.\"    @(#)btree.3     8.1 (Berkeley) 7/19/93
+.\"    @(#)btree.3     8.3 (Berkeley) 2/21/94

 .\"
 .\"

-.TH BTREE 3 "July 19, 1993"
+.TH BTREE 3 "February 21, 1994"

 .\".UC 7
 .SH NAME
 btree \- btree database access method
 .\".UC 7
 .SH NAME
 btree \- btree database access method


@@ -68,11 +68,11 @@ int maxkeypage;
 .br
 int minkeypage;
 .br
 .br
 int minkeypage;
 .br

-int psize;
+u_int psize;

 .br
 int (*compare)(const DBT *key1, const DBT *key2);
 .br
 .br
 int (*compare)(const DBT *key1, const DBT *key2);
 .br

-int (*prefix)(const DBT *key1, const DBT *key2);
+size_t (*prefix)(const DBT *key1, const DBT *key2);

 .br
 int lorder;
 .RE
 .br
 int lorder;
 .RE


@@ -121,24 +121,9 @@ If
 .I cachesize
 is 0 (no size is specified) a default cache is used.
 .TP
 .I cachesize
 is 0 (no size is specified) a default cache is used.
 .TP

-psize
-Page size is the size (in bytes) of the pages used for nodes in the tree.
-The minimum page size is 512 bytes and the maximum page size is 64K.
-If
-.I psize
-is 0 (no page size is specified) a page size is chosen based on the
-underlying file system I/O block size.
-.TP
-lorder
-The byte order for integers in the stored database metadata.
-The number should represent the order as an integer; for example, 
-big endian order would be the number 4,321.
-If
-.I lorder
-is 0 (no order is specified) the current host order is used.
-.TP

 maxkeypage
 maxkeypage

-Not currently used.
+The maximum number of keys which will be stored on any single page.
+Not currently implemented.

 .\" The maximum number of keys which will be stored on any single page.
 .\" Because of the way the btree data structure works,
 .\" .I maxkeypage
 .\" The maximum number of keys which will be stored on any single page.
 .\" Because of the way the btree data structure works,
 .\" .I maxkeypage


@@ -158,6 +143,14 @@ If
 .I minkeypage
 is 0 (no minimum number of keys is specified) a value of 2 is used.
 .TP
 .I minkeypage
 is 0 (no minimum number of keys is specified) a value of 2 is used.
 .TP

+psize
+Page size is the size (in bytes) of the pages used for nodes in the tree.
+The minimum page size is 512 bytes and the maximum page size is 64K.
+If
+.I psize
+is 0 (no page size is specified) a page size is chosen based on the
+underlying file system I/O block size.
+.TP

 compare
 Compare is the key comparison function.
 It must return an integer less than, equal to, or greater than zero if the
 compare
 Compare is the key comparison function.
 It must return an integer less than, equal to, or greater than zero if the


@@ -188,6 +181,14 @@ If
 .I prefix
 is NULL and a comparison routine is specified, no prefix comparison is
 done.
 .I prefix
 is NULL and a comparison routine is specified, no prefix comparison is
 done.

+.TP
+lorder
+The byte order for integers in the stored database metadata.
+The number should represent the order as an integer; for example, 
+big endian order would be the number 4,321.
+If
+.I lorder
+is 0 (no order is specified) the current host order is used.

 .PP
 If the file already exists (and the O_TRUNC flag is not specified), the
 values specified for the parameters flags, lorder and psize are ignored
 .PP
 If the file already exists (and the O_TRUNC flag is not specified), the
 values specified for the parameters flags, lorder and psize are ignored