Navigation Menu

Skip to content

Commit

Permalink
Update Groonga document
Browse files Browse the repository at this point in the history
  • Loading branch information
Masafumi Yokoyama committed Apr 30, 2015
1 parent f2fe8fe commit 92ddfef
Show file tree
Hide file tree
Showing 17 changed files with 176 additions and 62 deletions.
34 changes: 32 additions & 2 deletions docs/genindex.html
Expand Up @@ -222,6 +222,17 @@ <h2 id="Symbols">Symbols</h2>

</dl></dd>

<dt>
--log-rotate-threshold-size &lt;threshold&gt;
</dt>

<dd><dl>

<dt><a href="reference/executables/groonga.html#cmdoption--log-rotate-threshold-size">command line option</a>
</dt>

</dl></dd>

<dt>
--n-lines-per-log-file
</dt>
Expand Down Expand Up @@ -277,6 +288,17 @@ <h2 id="Symbols">Symbols</h2>

</dl></dd>

<dt>
--query-log-rotate-threshold-size &lt;threshold&gt;
</dt>

<dd><dl>

<dt><a href="reference/executables/groonga.html#cmdoption--query-log-rotate-threshold-size">command line option</a>
</dt>

</dl></dd>

<dt>
-a, --address &lt;ip/hostname&gt;
</dt>
Expand All @@ -298,6 +320,8 @@ <h2 id="Symbols">Symbols</h2>
</dt>

</dl></dd>
</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt>
-d
Expand All @@ -309,8 +333,6 @@ <h2 id="Symbols">Symbols</h2>
</dt>

</dl></dd>
</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt>
-d, --daemon
Expand Down Expand Up @@ -605,6 +627,10 @@ <h2 id="C">C</h2>
</dt>


<dt><a href="reference/executables/groonga.html#cmdoption--log-rotate-threshold-size">--log-rotate-threshold-size &lt;threshold&gt;</a>
</dt>


<dt><a href="reference/executables/groonga-suggest-httpd.html#cmdoption--n-lines-per-log-file">--n-lines-per-log-file</a>
</dt>

Expand All @@ -625,6 +651,10 @@ <h2 id="C">C</h2>
</dt>


<dt><a href="reference/executables/groonga.html#cmdoption--query-log-rotate-threshold-size">--query-log-rotate-threshold-size &lt;threshold&gt;</a>
</dt>


