aboutsummaryrefslogtreecommitdiff
path: root/lib/libc/db/man/btree.3
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libc/db/man/btree.3')
-rw-r--r--lib/libc/db/man/btree.350
1 files changed, 26 insertions, 24 deletions
diff --git a/lib/libc/db/man/btree.3 b/lib/libc/db/man/btree.3
index 923bc263cae2..afd3a672c884 100644
--- a/lib/libc/db/man/btree.3
+++ b/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.
.\"
-.\" @(#)btree.3 8.1 (Berkeley) 6/4/93
+.\" @(#)btree.3 8.2 (Berkeley) 1/2/94
.\"
-.TH BTREE 3
+.TH BTREE 3 "January 2, 1994"
.\".UC 7
.SH NAME
btree \- btree database access method
@@ -64,17 +64,17 @@ u_long flags;
.br
u_int cachesize;
.br
-index_t psize;
-.br
-int lorder;
-.\" .br
-.\" int maxkeypage;
+int maxkeypage;
.br
int minkeypage;
.br
+index_t psize;
+.br
int (*compare)(const DBT *key1, const DBT *key2);
.br
int (*prefix)(const DBT *key1, const DBT *key2);
+.br
+int lorder;
.RE
} BTREEINFO;
.PP
@@ -121,23 +121,9 @@ If
.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
+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
@@ -157,6 +143,14 @@ If
.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
@@ -187,6 +181,14 @@ If
.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