aboutsummaryrefslogtreecommitdiff
path: root/ja/man/man1/btreeop.1
blob: 8fc9a8fc3563fa290afbf5e12714e5a26658dc57 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
.\"
.\" 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, 1997
.\" jpman %Id: btreeop.1,v 1.3 1997/06/18 13:41:54 jsakai Stab %
.Dt BTREEOP 1
.Os BSD 4
.Sh 名称
.Nm btreeop
.Nd btree データベースメンテナンスツール
.Sh 書式
.Nm btreeop
.Op Fl A
.Op Fl C
.Op Fl D Ar key
.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 解説
.Nm btreeop
は、
.Xr btree 3
データベースに対して単純な操作を行います。
.Nm btreeop
は、データベースを作成したり、レコードを記入したり、(シーケンシャルや
インデックスで)レコードを読み出したり、レコードを削除したりすることができます。
重複したエントリを持つこともできます。
.Sh オプション
大文字はコマンドを示します。コマンドが指定されなかった場合は、
シーケンシャルな読み出しであると想定します。
.Bl -tag -width Ds
.It Fl A
レコードを追加します。データベースが存在しない場合、
btreeop はそれを作成します。
.It Fl C
データベースを作成し、レコードを記入します。
.It Fl D Ar key
key を用いてレコードを削除します。
.It Fl K Ar key
key を用いてレコードを検索します。
.It Fl b
バイトオーダが BIG_ENDIAN であると仮定します。デフォルトでは LITTLE_ENDIAN 
です。
.It Fl c Ar cashesize
キャッシュサイズを指定します。BTREEINFO の
.Nm info.cachesize
と等価です (btree(3) 参照)。
.It Fl l
バイトオーダが LITTLE_ENDIAN であると仮定します。(デフォルトです)
.It Fl p Ar psize
ページサイズを指定します。BTREEINFO の
.Nm info.psize
と等価です (btree(3) 参照)。
.It Ar dbname
データベース名を指定します。デフォルトは 'btree' です。
.Sh データフォーマット
データベースを作成する (あるいは追加する) 際、
.Nm btreeop
はデータを標準入力から読み込みます。
データのフォーマットは以下のようになります。

  Key         Data\\n
  Key         Data\\n
  .
  .
  .

.El

.Bl -enum -offset indent
.It
key とデータはブランク ('\\t' あるいは ' ') で区切られます。
.It
key にブランクを含めることはできません。
.It
データにはブランクを含めることができます。
.It
空のデータは許されません。
.It
加えて、META レコードが利用できます。META レコードはブランクで始まる key を
持ちます。このレコードは、インデックス検索 (-K オプション) だけで読むことが
できます。使用方法は btreeop によっては制限されません。
.El
.Sh 使用例
データベースの作成

  % btreeop -C
  key1	data1
  key2	data2
  key3	data3
  ^D
  %

レコードの追加

  % btreeop -A
   __.VERSION 2
  key2	data2-2
  ^D
  %

シーケンシャルな読み出し

  % btreeop
  key2  data2
  key3  data3
  key2  data2-2
  key1  data1
  %

インデックスによる読み出し

  % btreeop -K key2
  key2  data2-2
  key2  data2
  % btreeop -K ' __.VERSION'
   __.VERSION 2
  %

レコードの削除

  % btreeop -D ' __.VERSION'
  % btreeop -K ' __.VERSION'
  %

.Sh 関連ファイル
.Bl -tag -width tags -compact
.It Pa btree
デフォルトのデータベース名
.El
.Sh 診断
.Nm btreeop
は、エラーが発生した場合、値 1 で終了します。その他の場合は、0 で終了します。
.Sh 関連項目
.Xr btree 3
.Sh 作者
Shigio Yamaguchi (shigio@wafu.netgate.net)
.Sh 歴史
.Nm
コマンドは、FreeBSD 2.2 から登場しました。