<dt><a href="reference/executables/grnslap.html#cmdoption-P">-P</a>
</dt>

Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
22 changes: 20 additions & 2 deletions docs/reference/executables/groonga.html
Expand Up @@ -170,7 +170,7 @@ <h2>7.1.3.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this
usage.</p>
<p>In server mode, <tt class="docutils literal"><span class="pre">groonga</span></tt> executable file runs in the foreground. If
you want to run Groonga server in the background, see
<a class="reference internal" href="#groonga-executable-file-server-mode"><em>Server mode</em></a>.</p>
<a class="reference internal" href="#groonga-executable-file-daemon-mode"><em>Daemon mode</em></a>.</p>
<p>Here is the syntax to run Groonga server with temporary database:</p>
<div class="highlight-none"><div class="highlight"><pre>groonga [options] --protocol http -s
</pre></div>
Expand All @@ -189,7 +189,7 @@ <h2>7.1.3.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this
<span id="groonga-executable-file-daemon-mode"></span><h3>7.1.3.2.3. Daemon mode<a class="headerlink" href="#daemon-mode" title="Permalink to this headline"></a></h3>
<p>In daemon mode, <tt class="docutils literal"><span class="pre">groonga</span></tt> executable file runs as a daemon. Daemon
is similar to server but it runs in the background. See
<em class="xref std std-ref">_groonga-executable-file-daemon-mode</em> about server.</p>
<em class="xref std std-ref">_groonga-executable-file-server-mode</em> about server.</p>
<p>Here is the syntax to run Groonga daemon with temporary database:</p>
<div class="highlight-none"><div class="highlight"><pre>groonga [options] --protocol http -d
</pre></div>
Expand Down Expand Up @@ -359,12 +359,30 @@ <h2>7.1.3.3. Options<a class="headerlink" href="#options" title="Permalink to th
<dd><p>ログを出力するファイルのパスを指定します。(デフォルトは/var/log/groonga/groonga.logです)</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption--log-rotate-threshold-size">
<tt class="descname">--log-rotate-threshold-size</tt><tt class="descclassname"> &lt;threshold&gt;</tt><a class="headerlink" href="#cmdoption--log-rotate-threshold-size" title="Permalink to this definition"></a></dt>
<dd><div class="versionadded">
<p><span class="versionmodified">New in version 5.0.3.</span></p>
</div>
<p>Specifies threshold for log rotation. Log file is rotated when log file size is larger than or equals to the threshold (default: 0; disabled).</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption--query-log-path">
<tt class="descname">--query-log-path</tt><tt class="descclassname"> &lt;path&gt;</tt><a class="headerlink" href="#cmdoption--query-log-path" title="Permalink to this definition"></a></dt>
<dd><p>クエリーログを出力するファイルのパスを指定します。(デフォルトでは出力されません)</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption--query-log-rotate-threshold-size">
<tt class="descname">--query-log-rotate-threshold-size</tt><tt class="descclassname"> &lt;threshold&gt;</tt><a class="headerlink" href="#cmdoption--query-log-rotate-threshold-size" title="Permalink to this definition"></a></dt>
<dd><div class="versionadded">
<p><span class="versionmodified">New in version 5.0.3.</span></p>
</div>
<p>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).</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-t">
<span id="cmdoption--max-threads"></span><tt class="descname">-t</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--max-threads</tt><tt class="descclassname"> &lt;max threasd&gt;</tt><a class="headerlink" href="#cmdoption-t" title="Permalink to this definition"></a></dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/vector_size.html
Expand Up @@ -98,7 +98,7 @@ <h2>7.14.15.1. Summary<a class="headerlink" href="#summary" title="Permalink to
<div class="highlight-none"><div class="highlight"><pre>plugin_register functions/vector
</pre></div>
</div>
<p>Then, use <tt class="docutils literal"><span class="pre">vector_size</span></tt> function with <tt class="docutils literal"><span class="pre">--command_version</span> <span class="pre">2</span></tt> option.</p>
<p>Then, use <tt class="docutils literal"><span class="pre">vector_size</span></tt> function with <tt class="docutils literal"><span class="pre">--command_version</span> <span class="pre">2</span></tt> option. Note that you must specify <tt class="docutils literal"><span class="pre">--command_version</span> <span class="pre">2</span></tt> to use <tt class="docutils literal"><span class="pre">vector_size</span></tt> function.&quot;</p>
</div>
<div class="section" id="syntax">
<h2>7.14.15.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

20 changes: 16 additions & 4 deletions docs/sources/reference/executables/groonga.txt
Expand Up @@ -97,8 +97,8 @@ default protocol. This section describes only about HTTP protocol
usage.

In server mode, ``groonga`` executable file runs in the foreground. If
you want to run Groonga server in the background, see
:ref:`groonga-executable-file-server-mode`.
you want to run Groonga server in the background, see
:ref:`groonga-executable-file-daemon-mode`.

Here is the syntax to run Groonga server with temporary database::

Expand All @@ -119,8 +119,8 @@ Daemon mode
^^^^^^^^^^^

In daemon mode, ``groonga`` executable file runs as a daemon. Daemon
is similar to server but it runs in the background. See
:ref:`_groonga-executable-file-daemon-mode` about server.
is similar to server but it runs in the background. See
:ref:`_groonga-executable-file-server-mode` about server.

Here is the syntax to run Groonga daemon with temporary database::

Expand Down Expand Up @@ -250,10 +250,22 @@ Options

