move doc/man to tokudb/man. addresses #136

git-svn-id: file:///svn/tokudb@984 c7de825b-a66e-492c-adef-691d508d4ae1

man/foo.1

+\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH FOO 1 "MARCH 1995" Linux "User Manuals"
+.SH NAME
+foo \- frobnicate the bar library
+.SH SYNOPSIS
+.B foo [-bar] [-c
+.I config-file
+.B ]
+.I file
+.B ...
+.SH DESCRIPTION
+.B foo
+frobnicates the bar library by tweaking internal
+symbol tables. By default it parses all baz segments
+and rearranges them in reverse order by time for the
+.BR xyzzy (1)
+linker to find them. The symdef entry is then compressed
+using the WBG (Whiz-Bang-Gizmo) algorithm.
+All files are processed in the order specified.
+.SH OPTIONS
+.IP -b
+Do not write `busy' to stdout while processing.
+.IP "-c config-file"
+Use the alternate system wide
+.I config-file
+instead of
+.IR /etc/foo.conf .
+This overrides any
+.B FOOCONF
+environment variable.
+.IP -a
+In addition to the baz segments, also parse the
+blurfl headers.
+.IP -r
+Recursive mode. Operates as fast as lightning
+at the expense of a megabyte of virtual memory.
+.SH FILES
+.I /etc/foo.conf
+.RS
+The system wide configuration file. See
+.BR foo (5)
+for further details.
+.RE
+.I ~/.foorc
+.RS
+Per user configuration file. See
+.BR foo (5)
+for further details.
+.SH ENVIRONMENT
+.IP FOOCONF
+If non-null the full pathname for an alternate system wide
+.IR foo.conf .
+Overridden by the
+.B -c
+option.
+.SH DIAGNOSTICS
+The following diagnostics may be issued on stderr:
+ 
+Bad magic number.
+.RS
+The input file does not look like an archive file.
+.RE
+Old style baz segments.
+.RS
+.B foo
+can only handle new style baz segments. COBOL
+object libraries are not supported in this version.
+.SH BUGS
+The command name should have been chosen more carefully
+to reflect its purpose.
+.SH AUTHOR
+Jens Schweikhardt <howto at schweikhardt dot net>
+.SH "SEE ALSO"
+.BR bar (1),
+.BR foo (5),
+.BR xyzzy (1)

man/tdb_create.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH db_create 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+db_create
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.HP 13
+.BI "int db_create(DB **" dbp ", DB_ENV *" env ", u_int32_t " flags ");"
+.SH DESCRIPTION
+\fBdb_create\fR creates a DB handle, allocating memory and initializing its contents.
+.LP
+After creating the handle, you open a database using \fB*\fIdbp\fB->open()\fR.
+
+To free the memory associated with the handle call \fB*\fIdbp\fB->close()\fR
+(or \fBremove\fR or \fBrename\fR or \fBverify\fR when those are ready.)
+
+The handle contains a field called \fBapp_private\fR which is declared
+as type \fBvoid*\fR.  This field is provided for the use of the
+application and is not further used by TokuDB.  One typical use of
+\fBapp_private\fR is to pass information about the database to a
+user-defined sort-order function.
+
+.SH PARAMETERS
+.IP \fIdbp
+A pointer to a \fBDB\fR variable.  The \fBdb_create\fR function does something like \fB*\fIdbp\fB=malloc(...)\fR.
+
+.IP \fIenv
+If \fIenv\fB==NULL\fR then the database is not part of an environment
+(hence it has not transactions, locking, or recovery.)
+
+Otherwise the database is created within the specified environment,
+and inherits the properties of that environment.  (For example if
+logging for recovery is enabled by the environment, then the database
+will have logging too.)
+
+.IP \fIflags
+The \fIflags\fR parameter must be set to 0.
+
+.SH RETURN VALUE
+.LP
+Returns zero on success.  The following non-zero errors can be returned:
+.IP \fBEINVAL
+You passed invalid parameters to this operation.  In many cases
+\fBEINVAL\fR
+is not a very helpful error code, indicating only that you did something wrong.
+
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH RESTRICTIONS
+.LP
+Restrictions: At most a few thousand databases per file.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.
+

man/tdb_del.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH DB->del 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+DB->del
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.HP 12
+.BI "int DB->del(DB *" db ,
+.br
+.BI "DB_TXN *" txnid ,
+.br
+.BI "DBT *" key ,
+.br
+.BI "u_int32_t " flags );
+.br
+.SH DESCRIPTION
+.B DB->del
+removes all the key/data pairs that match \fIkey\fR.  If there are
+duplicates, all matching records are removed.
+
+When called on a secondary index (associated via
+\fBDB->associate(3)\fR), all the matching keys in the secondary
+database are used to identify keys/data pairs in the primary database.
+The keys in the primary are all removed, and all the corresponding
+records in all the secondary indices are removed.
+
+.SH PARAMETERS
+.IP \fIdb
+The \fBDB\fR handle for the database\fR.
+.IP \fItxnid
+Either \fBNULL\fR or a \fBTXNID\fR.
+.IP \fIkey
+The key to be deleted.
+.IP \fIflags
+Must be zero or \fBDB_DELETE_ANY\fR.
+Using \fBDB_DELETE_ANY\fR causes \fBDB->del()\fR to return 0 even if
+there are no matching key/data pairs.
+
+
+.SH RETURN VALUE
+.LP
+Returns zero on success.  Success is defined to be that either there
+was at least one matching key/data pair and it was deleted, or there
+were no matching key/data pairs and \fBDB_DELETE_ANY\fR was passed
+(and nothing else went wrong.)
+
+The following non-zero values can be returned:
+.IP \fBDB_NOTFOUND
+If the flags do not include \fBDB_DELETE_ANY\fR and there was no
+matching key/data pair, then return \fBDB_NOTFOUND\fR.
+.IP \fBDB_DEADLOCK
+The system discovered deadlock cycle involving this and other transactions.
+This operation was killed.
+.IP \fBDB_LOCK_NOTGRANTED
+In an environment configured for lock timeouts, the system was unable to grant a lock within the allowed time.
+.IP \fBEINVAL
+You passed invalid parameters to this operation.  In many cases
+\fBEINVAL\fR
+is not a very helpful error code, indicating only that you did something wrong.
+.SH PERFORMANCE DISCUSSION
+
+Performing a deletion without \fBDB_DELETE_ANY\fR is relatively
+expensive.  For example, suppose you have a large database that is
+stored on disk and is much larger than main memory.  Then
+\fBDB->get()\fR using a randomly selected key usually requires at
+least one disk-head movement, limiting you about 100 to 150 get
+operations per second per disk drive.  A delete operation that doesn't
+require the \fBDB_NOTFOUND\fR result to be computed can run much
+faster, however (orders of magnitude faster in some cases.)  For the
+\fBDB->del\fR operation to compute the \fBDB_NOTFOUND\fR result
+requires a get, which slows down the deletions.
+
+However, suppose that the key you are deleting is already in main
+memory (because you recently accessed it).  In that case, there is
+likely to be little or no performance difference between using
+\fBDB_DELETE_ANY\fR or not.
+
+Associated secondary indexes can also slow down deletion operations,
+since TokuDB performs a \fBDB->get\fR to get the primary key/data pair
+so that it can use the callback function to compute all the secondary
+keys that must be deleted.  
+
+One way to achieve fast deletions with secondary indices is to design
+your primary key so that contiguous ranges will be removed from your
+database at the same time.  For example, if you design your primary
+key to be a timestamp, and you expire the oldest data first, then
+deletions can run fast: Use a cursor to find the leftmost item, and
+delete it, move right, delete some more, and so forth.  The cursor
+scan is fast, and the deletes on all the secondary keys will be fast
+too.
+
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.

man/tdb_env_close.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH DB_ENV->close 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+DB_ENV->close
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.HP 13
+.BI "int DB_ENV->close(DB_ENV *" dbenv ", u_int32_t " flags ");"
+.SH DESCRIPTION
+Closes \fIenv\fR, a TokuDB environment, freeing any allocated resources and closing any underlying subystems.
+
+Close all databases, cursors, and abort or commit all transactions
+that refer the environment before closing the environment.
+
+Do not use the environment after closing it (even if the close
+operation returns some sort of failure).  Its underlying memory is
+likely to have been \fBfree()\fR'd.
+
+.SH PARAMETERS
+.IP \fIdbenv
+The environment.  The \fBDB_ENV->close()\fR environment does something like \fBfree(\fIdbenv\fB)\fR as part of its operation.
+
+.IP \fIflags
+The \fIflags\fR parameter must be set to 0.
+
+.SH RETURN VALUE
+.LP
+Returns zero on success, and nonzero on failure.
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.

man/tdb_env_create.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH db_env_create 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+db_env_create
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.HP 13
+.BI "int db_env_create(DB_ENV **" dbenvp ", u_int32_t " flags ");"
+.SH DESCRIPTION
+\fBdb_env_create\fR creates a DB_ENV handle, allocating memory and initializing its contents.
+.LP
+After creating the handle, you open a database using \fBdb_create\fR and then \fBDB->open()\fR.
+
+To free the memory associated with the handle call \fB*\fIdbenvp\fB->close()\fR
+(or \fBremove\fR when that is ready.)
+
+The handle contains a field called \fBapp_private\fR which is declared
+as type \fBvoid*\fR.  This field is provided for the use of the
+application and is not further used by TokuDB.
+
+.SH PARAMETERS
+.IP \fIdbenvp
+A pointer to a \fBDB_ENV\fR variable.  The \fBdb_env_create\fR function does something like \fB*\fIdbenvp\fB=malloc(...)\fR.
+
+.IP \fIflags
+The \fIflags\fR parameter must be set to 0.
+
+.SH RETURN VALUE
+.LP
+Returns zero on success.  The following non-zero errors can be returned:
+.IP \fBEINVAL
+You passed invalid parameters to this operation.  In many cases
+\fBEINVAL\fR
+is not a very helpful error code, indicating only that you did something wrong.
+
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH RESTRICTIONS
+.LP
+Restrictions: At most a few thousand databases per file.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.

man/tdb_env_err.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH DB_ENV->err 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+DB_ENV->err
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.HP 13
+.BI "void DB_ENV->err(DB_ENV *" dbenv ", int " error ", const char *" fmt ", ...);"
+.SH DESCRIPTION
+Prints an error message.  The error comprises
+.IP prefix
+An optional prefix string (set with \fBDB_ENV->set_errpfx\fR), followed by a colon and a space.
+.IP printf
+An optional printf-style message (provided by \fIfmt\fR, or no printf message is \fIfmt\fR is \fBNULL\fR.
+.IP separator
+A colon and a space
+.IP errstring
+An error string provided by \fBdb_strerror\fR.
+.SH PARAMETERS
+.IP \fIerror
+The error number.
+
+.IP \fIfmt
+Either \fBNULL\fR or a printf-style message.
+
+.IP ...
+The extra arguments needed by the printf.
+
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.

man/tdb_env_open.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH DB_ENV->open 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+DB_ENV->open
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.HP 13
+.BI "int DB_ENV->open(DB_ENV *" dbenv ", char *" db_home ", u_int32_t " flags " int " mode ");"
+.SH DESCRIPTION
+Open a TokuDB environment (which should previously have been created using \fBdb_env_create\fR, and which should eventually be closed using \fBDB_env->close()\fR.
+
+.SH PARAMETERS
+.IP \fIdbenv
+The environment.
+
+.IP \fIdb_home
+The name of the environment's directory if non-\fBNULL\fR.  Can be
+either a relative pathame (relative to the current working directory),
+or an absolute pathname.
+
+if \fidb_home\fR is \fBNULL\fR and the \fBDB_USE_ENVIRON\fR or \fBDB_USE_ENVIRON_ROOT\fB flag is set, then the value of the 
+\fBDB_HOME\fR environment variable is used.
+
+.IP \fIflags
+The \fIflags\fR parameter must be set to 0 or the bitwise or of one or more of the following values:
+..RS 4
+.IP \fBDB_INIT_LOCK
+.IP \fBDB_INIT_LOG
+.IP \fBDB_INIT_MPOOL
+.IP \fBDB_INIT_TXN
+.IP \fBDB_RECOVER
+.IP \fBDB_RECOVER_FATAL
+.IP \fBDB_USE_ENVIRON
+.IP \fBDB_USE_ENVIRON_ROOT
+.IP \fBDB_CREATE
+.IP \fBDB_PRIVATE
+.IP \fBDB_THREAD
+
+
+.SH RETURN VALUE
+.LP
+Returns zero on success, and nonzero on failure.
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.

man/tdb_env_set_cachesize.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH DB_ENV->set_cachesize 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+DB->set_cachesize
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.HP 13
+.BI "int DB_ENV->set_cachesize(DB_ENV *" dbenv ", u_int32_t " gbytes ", u_int32_t " bytes ", int " ncache ");"
+.br
+.SH DESCRIPTION
+\fBDB_ENV->set_cachesize\fr sets the size of the shared-memory buffer
+pool (the cache) to \fIgbytes\fR* gibibytes plus \fIbytes\fR bytes.
+
+.SH PARAMETERS
+.IP \fIdbenv
+The environment (which must have been created but not yet opened).
+
+The environment is modified, not just this particular handle.  If some
+other thread or process has opened the same environment, then this call
+is ignored.
+.IP \fIgbytes
+The number of gibibytes (gibi equals 2^30, giga equals 10^9) to allocate.
+.IP \fIbytes
+The number of additional bytes to allocate.
+.IP \fIncache
+Ignored in TokuDB.
+.SH RETURN VALUE
+.LP
+Returns zero on success.  The following non-zero errors can be returned:
+.IP \fBEINVAL
+You passed invalid parameters to this operation.  In many cases
+\fBEINVAL\fR
+is not a very helpful error code, indicating only that you did something wrong.
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.

man/tdb_env_set_lk_max_locks.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH DB_ENV->set_lk_max_locks 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+DB_ENV->set_lk_max_locks
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.BI "int DB_ENV->set_lk_max_locks(DB_ENV *" dbenv ", u_int32_t " max ");"
+.br
+.BI "int DB_ENV->set_lk_max(DB_ENV *" dbenv ", u_int32_t " max ");"
+.SH DESCRIPTION
+These functions provide compatibility with Berkeley DB.  The TokuDB
+locking system has no limits on the number of locks, and these function ignore their arguments, returning 0.
+.LP
+.SH RETURN VALUE
+.LP
+Returns zero.
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH RESTRICTIONS
+.LP
+Restrictions: At most a few thousand databases per file.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.

man/tdb_open.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH DB->open 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+DB->open
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.HP 13
+.BI "int DB->open(DB *" db ,
+.br
+.BI "DB_TXN *" txnid ,
+.br
+.BI "const char *" file ,
+.br
+.BI "const char *" database ,
+.br
+.BI "DBTYPE " type ,
+.br
+.BI "u_int32_t " flags ,
+.br
+.BI "int " mode );
+.br
+.SH DESCRIPTION
+.B DB->open
+opens the database named by
+.I file
+and
+.I database.
+.LP
+The database is opened read/write.
+.LP
+The \fBDB->open\fR operation is expensive.  If possible, open a
+database once, and reuse the \fBDB\fR handle for many operations.
+.SH PARAMETERS
+.IP \fIdb
+A unopened \fBDB\fR handle that was created using \fBdb_create()\fR.
+.IP \fItxnid
+Either \fBNULL\fR or a \fBTXNID\fR.
+.IP \fIfile
+The name of the file that holds the database.  
+.IP
+The
+.B file
+must be non-\fBNULL\fR.  TokuDB does not currently support in-memory databases.
+.IP \fIdatabase
+If \fBNULL\fR then the file contains only one unnamed database.
+Otherwise \fIdatabase\fR specifies the name of a database stored
+within the file.
+.IP \fItype
+must be set to \fBDB_BTREE\fR.
+.IP \fIflags
+must be zero or the bitwise-or of one or more of the following values:
+.RS 4
+.IP \fBDB_CREATE
+Create the database if it does not exist.  If the database does not
+already exist and \fBDB_CREATE\fR is not specified, then the
+\fBDB->open\fR will fail.
+.RE
+.IP \fImode
+The mode (see \fBchmod\fR(2)) modified by the \fBumask\fR(2), used when a file is created.
+.SH RETURN VALUE
+.LP
+Returns zero on success.  The following non-zero errors can be returned:
+.IP \fBDB_DEADLOCK
+The system discovered deadlock cycle involving this and other transactions.
+This operation was killed.
+.IP \fBDB_LOCK_NOTGRANTED
+In an environment configured for lock timeouts, the system was unable to grant a lock within the allowed time.
+.IP \fBENOENT
+The file or directory does not exist.
+.IP \fBEINVAL
+You passed invalid parameters to this operation.  In many cases
+\fBEINVAL\fR
+is not a very helpful error code, indicating only that you did something wrong.
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH RESTRICTIONS
+.LP
+Restrictions: At most a few thousand databases per file.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.

man/tdb_put.3

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH DB->put 3 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+DB->open
+.SH SYNOPSIS
+.LP
+\fB #include <db.h>
+.br
+.sp
+.HP 12
+.BI "int DB->put(DB *" db ,
+.br
+.BI "DB_TXN *" txnid ,
+.br
+.BI "DBT *" key ,
+.br
+.BI "DBT *" data ,
+.br
+.BI "u_int32_t " flags );
+.br
+.SH DESCRIPTION
+.B DB->put
+stores a key/data pair into a database, replacing any previously
+existing key if duplicates are not enabled, or adding a duplicate if
+duplicates are enabled.  TokuDB does not support unsorted duplicates
+(it supports no-duplicates and sorted duplicates), hence the new
+key-data pair is inserted at the correct sorted location.
+.SH PARAMETERS
+.IP \fIdb
+The \fBDB\fR handle for the database\fR.
+.IP \fItxnid
+Either \fBNULL\fR or a \fBTXNID\fR.
+.IP \fIkey
+The key to be inserted.
+.IP \fIdata
+The data to be inserted.
+.IP \fIflags
+Must be zero.
+
+Note: TokuDB does supports neither \fBDB_NODUPDATA\fR nor \fBDB_NOOVERRITE\fR.
+.SH RETURN VALUE
+.LP
+Returns zero on success.  The following non-zero errors can be returned:
+.IP \fBDB_DEADLOCK
+The system discovered deadlock cycle involving this and other transactions.
+This operation was killed.
+.IP \fBDB_LOCK_NOTGRANTED
+In an environment configured for lock timeouts, the system was unable to grant a lock within the allowed time.
+.IP \fBENOENT
+The file or directory does not exist.
+.IP \fBEINVAL
+You passed invalid parameters to this operation.  In many cases
+\fBEINVAL\fR
+is not a very helpful error code, indicating only that you did something wrong.
+
+If \fIflags\fR is non-zero, returns \fBEINVAL\fR.
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH RESTRICTIONS
+.LP
+Key items are limited to 16KB in size.
+Data items are limited to 256KB in size (for now.) 
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.

man/tokudb_gen.1

+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.\" Copyright (c) 2007 Tokutek.  All Rights Reserved.
+.TH tokudb_gen 1 "November 2007" Tokutek "TokuDB Programmer's Manual"
+.SH NAME
+tokudb_gen
+.SH SYNOPSIS
+.LP
+\fBtokudb_gen
+-n numkeys
+.SH DESCRIPTION
+The
+.B tokudb_gen
+program generates random key/data pairs onto the standard output that match
+the input requirements of the
+.B tokudb_load
+program and the output requirements of the
+.B tokudb_dump
+program.
+.SH CONFORMING TO
+The TokuDB embedded database provides a subset of the functionality of
+the Berkeley DB.  Programs that work with TokuDB probably work with
+with most versions of Berkeley DB with only recompilation or
+relinking.  The database files are incompatible, however, so to
+convert from one library to the other you would need to dump the
+database with one library's tool and load it with the other's.
+.SH AUTHOR
+Tokutek, Inc.
+.SH COPYRIGHT
+Copyright (c) 2007 Tokutek.  All Rights Reserved.