summaryrefslogtreecommitdiffstats
path: root/usr.bin/global/btreeop/btreeop.1
diff options
context:
space:
mode:
Diffstat (limited to 'usr.bin/global/btreeop/btreeop.1')
-rw-r--r--usr.bin/global/btreeop/btreeop.1142
1 files changed, 142 insertions, 0 deletions
diff --git a/usr.bin/global/btreeop/btreeop.1 b/usr.bin/global/btreeop/btreeop.1
new file mode 100644
index 0000000..b6baa6d
--- /dev/null
+++ b/usr.bin/global/btreeop/btreeop.1
@@ -0,0 +1,142 @@
+.\"
+.\" Copyright (c) 1996, 1997 Shigio Yamaguchi. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\" must display the following acknowledgement:
+.\" This product includes software developed by Shigio Yamaguchi.
+.\" 4. Neither the name of the author nor the names of any co-contributors
+.\" may be used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd April 21, 1996
+.Dt BTREEOP 1
+.Os BSD 4
+.Sh NAME
+.Nm btreeop
+.Nd btree database maintenance tool
+.Sh SYNOPSIS
+.Nm btreeop
+.Op Fl C
+.Op Fl K Ar key
+.Op Fl b
+.Op Fl c Ar cashesize
+.Op Fl l
+.Op Fl p Ar psize
+.Op Ar dbname
+.Sh DESCRIPTION
+.Nm Btreeop
+execute simple operations for
+.Xr btree 3
+database.
+.Nm Btreeop
+can create database and read (sequential or index) from it .
+Duplicate entries are allowed.
+.Sh OPTIONS
+A capital letter means a command. If no command specified
+then it assume sequential read operation.
+.Bl -tag -width Ds
+.It Fl C
+create database.
+.It Fl K Ar key
+search data by the key.
+.It Fl b
+assume BIG_ENDIAN byte order. default is LITTLE_ENDIAN.
+.It Fl c Ar cashesize
+specify cashesize. It's identical to
+.Nm info.cachesize
+of BTREEINFO. (see btree(3))
+.It Fl l
+assume LITTLE_ENDIAN byte order. (the default)
+.It Fl p Ar psize
+specify page size. It's identical to
+.Nm info.psize
+of BTREEINFO. (see btree(3))
+.It Ar dbname
+database name. default is 'btree'.
+.Sh DATA FORMAT
+To creat database,
+.Nm btreeop
+read data from stdin.
+The format of the data is the following.
+
+ Key Data\\n
+ Key Data\\n
+ .
+ .
+ .
+
+.El
+
+.Bl -enum -offset indent
+.It
+Key and Data are separated by blank('\\t' or ' ').
+.It
+Key cannot include blank.
+.It
+Data can include blank.
+.It
+Null Data not allowed.
+.El
+.Sh EXAMPLES
+Create database.
+
+ % btreeop -C
+ key1 data1
+ key2 data2
+ key2 data2-2
+ key3 data3
+ ^D
+ %
+
+Sequential read.
+
+ % btreeop
+ key2 data2
+ key3 data3
+ key2 data2-2
+ key1 data1
+ %
+
+Indexed read.
+
+ % btreeop -K key2
+ key2 data2-2
+ key2 data2
+ %
+
+.Sh FILES
+.Bl -tag -width tags -compact
+.It Pa btree
+default database name.
+.El
+.Sh DIAGNOSTICS
+.Nm Btreeop
+exits with a value of 1 if an error occurred, 0 otherwise.
+.Sh SEE ALSO
+.Xr btree 3 ,
+.Sh BUGS
+.Nm btreeop
+cannot utilize all features of
+.Xr btree 3
+.Sh AUTHOR
+Shigio Yamaguchi (shigio@wafu.netgate.net)
OpenPOWER on IntegriCloud