rroonga 3.0.9-x64-mingw32 → 3.1.0-x64-mingw32

data/vendor/local/share/man/man1/groonga.1

@@ -1,6 +1,6 @@
-.TH "GROONGA" "1" "October 28, 2013" "3.0.9" "groonga"
+.TH "GROONGA" "1" "November 27, 2013" "3.1.0" "Groonga"
 .SH NAME
-groonga \- groonga documentation
+groonga \- Groonga documentation
 .
 .nr rst2man-indent-level 0
 .
@@ -94,8 +94,8 @@ memory error with a 32\-bit package even if you just process medium
 size data.
 .SS Windows
 .sp
-This section describes how to install groonga on Windows. You can
-install groogna by extracting a zip package or running an installer.
+This section describes how to install Groonga on Windows. You can
+install Groogna by extracting a zip package or running an installer.
 .sp
 We distribute both 32\-bit and 64\-bit packages but we strongly
 recommend a 64\-bit package for server. You should use a 32\-bit package
@@ -104,81 +104,66 @@ memory error with a 32\-bit package even if you just process medium
 size data.
 .SS Installer
 .sp
-For 32\-bit environment, download x86 executable binary from packages.groonga.org.
-.sp
-You can download such a binary by command line operation.
-.sp
-Start command prompt \fBcmd.exe\fP and download x86 executable binary by default browser:
+For 32\-bit environment, download x86 executable binary from
+packages.groonga.org:
 .INDENT 0.0
 .INDENT 3.5
-.sp
-.nf
-.ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.9\-x86.exe
-.ft P
-.fi
+.INDENT 0.0
+.IP \(bu 2
+\fI\%http://packages.groonga.org/windows/groonga/groonga\-3.1.0\-x86.exe\fP
+.UNINDENT
 .UNINDENT
 .UNINDENT
 .sp
 Then run it.
 .sp
-For 64\-bit environment, download x64 executable binary from packages.groonga.org.
-.sp
-Start command prompt \fBcmd.exe\fP and download x64 executable binary by default browser:
+For 64\-bit environment, download x64 executable binary from
+packages.goronga.org:
 .INDENT 0.0
 .INDENT 3.5
-.sp
-.nf
-.ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.9\-x64.exe
-.ft P
-.fi
+.INDENT 0.0
+.IP \(bu 2
+\fI\%http://packages.groonga.org/windows/groonga/groonga\-3.1.0\-x64.exe\fP
+.UNINDENT
 .UNINDENT
 .UNINDENT
 .sp
 Then run it.
 .sp
-Use command prompt for \fB/reference/executables/groonga\fP installed in start menu.
+Use command prompt in start menu to run
+\fB/reference/executables/groonga\fP.
 .SS zip
 .sp
-For 32\-bit environment, download x86 zip archive from packages.groonga.org.
-.sp
-You can download such a binary by command line operation.
-.sp
-Start command prompt \fBcmd.exe\fP and download x86 zip archive by default browser:
+For 32\-bit environment, download x86 zip archive from
+packages.groonga.org:
 .INDENT 0.0
 .INDENT 3.5
-.sp
-.nf
-.ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.9\-x86.zip
-.ft P
-.fi
+.INDENT 0.0
+.IP \(bu 2
+\fI\%http://packages.groonga.org/windows/groonga/groonga\-3.1.0\-x86.zip\fP
+.UNINDENT
 .UNINDENT
 .UNINDENT
 .sp
 Then extract it.
 .sp
-For 64\-bit environment, download x64 zip archive from packages.groonga.org.
-.sp
-Start command prompt \fBcmd.exe\fP and download x64 zip archive by default browser:
+For 64\-bit environment, download x64 zip archive from
+packages.groonga.org:
 .INDENT 0.0
 .INDENT 3.5
-.sp
-.nf
-.ft C
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.9\-x64.zip
-.ft P
-.fi
+.INDENT 0.0
+.IP \(bu 2
+\fI\%http://packages.groonga.org/windows/groonga/groonga\-3.1.0\-x64.zip\fP
+.UNINDENT
 .UNINDENT
 .UNINDENT
 .sp
 Then extract it.
 .sp
-\fB/reference/executables/groonga\fP is in \fBbin\fP folder.
+You can find \fB/reference/executables/groonga\fP in \fBbin\fP folder.
 .SS Build from source
 .sp
-First, you need to install required tools for building groonga on
+First, you need to install required tools for building Groonga on
 Windows. Here are required tools:
 .INDENT 0.0
 .INDENT 3.5
@@ -191,33 +176,25 @@ Windows. Here are required tools:
 .UNINDENT
 .UNINDENT
 .sp
-Download zipped source from packages.groonga.org.
-.sp
-You can download such a zipped source file by command line operation.
-.sp
-Start \fBVisual Studio Command Prompt (2010)\fP installed by Microsoft
-Visual Studio 2010 Express and download it by default browser:
+Download zipped source from packages.groonga.org:
 .INDENT 0.0
 .INDENT 3.5
-.sp
-.nf
-.ft C
-> cd c:\eUsers\e%USERNAME%\eDownloads
-> "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/source/groonga/groonga\-3.0.9.zip
-.ft P
-.fi
+.INDENT 0.0
+.IP \(bu 2
+\fI\%http://packages.groonga.org/source/groonga/groonga\-3.1.0.zip\fP
+.UNINDENT
 .UNINDENT
 .UNINDENT
 .sp
 Then extract it.
 .sp
-Move to the groonga\(aqs source folder:
+Move to the Groonga\(aqs source folder:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-> cd c:\eUsers\e%USERNAME%\eDownloads\egroonga\-3.0.9
+> cd c:\eUsers\e%USERNAME%\eDownloads\egroonga\-3.1.0
 .ft P
 .fi
 .UNINDENT
@@ -231,7 +208,7 @@ parameter instead:
 .sp
 .nf
 .ft C
-groonga\-3.0.9> cmake . \-G "Visual Studio 10 Win64" \-DCMAKE_INSTALL_PREFIX=C:\egroonga
+groonga\-3.1.0> cmake . \-G "Visual Studio 10 Win64" \-DCMAKE_INSTALL_PREFIX=C:\egroonga
 .ft P
 .fi
 .UNINDENT
@@ -243,7 +220,7 @@ Build:
 .sp
 .nf
 .ft C
-groonga\-3.0.9> cmake \-\-build . \-\-config Release
+groonga\-3.1.0> cmake \-\-build . \-\-config Release
 .ft P
 .fi
 .UNINDENT
@@ -255,7 +232,7 @@ Install:
 .sp
 .nf
 .ft C
-groonga\-3.0.9> cmake \-\-build . \-\-config Release \-\-target Install
+groonga\-3.1.0> cmake \-\-build . \-\-config Release \-\-target Install
 .ft P
 .fi
 .UNINDENT
@@ -309,9 +286,9 @@ Download source:
 .sp
 .nf
 .ft C
-% curl \-O http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
-% tar xvzf groonga\-3.0.9.tar.gz
-% cd groonga\-3.0.9
+% curl \-O http://packages.groonga.org/source/groonga/groonga\-3.1.0.tar.gz
+% tar xvzf groonga\-3.1.0.tar.gz
+% cd groonga\-3.1.0
 .ft P
 .fi
 .UNINDENT
@@ -711,9 +688,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
-% tar xvzf groonga\-3.0.9.tar.gz
-% cd groonga\-3.0.9
+% wget http://packages.groonga.org/source/groonga/groonga\-3.1.0.tar.gz
+% tar xvzf groonga\-3.1.0.tar.gz
+% cd groonga\-3.1.0
 .ft P
 .fi
 .UNINDENT
@@ -1262,9 +1239,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
-% tar xvzf groonga\-3.0.9.tar.gz
-% cd groonga\-3.0.9
+% wget http://packages.groonga.org/source/groonga/groonga\-3.1.0.tar.gz
+% tar xvzf groonga\-3.1.0.tar.gz
+% cd groonga\-3.1.0
 .ft P
 .fi
 .UNINDENT
@@ -1411,7 +1388,7 @@ Enable Repoforge (RPMforge) repository on i386 environment:
 .sp
 .nf
 .ft C
-% wget http://pkgs.repoforge.org/rpmforge\-release/rpmforge\-release\-0.5.2\-2.el5.rf.i386.rpm
+% wget http://pkgs.repoforge.org/rpmforge\-release/rpmforge\-release\-0.5.3\-1.el5.rf.i386.rpm
 % sudo rpm \-ivh rpmforge\-release\-0.5.2\-2.el5.rf.i386.rpm
 .ft P
 .fi
@@ -1424,7 +1401,7 @@ Enable Repoforge (RPMforge) repository on x86_64 environment:
 .sp
 .nf
 .ft C
-% wget http://pkgs.repoforge.org/rpmforge\-release/rpmforge\-release\-0.5.2\-2.el5.rf.x86_64.rpm
+% wget http://pkgs.repoforge.org/rpmforge\-release/rpmforge\-release\-0.5.3\-1.el5.rf.x86_64.rpm
 % sudo rpm \-ivh rpmforge\-release\-0.5.2\-2.el5.rf.x86_64.rpm
 .ft P
 .fi
@@ -1602,9 +1579,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
-% tar xvzf groonga\-3.0.9.tar.gz
-% cd groonga\-3.0.9
+% wget http://packages.groonga.org/source/groonga/groonga\-3.1.0.tar.gz
+% tar xvzf groonga\-3.1.0.tar.gz
+% cd groonga\-3.1.0
 .ft P
 .fi
 .UNINDENT
@@ -1809,9 +1786,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
-% tar xvzf groonga\-3.0.9.tar.gz
-% cd groonga\-3.0.9
+% wget http://packages.groonga.org/source/groonga/groonga\-3.1.0.tar.gz
+% tar xvzf groonga\-3.1.0.tar.gz
+% cd groonga\-3.1.0
 .ft P
 .fi
 .UNINDENT
@@ -1876,9 +1853,9 @@ Download source:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
-% gtar xvzf groonga\-3.0.9.tar.gz
-% cd groonga\-3.0.9
+% wget http://packages.groonga.org/source/groonga/groonga\-3.1.0.tar.gz
+% gtar xvzf groonga\-3.1.0.tar.gz
+% cd groonga\-3.1.0
 .ft P
 .fi
 .UNINDENT
@@ -2018,9 +1995,9 @@ steps:
 .sp
 .nf
 .ft C
-% wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
-% tar xvzf groonga\-3.0.9.tar.gz
-% cd groonga\-3.0.9
+% wget http://packages.groonga.org/source/groonga/groonga\-3.1.0.tar.gz
+% tar xvzf groonga\-3.1.0.tar.gz
+% cd groonga\-3.1.0
 % ./configure
 % make
 % sudo make install
@@ -2419,10 +2396,10 @@ status
 #     "max_command_version": 2,
 #     "n_queries": 0,
 #     "cache_hit_rate": 0.0,
-#     "version": "3.0.7",
-#     "alloc_count": 154,
+#     "version": "3.1.0",
+#     "alloc_count": 159,
 #     "command_version": 1,
-#     "starttime": 1377493494,
+#     "starttime": 1385359899,
 #     "default_command_version": 1
 #   }
 # ]
@@ -3573,10 +3550,10 @@ status
 #     "max_command_version": 2,
 #     "n_queries": 0,
 #     "cache_hit_rate": 0.0,
-#     "version": "3.0.7",
-#     "alloc_count": 133,
+#     "version": "3.1.0",
+#     "alloc_count": 138,
 #     "command_version": 1,
-#     "starttime": 1377493621,
+#     "starttime": 1385359920,
 #     "default_command_version": 1
 #   }
 # ]
@@ -3685,14 +3662,14 @@ status
 #     0.000355720520019531
 #   ],
 #   {
-#     "uptime": 1,
+#     "uptime": 0,
 #     "max_command_version": 2,
 #     "n_queries": 0,
 #     "cache_hit_rate": 0.0,
-#     "version": "3.0.7",
-#     "alloc_count": 134,
+#     "version": "3.1.0",
+#     "alloc_count": 139,
 #     "command_version": 1,
-#     "starttime": 1377493621,
+#     "starttime": 1385359920,
 #     "default_command_version": 1
 #   }
 # ]
@@ -8144,7 +8121,11 @@ For example, there is a registered word "日本". And "ニホン"
 (it must be katakana) is registered as its reading. An user
 can find "日本" by "ni", "二" or "に".
 .sp
-If you create dataset which is named as example by \fB/reference/executables/groonga\-suggest\-create\-dataset\fP command, you can update pairs of registered word and its reading by loading data to \(aq_key\(aq and \(aqkana\(aq column of item_example table explicitly for prefix RK search.
+If you create dataset which is named as example by
+\fB/reference/executables/groonga\-suggest\-create\-dataset\fP command,
+you can update pairs of registered word and its reading by loading
+data to \(aq_key\(aq and \(aqkana\(aq column of item_example table explicitly for
+prefix RK search.
 .SS Cooccurrence search
 .sp
 Cooccurrence search can find registered words from user\(aqs
@@ -8538,11 +8519,14 @@ suggest \-\-table item_query \-\-column kana \-\-types complete \-\-frequency_th
 .UNINDENT
 .UNINDENT
 .sp
-Without loading above RK data, you can\(aqt complete registered word "日本" by query \- "nihon".
+Without loading above RK data, you can\(aqt complete registered word "日本"
+by query \- "nihon".
 .sp
-As the column type of item_query table is VECTOR_COLUMN, you can register multiple readings for registered word.
+As the column type of item_query table is VECTOR_COLUMN, you can
+register multiple readings for registered word.
 .sp
-This is the reason that you can also complete the registered word "日本" by query \- "nippon".
+This is the reason that you can also complete the registered word "日本"
+by query \- "nippon".
 .sp
 Execution example:
 .INDENT 0.0
@@ -8584,9 +8568,12 @@ suggest \-\-table item_query \-\-column kana \-\-types complete \-\-frequency_th
 .UNINDENT
 .UNINDENT
 .sp
-This feature is very convenient because you can search registered word even though Japanese IM is disabled.
+This feature is very convenient because you can search registered word
+even though Japanese IM is disabled.
 .sp
-If there are multiple candidates as completed result, you can customize priority to set the value of "boost" column in item_query table.
+If there are multiple candidates as completed result, you can
+customize priority to set the value of "boost" column in item_query
+table.
 .sp
 Here is the example to customize priority for RK search.
 .sp
@@ -10130,662 +10117,662 @@ gqtpでリクエストします。gqtpのリクエストをLF区切り形式で
 .fi
 .UNINDENT
 .UNINDENT
-.SS grntest
+.SS groonga command
 .SS 名前
 .sp
-grntest \- groongaテストプログラム
+groonga \- 列指向データベース機能を持つ全文検索エンジンソフトウェア
 .SS 書式
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-grntest  [options...] [script] [db]
+groonga [options] [dest] [command [args]]
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .SS 説明
 .sp
-grntestは、groonga汎用テストツールです。
-.sp
-groongaを単独のプロセスとして利用する場合はもちろん、サーバプログラムとして利用する場合の動作確認や実行速度測定が可能です。
-.sp
-grntest用のデータファイルは自分で作成することも既存のものを利用することもできます。既存のデータファイルは、ftp.groonga.orgから必要に応じダウンロードします。そのため、groonga及びgrntestが動作し、インターネットに接続できる環境であればgroongaコマンドの知識がなくてもgroongaの動作を確認できます。
-.sp
-現在は、Linux 及びWindows上で動作します。make installしてもインストールは行われません。
+groongaは列指向のデータベース機能を持つ高速でスケーラブルな全文検索エンジンです。
+groongaのデータベースは、groongaコマンドかCライブラリインタフェースを通して操作することができます。このマニュアルページでは、groongaコマンドの使い方について説明します。
 .SS オプション
 .INDENT 0.0
 .TP
-.B \-i, \-\-host <ip/hostname>
-接続するgroongaサーバを、ipアドレスまたはホスト名で指定します。指定先にgroongaサーバが立ち上がっていない場合、接続不能となることに注意してください。このオプションを指定しない場合、grntestは自動的にlocalhostのgroongaサーバを起動して接続します。
+.B \-n
+新たなデータベースを作成します。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-p, \-\-port <port number>
-自動的に起動するgroongaサーバ、または明示的に指定した接続先のgroonga サーバが利用するポート番号を指定します。接続先のgroongaサーバが利用しているポートと、このオプションで指定したポート番号が異なる場合、接続不能となることに注意してください。
+.B \-c
+クライアントモードで実行します。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-dir
-ftp.groonga.org に用意されているスクリプトファイルを表示します。
+.B \-s
+サーバモードで実行します。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-ftp
-ftp.groonga.orgとFTP通信を行い、scriptファイルの同期やログファイルの送信を行います。
+.B \-d
+デーモンモードで実行します。(forkする点がサーバモードと異なる)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-log\-output\-dir
-デフォルトでは、grntest終了後のログファイルの出力先ははカレントディレクトリです。このオプションを利用すると、任意のディレクトリに出力先を変更することができます。
+.B \-e, \-\-encoding <encoding>
+データベースで使用する文字エンコーディング方式を指定します。新たなデータベースを作成する時のみ有効です。none, euc, utf8, sjis, latin, koi8rのいずれかが指定できます。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-groonga <groonga_path>
-groongaコマンドのパスを指定します。デフォルトでは、PATHの中からgroongaコマンドを探します。
+.B \-l, \-\-log\-level <log level>
+ログレベルを指定します。0〜8までの数値が指定可能で、数が大きいほど多くのログが出力されます。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-protocol <gqtp|http>
-groongaコマンドが使うプロトコルとして \fIgqtp\fP または \fIhttp\fP を指定します。
+.B \-a, \-\-address <ip/hostname>
+Deprecated since version 1.2.2: Use \fI\-\-bind\-address\fP instead.
+
 .UNINDENT
-.SS 引数
 .INDENT 0.0
 .TP
-.B script
-grntestの動作方法(以下、grntest命令と呼びます)を記述したテキストファイルです。拡張子は.scrです。
+.B \-\-bind\-address <ip/hostname>
+New in version 1.2.2.
+
+.sp
+サーバモードかデーモンモードで実行するとき、listenするアドレスを指定します。(デフォルトは \fIhostname\fP の返すホスト名)
 .UNINDENT
 .INDENT 0.0
 .TP
-.B db
-grntestが利用するgroonga データベースです。指定されたデータベースが存在しない場合、grntestが新規に作成します。またgroonga サーバを自動的に起動する場合もこの引数で指定したデータベースが利用されます。接続するgroonga サーバを明示的に指定した場合に利用するデータベースは、接続先サーバが使用中のデータベースになることに注意してください。
+.B \-p, \-\-port <port number>
+クライアント、サーバ、またはデーモンモードで使用するTCPポート番号。
+(デフォルトは10041番)
 .UNINDENT
-.SS 使い方
-.sp
-まず、シェル上(Windowsならコマンドプロンプト上)で:
 .INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-grntest test.scr 任意のDB名
-.ft P
-.fi
+.TP
+.B \-i, \-\-server\-id <ip/hostname>
+サーバモードかデーモンモードで実行するとき、サーバのIDとなるアドレスを指定します。(デフォルトは\(gahostname\(gaの返すホスト名)
 .UNINDENT
+.INDENT 0.0
+.TP
+.B \-h, \-\-help
+ヘルプメッセージを出力します。
 .UNINDENT
-.sp
-とタイプしてください。もしgrntestが正常に動作すれば、:
 .INDENT 0.0
-.INDENT 3.5
+.TP
+.B \-\-document\-root <path>
+httpサーバとしてgroongaを使用する場合に静的ページを格納するディレクトリを指定します。
 .sp
-.nf
-.ft C
-test\-ユーザ名\-数字.log
-.ft P
-.fi
-.UNINDENT
+デフォルトでは、データベースを管理するための汎用的なページに対応するファイルが/usr/share/groonga/admin_html以下にインストールされます。このディレクトリをdocument\-rootオプションの値に指定して起動した場合、ウェブブラウザでhttp://hostname:port/index.htmlにアクセスすると、ウェブベースのデータベース管理ツールを使用できます。
 .UNINDENT
-.sp
-というファイルが作成されるはずです。作成されない場合、このドキュメントの「トラブルシューティング」の章を参照してください。
-.SS スクリプトファイル
-.sp
-スクリプトファイルは、grntest命令を記述したテキストファイルです。
-";"セミコロンを利用して、一行に複数のgrntest命令を記述することができます。一行に複数のgrntest命令がある場合、各命令は並列に実行されます。
-"#"で始まる行はコメントとして扱われます。
-.SS grntest命令
-.sp
-現在サポートされているgrntest命令は以下の8つです。
 .INDENT 0.0
-.INDENT 3.5
-do_local コマンドファイル [スレッド数] [繰り返し数]
-.INDENT 0.0
-.INDENT 3.5
-コマンドファイルをgrntest単体で実行します。スレッド数が指定されている場合、複数のスレッドで同じコマンドファイルを同時に実行します。繰り返し数が指定されてい場合、コマンドファイルの内容を繰り返し実行します。スレッド数、繰り返し数とも省略時は1です。1スレッドで複数回動作させたい場合は、do_local コマンドファイル 1 [繰り返し数]と明示的に指定してください。
-.UNINDENT
+.TP
+.B \-\-protocol <protocol>
+http,gqtpのいずれかを指定します。(デフォルトはgqtp)
 .UNINDENT
-.sp
-do_gqpt コマンドファイル [スレッド数] [繰り返し数]
 .INDENT 0.0
-.INDENT 3.5
-コマンドファイルをgroongaサーバで実行します。スレッド数や繰り返し数の意味はdo_localの場合と同じです。
-.UNINDENT
+.TP
+.B \-\-log\-path <path>
+ログを出力するファイルのパスを指定します。(デフォルトは/var/log/groonga/groonga.logです)
 .UNINDENT
-.sp
-rep_local コマンドファイル [スレッド数] [繰り返し数]
 .INDENT 0.0
-.INDENT 3.5
-コマンドファイルをgrntest単体で実行し、より詳細な報告を行います。
-.UNINDENT
+.TP
+.B \-\-query\-log\-path <path>
+クエリーログを出力するファイルのパスを指定します。(デフォルトでは出力されません)
 .UNINDENT
-.sp
-rep_gqpt コマンドファイル [スレッド数] [繰り返し数]
 .INDENT 0.0
-.INDENT 3.5
-コマンドファイルをgroongaサーバで実行し、より詳細な報告を行います。 スレッド数や繰り返し数の意味はdo_localと 同じです。
-.UNINDENT
+.TP
+.B \-t, \-\-max\-threads <max threasd>
+最大で利用するスレッド数を指定します。(デフォルトはマシンのCPUコア数と同じ数です)
 .UNINDENT
-.sp
-out_local コマンドファイル 入力ファイル名
 .INDENT 0.0
-.INDENT 3.5
-コマンドファイルをgrntest単体で実行し、各コマンドの実行結果をすべて”出力ファイル"に書きだします。この結果は、test_local,　test_gqtp命令で利用します。なおこの命令の「出力ファイル」とは、grntest実行時に自動的に作成されるログとは別のものです。grntestではコメントが利用できる以外、:
+.TP
+.B \-\-pid\-path <path>
+PIDを保存するパスを指定します。(デフォルトでは保存しません)
+.UNINDENT
 .INDENT 0.0
+.TP
+.B \-\-config\-path <path>
+設定ファイルのパスを指定します。設定ファイルは以下のようなフォーマットになります。:
+.INDENT 7.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-groonga < コマンドファイル > 出力ファイル
+# \(aq#\(aq以降はコメント。
+; \(aq;\(aq以降もコメント。
+
+# \(aqキー = 値\(aqでオプションを指定。
+pid\-file = /var/run/groonga.pid
+
+# \(aq=\(aqの前後の空白はは無視される。↓は↑と同じ意味。
+pid\-file=/var/run/groonga.pid
+
+# \(aqキー\(aqは\(aq\-\-XXX\(aqスタイルのオプション名と同じものが使える。
+# 例えば、\(aq\-\-pid\-path\(aqに対応するキーは\(aqpid\-path\(aq。
+# ただし、キーが\(aqconfig\-path\(aqのオプションは無視される。
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
-.sp
-とした場合と同じです。
 .UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-cache\-limit <limit>
+キャッシュ数の最大値を指定します。(デフォルトは100です)
 .UNINDENT
-.sp
-out_gqtp コマンドファイル 出力ファイル名
 .INDENT 0.0
-.INDENT 3.5
-コマンドファイルをgroongaサーバで実行します。その他はout_local命令と同等です。
+.TP
+.B \-\-default\-match\-escalation\-threshold <threshold>
+検索の挙動をエスカレーションする閾値を指定します。(デフォルトは0です)
 .UNINDENT
+.SS 引数
+.INDENT 0.0
+.TP
+.B dest
+使用するデータベースのパス名を指定します。
+.sp
+クライアントモードの場合は接続先のホスト名とポート番号を指定します(デフォルト値は\(aqlocalhost:10041\(aq)。ポート番号を指定しない場合には、10041が指定されたものとします。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B test_local コマンドファイル 入力ファイル名
-コマンドファイルをgrntest単体で実行し、各コマンドの実行結果を入力ファイルと比較します。処理時間など本質的要素以外に差分があった場合、差分を、入力ファイル.diffというファイルに書きだします。
+.B command [args]
+スタンドアロンおよびクライアントモードの場合は、実行するコマンドとその引数をコマンドライン引数に指定できます。コマンドライン引数にcommandを与えなかった場合は、標準入力から一行ずつEOFに達するまでコマンド文字列を読み取り、順次実行します。
 .UNINDENT
+.SS コマンド
+.sp
+groongaコマンドを通してデータベースを操作する命令をコマンドと呼びます。コマンドは主にC言語で記述され、groongaプロセスにロードすることによって使用できるようになります。
+それぞれのコマンドは一意な名前と、0個以上の引数を持ちます。
+.sp
+引数は以下の2種類の方法のいずれかで指定することができます。:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+形式1: コマンド名 値1 値2,..
+
+形式2: コマンド名 \-\-引数名1 値1 \-\-引数名2 値2,..
+.ft P
+.fi
 .UNINDENT
 .UNINDENT
-.SS コマンドファイル
 .sp
-コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては \fB/reference/commands\fP を参照してください。
-.SS サンプル
+形式1でコマンドを実行する場合は、定義された順番で値を指定しなければならず、途中の引数の値を省略することはできません。形式2でコマンドを実行する場合は、「\-\-引数名」のように引数の名前を明示しなければならない代わりに、任意の順番で引数を指定することが可能で、途中の引数の指定を省略することもできます。
 .sp
-スクリプトファイルのサンプルです。:
+標準入力からコマンド文字列を与える場合は、コマンド名と引数名と値は、空白( )で区切ります。空白や、記号「"\(aq()」のうちいずれかを含む値を指定したい場合は、シングルクォート(\(aq)かダブルクォート(")で値を囲みます。値として指定する文字列の中では、改行文字は\(aqn\(aqに置き換えて指定します。また、引用符に使用した文字を値の中で指定する場合には、その文字の前にバックスラッシュ(\(aq\(aq) を指定します。バックスラッシュ文字自身を値として指定する場合には、その前にバックスラッシュを指定します。
+.sp
+You can write command list with continuous line which is represented by \(aq\e\(aq character.:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-# sample script
-rep_local test.ddl
-do_local test.load;
-do_gqtp test.select 10 10; do_local test.status 10
+table_create \-\-name Terms \e
+             \-\-flags TABLE_PAT_KEY \e
+             \-\-key_type ShortText \e
+             \-\-default_tokenizer TokenBigram
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
+.SS 組み込みコマンド
 .sp
-上記の意味は以下のとおりです。
+以下のコマンドは組み込みコマンドとして予め定義されています。
 .INDENT 0.0
 .INDENT 3.5
 .INDENT 0.0
 .TP
-.B 1行目
-コメント行。
+.B \fBstatus\fP
+groongaプロセスの状態を表示します。
 .TP
-.B 2行目
-test.dll というコマンドファイルをgroonga単体で実行し、詳細に報告する。
+.B \fBtable_list\fP
+DBに定義されているテーブルのリストを表示します。
 .TP
-.B 3行目
-test.load というコマンドファイルをgroonga単体で実行する。(最後の";"セミコロンは複数のgrntest命令を記述する場合に必要ですが、この例のように1つのgrntest命令を実行する場合に付与しても問題ありません。)
+.B \fBcolumn_list\fP
+テーブルに定義されているカラムのリストを表示します。
 .TP
-.B 4行目
-test.select というコマンドファイルをgroongaサーバで10個のスレッドで同時に実行する。各スレッドはtest.selectの中身を10回繰り返す。また同時に、groonga単体でtest.statusというコマンドファイルを10個のスレッドで実行する。
+.B \fBtable_create\fP
+DBにテーブルを追加します。
+.TP
+.B \fBcolumn_create\fP
+テーブルにカラムを追加します。
+.TP
+.B \fBtable_remove\fP
+DBに定義されているテーブルを削除します。
+.TP
+.B \fBcolumn_remove\fP
+テーブルに定義されているカラムを削除します。
+.TP
+.B \fBload\fP
+テーブルにレコードを挿入します。
+.TP
+.B \fBselect\fP
+テーブルに含まれるレコードを検索して表示します。
+.TP
+.B \fBdefine_selector\fP
+検索条件をカスタマイズした新たな検索コマンドを定義します。
+.TP
+.B \fBquit\fP
+データベースとのセッションを終了します。
+.TP
+.B \fBshutdown\fP
+サーバ(デーモン)プロセスを停止します。
+.TP
+.B \fBlog_level\fP
+ログ出力レベルを設定します。
+.TP
+.B \fBlog_put\fP
+ログ出力を行います。
+.TP
+.B \fBclearlock\fP
+ロックを解除します。
 .UNINDENT
 .UNINDENT
 .UNINDENT
-.SS 特殊命令
+.SS 例
 .sp
-スクリプトファイルのコメント行には特殊コマンドを埋め込むことが可能です。現在サポートされている特殊命令は以下の二つです。
+新しいデータベースを作成します。:
 .INDENT 0.0
 .INDENT 3.5
-.INDENT 0.0
-.TP
-.B #SET_HOST <ip/hostname>
-\-i, \-\-hostオプションと同等の機能です。コマンドラインオプションに指定したIPアドレス/ホスト名と、SET_HOSTで指定したIPアドレス/ホスト名が異なる場合、またコマンドラインオプションを指定しなかった場合にもSET_HOSTが優先されます。SET_HOSTを利用した場合、サーバが自動的には起動されないのもコマンドラインオプションで指定した場合と同様です。
-.TP
-.B #SET_PORT <port number>
-\-p, \-\-port オプションと同等の機能です。コマンドラインオプションに指定したポート番号とSET_PORTで指定したポート番号が異なる場合、またコマンドラインオプションを指定しなかった場合にもSET_PORTが優先されます。
-.UNINDENT
+.sp
+.nf
+.ft C
+% groonga \-n /tmp/hoge.db quit
+%
+.ft P
+.fi
 .UNINDENT
 .UNINDENT
 .sp
-特殊命令はスクリプトファイルの任意の場所に書き込むことができます。同一ファイル内に複数回特殊命令を記述した場合、「最後の」特殊命令が有効となります。
-.sp
-例えば、
+作成済みのデータベースにテーブルを定義します。:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-$ ./grntest \-\-port 20010 test.scr testdb
+% groonga /tmp/hoge.db table_create Table 0 ShortText
+[[0]]
+%
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
-とコマンド上でポートを指定した場合でも、もしtest.scrの中身が
+サーバを起動します。:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-#SET_PORT 10900
-rep_local test.ddl
-do_local test.load;
-rep_gqtp test.select 10 10; rep_local test.status 10
-#SET_PORT 10400
+% groonga \-d /tmp/hoge.db
+%
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
-であれば、自動的に起動されるgroongaサーバはポート番号10400を利用します。
-.SS grntest実行結果
-.sp
-grntestが正常に終了すると、(拡張子を除いた)スクリプト名\-ユーザ名\-実行開始時刻.logという形式のログファイルがカレントディレクトリに作られます。ログファイルは自動的にftp.groonga.org
-に送信されます。ログファイルは以下のようなjson形式のテキストです。
+httpサーバとして起動します。:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-[{"script": "test.scr",
-  "user": "homepage",
-  "date": "2010\-04\-14 22:47:04",
-  "CPU": Intel(R) Pentium(R) 4 CPU 2.80GHz",
-  "BIT": 32,
-  "CORE": 1,
-  "RAM": "975MBytes",
-  "HDD": "257662232KBytes",
-  "OS": "Linux 2.4.20\-24.7\-i686",
-  "HOST": "localhost",
-  "PORT": "10041",
-  "VERSION": "0.1.8\-100\-ga54c5f8"
-},
-{"jobs": "rep_local test.ddl",
-"detail": [
-[0, "table_create res_table \-\-key_type ShortText", 1490, 3086, [0,1271252824.25846,0.00144
-7]],
-[0, "column_create res_table res_column \-\-type Text", 3137, 5956, [0,1271252824.2601,0.002
-741]],
-[0, "column_create res_table user_column \-\-type Text", 6020, 8935, [0,1271252824.26298,0.0
-02841]],
-[0, "column_create res_table mail_column \-\-type Text", 8990, 11925, [0,1271252824.26595,0.
-002861]],
-[0, "column_create res_table time_column \-\-type Time", 12008, 13192, [0,1271252824.26897,0
-\&.001147]],
-[0, "status", 13214, 13277, [0,1271252824.27018,3.0e\-05]],
-[0, "table_create thread_table \-\-key_type ShortText", 13289, 14541, [0,1271252824.27025,0.
-001213]],
-[0, "column_create thread_table thread_title_column \-\-type ShortText", 14570, 17380, [0,12
-71252824.27153,0.002741]],
-[0, "status", 17435, 17480, [0,1271252824.2744,2.7e\-05]],
-[0, "table_create lexicon_table \-\-flags 129 \-\-key_type ShortText \-\-default_tokenizer Token
-Bigram", 17491, 18970, [0,1271252824.27446,0.001431]],
-[0, "column_create lexicon_table inv_res_column 514 res_table res_column ", 18998, 33248,
-[0,1271252824.27596,0.01418]],
-[0, "column_create lexicon_table inv_thread_column 514 thread_table thread_title_column ",
- 33285, 48472, [0,1271252824.29025,0.015119]],
-[0, "status", 48509, 48554, [0,1271252824.30547,2.7e\-05]]],
-"summary" :[{"job": "rep_local test.ddl", "latency": 48607, "self": 47719, "qps": 272.4281
-73, "min": 45, "max": 15187, "queries": 13}]},
-{"jobs": "do_local test.load; ",
-"summary" :[{"job": "do_local test.load", "latency": 68693, "self": 19801, "qps": 1010.049
-997, "min": 202, "max": 5453, "queries": 20}]},
-{"jobs": "do_gqtp test.select 10 10; do_local test.status 10",
-"summary" :[{"job": " do_local test.status 10", "latency": 805990, "self": 737014, "qps":
-54.273053, "min": 24, "max": 218, "queries": 40},{"job": "do_gqtp test.select 10 10", "lat
-ency": 831495, "self": 762519, "qps": 1967.164097, "min": 73, "max": 135631, "queries": 15
-00}]},
-{"total": 915408, "qps": 1718.359464, "queries": 1573}]
+% groonga \-d \-p 80 \-\-protocol http \-\-document\-root /usr/share/groonga/admin_html /tmp/hoge.db
+%
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
-.SS 制限事項
-.INDENT 0.0
-.IP \(bu 2
-スクリプトファイルの一行には複数のgrntest命令を記述できますが、すべてのスレッド数の合計は最大64までに制限されます。
-.IP \(bu 2
-コマンドファイル中のgroongaコマンドの長さは最長5000000byteです。
-.UNINDENT
-.SS トラブルシューティング
 .sp
-もし、grntestが正常に動作しない場合、まず以下を確認してください。
+サーバに接続し、テーブル一覧を表示します。:
 .INDENT 0.0
-.IP \(bu 2
-インターネットに接続しているか？ \fI\-\-ftp\fP オプションを指定すると、grntestは動作のたびにftp.groonga.orgと通信します。ftp.groonga.orgと通信可能でない場合、grntestは正常に動作しません。
-.IP \(bu 2
-groonga サーバが動作していないか？　grntestは、\-i, \-\-host オプションで明示的にサーバを指定しないかぎり、自動的にlocalhostのgroongaサーバを立ち上げます。すでにgroongaサーバが動作している場合、grntestは正常に動作しない可能性があります。
-.IP \(bu 2
-指定したDBが適切か？ grntestは、引数で指定したDBの中身はチェックしません。もし指定されたDBが存在しなければ自動的にDBを作成しますが、もしファイルとして存在する場合は中身に関わらず動作を続けてしまい、結果が異常になる可能性があります。
-.UNINDENT
+.INDENT 3.5
 .sp
-以上の原因でなければ、問題はgrntestかgroongaにあります。ご報告をお願いします。
-.SS groonga command
+.nf
+.ft C
+% groonga \-c localhost table_list
+[[0],[["id","name","path","flags","domain"],[256,"Table","/tmp/hoge.db.0000100",49152,14]]]
+%
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS groonga\-benchmark
 .SS 名前
 .sp
-groonga \- 列指向データベース機能を持つ全文検索エンジンソフトウェア
+groonga\-benchmark \- groongaテストプログラム
 .SS 書式
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-groonga [options] [dest] [command [args]]
+groonga\-benchmark  [options...] [script] [db]
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .SS 説明
 .sp
-groongaは列指向のデータベース機能を持つ高速でスケーラブルな全文検索エンジンです。
-groongaのデータベースは、groongaコマンドかCライブラリインタフェースを通して操作することができます。このマニュアルページでは、groongaコマンドの使い方について説明します。
+groonga\-benchmarkは、groonga汎用ベンチマークツールです。
+.sp
+groongaを単独のプロセスとして利用する場合はもちろん、サーバプログラムとして利用する場合の動作確認や実行速度測定が可能です。
+.sp
+groonga\-benchmark用のデータファイルは自分で作成することも既存のものを利用することもできます。既存のデータファイルは、ftp.groonga.orgから必要に応じダウンロードします。そのため、groonga及びgroonga\-benchmarkが動作し、インターネットに接続できる環境であればgroongaコマンドの知識がなくてもgroongaの動作を確認できます。
+.sp
+現在は、Linux 及びWindows上で動作します。make installしてもインストールは行われません。
 .SS オプション
 .INDENT 0.0
 .TP
-.B \-n
-新たなデータベースを作成します。
+.B \-i, \-\-host <ip/hostname>
+接続するgroongaサーバを、ipアドレスまたはホスト名で指定します。指定先にgroongaサーバが立ち上がっていない場合、接続不能となることに注意してください。このオプションを指定しない場合、groonga\-benchmarkは自動的にlocalhostのgroongaサーバを起動して接続します。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-c
-クライアントモードで実行します。
+.B \-p, \-\-port <port number>
+自動的に起動するgroongaサーバ、または明示的に指定した接続先のgroonga サーバが利用するポート番号を指定します。接続先のgroongaサーバが利用しているポートと、このオプションで指定したポート番号が異なる場合、接続不能となることに注意してください。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-s
-サーバモードで実行します。
+.B \-\-dir
+ftp.groonga.org に用意されているスクリプトファイルを表示します。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-d
-デーモンモードで実行します。(forkする点がサーバモードと異なる)
+.B \-\-ftp
+ftp.groonga.orgとFTP通信を行い、scriptファイルの同期やログファイルの送信を行います。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-e, \-\-encoding <encoding>
-データベースで使用する文字エンコーディング方式を指定します。新たなデータベースを作成する時のみ有効です。none, euc, utf8, sjis, latin, koi8rのいずれかが指定できます。
+.B \-\-log\-output\-dir
+デフォルトでは、groonga\-benchmark終了後のログファイルの出力先ははカレントディレクトリです。このオプションを利用すると、任意のディレクトリに出力先を変更することができます。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-l, \-\-log\-level <log level>
-ログレベルを指定します。0〜8までの数値が指定可能で、数が大きいほど多くのログが出力されます。
+.B \-\-groonga <groonga_path>
+groongaコマンドのパスを指定します。デフォルトでは、PATHの中からgroongaコマンドを探します。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-a, \-\-address <ip/hostname>
-Deprecated since version 1.2.2: Use \fI\-\-bind\-address\fP instead.
-
+.B \-\-protocol <gqtp|http>
+groongaコマンドが使うプロトコルとして \fIgqtp\fP または \fIhttp\fP を指定します。
 .UNINDENT
+.SS 引数
 .INDENT 0.0
 .TP
-.B \-\-bind\-address <ip/hostname>
-New in version 1.2.2.
-
-.sp
-サーバモードかデーモンモードで実行するとき、listenするアドレスを指定します。(デフォルトは \fIhostname\fP の返すホスト名)
+.B script
+groonga\-benchmarkの動作方法(以下、groonga\-benchmark命令と呼びます)を記述したテキストファイルです。拡張子は.scrです。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-p, \-\-port <port number>
-クライアント、サーバ、またはデーモンモードで使用するTCPポート番号。
-(デフォルトは10041番)
+.B db
+groonga\-benchmarkが利用するgroonga データベースです。指定されたデータベースが存在しない場合、groonga\-benchmarkが新規に作成します。またgroonga サーバを自動的に起動する場合もこの引数で指定したデータベースが利用されます。接続するgroonga サーバを明示的に指定した場合に利用するデータベースは、接続先サーバが使用中のデータベースになることに注意してください。
 .UNINDENT
+.SS 使い方
+.sp
+まず、シェル上(Windowsならコマンドプロンプト上)で:
 .INDENT 0.0
-.TP
-.B \-i, \-\-server\-id <ip/hostname>
-サーバモードかデーモンモードで実行するとき、サーバのIDとなるアドレスを指定します。(デフォルトは\(gahostname\(gaの返すホスト名)
+.INDENT 3.5
+.sp
+.nf
+.ft C
+groonga\-benchmark test.scr 任意のDB名
+.ft P
+.fi
 .UNINDENT
-.INDENT 0.0
-.TP
-.B \-h, \-\-help
-ヘルプメッセージを出力します。
 .UNINDENT
+.sp
+とタイプしてください。もしgroonga\-benchmarkが正常に動作すれば、:
 .INDENT 0.0
-.TP
-.B \-\-document\-root <path>
-httpサーバとしてgroongaを使用する場合に静的ページを格納するディレクトリを指定します。
+.INDENT 3.5
 .sp
-デフォルトでは、データベースを管理するための汎用的なページに対応するファイルが/usr/share/groonga/admin_html以下にインストールされます。このディレクトリをdocument\-rootオプションの値に指定して起動した場合、ウェブブラウザでhttp://hostname:port/index.htmlにアクセスすると、ウェブベースのデータベース管理ツールを使用できます。
+.nf
+.ft C
+test\-ユーザ名\-数字.log
+.ft P
+.fi
 .UNINDENT
+.UNINDENT
+.sp
+というファイルが作成されるはずです。作成されない場合、このドキュメントの「トラブルシューティング」の章を参照してください。
+.SS スクリプトファイル
+.sp
+スクリプトファイルは、groonga\-benchmark命令を記述したテキストファイルです。
+";"セミコロンを利用して、一行に複数のgroonga\-benchmark命令を記述することができます。一行に複数のgroonga\-benchmark命令がある場合、各命令は並列に実行されます。
+"#"で始まる行はコメントとして扱われます。
+.SS groonga\-benchmark命令
+.sp
+現在サポートされているgroonga\-benchmark命令は以下の8つです。
 .INDENT 0.0
-.TP
-.B \-\-protocol <protocol>
-http,gqtpのいずれかを指定します。(デフォルトはgqtp)
+.INDENT 3.5
+do_local コマンドファイル [スレッド数] [繰り返し数]
+.INDENT 0.0
+.INDENT 3.5
+コマンドファイルをgroonga\-benchmark単体で実行します。スレッド数が指定されている場合、複数のスレッドで同じコマンドファイルを同時に実行します。繰り返し数が指定されてい場合、コマンドファイルの内容を繰り返し実行します。スレッド数、繰り返し数とも省略時は1です。1スレッドで複数回動作させたい場合は、do_local コマンドファイル 1 [繰り返し数]と明示的に指定してください。
 .UNINDENT
+.UNINDENT
+.sp
+do_gqpt コマンドファイル [スレッド数] [繰り返し数]
 .INDENT 0.0
-.TP
-.B \-\-log\-path <path>
-ログを出力するファイルのパスを指定します。(デフォルトは/var/log/groonga/groonga.logです)
+.INDENT 3.5
+コマンドファイルをgroongaサーバで実行します。スレッド数や繰り返し数の意味はdo_localの場合と同じです。
 .UNINDENT
+.UNINDENT
+.sp
+rep_local コマンドファイル [スレッド数] [繰り返し数]
 .INDENT 0.0
-.TP
-.B \-\-query\-log\-path <path>
-クエリーログを出力するファイルのパスを指定します。(デフォルトでは出力されません)
+.INDENT 3.5
+コマンドファイルをgroonga\-benchmark単体で実行し、より詳細な報告を行います。
+.UNINDENT
 .UNINDENT
+.sp
+rep_gqpt コマンドファイル [スレッド数] [繰り返し数]
 .INDENT 0.0
-.TP
-.B \-t, \-\-max\-threads <max threasd>
-最大で利用するスレッド数を指定します。(デフォルトはマシンのCPUコア数と同じ数です)
+.INDENT 3.5
+コマンドファイルをgroongaサーバで実行し、より詳細な報告を行います。 スレッド数や繰り返し数の意味はdo_localと 同じです。
+.UNINDENT
 .UNINDENT
+.sp
+out_local コマンドファイル 入力ファイル名
 .INDENT 0.0
-.TP
-.B \-\-pid\-path <path>
-PIDを保存するパスを指定します。(デフォルトでは保存しません)
-.UNINDENT
+.INDENT 3.5
+コマンドファイルをgroonga\-benchmark単体で実行し、各コマンドの実行結果をすべて”出力ファイル"に書きだします。この結果は、test_local,　test_gqtp命令で利用します。なおこの命令の「出力ファイル」とは、groonga\-benchmark実行時に自動的に作成されるログとは別のものです。groonga\-benchmarkではコメントが利用できる以外、:
 .INDENT 0.0
-.TP
-.B \-\-config\-path <path>
-設定ファイルのパスを指定します。設定ファイルは以下のようなフォーマットになります。:
-.INDENT 7.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-# \(aq#\(aq以降はコメント。
-; \(aq;\(aq以降もコメント。
-
-# \(aqキー = 値\(aqでオプションを指定。
-pid\-file = /var/run/groonga.pid
-
-# \(aq=\(aqの前後の空白はは無視される。↓は↑と同じ意味。
-pid\-file=/var/run/groonga.pid
-
-# \(aqキー\(aqは\(aq\-\-XXX\(aqスタイルのオプション名と同じものが使える。
-# 例えば、\(aq\-\-pid\-path\(aqに対応するキーは\(aqpid\-path\(aq。
-# ただし、キーが\(aqconfig\-path\(aqのオプションは無視される。
+groonga < コマンドファイル > 出力ファイル
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
+.sp
+とした場合と同じです。
 .UNINDENT
-.INDENT 0.0
-.TP
-.B \-\-cache\-limit <limit>
-キャッシュ数の最大値を指定します。(デフォルトは100です)
 .UNINDENT
+.sp
+out_gqtp コマンドファイル 出力ファイル名
 .INDENT 0.0
-.TP
-.B \-\-default\-match\-escalation\-threshold <threshold>
-検索の挙動をエスカレーションする閾値を指定します。(デフォルトは0です)
+.INDENT 3.5
+コマンドファイルをgroongaサーバで実行します。その他はout_local命令と同等です。
 .UNINDENT
-.SS 引数
-.INDENT 0.0
-.TP
-.B dest
-使用するデータベースのパス名を指定します。
-.sp
-クライアントモードの場合は接続先のホスト名とポート番号を指定します(デフォルト値は\(aqlocalhost:10041\(aq)。ポート番号を指定しない場合には、10041が指定されたものとします。
 .UNINDENT
 .INDENT 0.0
 .TP
-.B command [args]
-スタンドアロンおよびクライアントモードの場合は、実行するコマンドとその引数をコマンドライン引数に指定できます。コマンドライン引数にcommandを与えなかった場合は、標準入力から一行ずつEOFに達するまでコマンド文字列を読み取り、順次実行します。
+.B test_local コマンドファイル 入力ファイル名
+コマンドファイルをgroonga\-benchmark単体で実行し、各コマンドの実行結果を入力ファイルと比較します。処理時間など本質的要素以外に差分があった場合、差分を、入力ファイル.diffというファイルに書きだします。
 .UNINDENT
-.SS コマンド
-.sp
-groongaコマンドを通してデータベースを操作する命令をコマンドと呼びます。コマンドは主にC言語で記述され、groongaプロセスにロードすることによって使用できるようになります。
-それぞれのコマンドは一意な名前と、0個以上の引数を持ちます。
-.sp
-引数は以下の2種類の方法のいずれかで指定することができます。:
-.INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-形式1: コマンド名 値1 値2,..
-
-形式2: コマンド名 \-\-引数名1 値1 \-\-引数名2 値2,..
-.ft P
-.fi
 .UNINDENT
 .UNINDENT
+.SS コマンドファイル
 .sp
-形式1でコマンドを実行する場合は、定義された順番で値を指定しなければならず、途中の引数の値を省略することはできません。形式2でコマンドを実行する場合は、「\-\-引数名」のように引数の名前を明示しなければならない代わりに、任意の順番で引数を指定することが可能で、途中の引数の指定を省略することもできます。
-.sp
-標準入力からコマンド文字列を与える場合は、コマンド名と引数名と値は、空白( )で区切ります。空白や、記号「"\(aq()」のうちいずれかを含む値を指定したい場合は、シングルクォート(\(aq)かダブルクォート(")で値を囲みます。値として指定する文字列の中では、改行文字は\(aqn\(aqに置き換えて指定します。また、引用符に使用した文字を値の中で指定する場合には、その文字の前にバックスラッシュ(\(aq\(aq) を指定します。バックスラッシュ文字自身を値として指定する場合には、その前にバックスラッシュを指定します。
+コマンドファイルは、groonga組み込みコマンドを1行に1つずつ記述したテキストファイルです。拡張子に制限はありません。groonga組み込みコマンドに関しては \fB/reference/commands\fP を参照してください。
+.SS サンプル
 .sp
-You can write command list with continuous line which is represented by \(aq\e\(aq character.:
+スクリプトファイルのサンプルです。:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-table_create \-\-name Terms \e
-             \-\-flags TABLE_PAT_KEY \e
-             \-\-key_type ShortText \e
-             \-\-default_tokenizer TokenBigram
+# sample script
+rep_local test.ddl
+do_local test.load;
+do_gqtp test.select 10 10; do_local test.status 10
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
-.SS 組み込みコマンド
 .sp
-以下のコマンドは組み込みコマンドとして予め定義されています。
+上記の意味は以下のとおりです。
 .INDENT 0.0
 .INDENT 3.5
 .INDENT 0.0
 .TP
-.B \fBstatus\fP
-groongaプロセスの状態を表示します。
-.TP
-.B \fBtable_list\fP
-DBに定義されているテーブルのリストを表示します。
-.TP
-.B \fBcolumn_list\fP
-テーブルに定義されているカラムのリストを表示します。
-.TP
-.B \fBtable_create\fP
-DBにテーブルを追加します。
-.TP
-.B \fBcolumn_create\fP
-テーブルにカラムを追加します。
-.TP
-.B \fBtable_remove\fP
-DBに定義されているテーブルを削除します。
-.TP
-.B \fBcolumn_remove\fP
-テーブルに定義されているカラムを削除します。
-.TP
-.B \fBload\fP
-テーブルにレコードを挿入します。
-.TP
-.B \fBselect\fP
-テーブルに含まれるレコードを検索して表示します。
-.TP
-.B \fBdefine_selector\fP
-検索条件をカスタマイズした新たな検索コマンドを定義します。
-.TP
-.B \fBquit\fP
-データベースとのセッションを終了します。
-.TP
-.B \fBshutdown\fP
-サーバ(デーモン)プロセスを停止します。
+.B 1行目
+コメント行。
 .TP
-.B \fBlog_level\fP
-ログ出力レベルを設定します。
+.B 2行目
+test.dll というコマンドファイルをgroonga単体で実行し、詳細に報告する。
 .TP
-.B \fBlog_put\fP
-ログ出力を行います。
+.B 3行目
+test.load というコマンドファイルをgroonga単体で実行する。(最後の";"セミコロンは複数のgroonga\-benchmark命令を記述する場合に必要ですが、この例のように1つのgroonga\-benchmark命令を実行する場合に付与しても問題ありません。)
 .TP
-.B \fBclearlock\fP
-ロックを解除します。
+.B 4行目
+test.select というコマンドファイルをgroongaサーバで10個のスレッドで同時に実行する。各スレッドはtest.selectの中身を10回繰り返す。また同時に、groonga単体でtest.statusというコマンドファイルを10個のスレッドで実行する。
 .UNINDENT
 .UNINDENT
 .UNINDENT
-.SS 例
+.SS 特殊命令
 .sp
-新しいデータベースを作成します。:
+スクリプトファイルのコメント行には特殊コマンドを埋め込むことが可能です。現在サポートされている特殊命令は以下の二つです。
 .INDENT 0.0
 .INDENT 3.5
-.sp
-.nf
-.ft C
-% groonga \-n /tmp/hoge.db quit
-%
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B #SET_HOST <ip/hostname>
+\-i, \-\-hostオプションと同等の機能です。コマンドラインオプションに指定したIPアドレス/ホスト名と、SET_HOSTで指定したIPアドレス/ホスト名が異なる場合、またコマンドラインオプションを指定しなかった場合にもSET_HOSTが優先されます。SET_HOSTを利用した場合、サーバが自動的には起動されないのもコマンドラインオプションで指定した場合と同様です。
+.TP
+.B #SET_PORT <port number>
+\-p, \-\-port オプションと同等の機能です。コマンドラインオプションに指定したポート番号とSET_PORTで指定したポート番号が異なる場合、またコマンドラインオプションを指定しなかった場合にもSET_PORTが優先されます。
+.UNINDENT
 .UNINDENT
 .UNINDENT
 .sp
-作成済みのデータベースにテーブルを定義します。:
+特殊命令はスクリプトファイルの任意の場所に書き込むことができます。同一ファイル内に複数回特殊命令を記述した場合、「最後の」特殊命令が有効となります。
+.sp
+例えば、
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-% groonga /tmp/hoge.db table_create Table 0 ShortText
-[[0]]
-%
+$ ./groonga\-benchmark \-\-port 20010 test.scr testdb
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
-サーバを起動します。:
+とコマンド上でポートを指定した場合でも、もしtest.scrの中身が
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-% groonga \-d /tmp/hoge.db
-%
+#SET_PORT 10900
+rep_local test.ddl
+do_local test.load;
+rep_gqtp test.select 10 10; rep_local test.status 10
+#SET_PORT 10400
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
-httpサーバとして起動します。:
+であれば、自動的に起動されるgroongaサーバはポート番号10400を利用します。
+.SS groonga\-benchmark実行結果
+.sp
+groonga\-benchmarkが正常に終了すると、(拡張子を除いた)スクリプト名\-ユーザ名\-実行開始時刻.logという形式のログファイルがカレントディレクトリに作られます。ログファイルは自動的にftp.groonga.org
+に送信されます。ログファイルは以下のようなjson形式のテキストです。
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-% groonga \-d \-p 80 \-\-protocol http \-\-document\-root /usr/share/groonga/admin_html /tmp/hoge.db
-%
+[{"script": "test.scr",
+  "user": "homepage",
+  "date": "2010\-04\-14 22:47:04",
+  "CPU": Intel(R) Pentium(R) 4 CPU 2.80GHz",
+  "BIT": 32,
+  "CORE": 1,
+  "RAM": "975MBytes",
+  "HDD": "257662232KBytes",
+  "OS": "Linux 2.4.20\-24.7\-i686",
+  "HOST": "localhost",
+  "PORT": "10041",
+  "VERSION": "0.1.8\-100\-ga54c5f8"
+},
+{"jobs": "rep_local test.ddl",
+"detail": [
+[0, "table_create res_table \-\-key_type ShortText", 1490, 3086, [0,1271252824.25846,0.00144
+7]],
+[0, "column_create res_table res_column \-\-type Text", 3137, 5956, [0,1271252824.2601,0.002
+741]],
+[0, "column_create res_table user_column \-\-type Text", 6020, 8935, [0,1271252824.26298,0.0
+02841]],
+[0, "column_create res_table mail_column \-\-type Text", 8990, 11925, [0,1271252824.26595,0.
+002861]],
+[0, "column_create res_table time_column \-\-type Time", 12008, 13192, [0,1271252824.26897,0
+\&.001147]],
+[0, "status", 13214, 13277, [0,1271252824.27018,3.0e\-05]],
+[0, "table_create thread_table \-\-key_type ShortText", 13289, 14541, [0,1271252824.27025,0.
+001213]],
+[0, "column_create thread_table thread_title_column \-\-type ShortText", 14570, 17380, [0,12
+71252824.27153,0.002741]],
+[0, "status", 17435, 17480, [0,1271252824.2744,2.7e\-05]],
+[0, "table_create lexicon_table \-\-flags 129 \-\-key_type ShortText \-\-default_tokenizer Token
+Bigram", 17491, 18970, [0,1271252824.27446,0.001431]],
+[0, "column_create lexicon_table inv_res_column 514 res_table res_column ", 18998, 33248,
+[0,1271252824.27596,0.01418]],
+[0, "column_create lexicon_table inv_thread_column 514 thread_table thread_title_column ",
+ 33285, 48472, [0,1271252824.29025,0.015119]],
+[0, "status", 48509, 48554, [0,1271252824.30547,2.7e\-05]]],
+"summary" :[{"job": "rep_local test.ddl", "latency": 48607, "self": 47719, "qps": 272.4281
+73, "min": 45, "max": 15187, "queries": 13}]},
+{"jobs": "do_local test.load; ",
+"summary" :[{"job": "do_local test.load", "latency": 68693, "self": 19801, "qps": 1010.049
+997, "min": 202, "max": 5453, "queries": 20}]},
+{"jobs": "do_gqtp test.select 10 10; do_local test.status 10",
+"summary" :[{"job": " do_local test.status 10", "latency": 805990, "self": 737014, "qps":
+54.273053, "min": 24, "max": 218, "queries": 40},{"job": "do_gqtp test.select 10 10", "lat
+ency": 831495, "self": 762519, "qps": 1967.164097, "min": 73, "max": 135631, "queries": 15
+00}]},
+{"total": 915408, "qps": 1718.359464, "queries": 1573}]
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
-.sp
-サーバに接続し、テーブル一覧を表示します。:
+.SS 制限事項
 .INDENT 0.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-% groonga \-c localhost table_list
-[[0],[["id","name","path","flags","domain"],[256,"Table","/tmp/hoge.db.0000100",49152,14]]]
-%
-.ft P
-.fi
+.IP \(bu 2
+スクリプトファイルの一行には複数のgroonga\-benchmark命令を記述できますが、すべてのスレッド数の合計は最大64までに制限されます。
+.IP \(bu 2
+コマンドファイル中のgroongaコマンドの長さは最長5000000byteです。
 .UNINDENT
+.SS トラブルシューティング
+.sp
+もし、groonga\-benchmarkが正常に動作しない場合、まず以下を確認してください。
+.INDENT 0.0
+.IP \(bu 2
+インターネットに接続しているか？ \fI\-\-ftp\fP オプションを指定すると、groonga\-benchmarkは動作のたびにftp.groonga.orgと通信します。ftp.groonga.orgと通信可能でない場合、groonga\-benchmarkは正常に動作しません。
+.IP \(bu 2
+groonga サーバが動作していないか？　groonga\-benchmarkは、\-i, \-\-host オプションで明示的にサーバを指定しないかぎり、自動的にlocalhostのgroongaサーバを立ち上げます。すでにgroongaサーバが動作している場合、groonga\-benchmarkは正常に動作しない可能性があります。
+.IP \(bu 2
+指定したDBが適切か？ groonga\-benchmarkは、引数で指定したDBの中身はチェックしません。もし指定されたDBが存在しなければ自動的にDBを作成しますが、もしファイルとして存在する場合は中身に関わらず動作を続けてしまい、結果が異常になる可能性があります。
 .UNINDENT
+.sp
+以上の原因でなければ、問題はgroonga\-benchmarkかgroongaにあります。ご報告をお願いします。
 .SS groonga\-httpd
 .SS Summary
 .sp
@@ -10870,14 +10857,14 @@ Execution example:
     0.000355720520019531
   ],
   {
-    "uptime": 0,
+    "uptime": 1,
     "max_command_version": 2,
     "n_queries": 0,
     "cache_hit_rate": 0.0,
-    "version": "3.0.7",
-    "alloc_count": 154,
+    "version": "3.1.0",
+    "alloc_count": 159,
     "command_version": 1,
-    "starttime": 1377493431,
+    "starttime": 1385359876,
     "default_command_version": 1
   }
 ]
@@ -14795,6 +14782,21 @@ You can load any script file which mruby supports by calling \fBruby_load\fP.
 .sp
 Here is an example that just load \fBexpression.rb\fP as Ruby script.
 .sp
+Execution example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+register ruby/load
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+ruby_load "expression.rb"
+# [[0, 1337566253.89858, 0.000355720520019531], {"value": null}]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
 Register \fBruby/load\fP plugin to use \fBruby_load\fP command in advance.
 .sp
 Note that \fBruby_load\fP is implemented as an experimental plugin,
@@ -17529,14 +17531,14 @@ status
 #     0.000355720520019531
 #   ],
 #   {
-#     "uptime": 50,
+#     "uptime": 0,
 #     "max_command_version": 2,
-#     "n_queries": 39,
+#     "n_queries": 0,
 #     "cache_hit_rate": 0.0,
-#     "version": "3.0.7",
-#     "alloc_count": 300,
+#     "version": "3.1.0",
+#     "alloc_count": 290,
 #     "command_version": 1,
-#     "starttime": 1377493297,
+#     "starttime": 1385359891,
 #     "default_command_version": 1
 #   }
 # ]
@@ -32794,7 +32796,7 @@ as \(aqja\(aq.
 \fIsearch\fP
 .UNINDENT
 .SH AUTHOR
-groonga project
+Groonga Project
 .SH COPYRIGHT
 2009-2013, Brazil, Inc
 .\" Generated by docutils manpage writer.