Commit 6a44583d authored by Bradley C. Kuszmaul's avatar Bradley C. Kuszmaul

Remove tdb_create.3 (adding it to .junk) since the texi man pages are starting...

Remove tdb_create.3 (adding it to .junk) since the texi man pages are starting to get ready to go.  Addresse #52.

git-svn-id: file:///svn/tokudb@1162 c7de825b-a66e-492c-adef-691d508d4ae1
parent 7dc28cb3
\" 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)
.\" 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.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment