RubyGems - rroonga - Versions diffs - 2.0.7-x86-mingw32 → 2.0.8-x86-mingw32 - Mend

rroonga 2.0.7-x86-mingw32 → 2.0.8-x86-mingw32

Files changed (403) hide show

data/vendor/local/share/doc/groonga/en/html/reference/cast.html CHANGED Viewed

@@ -9,7 +9,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Cast &mdash; groonga v2.0.5-316-g23cc017 documentation</title>
+    <title>Cast &mdash; groonga v2.0.9 documentation</title>
     <link rel="stylesheet" href="../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -17,7 +17,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '2.0.5-316-g23cc017',
+        VERSION:     '2.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -27,7 +27,7 @@
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
-    <link rel="top" title="groonga v2.0.5-316-g23cc017 documentation" href="../index.html" />
+    <link rel="top" title="groonga v2.0.9 documentation" href="../index.html" />
   </head>
   <body>
 <div class="header">
@@ -53,7 +53,7 @@
         <li class="right" style="margin-right: 10px">
           <a href="../genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li><a href="../index.html">groonga v2.0.5-316-g23cc017 documentation</a> &raquo;</li>
+        <li><a href="../index.html">groonga v2.0.9 documentation</a> &raquo;</li>
       </ul>
     </div>
@@ -101,7 +101,7 @@
         <li class="right" style="margin-right: 10px">
           <a href="../genindex.html" title="General Index"
              >index</a></li>
-        <li><a href="../index.html">groonga v2.0.5-316-g23cc017 documentation</a> &raquo;</li>
+        <li><a href="../index.html">groonga v2.0.9 documentation</a> &raquo;</li>
       </ul>
     </div>
     <div class="footer">

data/vendor/local/share/doc/groonga/en/html/reference/{commands.html → command.html} RENAMED Viewed

@@ -9,7 +9,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.4. コマンド &mdash; groonga v2.0.5-316-g23cc017 documentation</title>
+    <title>8.3. Command &mdash; groonga v2.0.9 documentation</title>
     <link rel="stylesheet" href="../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -17,7 +17,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '2.0.5-316-g23cc017',
+        VERSION:     '2.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -27,10 +27,10 @@
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
-    <link rel="top" title="groonga v2.0.5-316-g23cc017 documentation" href="../index.html" />
+    <link rel="top" title="groonga v2.0.9 documentation" href="../index.html" />
     <link rel="up" title="8. リファレンスマニュアル" href="../reference.html" />
-    <link rel="next" title="8.4.1. コマンドバージョン" href="command_version.html" />
-    <link rel="prev" title="8.4.1. コマンドバージョン" href="command_version.html" />
+    <link rel="next" title="8.3.1. コマンドバージョン" href="command/command_version.html" />
+    <link rel="prev" title="8.2. Output" href="output.html" />
   </head>
   <body>
 <div class="header">
@@ -44,7 +44,7 @@
   <div class="other-language-links">
     <ul>
-      <li><a href="../../../ja/html/reference/commands.html"><img src="../_static/jp.png" alt="日本語">日本語版はこちら</a></li>
+      <li><a href="../../../ja/html/reference/command.html"><img src="../_static/jp.png" alt="日本語">日本語版はこちら</a></li>
     </ul>
   </div>
 </div>
@@ -57,12 +57,12 @@
           <a href="../genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="command_version.html" title="8.4.1. コマンドバージョン"
+          <a href="command/command_version.html" title="8.3.1. コマンドバージョン"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="command_version.html" title="8.4.1. コマンドバージョン"
+          <a href="output.html" title="8.2. Output"
              accesskey="P">previous</a> |</li>
-        <li><a href="../index.html">groonga v2.0.5-316-g23cc017 documentation</a> &raquo;</li>
+        <li><a href="../index.html">groonga v2.0.9 documentation</a> &raquo;</li>
           <li><a href="../reference.html" accesskey="U">8. リファレンスマニュアル</a> &raquo;</li>
       </ul>
     </div>
@@ -72,35 +72,40 @@
         <div class="bodywrapper">
           <div class="body">
-  <div class="section" id="id1">
-<h1>8.4. コマンド<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
-<p>まず、すべてのコマンドに関係するコマンドバージョンについて説明します。その後、組み込みのコマンドを順に説明します。</p>
+  <div class="section" id="command">
+<h1>8.3. Command<a class="headerlink" href="#command" title="Permalink to this headline">¶</a></h1>
+<p>Command is the most important processing unit in query API. You
+request a processing to groonga by a command.</p>
+<p>This section describes about command and built-in commands.</p>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="command_version.html">8.4.1. コマンドバージョン</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/cache_limit.html">8.4.2. cache_limit</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/check.html">8.4.3. check</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/clearlock.html">8.4.4. clearlock</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/column_create.html">8.4.5. column_create</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/column_list.html">8.4.6. column_list</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/column_remove.html">8.4.7. column_remove</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/define_selector.html">8.4.8. define_selector</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/defrag.html">8.4.9. defrag</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/delete.html">8.4.10. delete</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/dump.html">8.4.11. dump</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/load.html">8.4.12. load</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/log_level.html">8.4.13. log_level</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/log_put.html">8.4.14. log_put</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/log_reopen.html">8.4.15. log_reopen</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/quit.html">8.4.16. quit</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/select.html">8.4.17. select</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/shutdown.html">8.4.18. shutdown</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/status.html">8.4.19. status</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/suggest.html">8.4.20. suggest</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/table_create.html">8.4.21. table_create</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/table_list.html">8.4.22. table_list</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/table_remove.html">8.4.23. table_remove</a></li>
-<li class="toctree-l1"><a class="reference internal" href="commands/view_add.html">8.4.24. view_add</a></li>
+<li class="toctree-l1"><a class="reference internal" href="command/command_version.html">8.3.1. コマンドバージョン</a></li>
+<li class="toctree-l1"><a class="reference internal" href="command/output_format.html">8.3.2. Output format</a></li>
+<li class="toctree-l1"><a class="reference internal" href="command/return_code.html">8.3.3. Return code</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/cache_limit.html">8.3.4. cache_limit</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/check.html">8.3.5. check</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/clearlock.html">8.3.6. clearlock</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/column_create.html">8.3.7. column_create</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/column_list.html">8.3.8. column_list</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/column_remove.html">8.3.9. column_remove</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/define_selector.html">8.3.10. define_selector</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/defrag.html">8.3.11. defrag</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/delete.html">8.3.12. delete</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/dump.html">8.3.13. dump</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/load.html">8.3.14. load</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/log_level.html">8.3.15. log_level</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/log_put.html">8.3.16. log_put</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/log_reopen.html">8.3.17. log_reopen</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/quit.html">8.3.18. quit</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/register.html">8.3.19. register</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/select.html">8.3.20. select</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/shutdown.html">8.3.21. shutdown</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/status.html">8.3.22. status</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/suggest.html">8.3.23. suggest</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/table_create.html">8.3.24. table_create</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/table_list.html">8.3.25. table_list</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/table_remove.html">8.3.26. table_remove</a></li>
+<li class="toctree-l1"><a class="reference internal" href="commands/view_add.html">8.3.27. view_add</a></li>
 </ul>
 </div>
 </div>
@@ -112,14 +117,14 @@
       <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
   <h4>Previous topic</h4>
-  <p class="topless"><a href="command_version.html"
-                        title="previous chapter">8.4.1. コマンドバージョン</a></p>
+  <p class="topless"><a href="output.html"
+                        title="previous chapter">8.2. Output</a></p>
   <h4>Next topic</h4>
-  <p class="topless"><a href="command_version.html"
-                        title="next chapter">8.4.1. コマンドバージョン</a></p>
+  <p class="topless"><a href="command/command_version.html"
+                        title="next chapter">8.3.1. コマンドバージョン</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
-    <li><a href="../_sources/reference/commands.txt"
+    <li><a href="../_sources/reference/command.txt"
            rel="nofollow">Show Source</a></li>
   </ul>
 <div id="searchbox" style="display: none">
@@ -146,12 +151,12 @@
           <a href="../genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="command_version.html" title="8.4.1. コマンドバージョン"
