rroonga 6.1.3-x64-mingw32 → 7.0.2-x64-mingw32

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/grnslap.txt

@@ -2,6 +2,8 @@
 
 .. highlightlang:: none
 
+.. program:: grnslap
+
 grnslap
 =======
 
@@ -31,7 +33,7 @@ Groonga独自プロトコルであるGQTPと、httpの両プロトコルでリ
 オプション
 ----------
 
-.. cmdoption:: -P
+.. option:: -P
 
    リクエストのプロトコルを指定します。
 
@@ -43,14 +45,14 @@ Groonga独自プロトコルであるGQTPと、httpの両プロトコルでリ
 
      gqtpでリクエストします。gqtpのリクエストをLF区切り形式で標準入力に与えると、それらのリクエストを順次行います。
 
-.. cmdoption:: -m
+.. option:: -m
 
    リクエストの多重度を指定します。初期値は10です。
 
 引数
 ----
 
-.. cmdoption:: dest
+.. option:: dest
 
    接続先のホスト名とポート番号をを指定します(デフォルト値は'localhost:10041')。ポート番号を指定しない場合には、10041が指定されたものとします。
 

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-benchmark.txt

@@ -2,6 +2,8 @@
 
 .. highlightlang:: none
 
+.. program:: groonga-benchmark
+
 groonga-benchmark
 =================
 
@@ -30,44 +32,44 @@ groonga-benchmark用のデータファイルは自分で作成することも既
 
 オプション
 ----------
-.. cmdoption:: -i, --host <ip/hostname>
+.. option:: -i, --host <ip/hostname>
 
   接続するgroongaサーバを、ipアドレスまたはホスト名で指定します。指定先にgroongaサーバが立ち上がっていない場合、接続不能となることに注意してください。このオプションを指定しない場合、groonga-benchmarkは自動的にlocalhostのgroongaサーバを起動して接続します。
 
 
-.. cmdoption:: -p, --port <port number>
+.. option:: -p, --port <port number>
 
   自動的に起動するgroongaサーバ、または明示的に指定した接続先のgroonga サーバが利用するポート番号を指定します。接続先のgroongaサーバが利用しているポートと、このオプションで指定したポート番号が異なる場合、接続不能となることに注意してください。
 
 
-.. cmdoption:: --dir
+.. option:: --dir
 
   ftp.groonga.org に用意されているスクリプトファイルを表示します。
 
-.. cmdoption:: --ftp
+.. option:: --ftp
 
   ftp.groonga.orgとFTP通信を行い、scriptファイルの同期やログファイルの送信を行います。
 
-.. cmdoption:: --log-output-dir
+.. option:: --log-output-dir
 
   デフォルトでは、groonga-benchmark終了後のログファイルの出力先ははカレントディレクトリです。このオプションを利用すると、任意のディレクトリに出力先を変更することができます。
 
-.. cmdoption:: --groonga <groonga_path>
+.. option:: --groonga <groonga_path>
 
   groongaコマンドのパスを指定します。デフォルトでは、PATHの中からgroongaコマンドを探します。
 
-.. cmdoption:: --protocol <gqtp|http>
+.. option:: --protocol <gqtp|http>
 
   groongaコマンドが使うプロトコルとして `gqtp` または `http` を指定します。
 
 引数
 ----
 
-.. cmdoption:: script
+.. option:: script
 
   groonga-benchmarkの動作方法(以下、groonga-benchmark命令と呼びます)を記述したテキストファイルです。拡張子は.scrです。
 
-.. cmdoption:: db
+.. option:: db
 
   groonga-benchmarkが利用するgroonga データベースです。指定されたデータベースが存在しない場合、groonga-benchmarkが新規に作成します。またgroonga サーバを自動的に起動する場合もこの引数で指定したデータベースが利用されます。接続するgroonga サーバを明示的に指定した場合に利用するデータベースは、接続先サーバが使用中のデータベースになることに注意してください。
 

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-httpd.txt

@@ -20,8 +20,8 @@ by nginx is also available in groonga-httpd.
 groonga-httpd has an Web-based administration tool implemented with HTML and
 JavaScript. You can access to it from http://hostname:port/.
 
-Synopsis
---------
+Syntax
+------
 
 ::
 
