pgpool2.git / summary / log / commit / refs
commit 6db9ba71c4775fa82ff91cd6086ad03e1da76575
Author: pengbo <pengbo@sraoss.co.jp>
Date: Tue Oct 25 09:10:46 2016 +0000
translate some reference docs into Japanese
doc.ja/src/sgml/ref/pcp_common_options.sgml | 54 ++++++++++++++++-
doc.ja/src/sgml/ref/pcp_node_count.sgml | 23 ++++++++
doc.ja/src/sgml/ref/pcp_node_info.sgml | 50 +++++++++++++++-
doc.ja/src/sgml/ref/pcp_watchdog_info.sgml | 90 +++++++++++++++++++++++++++--
doc.ja/src/sgml/reference.sgml | 60 ++++++++++++++++++-
5 files changed, 267 insertions(+), 10 deletions(-)
diff --git a/doc.ja/src/sgml/ref/pcp_common_options.sgml b/doc.ja/src/sgml/ref/pcp_common_options.sgml
index b010ec986..e2c59e7c5 100644
--- a/doc.ja/src/sgml/ref/pcp_common_options.sgml
+++ b/doc.ja/src/sgml/ref/pcp_common_options.sgml
@@ -16,8 +16,12 @@ Pgpool-II documentation
<refnamediv>
<refname>pcp_common_options</refname>
+ <!--
<refpurpose>
common options used in PCP commands</refpurpose>
+ -->
+ <refpurpose>
+ PCP コマンドには共通する引数</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -29,17 +33,27 @@ Pgpool-II documentation
<refsect1 id="R1-PCP-common-options-1">
<title>
+ <!--
Description
+ -->
+ 説明
</title>
<para>
+ <!--
There are some arguments common to all PCP commands. Most of
these are for authentication and the rest are about verbose
mode, debug message, and so on.
+ -->
+ 全てのコマンドには共通する引数があります。
+ そのほとんどは認証情報を指定するもので、 他は冗長出力モードやデバッグなどに関するものです。
</para>
</refsect1>
<refsect1>
+ <!--
<title>Options</title>
+ -->
+ <title>オプション</title>
<para>
<variablelist>
@@ -49,8 +63,12 @@ Pgpool-II documentation
<term><option>--host=<replaceable class="parameter">hostname</replaceable></option></term>
<listitem>
<para>
+ <!--
The host name of the machine on which the server is running. If the
value begins with a slash, it is used as the directory for the Unix-domain socket.
+ -->
+ pgpool-II が稼働しているホスト名を指定します。 スラッシュから始まる場合は、
+ Unix ドメインソケットのディレクトリと解釈されます。
</para>
</listitem>
</varlistentry>
@@ -60,7 +78,10 @@ Pgpool-II documentation
<term><option>--port=<replaceable class="parameter">port</replaceable></option></term>
<listitem>
<para>
+ <!--
The PCP port number (default:"9898").
+ -->
+ PCP ポート番号を指定します。(デフォルト: 9898)
</para>
</listitem>
</varlistentry>
@@ -70,7 +91,10 @@ Pgpool-II documentation
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
<listitem>
<para>
+ <!--
The user name for PCP authentication (default: OS user name).
+ -->
+ PCP 認証のユーザ名を指定します。(デフォルト: OS のユーザ)
</para>
</listitem>
</varlistentry>
@@ -80,10 +104,15 @@ Pgpool-II documentation
<term><option>--no-password</option></term>
<listitem>
<para>
+ <!--
Never prompt for password. And if a password is not available
by a <filename>.pcppass</filename> file, the connection
attempt will fail. This option can be useful in batch jobs
and scripts where no user is present to enter a password.
+ -->
+ パスワード入力プロンプトを表示しません。 もしパスワードが <filename>.pcppass</filename> ファイルから
+ 取得できない場合には接続は失敗します。 このオプションはバッチジョブやスクリプトなど、
+ パスワード入力が行うユーザいない場合に有用です。
</para>
</listitem>
</varlistentry>
@@ -93,7 +122,10 @@ Pgpool-II documentation
<term><option>--password</option></term>
<listitem>
<para>
+ <!--
Force password prompt (should happen automatically).
+ -->
+ パスワード入力プロンプトを表示します。（自動的に選択される動作です）
</para>
</listitem>
</varlistentry>
@@ -103,7 +135,10 @@ Pgpool-II documentation
<term><option>--debug</option></term>
<listitem>
<para>
- Enable debug message.
+ <!--
+ Enable debug message.
+ -->
+ デバッグメッセージを表示します。
</para>
</listitem>
</varlistentry>
@@ -113,7 +148,10 @@ Pgpool-II documentation
<term><option>--verbose</option></term>
<listitem>
<para>
+ <!--
Enable verbose output.
+ -->
+ 冗長出力を有効にします。
</para>
</listitem>
</varlistentry>
@@ -123,7 +161,10 @@ Pgpool-II documentation
<term><option>--version</option></term>
<listitem>
<para>
+ <!--
Print the command version, then exit.
+ -->
+ バージョンを表示して終了します。
</para>
</listitem>
</varlistentry>
@@ -133,7 +174,10 @@ Pgpool-II documentation
<term><option>--help</option></term>
<listitem>
<para>
- Shows help for the command line arguments, then exit.
+ <!--
+ Shows help for the command line arguments, then exit.
+ -->
+ コマンドラインのヘルプを表示して終了します。
</para>
</listitem>
</varlistentry>
@@ -144,7 +188,10 @@ Pgpool-II documentation
</refsect1>
<refsect1>
+ <!--
<title>Environment</title>
+ -->
+ <title>環境変数</title>
<variablelist>
<varlistentry>
@@ -152,7 +199,10 @@ Pgpool-II documentation
<listitem>
<para>
+ <!--
Specifies the path to pcp password file.
+ -->
+ pcp パスワードファイルをパスを指定します。
</para>
</listitem>
</varlistentry>
diff --git a/doc.ja/src/sgml/ref/pcp_node_count.sgml b/doc.ja/src/sgml/ref/pcp_node_count.sgml
index 6e07ad34d..d1fe8aa23 100644
--- a/doc.ja/src/sgml/ref/pcp_node_count.sgml
+++ b/doc.ja/src/sgml/ref/pcp_node_count.sgml
@@ -16,8 +16,12 @@ Pgpool-II documentation
<refnamediv>
<refname>pcp_node_count</refname>
+ <!--
<refpurpose>
displays the total number of database nodes</refpurpose>
+ -->
+ <refpurpose>
+ <productname>pgpool-II</productname> の <filename>pgpool.conf</filename> で定義されたノードの総数を表示します。</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -29,26 +33,45 @@ Pgpool-II documentation
<refsect1 id="R1-PCP-NODE-COUNT-1">
<title>
+ <!--
Description
+ -->
+ 説明
</title>
<para>
<command>pcp_node_count</command>
+ <!--
displays the total number of database nodes defined in <filename>pgpool.conf</filename>. It does
not distinguish between nodes status, ie attached/detached. ALL nodes are counted.
+ -->
+ <productname>pgpool-II</productname> の <filename>pgpool.conf</filename>
+ で定義されたノードの総数を表示します。 切り離されているノードの区別はしません。
</para>
</refsect1>
<refsect1>
+ <!--
<title>Options</title>
+ -->
+ <title>オプション</title>
<para>
+ <!--
See <xref linkend="pcp-common-options">.
+ -->
+ <xref linkend="pcp-common-options"> を参照してください。
</para>
</refsect1>
<refsect1>
+ <!--
<title>Example</title>
+ -->
+ <title>出力例</title>
<para>
+ <!--
Here is an example output:
+ -->
+ ここでは，出力例を示します。
<programlisting>
$ pcp_node_count -p 11001
Password:
diff --git a/doc.ja/src/sgml/ref/pcp_node_info.sgml b/doc.ja/src/sgml/ref/pcp_node_info.sgml
index fedd3ce24..4e6901e06 100644
--- a/doc.ja/src/sgml/ref/pcp_node_info.sgml
+++ b/doc.ja/src/sgml/ref/pcp_node_info.sgml
@@ -17,7 +17,10 @@ Pgpool-II documentation
<refnamediv>
<refname>pcp_node_info</refname>
<refpurpose>
+ <!--
displays the information on the given node ID</refpurpose>
+ -->
+ 指定されたノードの情報を表示します。</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -29,15 +32,24 @@ Pgpool-II documentation
</refsynopsisdiv>
<refsect1 id="R1-PCP-NODE-INFO-1">
+ <!--
<title>Description</title>
+ -->
+ <title>説明</title>
<para>
<command>pcp_node_info</command>
+ <!--
displays the information on the given node ID.
+ -->
+ 指定されたノードの情報を表示します。
</para>
</refsect1>
<refsect1>
+ <!--
<title>Options</title>
+ -->
+ <title>オプション</title>
<para>
<variablelist>
@@ -46,7 +58,10 @@ Pgpool-II documentation
<term><option>--node-id=<replaceable class="parameter">node_id</replaceable></option></term>
<listitem>
<para>
+ <!--
The index of backend node to get information of.
+ -->
+ 情報を表示するバックエンドノードのインデックスを指定します。
</para>
</listitem>
</varlistentry>
@@ -55,7 +70,10 @@ Pgpool-II documentation
<term><option>Other options </option></term>
<listitem>
<para>
+ <!--
See <xref linkend="pcp-common-options">.
+ -->
+ <xref linkend="pcp-common-options"> を参照してください。
</para>
</listitem>
</varlistentry>
@@ -64,37 +82,67 @@ Pgpool-II documentation
</refsect1>
<refsect1>
+ <!--
<title>Example</title>
+ -->
+ <title>出力例</title>
<para>
+ <!--
Here is an example output:
+ -->
+ ここでは，出力例を示します。
<programlisting>
$ pcp_node_info -h localhost -U postgres 0
host1 5432 1 1073741823.500000
</programlisting>
</para>
<para>
+ <!--
The result is in the following order:
+ -->
+ 結果は以下の順のとおりです。
<literallayout class="monospaced">
+<!--
1. hostname
2. port number
3. status
4. load balance weight
+-->
+1. ノードのホスト名
+2. ノードのポート番号
+3. ステータス
+4. ロードバランスウェイト
</literallayout>
</para>
<para>
+ <!--
Status is represented by a digit from [0 to 3].
+ -->
+ ステータスは [0..3] までの数字で表わされます。各数字の意味は以下のとおりです。
<itemizedlist>
+<!--
<listitem><para>0 - This state is only used during the initialization. PCP will never display it. </para></listitem>
<listitem><para>1 - Node is up. No connections yet. </para></listitem>
<listitem><para>2 - Node is up. Connections are pooled. </para></listitem>
<listitem><para>3 - Node is down. </para></listitem>
+-->
+ <listitem><para>0 - 初期化時のみに表われる。PCP コマンドで表示されることはない。 </para></listitem>
+ <listitem><para>1 - ノード稼働中。接続無し </para></listitem>
+ <listitem><para>2 - ノード稼働中。接続有り </para></listitem>
+ <listitem><para>3 - ノードダウン </para></listitem>
</itemizedlist>
</para>
<para>
+ <!--
The load balance weight is displayed in normalized format.
+ -->
+ ロードバランスウェイトは Normalize されたフォーマットで出力されます。
</para>
<para>
- The <option>--verbose</option> option can help understand the output. For example:
+ <!--
+ The <option>verbose</option> option can help understand the output. For example:
+ -->
+ <option>--verbose</option> オプションは出力内容を理解するのに役に立ちます。例：
</para>
<programlisting>
$ pcp_node_info --verbose -h localhost -U postgres 0
diff --git a/doc.ja/src/sgml/ref/pcp_watchdog_info.sgml b/doc.ja/src/sgml/ref/pcp_watchdog_info.sgml
index 294d68f15..0c1172838 100644
--- a/doc.ja/src/sgml/ref/pcp_watchdog_info.sgml
+++ b/doc.ja/src/sgml/ref/pcp_watchdog_info.sgml
@@ -17,7 +17,10 @@ Pgpool-II documentation
<refnamediv>
<refname>pcp_watchdog_info</refname>
<refpurpose>
+ <!--
displays the watchdog status of the Pgpool-II</refpurpose>
+ -->
+ <productname>Pgpool-II</productname> の watchdog ステータスを表示します</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -29,15 +32,46 @@ Pgpool-II documentation
</refsynopsisdiv>
<refsect1 id="R1-PCP-WATCHDOG-INFO-1">
+ <!--
<title>Description</title>
+ -->
+ <title>説明</title>
<para>
- <command>pcp_node_info</command>
- displays the information on the given node ID.
- </para>
+ <command>pcp_watchdog_info</command> は、
+<!--
+ Displays the watchdog status of the pgpool-II. watchdog_id is the index of watchdog node to get information for. If this is omitted, display the watchdog status of all watchdog nodes in the cluster.
+
+ watchdog_id = 0 is reserved for local pgpool-II node, So the index of remote watchdog nodes starts from 1. Note that since the index numbering in pcp_watchdog_info utility starts from 1 while the pgpool.conf file uses 0 based indexing to define remote watchdog nodes, so you will require to add one to the other watchdog index to get its information using pcp_watchdog_info utility.
+
+ For example, to get the information of first remote watchdog node configured with prefix 0 defined by other_pgpool_hostname0 parameters you will use watchdog_id = 1 for pcp_watchdog_info.
+
+-->
+ <productname>Pgpool-II</productname> の <filename>pgpool.conf</filename>
+ の watchdog セクションで定義された <productname>Pgpool-II</productname> の watchdog ステータスを表示します。
+ watchdog_id は情報を取得する watchdog ノードのインデックです。
+ 省略された場合には、クラスタ中の全ての Pgpool-II の watchdog ノードのステータスが表示されます。
+ </para>
+ <para>
+ watchdog_id = 0 はローカルの <productname>Pgpool-II</productname> ノードのために予約されています。
+ そのため、リモートの watchdog ノードのインデックスは 1 から始まります。
+ <filename>pgpool.conf</filename> ではリモート watchdog ノードのインデックスは 0 をベースにしていますが、
+ <command>pcp_watchdog_info</command> ではそれが 1 から始まることに注意してください。
+ </para>
+ <para>
+ <command>pcp_watchdog_info</command> コマンドで情報を取得する際には、他の watchdog のインデックスに 1 を足す必要があります。
+ </para>
+ <para>
+ 例えば、<varname>other_pgpool_hostname0</varname> パラメータで定義されている、添字 0 である最初のリモート watchdog ノードの情報を取得するには、
+ <command>pcp_watchdog_info</command> で watchdog_id = 1 を指定します。
+ </para>
+
</refsect1>
<refsect1>
+ <!--
<title>Options</title>
+ -->
+ <title>オプション</title>
<para>
<variablelist>
@@ -46,22 +80,37 @@ Pgpool-II documentation
<term><option>--node-id=<replaceable class="parameter">watcgdog_id</replaceable></option></term>
<listitem>
<para>
+ <!--
The index of other Pgpool-II to get information for.
+ -->
+ 情報を取得する他の <productname>Pgpool-II</productname> のインデックスを指定します。
</para>
<para>
+ <!--
Index 0 gets one's self watchdog information.
+ -->
+ 0 の場合ははローカルの watchdog の情報を取得します。
</para>
<para>
+ <!--
If ommitted then gets information of all watchdog nodes.
+ -->
+ 省略された場合は、全ての watchdog ノードの情報を取得します。
</para>
</listitem>
</varlistentry>
<varlistentry>
+ <!--
<term><option>Other options </option></term>
+ -->
+ <term><option>その他 </option></term>
<listitem>
<para>
+ <!--
See <xref linkend="pcp-common-options">.
+ -->
+ <xref linkend="pcp-common-options"> を参照してください。
</para>
</listitem>
</varlistentry>
@@ -70,9 +119,15 @@ Pgpool-II documentation
</refsect1>
<refsect1>
+ <!--
<title>Example</title>
+ -->
+ <title>出力例</title>
<para>
+ <!--
Here is an example output:
+ -->
+ ここでは，出力例を示します。
<programlisting>
$ pcp_watchdog_info -h localhost -u postgres
@@ -84,16 +139,29 @@ Linux_host3.localdomain_9993 host3 9993 9003 7 STANDBY
</programlisting>
</para>
<para>
+ <!--
The result is in the following order:
+ -->
+ 結果は以下の順のとおりです。
<literallayout class="monospaced">
+<!--
The first output line describes the watchdog cluster information:
-
+-->
+最初に出力される行は、watchdog クラスタの情報を示しています:
+<!--
1. Total watchdog nodes in the cluster
2. Is VIP is up on current node?
3. Master node name
4. Master node host
+-->
+
+1. クラスタ内の全 watchdog ノード数
+2. 仮想 IP がこのノードで起動しているか？
+3. マスターノード名
+4. マスターノードホスト
</literallayout>
<literallayout class="monospaced">
+<!--
Next is the list of watchdog nodes:
1. node name
@@ -102,10 +170,22 @@ Next is the list of watchdog nodes:
4. watchdog port
5. current node state
6. current node state name
+-->
+それ以降は watchdog ノードのリストが出力されます:
+
+1. ノード名
+2. ホスト名
+3. pgpool ポート番号
+4. watchdog ポート番号
+5. 現在のノードステータス
+6. 現在のノードステータス名
</literallayout>
</para>
<para>
- The <option>--verbose</option> option can help understand the output. For example:
+<!--
+ The verbose option can help understand the output. For example:
+-->
+ <option>verbose</option> モードは結果の詳細を表示できます。例えば:
</para>
<programlisting>
$ pcp_watchdog_info -h localhost -v -u postgres
diff --git a/doc.ja/src/sgml/reference.sgml b/doc.ja/src/sgml/reference.sgml
index c4f2d4fe1..83c2323b6 100644
--- a/doc.ja/src/sgml/reference.sgml
+++ b/doc.ja/src/sgml/reference.sgml
@@ -1,57 +1,93 @@
<!-- doc/src/sgml/reference.sgml -->
<part id="reference">
+<!--
<title>Reference</title>
+-->
+ <title>リファレンス</title>
<partintro>
<para>
+ <!--
This part contains reference information for the pgool-II.
+ -->
+ ここには <productname>Pgpool-II</productname> のリファレンス情報があります。
</para>
<para>
+ <!--
The reference entries are also available as traditional
<quote>man</quote> pages.
+ -->
+ このリファレンスは伝統的な <quote>man</quote> ページとしても入手できます。
</para>
</partintro>
<reference id="pcp-commands">
+<!--
<title>PCP commands</title>
+-->
+ <title>PCP コマンド</title>
<partintro>
<para>
+ <!--
This part contains reference information for PCP commands.
PCP commands are UNIX commands which manipulate pgpool-II via the network.
Please note that the parameter format for all PCP commands has been changed since pgpool-II 3.5.
+ -->
+ ここには <productname>Pgpool-II</productname> の PCP コマンドのリファレンス情報があります。
+ PCP コマンドはネットワーク経由で複数の <productname>pgpool-II</productname> を操作する UNIX コマンドです。
+ 注意：<productname>pgpool-II</productname> 3.5 より、全ての PCP コマンドのパラメータ書式が変更されています。
</para>
<sect1 id="pcp-connection-authentication">
+ <!--
<title>PCP connection authentication</title>
+ -->
+ <title>PCP 接続認証</title>
<para>
+ <!--
PCP user names and passwords must be declared in
<filename>pcp.conf</filename> in <filename>$prefix/etc</filename>
directory. <option>-F</option> option can be used when starting
pgpool-II if <filename>pcp.conf</filename> is placed somewhere
else.
+ -->
+ PCP ユーザ名とパスワードが <filename>$prefix/etc</filename> ディレクトリ内の <filename>pcp.conf</filename>
+ で宣言されている必要があります。<filename>pcp.conf</filename> が他の場所にある場合には、
+ <productname>pgpool-II</productname> の起動時に <option>-F</option> オプションで指定することができます。
</para>
</sect1>
<sect1 id="pcp-password-file">
+ <!--
<title>PCP password file</title>
+ -->
+ <title>PCP パスワードファイル</title>
<para>
+ <!--
The file <filename>.pcppass</filename> in a user's home
directory or the file referenced by environment variable
PCPPASSFILE can contain passwords to be used if no password has
been specified for the pcp connection.
+ -->
+ PCP 接続時にパスワードが指定されなかった場合、ユーザのホームディレクトリに配置された <filename>.pcppass</filename> ファイルか、
+ 環境変数 PCPPASSFILE で参照されるファイルに格納されたパスワードが使用可能です。
</para>
<para>
+ <!--
This file should contain lines of the following format:
+ -->
+ このファイルの各行の書式は以下のとおりです：
<programlisting>
- hostname:port:username:password
+hostname:port:username:password
</programlisting>
</para>
<para>
+ <!--
(You can add a reminder comment to the file by copying the line
above and preceding it with #.) Each of the first three fields
can be a literal value, or *, which matches anything. The password
@@ -61,13 +97,24 @@
: or \, escape this character with \. A host name of localhost
matches both TCP (host name localhost) and Unix domain socket
connections coming from the local machine.
+ -->
+ （この文字列の行頭に # を付けてからファイルにコピーしておけば備忘録のコメントになります。）
+ 最初の３つのフィールドはそれぞれリテラル値か、任意のものにマッチする * を指定します。
+ 現在の接続パラメータにマッチした最初の行の password フィールドが使用されます。
+ （したがって、ワイルドーカードを使用する場合には、具体的なエントリーの方を先に書きます。）
+ エントリーの中に : か \ を含む必要がある場合には、その文字を \ をつかってエスケープしてください。
+ ホスト名 localhost はローカルマシンからの TCP と Unix ドメインソケットの両方の接続にマッチします。
</para>
<para>
+ <!--
The permissions on .pcppass must disallow any access to world or
group; achieve this by the command chmod 0600 ~/.pcppass. If the
permissions are less strict than this, the file will be
ignored.
+ -->
+ <filename>.pcppass</filename> のパーミッションはグループおよび全ユーザからのアクセスを許してはいけません。
+ chmod 0600 ~/.pcppass を実行してください。これよりパーミッションの制限が弱い場合には、 このファイルは無視されます。
</para>
</sect1>
@@ -94,7 +141,10 @@
<partintro>
<para>
+ <!--
This part contains reference information for various Pgpool-II commands.
+ -->
+ ここには、他の <productname>Pgpool-II</productname> コマンドのリファレンス情報があります。
</para>
</partintro>
@@ -104,16 +154,22 @@
&watchdoglSetup;
</reference>
-
+
<reference id="sql-commands">
<title>SQL type commands</title>
<partintro>
<para>
+ <!--
This part contains reference information for various SQL type Pgpool-II commands.
These commands can be issued inside the SQL session using the standard PostgreSQL
client like <literal>psql</literal> and are not forwarded to the backend DB instead
are processed by <productname>Pgpool-II</productname> server
+ -->
+ ここには、SQL 型の <productname>Pgpool-II</productname> コマンドのリファレンス情報があります。
+ これらのコマンドは、<literal>psql</literal> のような標準 <productname>PostgreSQL</productname>
+ のクライアント側から SQL セッション内で発行されますが、バックエンド DB に転送されず、
+ <productname>Pgpool-II</productname> サーバで処理されます。
</para>
</partintro>
[parent: ca85ae950d07]