+          <a href="command/command_version.html" title="8.3.1. コマンドバージョン"
              >next</a> |</li>
         <li class="right" >
-          <a href="command_version.html" title="8.4.1. コマンドバージョン"
+          <a href="output.html" title="8.2. Output"
              >previous</a> |</li>
-        <li><a href="../index.html">groonga v2.0.5-316-g23cc017 documentation</a> &raquo;</li>
+        <li><a href="../index.html">groonga v2.0.9 documentation</a> &raquo;</li>
           <li><a href="../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
       </ul>
     </div>

data/vendor/local/share/doc/groonga/en/html/reference/{command_version.html → command/command_version.html} RENAMED Viewed

@@ -9,33 +9,33 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.4.1. コマンドバージョン &mdash; groonga v2.0.5-316-g23cc017 documentation</title>
+    <title>8.3.1. コマンドバージョン &mdash; groonga v2.0.9 documentation</title>
-    <link rel="stylesheet" href="../_static/groonga.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../',
-        VERSION:     '2.0.5-316-g23cc017',
+        URL_ROOT:    '../../',
+        VERSION:     '2.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
       };
     </script>
-    <script type="text/javascript" src="../_static/jquery.js"></script>
-    <script type="text/javascript" src="../_static/underscore.js"></script>
-    <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="shortcut icon" href="../_static/favicon.ico"/>
-    <link rel="top" title="groonga v2.0.5-316-g23cc017 documentation" href="../index.html" />
-    <link rel="up" title="8.4. コマンド" href="commands.html" />
-    <link rel="next" title="8.4.2. cache_limit" href="commands/cache_limit.html" />
-    <link rel="prev" title="8.4. コマンド" href="commands.html" />
+    <script type="text/javascript" src="../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+    <link rel="top" title="groonga v2.0.9 documentation" href="../../index.html" />
+    <link rel="up" title="8.3. Command" href="../command.html" />
+    <link rel="next" title="8.3.2. Output format" href="output_format.html" />
+    <link rel="prev" title="8.3. Command" href="../command.html" />
   </head>
   <body>
 <div class="header">
   <h1 class="title">
-    <a id="top-link" href="../index.html">
+    <a id="top-link" href="../../index.html">
       <span class="project">groonga</span>
       <span class="separator">-</span>
       <span class="description">An open-source fulltext search engine and column store.</span>
@@ -44,7 +44,7 @@
   <div class="other-language-links">
     <ul>
-      <li><a href="../../../ja/html/reference/command_version.html"><img src="../_static/jp.png" alt="日本語">日本語版はこちら</a></li>
+      <li><a href="../../../../ja/html/reference/command/command_version.html"><img src="../../_static/jp.png" alt="日本語">日本語版はこちら</a></li>
     </ul>
   </div>
 </div>
@@ -54,17 +54,17 @@
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
-          <a href="../genindex.html" title="General Index"
+          <a href="../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="commands/cache_limit.html" title="8.4.2. cache_limit"
+          <a href="output_format.html" title="8.3.2. Output format"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="commands.html" title="8.4. コマンド"
+          <a href="../command.html" title="8.3. Command"
              accesskey="P">previous</a> |</li>
-        <li><a href="../index.html">groonga v2.0.5-316-g23cc017 documentation</a> &raquo;</li>
-          <li><a href="../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
-          <li><a href="commands.html" accesskey="U">8.4. コマンド</a> &raquo;</li>
+        <li><a href="../../index.html">groonga v2.0.9 documentation</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../command.html" accesskey="U">8.3. Command</a> &raquo;</li>
       </ul>
     </div>
@@ -74,16 +74,16 @@
           <div class="body">
   <div class="section" id="id1">