@@ -121,7 +121,7 @@ by groonga-httpd to configure groonga-httpd specific configurations.
 ``groonga``
 """""""""""
 
-Synopsis::
+Syntax::
 
   groonga on | off;
 
@@ -144,12 +144,12 @@ Examples::
     groonga off; # Disables groonga under /d/... path
   }
 
-.. _groonga-database:
+.. _groonga-httpd-groonga-database:
 
 ``groonga_database``
 """"""""""""""""""""
 
-Synopsis::
+Syntax::
 
   groonga_database /path/to/groonga/database;
 
@@ -162,12 +162,12 @@ Context
 Specifies the path to a Groonga database. This is the required
 directive.
 
-.. _groonga-database-auto-create:
+.. _groonga-httpd-groonga-database-auto-create:
 
 ``groonga_database_auto_create``
 """"""""""""""""""""""""""""""""
 
-Synopsis::
+Syntax::
 
   groonga_database_auto_create on | off;
 
@@ -179,9 +179,9 @@ Context
 
 Specifies whether Groonga database is created automatically or not. If
 the value is ``on`` and the Groonga database specified by
-:ref:`groonga-database` doesn't exist, the Groonga database is created
-automatically. If the Groonga database exists, groonga-httpd does
-nothing.
+:ref:`groonga-httpd-groonga-database` doesn't exist, the Groonga
+database is created automatically. If the Groonga database exists,
+groonga-httpd does nothing.
 
 If parent directory doesn't exist, parent directory is also created
 recursively.
@@ -193,7 +193,7 @@ changed.
 ``groonga_base_path``
 """""""""""""""""""""
 
-Synopsis::
+Syntax::
 
   groonga_base_path /d/;
 
@@ -237,12 +237,12 @@ Here is an example configuration to add authorization to
     # Because location name is the base path.
   }
 
-.. _groonga-log-path:
+.. _groonga-httpd-groonga-log-path:
 
 ``groonga_log_path``
 """""""""""""""""""""
 
-Synopsis::
+Syntax::
 
   groonga_log_path path | off;
 
@@ -264,12 +264,12 @@ Examples::
     groonga_log_path off;
   }
 
-.. _groonga-log-level:
+.. _groonga-httpd-groonga-log-level:
 
 ``groonga_log_level``
 """""""""""""""""""""
 
-Synopsis::
+Syntax::
 
   groonga_log_level none | emergency | alert | ciritical | error | warning | notice | info | debug | dump;
 
@@ -290,12 +290,12 @@ Examples::
     groonga_log_level notice;
   }
 
-.. _groonga-query-log-path:
+.. _groonga-httpd-groonga-query-log-path:
 
 ``groonga_query_log_path``
 """"""""""""""""""""""""""
 
-Synopsis::
+Syntax::
 
   groonga_query_log_path path | off;
 
@@ -349,19 +349,17 @@ see http://wiki.nginx.org/CoreModule#worker_processes.
 
 By default, this is set to 1. It is nginx's default.
 