ログを出力するファイルのパスを指定します。(デフォルトは/var/log/groonga/groonga.logです)

.. cmdoption:: --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>

クエリーログを出力するファイルのパスを指定します。(デフォルトでは出力されません)

.. cmdoption:: --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>

最大で利用するスレッド数を指定します。(デフォルトはマシンのCPUコア数と同じ数です)
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/functions/vector_size.txt
Expand Up @@ -19,7 +19,7 @@ To enable this function, register ``functions/vector`` plugin by following the c

plugin_register functions/vector

Then, use ``vector_size`` function with ``--command_version 2`` option.
Then, use ``vector_size`` function with ``--command_version 2`` option. Note that you must specify ``--command_version 2`` to use ``vector_size`` function."

Syntax
------
Expand Down
34 changes: 32 additions & 2 deletions ja/docs/genindex.html
Expand Up @@ -224,6 +224,17 @@ <h2 id="記号">記号</h2>

</dl></dd>

<dt>
--log-rotate-threshold-size &lt;threshold&gt;
</dt>

<dd><dl>

<dt><a href="reference/executables/groonga.html#cmdoption--log-rotate-threshold-size">コマンドラインオプション</a>
</dt>

</dl></dd>

<dt>
--n-lines-per-log-file
</dt>
Expand Down Expand Up @@ -279,6 +290,17 @@ <h2 id="記号">記号</h2>

</dl></dd>

<dt>
--query-log-rotate-threshold-size &lt;threshold&gt;
</dt>

<dd><dl>

<dt><a href="reference/executables/groonga.html#cmdoption--query-log-rotate-threshold-size">コマンドラインオプション</a>
</dt>

</dl></dd>

<dt>
-a, --address &lt;ip/hostname&gt;
</dt>
Expand All @@ -300,6 +322,8 @@ <h2 id="記号">記号</h2>
</dt>

</dl></dd>
</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt>
-d
Expand All @@ -311,8 +335,6 @@ <h2 id="記号">記号</h2>
</dt>

</dl></dd>
</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt>
-d, --daemon
Expand Down Expand Up @@ -1474,6 +1496,10 @@ <h2 id="記号">記号</h2>
</dt>


<dt><a href="reference/executables/groonga.html#cmdoption--log-rotate-threshold-size">--log-rotate-threshold-size &lt;threshold&gt;</a>
</dt>


<dt><a href="reference/executables/groonga-suggest-httpd.html#cmdoption--n-lines-per-log-file">--n-lines-per-log-file</a>
</dt>

Expand All @@ -1494,6 +1520,10 @@ <h2 id="記号">記号</h2>
</dt>


<dt><a href="reference/executables/groonga.html#cmdoption--query-log-rotate-threshold-size">--query-log-rotate-threshold-size &lt;threshold&gt;</a>
</dt>


<dt><a href="reference/executables/grnslap.html#cmdoption-P">-P</a>
</dt>