-<h1>8.4.1. コマンドバージョン<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
+<h1>8.3.1. コマンドバージョン<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="id2">
-<h2>8.4.1.1. 概要<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
+<h2>8.3.1.1. 概要<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
 <p>groonga1.1からコマンドバージョンという概念が導入されます。コマンドバージョンは、selectやloadなどのgroongaのコマンドの仕様の互換性を表します。groongaパッケージのバージョンが新しくなったとしても、同一のコマンドバージョンが使用可能であるなら、すべてのコマンドについて互換性が保証されます。コマンドバージョンが異なれば、同じ名前のコマンドであっても、動作に互換性がない可能性があります。</p>
 <p>あるバージョンのgroongaは、二つのコマンドバージョンを同時にサポートするようになります。
 使用するコマンドバージョンは、groongaを起動する際のコマンドラインオプションないしコンフィグファイルにdefault-commnad-versionパラメータを与えることによって指定できます。また、個々のコマンドを実行する際に、command_versionパラメータを与えることによっても指定することができます。</p>
 <p>コマンドバージョンは1からはじまり、更新されるたびに1ずつ大きくなります。現状のgroongaのコマンドの仕様はcommand-version 1という扱いになります。次回提供するgroongaは、command-version 1とcommand-version 2の二つをサポートすることになります。</p>
 </div>
 <div class="section" id="id3">
-<h2>8.4.1.2. バージョンの位置づけ<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
+<h2>8.3.1.2. バージョンの位置づけ<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
 <p>あるバージョンのgroongaにおいてサポートされるコマンドバージョンは、develop, stable,deprecatedのいずれかの位置づけとなります。</p>
 <dl class="docutils">
 <dt>develop</dt>
@@ -108,10 +108,10 @@ groonga1.5: command-version3=stable     command-version4=develop
 <p>groongaプロセス起動時に、default-command-versionパラメータにstable扱いでないコマンドバージョンを指定した場合には、警告メッセージがログファイルに出力されます。また、サポート範囲外のコマンドバージョンを指定した場合にはエラーとなり、プロセスは速やかに停止します。</p>
 </div>
 <div class="section" id="id4">
-<h2>8.4.1.3. コマンドバージョンの指定方法<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
+<h2>8.3.1.3. コマンドバージョンの指定方法<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
 <p>コマンドバージョンの指定方法はgroonga実行モジュールの引数として指定する方法と各コマンドの引数として指定する方法があります。</p>
 <div class="section" id="default-command-version">
-<h3>8.4.1.3.1. default-command-versionパラメータ<a class="headerlink" href="#default-command-version" title="Permalink to this headline">¶</a></h3>
+<h3>8.3.1.3.1. default-command-versionパラメータ<a class="headerlink" href="#default-command-version" title="Permalink to this headline">¶</a></h3>
 <p>groonga実行モジュールの引数としてdefault-command-versionパラメータを指定できます。
 (configファイルの中に指定することも可能です)</p>
 <p>実行例:</p>
@@ -121,7 +121,7 @@ groonga1.5: command-version3=stable     command-version4=develop
 <p>そのプロセスで実行するすべてのコマンドについて、デフォルトのコマンドバージョンとして指定されたバージョンを使用します。指定されたコマンドバージョンがstableであった場合にはなんのメッセージも表示されずそのまま起動します。指定されたコマンドバージョンがdevelopあるいはdeprecatedであった場合には、groonga.logファイルに警告メッセージを出力します。指定されたコマンドバージョンがサポート対象外であった場合には標準エラー出力にエラーメッセージを出力し、プロセスは速やかに終了します。</p>
 </div>
 <div class="section" id="command-version">
-<h3>8.4.1.3.2. command_versionパラメータ<a class="headerlink" href="#command-version" title="Permalink to this headline">¶</a></h3>
+<h3>8.3.1.3.2. command_versionパラメータ<a class="headerlink" href="#command-version" title="Permalink to this headline">¶</a></h3>
 <p>select,loadなどのすべてのgroongaコマンドにcommand_versionが指定できます。</p>
 <p>実行例:</p>
 <div class="highlight-none"><div class="highlight"><pre>select --command_version 1 --table tablename
@@ -138,14 +138,14 @@ groonga1.5: command-version3=stable     command-version4=develop
       </div>
       <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