-.. _groonga-cache-limit:
+.. _groonga-httpd-groonga-cache-limit:
 
 ``groonga_cache_limit``
 """""""""""""""""""""""
 
-This directive is introduced to customize cache limit for each worker process.
+Syntax::
 
-Synopsis::
-
-  groonga_cache_limit CACHE_LIMIT;
+  groonga_cache_limit limit;
 
 Default
-  100
+  ``groonga_cache_limit 100;``
 
 Context
   ``http``, ``server``, ``location``
@@ -378,6 +376,56 @@ Examples::
     groonga_cache_limit 100;
   }
 
+.. _groonga-httpd-groonga-cache-base-path:
+
+``groonga_cache_base_path``
+"""""""""""""""""""""""""""
+
+Syntax::
+
+  groonga_cache_base_path path | off;
+
+Default
+  ``groonga_cache_base_path off;``
+
+Context
+  ``http``, ``server``, ``location``
+
+Specifies the base path of query cache in the ``http``, ``server`` or
+``location`` block.
+
+It's recommended that you specify this configuration when you use
+multi-workers configuration.
+
+If the base path is specified, you can use persistent cache instead of
+on memory cache. If you use persistent cache, workers share query
+cache. It's efficient for multi-workers configuration because the same
+response is cached only once in multiple workers.
+
+There is one more merit for persistent cache. You don't need to warm
+up cache after groonga-httpd is restarted. Persistent cache isn't
+cleared when groonga-httpd is down. groonga-httpd can use existing
+persistent cache again.
+
+The default value is ``off``. It means that persistent cache is
+disabled. On memory cache is used. On memory cache is independent in
+each worker. It's not efficient for multi-workers configuration
+because two or more workers may keeps the same response separately.
+
+Persistent cache is a bit slower than on memory cache. Normally, the
+difference has little influence on performance.
+
+You must specify the base path on memory file system. If you specify
+the base path on disk, your cache will be slow. It's not make sense.
+
+Examples::
+
+  location /d/ {
+    groonga on;
+    # You can customize query cache limit for groonga.
+    groonga_cache_base_path /dev/shm/groonga-httpd-cache;
+  }
+
 ``proxy_cache``
 """""""""""""""
 

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-suggest-httpd.txt

@@ -2,6 +2,8 @@
 
 .. highlightlang:: none
 
+.. program:: groonga-suggest-httpd
+
 .. groonga-command
 .. database: groonga-suggest-httpd
 .. % killall lt-groonga-suggest-learner || :

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-suggest-learner.txt

@@ -2,6 +2,8 @@
 
 .. highlightlang:: none
 
+.. program:: groonga-suggest-learner
+
 groonga-suggest-learner
 =======================
 
@@ -45,27 +47,27 @@ Here is the sample to load log data under ``logs`` directory::
 Options
 -------
 
-.. cmdoption:: -r <endpoint>, --receive-endpoint <endpoint>
+.. option:: -r <endpoint>, --receive-endpoint <endpoint>
 
    Uses ``<endpoint>`` as the receiver endpoint.
 
-.. cmdoption:: -s <endpoint>, --send-endpoint <endpoint>
+.. option:: -s <endpoint>, --send-endpoint <endpoint>
 
    Uses ``<endpoint>`` as the sender endpoint.
 
-.. cmdoption:: -d, --daemon
+.. option:: -d, --daemon
 
    Runs as a daemon.
 
-.. cmdoption:: -l <directory>, --log-base-path <directory>
+.. option:: -l <directory>, --log-base-path <directory>
 
    Reads logs from ``<directory>``.
 
-.. cmdoption:: --log-path <path>
+.. option:: --log-path <path>
 
    Outputs log to ``<path>``.
 
-.. cmdoption:: --log-level <level>
+.. option:: --log-level <level>
 
    Uses ``<level>`` for log level. ``<level>`` must be between 1 and 9.
    Larger level outputs more logs.

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga.txt

@@ -2,6 +2,8 @@
 
 .. highlightlang:: none
 
+.. program:: groonga
+
 ``groonga`` executable file
 ===========================
 
@@ -164,27 +166,27 @@ is running at ``192.168.0.1:10043`` and exit::
 Options
 -------
 
-.. cmdoption:: -n
+.. option:: -n
 
    Creates new database.
 
-.. cmdoption:: -c
+.. option:: -c
 
    Executes ``groonga`` command in client mode.
 
-.. cmdoption:: -s
+.. option:: -s
 
    Executes ``groonga`` command in server mode. Use "Ctrl+C" to stop the ``groonga`` process.
 
-.. cmdoption:: -d
+.. option:: -d
 
    Executes ``groonga`` command in daemon mode. In contrast to server mode, ``groonga`` command forks in daemon mode. For example, to stop local daemon process, use "curl http://127.0.0.1:10041/d/shutdown".
 
-.. cmdoption:: -e, --encoding <encoding>
+.. option:: -e, --encoding <encoding>
 
    Specifies encoding which is used for Groonga database. This option is effective when you create new Groonga database.  This parameter specifies one of the following values: ``none``, ``euc``, ``utf8``, ``sjis``, ``latin`` or ``koi8r``.
 
-.. cmdoption:: -l, --log-level <log level>
+.. option:: -l, --log-level <log level>
 
    Specifies log level. Log level must be a log level name or an
    integer value. Here are available log levels:
@@ -226,69 +228,69 @@ Options
      - ``-`` or ``dump``
      - ``9``
 
-.. cmdoption:: -a, --address <ip/hostname>
+.. option:: -a, --address <ip/hostname>
 
    .. deprecated:: 1.2.2
       Use :option:`--bind-address` instead.
 
-.. cmdoption:: --bind-address <ip/hostname>
+.. option:: --bind-address <ip/hostname>
 
    .. versionadded:: 1.2.2
 
    サーバモードかデーモンモードで実行するとき、listenするアドレスを指定します。(デフォルトは `hostname` の返すホスト名)
 
-.. cmdoption:: -p, --port <port number>
+.. option:: -p, --port <port number>
 
    クライアント、サーバ、またはデーモンモードで使用するTCPポート番号。
    (クライアントモードのデフォルトは10043番、サーバ、またはデーモンモードのデフォルトは、HTTPの場合、10041番、GQTPの場合、10043番)
 
-.. cmdoption:: -i, --server-id <ip/hostname>
+.. option:: -i, --server-id <ip/hostname>
 
    サーバモードかデーモンモードで実行するとき、サーバのIDとなるアドレスを指定します。(デフォルトは`hostname`の返すホスト名)
 
-.. cmdoption:: -h, --help
+.. option:: -h, --help
 
    ヘルプメッセージを出力します。
 
-.. cmdoption:: --document-root <path>
+.. option:: --document-root <path>
 
    httpサーバとしてgroongaを使用する場合に静的ページを格納するディレクトリを指定します。
 
    デフォルトでは、データベースを管理するための汎用的なページに対応するファイルが/usr/share/groonga/admin_html以下にインストールされます。このディレクトリをdocument-rootオプションの値に指定して起動した場合、ウェブブラウザでhttp://hostname:port/index.htmlにアクセスすると、ウェブベースのデータベース管理ツールを使用できます。
 
-.. cmdoption:: --protocol <protocol>
+.. option:: --protocol <protocol>
 
    http,gqtpのいずれかを指定します。(デフォルトはgqtp)
 
-.. cmdoption:: --log-path <path>
+.. option:: --log-path <path>
 
    ログを出力するファイルのパスを指定します。(デフォルトは/var/log/groonga/groonga.logです)
 
-.. cmdoption:: --log-rotate-threshold-size <threshold>
+.. option:: --log-rotate-threshold-size <threshold>
 
    .. versionadded:: 5.0.3
 
    Specifies threshold for log rotation. Log file is rotated when log file size is larger than or equals to the threshold (default: 0; disabled).
 
-.. cmdoption:: --query-log-path <path>
+.. option:: --query-log-path <path>
 
    クエリーログを出力するファイルのパスを指定します。(デフォルトでは出力されません)
 
-.. cmdoption:: --query-log-rotate-threshold-size <threshold>
+.. option:: --query-log-rotate-threshold-size <threshold>
 
    .. versionadded:: 5.0.3
 
    Specifies threshold for query log rotation. Query log file is rotated when query log file size is larger than or equals to the threshold (default: 0; disabled).
 
-.. cmdoption:: -t, --max-threads <max threasd>
+.. option:: -t, --max-threads <max threasd>
 
    最大で利用するスレッド数を指定します。(デフォルトはマシンのCPUコア数と同じ数です)
 
-.. cmdoption:: --pid-path <path>
+.. option:: --pid-path <path>
 
    PIDを保存するパスを指定します。(デフォルトでは保存しません)
 
-.. cmdoption:: --config-path <path>
+.. option:: --config-path <path>
 
    設定ファイルのパスを指定します。設定ファイルは以下のようなフォーマットになります。::
 
@@ -305,15 +307,15 @@ Options
      # 例えば、'--pid-path'に対応するキーは'pid-path'。
      # ただし、キーが'config-path'のオプションは無視される。
 
-.. cmdoption:: --cache-limit <limit>
+.. option:: --cache-limit <limit>
 
    キャッシュ数の最大値を指定します。(デフォルトは100です)
 
-.. cmdoption:: --default-match-escalation-threshold <threshold>
+.. option:: --default-match-escalation-threshold <threshold>
 
    検索の挙動をエスカレーションする閾値を指定します。(デフォルトは0です)
 
-.. cmdoption:: --default-request-timeout <timeout>
+.. option:: --default-request-timeout <timeout>
 
    Specifies the default request timeout in seconds.
 
@@ -327,16 +329,40 @@ Options
 
    .. seealso:: :doc:`/reference/command/request_timeout`
 
+.. option:: --cache-base-path <path>
+
+   .. versionadded:: 7.0.2
+
+   Specifies the base path for cache. It enables persistent cache
+   feature.
+
+   You can get the following merits by persistent cache feature:
+
+     * You can reuse cache after ``groonga`` process is restarted. You
+       don't need to warm up your cache each restart.
+
+     * You can share cache with multiple ``groonga`` processes.
+
+   You must specify the base path on memory file system. If you
+   specify the base path on disk, your cache will be slow. It's not
+   make sense.
+
+   The default is nothing. It means that persistent cache is
+   disabled. On memory cache is used.
+
+   Persistent cache is a bit slower than on memory cache. Normally,
+   the difference has little influence on performance.
+
 Command line parameters
 -----------------------
 
-.. cmdoption:: dest
+.. option:: dest
 
    使用するデータベースのパス名を指定します。
 
    クライアントモードの場合は接続先のホスト名とポート番号を指定します(デフォルト値は'localhost:10043')。ポート番号を指定しない場合には、10043が指定されたものとします。
 
-.. cmdoption:: command [args]
+.. option:: command [args]
 
    スタンドアロンおよびクライアントモードの場合は、実行するコマンドとその引数をコマンドライン引数に指定できます。コマンドライン引数にcommandを与えなかった場合は、標準入力から一行ずつEOFに達するまでコマンド文字列を読み取り、順次実行します。