[Groonga-commit] groonga/groonga at f64cb4e [master] doc: follow new markup guideline about dump command documentation

Back to archive index

naoa null+****@clear*****
Tue Aug 12 08:25:39 JST 2014


naoa	2014-08-12 08:25:39 +0900 (Tue, 12 Aug 2014)

  New Revision: f64cb4eb6523c5118e223c50125733cb7c92207c
  https://github.com/groonga/groonga/commit/f64cb4eb6523c5118e223c50125733cb7c92207c

  Merged 13a8eb1: Merge pull request #189 from naoa/reformat-command-reference

  Message:
    doc: follow new markup guideline about dump command documentation

  Modified files:
    doc/source/reference/commands/dump.rst

  Modified: doc/source/reference/commands/dump.rst (+28 -28)
===================================================================
--- doc/source/reference/commands/dump.rst    2014-08-12 08:25:29 +0900 (9274a56)
+++ doc/source/reference/commands/dump.rst    2014-08-12 08:25:39 +0900 (bc8ce69)
@@ -2,47 +2,34 @@
 
 .. highlightlang:: none
 
-dump
-====
+``dump``
+========
 
-名前
-----
+Summary
+-------
 
 dump - データベースのスキーマとデータを出力する
 
-書式
-----
-::
-
-  dump [tables]
+Groonga組込コマンドの一つであるdumpについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、
+またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
 
-説明
-----
+dumpはデータベースのスキーマとデータを後から読み込めるフォーマットで出力します。dumpの結果は大きくなるため、
+主にコマンドラインから使うことを想定しています。データベースのバックアップが主な利用方法です。
 
-Groonga組込コマンドの一つであるdumpについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-
-dumpはデータベースのスキーマとデータを後から読み込めるフォーマットで出力します。dumpの結果は大きくなるため、主にコマンドラインから使うことを想定しています。データベースのバックアップが主な利用方法です。
-
-dumpが出力するフォーマットは直接Groongaが解釈できるフォーマットです。そのため、以下のようにしてデータベースをコピーすることができます。::
+dumpが出力するフォーマットは直接Groongaが解釈できるフォーマットです。そのため、以下のようにしてデータベース>をコピーすることができます。::
 
   % groonga original/db dump > dump.grn
   % mkdir backup
   % groonga -n backup/db < dump.grn
 
-引数
-----
-
-``tables``
-
-  出力対象のテーブルを「,」(カンマ)区切りで指定します。存在しないテーブルを指定した場合は無視されます。
-
-返値
-----
+Syntax
+------
+::
 
-データベースのスキーマとデータをGroongaの組み込みコマンド呼び出し形式で出力します。output_type指定は無視されます。
+  dump [tables]
 
-例
---
+Usage
+-----
 
 データベース内のすべてのデータを出力::
 
@@ -84,3 +71,16 @@ dumpが出力するフォーマットは直接Groongaが解釈できるフォー
   [2,"http://qwik.jp/senna/"],
   ...
   ]
+
+Parameters
+----------
+
+``tables``
+
+  出力対象のテーブルを「,」(カンマ)区切りで指定します。存在しないテーブルを指定した場合は無視されます。
+
+Return value
+------------
+
+データベースのスキーマとデータをGroongaの組み込みコマンド呼び出し形式で出力します。output_type指定は無視されます。
+
-------------- next part --------------
HTML����������������������������...
Descargar 



More information about the Groonga-commit mailing list
Back to archive index