-  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <h3><a href="../../index.html">Table Of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">8.4.1. コマンドバージョン</a><ul>
-<li><a class="reference internal" href="#id2">8.4.1.1. 概要</a></li>
-<li><a class="reference internal" href="#id3">8.4.1.2. バージョンの位置づけ</a></li>
-<li><a class="reference internal" href="#id4">8.4.1.3. コマンドバージョンの指定方法</a><ul>
-<li><a class="reference internal" href="#default-command-version">8.4.1.3.1. default-command-versionパラメータ</a></li>
-<li><a class="reference internal" href="#command-version">8.4.1.3.2. command_versionパラメータ</a></li>
+<li><a class="reference internal" href="#">8.3.1. コマンドバージョン</a><ul>
+<li><a class="reference internal" href="#id2">8.3.1.1. 概要</a></li>
+<li><a class="reference internal" href="#id3">8.3.1.2. バージョンの位置づけ</a></li>
+<li><a class="reference internal" href="#id4">8.3.1.3. コマンドバージョンの指定方法</a><ul>
+<li><a class="reference internal" href="#default-command-version">8.3.1.3.1. default-command-versionパラメータ</a></li>
+<li><a class="reference internal" href="#command-version">8.3.1.3.2. command_versionパラメータ</a></li>
 </ul>
 </li>
 </ul>
@@ -153,19 +153,19 @@ groonga1.5: command-version3=stable     command-version4=develop
 </ul>
   <h4>Previous topic</h4>
-  <p class="topless"><a href="commands.html"
-                        title="previous chapter">8.4. コマンド</a></p>
+  <p class="topless"><a href="../command.html"
+                        title="previous chapter">8.3. Command</a></p>
   <h4>Next topic</h4>
-  <p class="topless"><a href="commands/cache_limit.html"
-                        title="next chapter">8.4.2. cache_limit</a></p>
+  <p class="topless"><a href="output_format.html"
+                        title="next chapter">8.3.2. Output format</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
-    <li><a href="../_sources/reference/command_version.txt"
+    <li><a href="../../_sources/reference/command/command_version.txt"
            rel="nofollow">Show Source</a></li>
   </ul>
 <div id="searchbox" style="display: none">
   <h3>Quick search</h3>
-    <form class="search" action="../search.html" method="get">
+    <form class="search" action="../../search.html" method="get">
       <input type="text" name="q" />
       <input type="submit" value="Go" />
       <input type="hidden" name="check_keywords" value="yes" />
@@ -184,17 +184,17 @@ groonga1.5: command-version3=stable     command-version4=develop
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
-          <a href="../genindex.html" title="General Index"
+          <a href="../../genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="commands/cache_limit.html" title="8.4.2. cache_limit"
+          <a href="output_format.html" title="8.3.2. Output format"
              >next</a> |</li>
         <li class="right" >
-          <a href="commands.html" title="8.4. コマンド"
+          <a href="../command.html" title="8.3. Command"
              >previous</a> |</li>
-        <li><a href="../index.html">groonga v2.0.5-316-g23cc017 documentation</a> &raquo;</li>
-          <li><a href="../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
-          <li><a href="commands.html" >8.4. コマンド</a> &raquo;</li>
+        <li><a href="../../index.html">groonga v2.0.9 documentation</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../command.html" >8.3. Command</a> &raquo;</li>
       </ul>
     </div>
     <div class="footer">

data/vendor/local/share/doc/groonga/en/html/reference/command/output_format.html ADDED Viewed