Expand Down
13 changes: 5 additions & 8 deletions ja/docs/install/others.html
Expand Up @@ -117,8 +117,8 @@ <h3>2.8.1.1. ツール<a class="headerlink" href="#tools" title="このヘッド
<div><ul class="simple">
<li><p class="first"><a class="reference external" href="http://www.freedesktop.org/wiki/Software/pkg-config">pkg-config</a> (ライブラリを検出するため)</p>
</li>
<li><a class="reference external" href="http://www.gratisoft.us/sudo/">sudo</a> for installing built
Groonga</li>
<li><p class="first"><a class="reference external" href="http://www.gratisoft.us/sudo/">sudo</a> (ビルドしたGroongaをインストールするため)</p>
</li>
</ul>
</div></blockquote>
<p>追加のライブラリを使いたい場合はこれらのツールを用意しておかなければいけません。</p>
Expand Down Expand Up @@ -161,8 +161,7 @@ <h2>2.8.2. ソースからビルド<a class="headerlink" href="#build-from-sourc
</pre></div>
</div>
<p>上記の手順を実行すると <tt class="docutils literal"><span class="pre">/usr/local/bin/groonga</span></tt><a class="reference internal" href="../reference/executables/groonga.html"><em>groonga executable file</em></a> がインストールされます。</p>
<p>The default build will work well but you can customize Groonga at
<tt class="docutils literal"><span class="pre">configure</span></tt> step.</p>
<p>デフォルトのビルドでもうまく動くでしょうが、 <tt class="docutils literal"><span class="pre">configure</span></tt> のときにGroongaをカスタマイズすることができます。</p>
<p>以下、それぞれの手順の詳細を説明します。</p>
<div class="section" id="configure">
<span id="source-configure"></span><h3>2.8.2.1. <tt class="docutils literal"><span class="pre">configure</span></tt><a class="headerlink" href="#configure" title="このヘッドラインへのパーマリンク"></a></h3>
Expand Down Expand Up @@ -233,9 +232,7 @@ <h4>2.8.2.1.7. <tt class="docutils literal"><span class="pre">--with-lz4</span><
<div class="section" id="with-message-pack-message-pack-install-prefix">
<h4>2.8.2.1.8. <tt class="docutils literal"><span class="pre">--with-message-pack=MESSAGE_PACK_INSTALL_PREFIX</span></tt><a class="headerlink" href="#with-message-pack-message-pack-install-prefix" title="このヘッドラインへのパーマリンク"></a></h4>
<p>MessagePackがどこにインストールされているかを指定します。MessagePackを <tt class="docutils literal"><span class="pre">--prefix=/usr</span></tt> という <tt class="docutils literal"><span class="pre">configure</span></tt> オプションでインストールしていない場合は、MessagePackをビルドするときに指定したパスをこのオプションで指定してください。</p>
<p>If you installed MessagePack with <tt class="docutils literal"><span class="pre">--prefix=$HOME/local</span></tt> option, you
should specify <tt class="docutils literal"><span class="pre">--with-message-pack=$HOME/local</span></tt> to Groonga's
<tt class="docutils literal"><span class="pre">configure</span></tt>.</p>
<p>もし、MessagePackを <tt class="docutils literal"><span class="pre">--prefix=$HOME/local</span></tt> という <tt class="docutils literal"><span class="pre">configure</span></tt> オプションでインストールした場合は、Groongaの <tt class="docutils literal"><span class="pre">configure</span></tt> では <tt class="docutils literal"><span class="pre">--with-message-pack=$HOME/local</span></tt> と指定してください。</p>
<p>デフォルトは <tt class="docutils literal"><span class="pre">/usr</span></tt> です。</p>
<p>以下はMessagePackが <tt class="docutils literal"><span class="pre">--prefix=$HOME/local</span></tt> という <tt class="docutils literal"><span class="pre">configure</span></tt> オプションでインストールされている場合の例です:</p>
<div class="highlight-none"><div class="highlight"><pre>% ./configure --with-message-pack=$HOME/local
Expand Down Expand Up @@ -267,7 +264,7 @@ <h4>2.8.2.1.11. <tt class="docutils literal"><span class="pre">--help</span></tt
</div>
<div class="section" id="make">
<h3>2.8.2.2. <tt class="docutils literal"><span class="pre">make</span></tt><a class="headerlink" href="#make" title="このヘッドラインへのパーマリンク"></a></h3>
<p><tt class="docutils literal"><span class="pre">configure</span></tt> is succeeded, you can build Groonga by <tt class="docutils literal"><span class="pre">make</span></tt>:</p>
<p><tt class="docutils literal"><span class="pre">configure</span></tt> が成功したら <tt class="docutils literal"><span class="pre">make</span></tt> でGroongaをビルドします:</p>
<div class="highlight-none"><div class="highlight"><pre>% make
</pre></div>
</div>
Expand Down
Binary file modified ja/docs/objects.inv
Binary file not shown.

0 comments on commit 92ddfef

Please sign in to comment.