@@ -0,0 +1,356 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>8.3.2. Output format &mdash; groonga v2.0.9 documentation</title>
+    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '2.0.9',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+    <link rel="top" title="groonga v2.0.9 documentation" href="../../index.html" />
+    <link rel="up" title="8.3. Command" href="../command.html" />
+    <link rel="next" title="8.3.3. Return code" href="return_code.html" />
+    <link rel="prev" title="8.3.1. コマンドバージョン" href="command_version.html" />
+  </head>
+  <body>
+<div class="header">
+  <h1 class="title">
+    <a id="top-link" href="../../index.html">
+      <span class="project">groonga</span>
+      <span class="separator">-</span>
+      <span class="description">An open-source fulltext search engine and column store.</span>
+    </a>
+  </h1>
+  <div class="other-language-links">
+    <ul>
+      <li><a href="../../../../ja/html/reference/command/output_format.html"><img src="../../_static/jp.png" alt="日本語">日本語版はこちら</a></li>
+    </ul>
+  </div>
+</div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="return_code.html" title="8.3.3. Return code"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="command_version.html" title="8.3.1. コマンドバージョン"
+             accesskey="P">previous</a> |</li>
+        <li><a href="../../index.html">groonga v2.0.9 documentation</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../command.html" accesskey="U">8.3. Command</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+  <div class="section" id="output-format">
+<h1>8.3.2. Output format<a class="headerlink" href="#output-format" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="summary">
+<h2>8.3.2.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
+<p>Commands output their result as JSON, MessagePack, XML or TSV format.</p>
+<p>JSON and MessagePack output have the same structure. XML and TSV are
+their original structure.</p>
+<p>JSON or MessagePack is recommend format. XML is useful for visual
+result check. TSV is just for special use. Normally you doesn't need
+to use TSV.</p>
+</div>
+<div class="section" id="json-and-messagepack">
+<h2>8.3.2.2. JSON and MessagePack<a class="headerlink" href="#json-and-messagepack" title="Permalink to this headline">¶</a></h2>
+<p>This secsion describes the structure of command result on JSON and
+MessagePack format. JSON is used to show structure because MessagePack
+is binary format. Binary format isn't proper for documenataion.</p>
+<p>JSON and MessagePack uses the following structure:</p>
+<div class="highlight-none"><div class="highlight"><pre>[HEADER, BODY]
+</pre></div>
+</div>
+<p>For example:</p>
+<div class="highlight-none"><div class="highlight"><pre>[
+  [
+    0,
+    1337566253.89858,
+    0.000355720520019531
+  ],
+  [
+    [
+      [
+        1
+      ],
+      [
+        [
+          &quot;_id&quot;,
+          &quot;UInt32&quot;
+        ],
+        [
+          &quot;_key&quot;,
+          &quot;ShortText&quot;
+        ],
+        [
+          &quot;content&quot;,
+          &quot;Text&quot;
+        ],
+        [
+          &quot;n_likes&quot;,
+          &quot;UInt32&quot;
+        ]
+      ],
+      [
+        2,
+        &quot;Groonga&quot;,
+        &quot;I started to use groonga. It&#39;s very fast!&quot;,
+        10
+      ]
+    ]
+  ]
+]
+</pre></div>
+</div>
+<p>In the example, the following part is <tt class="docutils literal"><span class="pre">HEADER</span></tt>:</p>
+<div class="highlight-none"><div class="highlight"><pre>[
+  0,
+  1337566253.89858,
+  0.000355720520019531
+]
+</pre></div>
+</div>
+<p>The following part is <tt class="docutils literal"><span class="pre">BODY</span></tt>:</p>
+<div class="highlight-none"><div class="highlight"><pre>[
+  [
+    [
+      1
+    ],
+    [
+      [
+        &quot;_id&quot;,
+        &quot;UInt32&quot;
+      ],
+      [
+        &quot;_key&quot;,
+        &quot;ShortText&quot;
+      ],
+      [
+        &quot;content&quot;,
+        &quot;Text&quot;
+      ],
+      [
+        &quot;n_likes&quot;,
+        &quot;UInt32&quot;
+      ]
+    ],
+    [
+      2,
+      &quot;Groonga&quot;,
+      &quot;I started to use groonga. It&#39;s very fast!&quot;,
+      10
+    ]
+  ]
+]
+</pre></div>
+</div>
+<div class="section" id="header">
+<h3>8.3.2.2.1. <tt class="docutils literal"><span class="pre">HEADER</span></tt><a class="headerlink" href="#header" title="Permalink to this headline">¶</a></h3>
+<p><tt class="docutils literal"><span class="pre">HEADER</span></tt> is an array. The content of <tt class="docutils literal"><span class="pre">HEADER</span></tt> has some patterns.</p>
+<div class="section" id="success-case">
+<h4>8.3.2.2.1.1. Success case<a class="headerlink" href="#success-case" title="Permalink to this headline">¶</a></h4>
+<p><tt class="docutils literal"><span class="pre">HEADER</span></tt> has three elements on success:</p>
+<div class="highlight-none"><div class="highlight"><pre>[0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME]
+</pre></div>
+</div>
+<p>The first element is always <tt class="docutils literal"><span class="pre">0</span></tt>.</p>
+<p><tt class="docutils literal"><span class="pre">UNIX_TIME_WHEN_COMMAND_IS_STARTED</span></tt> is the number of seconds
+since 1970-01-01 00:00:00 UTC when the command is started
+processing. <tt class="docutils literal"><span class="pre">ELAPSED_TIME</span></tt> is the elapsed time for processing the
+command in seconds. Both <tt class="docutils literal"><span class="pre">UNIX_TIME_WHEN_COMMAND_IS_STARTED</span></tt> and
+<tt class="docutils literal"><span class="pre">ELAPSED_TIME</span></tt> are float value. The precision of them are
+nanosecond.</p>
+</div>
+<div class="section" id="error-case">
+<h4>8.3.2.2.1.2. Error case<a class="headerlink" href="#error-case" title="Permalink to this headline">¶</a></h4>
+<p><tt class="docutils literal"><span class="pre">HEADER</span></tt> has four or five elements on error:</p>
+<div class="highlight-none"><div class="highlight"><pre>[
+  RETURN_CODE,
+  UNIX_TIME_WHEN_COMMAND_IS_STARTED,
+  ELAPSED_TIME,
+  ERROR_MESSAGE,
+  ERROR_LOCATION
+]
+</pre></div>
+</div>
+<p><tt class="docutils literal"><span class="pre">ERROR_LOCATION</span></tt> may not be included in <tt class="docutils literal"><span class="pre">HEADER</span></tt> but other four
+elements are always included.</p>
+<p><tt class="docutils literal"><span class="pre">RETURN_CODE</span></tt> is non 0 value. See <a class="reference internal" href="return_code.html"><em>Return code</em></a> about available
+return codes.</p>
+<p><tt class="docutils literal"><span class="pre">UNIX_TIME_WHEN_COMMAND_IS_STARTED</span></tt> and <tt class="docutils literal"><span class="pre">ELAPSED_TIME</span></tt> are the
+same as success case.</p>
+<p><tt class="docutils literal"><span class="pre">ERROR_MESSAGE</span></tt> is an error message in string.</p>
+<p><tt class="docutils literal"><span class="pre">ERROR_LOCATION</span></tt> is optional. If error location is collected,
+<tt class="docutils literal"><span class="pre">ERROR_LOCATION</span></tt> is included. <tt class="docutils literal"><span class="pre">ERROR_LOCATION</span></tt> is an
+array. <tt class="docutils literal"><span class="pre">ERROR_LOCATION</span></tt> has one ore two elements:</p>
+<div class="highlight-none"><div class="highlight"><pre>[
+  LOCATION_IN_GROONGA,
+  LOCATION_IN_INPUT
+]
+</pre></div>
+</div>
+<p><tt class="docutils literal"><span class="pre">LOCATION_IN_GROONGA</span></tt> is the source location that error is occurred
+in groonga. It is useful for groonga developers but not useful for
+users. <tt class="docutils literal"><span class="pre">LOCATION_IN_GROONGA</span></tt> is an array. <tt class="docutils literal"><span class="pre">LOCATION_IN_GROONGA</span></tt> has
+three elements:</p>
+<div class="highlight-none"><div class="highlight"><pre>[
+  FUNCTION_NAME,
+  SOURCE_FILE_NAME,
+  LINE_NUMBER
+]
+</pre></div>
+</div>
+<p><tt class="docutils literal"><span class="pre">FUNCTION_NAME</span></tt> is the name of function that error is occurred.</p>
+<p><tt class="docutils literal"><span class="pre">SOURCE_FILE_NAME</span></tt> is the name of groonga's source file that error is
+occurred.</p>
+<p><tt class="docutils literal"><span class="pre">LINE_NUMBER</span></tt> is the line number of <tt class="docutils literal"><span class="pre">SOURCE_FILE_NAME</span></tt> that error
+is occurred.</p>
+<p><tt class="docutils literal"><span class="pre">LOCATION_IN_INPUT</span></tt> is optional. <tt class="docutils literal"><span class="pre">LOCATION_IN_INPUT</span></tt> is included
+when the location that error is occurred in input file is
+collected. Input file can be specified by <tt class="docutils literal"><span class="pre">--file</span></tt> command line
+option for <tt class="docutils literal"><span class="pre">groonga</span></tt> command. <tt class="docutils literal"><span class="pre">LOCATION_IN_GROONGA</span></tt> is an
+array. <tt class="docutils literal"><span class="pre">LOCATION_IN_GROONGA</span></tt> has three elements:</p>
+<div class="highlight-none"><div class="highlight"><pre>[
+  INPUT_FILE_NAME,
+  LINE_NUMBER,
+  LINE_CONTENT
+]
+</pre></div>
+</div>
+<p><tt class="docutils literal"><span class="pre">INPUT_FILE_NAME</span></tt> is the input file name that error is occurred.</p>
+<p><tt class="docutils literal"><span class="pre">LINE_NUMBER</span></tt> is the line number of <tt class="docutils literal"><span class="pre">INPUT_FILE_NAME</span></tt> that error
+is occurred.</p>
+<p><tt class="docutils literal"><span class="pre">LINE_CONTENT</span></tt> is the content at <tt class="docutils literal"><span class="pre">LINE_NUMBER</span></tt> in
+<tt class="docutils literal"><span class="pre">INPUT_FILE_NAME</span></tt>.</p>
+</div>
+</div>
+<div class="section" id="body">
+<h3>8.3.2.2.2. <tt class="docutils literal"><span class="pre">BODY</span></tt><a class="headerlink" href="#body" title="Permalink to this headline">¶</a></h3>
+<p><tt class="docutils literal"><span class="pre">BODY</span></tt> content depends on the executed command. It may be omitted.</p>
+<p><tt class="docutils literal"><span class="pre">BODY</span></tt> may be an error message on error case.</p>
+</div>
+</div>
+<div class="section" id="xml">
+<h2>8.3.2.3. XML<a class="headerlink" href="#xml" title="Permalink to this headline">¶</a></h2>
+<p>TODO</p>
+</div>
+<div class="section" id="tsv">
+<h2>8.3.2.4. TSV<a class="headerlink" href="#tsv" title="Permalink to this headline">¶</a></h2>
+<p>TODO</p>
+</div>
+<div class="section" id="see-also">
+<h2>8.3.2.5. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><a class="reference internal" href="return_code.html"><em>Return code</em></a> describes about return code.</li>
+</ul>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">8.3.2. Output format</a><ul>
+<li><a class="reference internal" href="#summary">8.3.2.1. Summary</a></li>
+<li><a class="reference internal" href="#json-and-messagepack">8.3.2.2. JSON and MessagePack</a><ul>
+<li><a class="reference internal" href="#header">8.3.2.2.1. <tt class="docutils literal"><span class="pre">HEADER</span></tt></a><ul>
+<li><a class="reference internal" href="#success-case">8.3.2.2.1.1. Success case</a></li>
+<li><a class="reference internal" href="#error-case">8.3.2.2.1.2. Error case</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#body">8.3.2.2.2. <tt class="docutils literal"><span class="pre">BODY</span></tt></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#xml">8.3.2.3. XML</a></li>
+<li><a class="reference internal" href="#tsv">8.3.2.4. TSV</a></li>
+<li><a class="reference internal" href="#see-also">8.3.2.5. See also</a></li>
+</ul>
+</li>
+</ul>
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="command_version.html"
+                        title="previous chapter">8.3.1. コマンドバージョン</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="return_code.html"
+                        title="next chapter">8.3.3. Return code</a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../../_sources/reference/command/output_format.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="return_code.html" title="8.3.3. Return code"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="command_version.html" title="8.3.1. コマンドバージョン"
+             >previous</a> |</li>
+        <li><a href="../../index.html">groonga v2.0.9 documentation</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../command.html" >8.3. Command</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2012, Brazil, Inc.
+    </div>
+  </body>
+</html>