pgpool2.git / summary / log / commit / refs
commit 07a523826c7ec3a4d90ac75e1e25d51fbeea707b
Author: Yugo Nagata <nagata@sraoss.co.jp>
Date: Fri Apr 24 07:37:16 2015 +0000
Update documents for new pcp commands
Make a section of common options in order to reduce redundancy
and make easy to maintain. Also, rearrange the HTML strucure, and
translate the english document to Japanese.
doc/diff | 70 +++
doc/pgpool-en.html | 1332 +++++++++++++++-------------------------------------
doc/pgpool-ja.html | 569 +++++++++++++++-------
doc/pgpool.css | 9 +
4 files changed, 844 insertions(+), 1136 deletions(-)
diff --git a/doc/diff b/doc/diff
new file mode 100644
index 000000000..6e6c2d0b3
--- /dev/null
+++ b/doc/diff
@@ -0,0 +1,70 @@
+diff --git a/doc/pgpool-ja.html b/doc/pgpool-ja.html
+index d7a99a1..567c6f3 100644
+--- a/doc/pgpool-ja.html
++++ b/doc/pgpool-ja.html
+@@ -1730,7 +1730,7 @@ black_function_list = 'nextval,setval,lastval,currval'
+ <p>
+ true を設定すると、レプリケーションモードでは SELECT 文をレプリケーションします。
+ これは pgpool-II 1.0 までの挙動と同じになります。
+- false を設定すると SELECT 文をマスタのみに送信します。デフォルト値は false です。
++ false を設定すると更新を伴わない SELECT 文をマスタのみに送信します。デフォルト値は false です。
+ </p>
+ <p>
+ replicate_select、<a href="#LOAD_BALANCE_MODE">load_balance_mode</a>、
+@@ -1738,34 +1738,28 @@ black_function_list = 'nextval,setval,lastval,currval'
+ レプリケーションモードの動作が変化します。詳細を表に示します。
+ </p>
+
+- <table border>
+- <tr>
+- <th class="nodec">SELECTが明示的なトランザクションブロックの内側にある</th>
+- <td>Y</td><td>Y</td><td>Y</td><td>N</td><td>N</td><td>N</td><td>Y</td><td>N</td>
+- </tr>
+-
+- <tr>
+- <th class="nodec">replicate_selectがtrue</th>
+- <td>Y</td>
+- <td>Y</td>
+- <td>N</td>
+- <td>N</td>
+- <td>Y</td>
+- <td>Y</td>
+- <td>N</td>
+- <td>N</td>
+- </tr>
+-
+- <tr>
+- <th class="nodec">load_balance_modeがtrue</th>
+- <td>Y</td><td>N</td><td>N</td><td>N</td><td>Y</td><td>N</td><td>Y</td><td>Y</td>
+- </tr>
+-
+- <tr>
+- <th class="nodec">結果(R:レプリケーション, M: マスタのみに送信, L: ロードバランスされる)</th>
+- <td>R</td><td>R</td><td>M</td><td>M</td><td>R</td><td>R</td><td>M</td><td>L</td>
+- </tr>
+- </table>
++ <table border>
++ <tr class="center">
++ <th class="nodec">replicate_selectがtrue</th>
++ <td>Y</td><td colspan="4">N</td>
++ </tr>
++ <tr class="center">
++ <th class="nodec">load_balance_modeがtrue</th>
++ <td>any</td><td colspan="3">Y</td><td>N</td>
++ <tr class="center">
++ <th class="nodec">SELECTが明示的なトランザクションブロックの内側にある</th>
++ <td>any</td><td colspan="2">Y</td><td>N</td><td>any</td>
++ </tr>
++ <tr class="center">
++ <th class="nodec">「トランザクション分離レベルがSERIALIZABLE」または<br>
++ 「トランザクション内で更新を伴うクエリが実行されている」</th>
++ <td>any</td><td>Y</td><td>N</td><td>any</td><td>any</td>
++ </tr>
++ <tr class="footer center">
++ <th class="nodec">結果(R:レプリケーション, M: マスタのみに送信, L: ロードバランスされる)</th>
++ <td>R</td><td>M</td><td>L</td><td>L</td><td>M</td>
++ </tr>
++ </table>
+ </dd>
+
+ <dt><a name="INSERT_LOCK"></a>insert_lock</dt>
diff --git a/doc/pgpool-en.html b/doc/pgpool-en.html
index d2c4bd253..778e7fa53 100644
--- a/doc/pgpool-en.html
+++ b/doc/pgpool-en.html
@@ -4741,17 +4741,100 @@ if <code>pcp.conf</code> is placed somewhere else.</p>
<h3 id="password_file">The Password File</h3>
-<p>The file .pcppass 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.</p>
-<p>This file should contain lines of the following format:<p>
+<p>The file .pcppass 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.</p>
+<p>This file should contain lines of the following format:/<p>
<pre>
hostname:port:username:password
</pre>
<p>
-(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 field from the first line that matches the current connection parameters will be used. (Therefore, put more-specific entries first when you are using wildcards.) If an entry needs to contain : 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.</p>
-
-<p>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.</p>
-
+(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
+field from the first line that matches the current connection parameters will be used. (Therefore,
+put more-specific entries first when you are using wildcards.) If an entry needs to contain : 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.</p>
+
+<p>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.</p>
+
+<h2 id="pcp_common_options">Common options</h2>
+
+<p>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.
+<pre>
+e.g.) $ pcp_node_count -h localhost -p 9898 -u postgres -w -d -v
+</pre>
+
+<dl class="options">
+<dt><code>
+-h <strong>hostname</strong>, --host=<strong>hostname</strong>
+</code></dt>
+<dd><p>
+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.
+</p></dd>
+
+<dt><code>
+-p <strong>port</strong>, --port=<strong>port</strong>
+</code></dt>
+<dd><p>
+The PCP port number (default:"9898").
+</p></dd>
+
+<dt><code>
+-u <strong>username</strong>, --username=<strong>username</strong>
+</code></dt>
+<dd><p>
+The user name for PCP authentication (default: OS user name).
+</p></dd>
+
+<dt><code>
+-w, --no-password
+</code></dt>
+<dd><p>
+Never prompt for password. And if a password is not available by a .pcppass 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.
+</p></dd>
+
+<dt><code>
+-W, --password
+</code></dt>
+<dd><p>
+Force password prompt (should happen automatically).
+</p></dd>
+
+<dt><code>
+-d, --debug
+</code></dt>
+<dd><p>
+Enable debug message.
+</p></dd>
+
+<dt><code>
+-v, --verbose
+</code></dt>
+<dd><p>
+Enable verbose output.
+</p></dd>
+
+<dt><code>
+-V, --version
+</code></dt>
+<dd><p>
+Print the command version, then exit.
+</p></dd>
+
+<dt><code>
+-?, --help
+</code></dt>
+<dd><p>
+Shows help for the command line arguments, then exit.
+</p></dd>
+</dl>
<h2>PCP Commands to know status and configuration</h2>
@@ -4759,171 +4842,59 @@ hostname:port:username:password
<h3 id="pcp_node_count">pcp_node_count</h3>
-<p><strong>Format:</strong></p>
-<dl class="flat">
-<pre><code>pcp_node_count [options...] </code></pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_node_count [options...] </code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Displays the total number of nodes defined in <code>pgpool.conf</code>. It does
not distinguish between nodes status, ie attached/detached. ALL nodes are counted.</p>
+</dd>
+<dt>Options:</dt>
+<dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+</dd>
</dl>
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-
-<p><code>-v </p>
- <p>--verbose</code></p>
-<dl class="flat">
- <p>enable verbose output.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_node_count version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_node_count command line arguments, and exit.</p>
-</dl>
-
-
-<h3><a name="pcp_node_info"/></a>pcp_node_info</h3>
-<p><strong>Format:</strong></p>
-<dl class="flat">
-<pre><code>pcp_node_info [options...] [node_id] </code></pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<h3 id="pcp_node_info">pcp_node_info</h3>
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_node_info [options...] [node_id] </code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Displays the information on the given node ID.</p>
-</dl>
-
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-n <strong>node_id</strong></p>
- <p>--node-id=<strong>node_id</strong></code></p>
-<dl class="flat">
- <p>index of backend node to get information of.</p>
-</dl>
-
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-
-<p><code>-v </p>
- <p>--verbose</code></p>
-<dl class="flat">
- <p>enable verbose output.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_node_info version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_node_info command line arguments, and exit.</p>
-</dl>
-
-<p><strong>Output example:</strong></p>
-<dl class="flat">
+</dd>
+<dt>Options:</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>The index of backend node to get information of.</p>
+ </dd>
+ <dt>Other options</dt>
+ <dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+ </dd>
+ </dl>
+</dd>
+<dt>Output example:</dt>
+<dd>
<pre>
$ pcp_node_info -h localhost -U postgres 0
host1 5432 1 1073741823.500000
</pre>
<p>The result is in the following order:</p>
-<ul>
-<li>1. hostname</li>
-<li>2. port number</li>
-<li>3. status</li>
-<li>4. load balance weight</li>
-</ul>
+<ol>
+<li>hostname</li>
+<li>port number</li>
+<li>status</li>
+<li>load balance weight</li>
+</ol>
<p>Status is represented by a digit from [0 to 3].</p>
<ul>
@@ -4943,99 +4914,37 @@ Port : 5432
Status : 1
Weight : 0.5
</pre>
-</dl>
+</dd>
</dl>
<h3><a name="pcp_watchdog_info"/></a>pcp_watchdog_info <span class="version">V3.3 -</span></h3>
-<p>
-<strong>Format:</strong>
-</p>
-
-<dl class="flat">
-<pre>
-<code>pcp_watchdog_info [options...] [watchdogid]</code>
-</pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_watchdog_info [options...] [watchdog_id]</code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Displays the watchdog status of the pgpool-II.
- watchdogid is the index of other_pgpool_hostname parameter in pgpool.conf.</p>
- <p>If this is omitted, display the watchdog status of one's self watchdog.</p>
-</dl>
-
-<p><strong>Options:</strong></p>
- <p>
- <p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
- </p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
-<p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-n <strong>watchdog_id</strong></p>
- <p>--watchdog-id=<strong>watchdog_id</strong></code></p>
-<dl class="flat">
- <p>index of other pgpool-II to get information for.</p>
- <p>If ommitted then gets one's self watchdog information'.</p>
-</dl>
-
-<p><code>-w </p>
-<p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-
-<p><code>-W </p>
-<p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
-<p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-
-<p><code>-v </p>
- <p>--verbose</code></p>
-<dl class="flat">
- <p>enable verbose output.</p>
-</dl>
-
-<p><code>-V </p>
-<p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_watchdog_info version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
-<p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_watchdog_info command line arguments, and exit.</p>
-</dl>
-
-
-<p><strong>Output example:</strong></p>
-<dl class="flat">
+ <code>watchdog_id</code> is the index of other_pgpool_hostname parameter in pgpool.conf.
+ If this is omitted, display the watchdog status of local pgpool-II.</p>
+</dd>
+<dt>Options:</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-n <strong>watchdog_id</strong>, --node-id=<strong>watchdog_id</strong></code></dt>
+ <dd>
+ <p>The index of other pgpool-II to get information for.</p>
+ <p>If ommitted then gets one's self watchdog information'.</p>
+ </dd>
+ <dt>Other options</dt>
+ <dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+ </dd>
+ </dl>
+</dd>
+<dt>Output example:</dt>
+<dd>
<pre>
$ pcp_watchdog_info -h localhost -p 9898 -u postgres 0
@@ -5044,12 +4953,12 @@ Here is an output example:
</pre>
<p>The result is in the following order:</p>
-<ul>
-<li>1. hostname</li>
-<li>2. port number for pgpool-II</li>
-<li>3. port number for watchdog</li>
-<li>4. watchdog Status</li>
-</ul>
+<ol>
+<li>hostname</li>
+<li>port number for pgpool-II</li>
+<li>port number for watchdog</li>
+<li>watchdog Status</li>
+</ol>
<p>Status is represented by a digit from [1 to 4].</p>
<ul>
@@ -5058,177 +4967,51 @@ Here is an output example:
<li>3 - Active: holding the virtual IP</li>
<li>4 - Down</li>
</ul>
-<p>The load balance weight is displayed in normalized format.</p>
-
+</dd>
</dl>
<h3 id="pcp_proc_count">pcp_proc_count</h3>
-
-<p>
-<strong>Format:</strong>
-</p>
-
-<dl class="flat">
-<pre>
-<code>pcp_proc_count [options...] </code>
-</pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_proc_count [options...] </code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Displays the list of pgpool-II children process IDs. If there is more than
one process, IDs will be delimited by a white space.</p>
-</dl>
-
-<p>
-<strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-<p><code>-v </p>
- <p>--verbose</code></p>
-<dl class="flat">
- <p>enable verbose output.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_proc_count version, and exit.</p>
-</dl>
+</dd>
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_proc_count command line arguments, and exit.</p>
+<dt>Options:</dt>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+</dd>
</dl>
-
<h3 id="pcp_proc_info">pcp_proc_info</h3>
-<p>
-<strong>Format:</strong>
-</p>
-
-<dl class="flat">
-<pre>
-<code>pcp_proc_info [options...] [processid] </code>
-</pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_proc_info [options...] [processid] </code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Displays the information on the given pgpool-II child process ID.</p>
-</dl>
-
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-
-
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-P <strong>PID</strong></p>
- <p>--process-id=<strong>PID</strong></code></p>
-<dl class="flat">
- <p>PID of pgpool-II child process.</p>
-</dl>
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-<p><code>-v </p>
- <p>--verbose</code></p>
-<dl class="flat">
- <p>enable verbose output.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_proc_info version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_proc_info command line arguments, and exit.</p>
-</dl>
-
-<p><strong>Output example:</strong></p>
-<dl class="flat">
+</dd>
+<dt>Options:</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-P <strong>PID</strong>, --process-id=<strong>PID</strong></code></dt>
+ <dd>
+ <p>PID of pgpool-II child process.</p>
+ </dd>
+ <dt>Other options</dt>
+ <dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+ </dd>
+</dd>
+<dt>Output example:</dt>
+<dd>
<pre>
$ pcp_proc_info -h localhost -p 9898 -U postgres 3815
postgres_db postgres 1150769932 1150767351 3 0 1 1467 1
@@ -5236,17 +5019,17 @@ postgres_db postgres 1150769932 1150767351 3 0 1 1468 1
</pre>
<p>The result is in the following order:</p>
-<ul>
-<li>1. connected database name</li>
-<li>2. connected user name</li>
-<li>3. process start-up timestamp</li>
-<li>4. connection created timestamp</li>
-<li>5. protocol major version</li>
-<li>6. protocol minor version</li>
-<li>7. connection-reuse counter</li>
-<li>8. PostgreSQL backend process id</li>
-<li>9. 1 if frontend conncted 0 if not</li>
-</ul>
+<ol>
+<li>connected database name</li>
+<li>connected user name</li>
+<li>process start-up timestamp</li>
+<li>connection created timestamp</li>
+<li>protocol major version</li>
+<li>protocol minor version</li>
+<li>connection-reuse counter</li>
+<li>PostgreSQL backend process id</li>
+<li>1 if frontend conncted 0 if not</li>
+</ol>
<p>
If there is no connection to the backends, nothing will be
@@ -5280,88 +5063,25 @@ Counter : 1
PID : 1468
Connected : 1
</pre>
-
+</dd>
</dl>
<h3 id="pcp_pool_status">pcp_pool_status <span class="version">V3.1 -</span></h3>
-
-<p>
-<strong>Format:</strong>
-</p>
-
-<dl class="flat">
-<pre>
-<code>pcp_pool_status [options...]</code>
-</pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_pool_status [options...]</code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Displays the parameter values as defined in pgpool.conf.</p>
-</dl>
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-<p><code>-v </p>
- <p>--verbose</code></p>
-<dl class="flat">
- <p>enable verbose output.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_pool_status version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_pool_status command line arguments, and exit.</p>
-</dl>
-
-<p><strong>Output example:</strong></p>
-<dl class="flat">
+</dd>
+<dt>Options:</dt>
+<dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+</dd>
+<dt>Output example:</dt>
+<dd>
<pre>
$ pcp_pool_status -h localhost -U postgres
name : listen_addresses
@@ -5384,84 +5104,21 @@ desc : PCP port # to bind
</dl>
<h3 id="pcp_systemdb_info">pcp_systemdb_info</h3>
-
-<p>
-<strong>Format:</strong>
-</p>
-
-<dl class="flat">
-<pre>
-<code>pcp_systemdb_info [options...]</code>
-</pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_systemdb_info [options...]</code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Displays the System DB information.</p>
-</dl>
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-<p><code>-v </p>
- <p>--verbose</code></p>
-<dl class="flat">
- <p>enable verbose output.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_systemdb_info version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_systemdb_info command line arguments, and exit.</p>
-</dl>
-
-<p><strong>Output example:</strong></p>
-<dl class="flat">
+</dd>
+<dt>Options:</dt>
+<dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+</dd>
+<dt>Output example:</dt>
+<dd>
<pre>
$ pcp_systemdb_info -U postgres
localhost 5432 yamaguti '' pgpool_catalog pgpool 3
@@ -5472,408 +5129,175 @@ yamaguti public tellers bid 4 tid bid tbalance filler integer integer integer ch
<p>First, the System DB information will be displayed on the first line.
The result is in the following order:</p>
-<ul>
-<li>1. hostname</li>
-<li>2. port number</li>
-<li>3. user name</li>
-<li>4. password. '' for no password.</li>
-<li>5. schema name</li>
-<li>6. database name</li>
-<li>7. number of partioning rules defined</li>
-</ul>
+<ol>
+<li>hostname</li>
+<li>port number</li>
+<li>user name</li>
+<li>password. '' for no password.</li>
+<li>schema name</li>
+<li>database name</li>
+<li>number of partioning rules defined</li>
+</ol>
<p>
Second, partitioning rules will be displayed on the following lines. If
there are multiple definitions, one definition will be displayed on
each line multiple times. The result is in the following order:
</p>
-<ul>
-<li>1. targeted partitioning database name</li>
-<li>2. targeted partitioning schema name</li>
-<li>3. targeted partitioning table name</li>
-<li>4. partitioning key column name</li>
-<li>5. number of columns in the targeted table</li>
-<li>6. column names (displayed as many as said in 5.)</li>
-<li>7. column types (displayed as many as said in 5.)</li>
-<li>8. partitioning rule function name</li>
-</ul>
+<ol>
+<li>targeted partitioning database name</li>
+<li>targeted partitioning schema name</li>
+<li>targeted partitioning table name</li>
+<li>partitioning key column name</li>
+<li>number of columns in the targeted table</li>
+<li>column names (displayed as many as said in 5.)</li>
+<li>column types (displayed as many as said in 5.)</li>
+<li>partitioning rule function name</li>
+</ol>
</dd>
</dl>
<h2>PCP Commands to control backend nodes, etc.</h2>
<h3 id="pcp_detach_node">pcp_detach_node</h3>
-<p>
-<strong>Format:</strong>
-</p>
-
-<dl class="flat">
-<pre>
-<code>pcp_detach_node [options...] [node_id]</code>
-</pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_detach_node [options...] [node_id] [gracefully]</code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Detaches the given node from pgpool-II. Exisiting connections to pgpool-II are forced to be disconnected.</p>
-</dl>
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-n <strong>node_id</strong></p>
- <p>--node-id=<strong>node_id</strong></code></p>
-<dl class="flat">
- <p>index of backend node to detach.</p>
-</dl>
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_detach_node version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_detach_node command line arguments, and exit.</p>
+</dd>
+<dt>Options:</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>The index of backend node to detach.</p>
+ </dd>
+ <dt><code>-g, --gracefully </code></dt>
+ <dd>
+ <p>Wait until all clients are disconnected (unless
+ client_idle_limit_in_recovery is -1 or recovery_timeout is expired).</p>
+ </dd>
+ <dt>Other options</dt>
+ <dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+ </dd>
+ </dl>
+</dd>
</dl>
<h3 id="pcp_attach_node">pcp_attach_node</h3>
-<p><strong>Format:</strong></p>
-
-<dl class="flat">
-<pre><code>pcp_attach_node [options...] [node_id]</code></pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_attach_node [options...] [node_id]</code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Attaches the given node to pgpool-II.</p>
-</dl>
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-n <strong>node)id</strong></p>
- <p>--node-id=<strong>node_id</strong></code></p>
-<dl class="flat">
- <p>index of backend node to attach.</p>
-</dl>
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_node_info version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_attach_node command line arguments, and exit.</p>
+</dd>
+<dt>Options:</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>The index of backend node to attach.</p>
+ </dd>
+ <dt>Other options</dt>
+ <dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+ </dd>
+ </dl>
+</dd>
</dl>
<h3 id="pcp_promote_node">pcp_attach_node <span class="version">V3.1 -</span></h3>
-
-<p><strong>Format:</strong></p>
-<dl class="flat">
-<pre><code>pcp_promote_node [options...] [node_id]</code></pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
- <p>Promotes the given node as new master to pgpool-II. In master/slave streaming replication only.
- If -g is given, wait until all clients are disconnected (unless
- client_idle_limit_in_recovery is -1 or recovery_timeout is expired).</p>
-</dl>
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-n <strong>node_id</strong></p>
- <p>--node-id=<strong>node_id</strong></code></p>
-<dl class="flat">
- <p>index of backend node to promote as new master.</p>
-</dl>
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_promote_node version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_promote_node command line arguments, and exit.</p>
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_promote_node [options...] [node_id] [gracefully]</code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
+ <p>Promotes the given node as new master to pgpool-II. In master/slave streaming replication only.</p>
+</dd>
+<dt>Options:</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>The index of backend node to promote as new master.</p>
+ </dd>
+ <dt><code>-g, --gracefully </code></dt>
+ <dd>
+ <p>Wait until all clients are disconnected (unless
+ client_idle_limit_in_recovery is -1 or recovery_timeout is expired).</p>
+ </dd>
+ <dt>Other options</dt>
+ <dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+ </dd>
+ </dl>
+</dd>
</dl>
-
<h3 id="pcp_stop_pgpool">pcp_stop_pgpool</h3>
-
-<p><strong>Format:</strong></p>
-<dl class="flat">
-<pre><code>pcp_stop_pgpool [options...]</code></pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_stop_pgpool [options...] [mode]</code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Terminate the pgpool-II process.</p>
+</dd>
+<dt>Options:</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-m <strong>mode</strong>, --mode=<strong>mode</strong></code></p>
+ <dd>
+ <p>Shutdown mode for terminating the pgpool-II process.</p>
+ <p>The available modes are as follows:</p>
+ <ul>
+ <li>s, smart : smart mode</li>
+ <li>f, fast : fast mode</li>
+ <li>i, immediate : immediate mode</li>
+ </ul>
+ </dd>
+ <dt>Other options</dt>
+ <dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+ </dd>
+ </dl>
</dl>
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-m <strong>mode</strong></p>
- <p>--mode=<strong>mode</strong></code></p>
-<dl class="flat">
- <p>shutdown mode for terminating the pgpool-II process.</p>
- <p>The available modes are as follows:</p>
- <ul>
- <li>smart - smart mode</li>
- <li>fast - fast mode</li>
- <li>immediate - immediate mode</li>
- </ul>
-
-</dl>
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_stop_pgpool version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_stop_pgpool command line arguments, and exit.</p>
-</dl>
-
-
<h3 id="pcp_recovery_node">pcp_recovery_node</h3>
-
-<p><strong>Format:</strong></p>
-<dl class="flat">
-<pre><code>pcp_recovery_node [options...] [node_id] </code></pre>
-</dl>
-
-<p>
-<strong>Description:</strong>
-</p>
-<dl class="flat">
+<dl>
+<dt>Format:</dt>
+<dd>
+ <pre><code>pcp_recovery_node [options...] [node_id] </code></pre>
+</dd>
+<dt>Description:</dt>
+<dd>
<p>Attaches the given backend node with recovery.</p>
-</dl>
-
-<p><strong>Options:</strong></p>
-<p>
-<p><code>-h <strong>hostname</strong></p>
- <p>--host=<strong>hostname</strong></code></p>
-</p>
-<dl class="flat">
- <p>Specifies 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.</p>
-</dl>
-<p><code>-p <strong>port</strong></p>
- <p>--port=<strong>port</strong></code></p>
-<dl class="flat">
- <p>pgpool-II server PCP port (default:"9898").</p>
-</dl>
-
-<p><code>-u <strong>username</strong></p>
- <p>--username=<strong>username</strong></code></p>
-<dl class="flat">
- <p>username for PCP authentication (default: OS user name).</p>
-</dl>
-
-<p><code>-n <strong>node_id</strong></p>
- <p>--node-id=<strong>node_id</strong></code></p>
-<dl class="flat">
- <p>index of backend node.</p>
-</dl>
-
-<p><code>-w </p>
- <p>--no-password</code></p>
-<dl class="flat">
- <p>never prompt for password. And if a password is not available by a .pcppass 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</p>
-</dl>
-
-<p><code>-W </p>
- <p>--password</code></p>
-<dl class="flat">
- <p>force password prompt (should happen automatically).</p>
-</dl>
-
-<p><code>-d </p>
- <p>--debug</code></p>
-<dl class="flat">
- <p>enable debug message.</p>
-</dl>
-
-<p><code>-V </p>
- <p>--version</code></p>
-<dl class="flat">
- <p>print the pcp_recovery_node version, and exit.</p>
-</dl>
-
-<p><code>-? </p>
- <p>--help</code></p>
-</p>
-<dl class="flat">
- <p>show help about pcp_recovery_node command line arguments, and exit.</p>
+</dd>
+<dt>Options:</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>The index of backend node.</p>
+ </dd>
+ <dt>Other options</dt>
+ <dd>
+ <p>See <a href="#pcp_common_options">common options</a>. </p>
+ </dd>
+ </dl>
+</dd>
</dl>
<p class="top_link"><a href="#Top">back to top</a></p>
diff --git a/doc/pgpool-ja.html b/doc/pgpool-ja.html
index 3b700edae..011e4845e 100644
--- a/doc/pgpool-ja.html
+++ b/doc/pgpool-ja.html
@@ -4857,9 +4857,9 @@ pgpool-II が生きていて PostgreSQL と繋がっている場合でも、
<h2>PCP コマンド一覧</h2>
<p>pgpool-II を操作する UNIX コマンドとして、以下のものがあります。</p>
+<p><font color="red">注意</font>：pgpool-II 3.5 より、全ての PCP コマンドのパラメータ書式が変更されています。</p>
<table border>
-<tr><th colspan="2">情報を取得する PCP コマンド</th></tr>
<tr><th><a href="#pcp_node_count">pcp_node_count</a></th>
<td>ノード数を取得する</td></tr>
<tr><th><a href="#pcp_node_info">pcp_node_info</a></th>
@@ -4875,8 +4875,6 @@ pgpool-II が生きていて PostgreSQL と繋がっている場合でも、
<tr><th><a href="#pcp_systemdb_info">pcp_systemdb_info</a></th>
<td>システム DB 情報を取得する</td></tr>
<tr><th><a href="#pcp_detach_node">pcp_detach_node</a></th>
-
-<tr><th colspan="2">ノード等を操作する PCP コマンド</th></tr>
<tr><th><a href="#pcp_detach_node">pcp_detach_node</a></th>
<td>ノードを切り離す</td></tr>
<tr><th><a href="#pcp_attach_node">pcp_attach_node</a></th>
@@ -4890,40 +4888,108 @@ pgpool-II が生きていて PostgreSQL と繋がっている場合でも、
</table>
-<h2 id="pcp_comand_args">共通引数</h2>
-<p>全てのコマンドには共通する引数があります。これは接続するpgpool-IIの情報や認証情報などです。</p>
+<h2 id="pcp_comand_password">PCP 接続認証</h2>
+
+<p>PCP ユーザ名とパスワードが <code>$prefix/etc</code> ディレクトリ内の <code>pcp.conf</code>
+で宣言されている必要があります。<code>pcp.conf</code> が他の場所にある場合には、pgpool-II
+の起動時に <code>-F</code> オプションで指定することができます。</p>
+
+<h3 id="password_file">パスワードファイル</h3>
+<p>PCP 接続時にパスワードが指定されなかった場合、ユーザのホームディレクトリに配置された .pcppass
+ファイルか、環境変数 PCPPASSFILE で参照されるファイルに格納されたパスワードが使用可能です。</p>
+<p>このファイルの各行の書式は以下のとおりです：</p>
<pre>
-ex)
-$ pcp_node_count [-d] 10 localhost 9898 postgres hogehoge
+hostname:port:username:password
</pre>
+<p>
+（この文字列の行頭に # を付けてからファイルにコピーしておけば備忘録のコメントになります。）
+最初の３つのフィールドはそれぞれリテラル値か、任意のものにマッチする * を指定します。
+現在の接続パラメータにマッチした最初の行のpassword フィールドが使用されます。
+（したがって、ワイルドーカードを使用する場合には、具体的なエントリーの方を先に書きます。）
+エントリーの中に : か \ を含む必要がある場合には、その文字を \ をつかってエスケープしてください。
+ホスト名 localhost はローカルマシンからの TCP と Unix ドメインソケットの両方の接続にマッチします。</p>
-<table border>
-<tr>
-<th nowrap>第 1 引数</th><td>タイムアウト値<br>
-秒数でタイムアウト値を指定します。
-この時間内に pgpool-II から応答がない場合はコネクションを切断して終了します。
-なお、このオプションは 2.1 からは無視するようになっています。
-</td>
-</tr>
-<tr><th nowrap>第 2 引数</th><td>pgpool-II が稼動しているホスト名</td></tr>
-<tr><th nowrap>第 3 引数</th><td>PCP ポート番号</td></tr>
-<tr><th nowrap>第 4 引数</th><td>PCP ユーザ名</td></tr>
-<tr><th nowrap>第 5 引数</th><td>PCP パスワード</td></tr>
-</table>
+<p>.pcppass のパーミッションはグループおよび全ユーザからのアクセスを許してはいけません。
+chmod 0600 ~/.pcppass を実行してください。これよりパーミッションの制限が弱い場合には、
+このファイルは無視されます。</p>
-<p>
-オプション引数として、<code>-d </code>があります。
-<code>-d</code> が指定されるとデバッグ情報を出力します。
-</p>
-<p>
-PCPユーザ名とパスワードは <code>./configure</code> 時に <code>--prefix</code> で指定した
-'インストールディレクトリ/etc' にある pcp.conf 内に記述されているものを指定します。
-pcp.conf ファイルの場所がデフォルト以外の場所にある場合、
-<code>pgpool</code> の <code>-F</code> オプションでその位置を指定することができます。
-パスワードはコマンドに渡す時点でmd5化されている必要はありません。
-</p>
+<h2 id="pcp_common_options">共通引数</h2>
+<p>全てのコマンドには共通する引数があります。そのほとんどは認証情報を指定するもので、
+他は冗長出力モードやデバッグなどに関するものです。</p>
+
+<pre>
+-ex)
+$ pcp_node_count [-d] 10 localhost 9898 postgres hogehoge
+</pre>
+<dl class="options">
+<dt><code>
+-h <strong>hostname</strong>, --host=<strong>hostname</strong>
+</code></dt>
+<dd><p>
+pgpool-II が稼働しているホスト名を指定します。
+スラッシュから始まる場合は、Unix ドメインソケットのディレクトリと解釈されます。
+</p></dd>
+
+<dt><code>
+-p <strong>port</strong>, --port=<strong>port</strong>
+</code></dt>
+<dd><p>
+PCP ポート番号を指定します。(デフォルト: 9898)
+</p></dd>
+
+<dt><code>
+-u <strong>username</strong>, --username=<strong>username</strong>
+</code></dt>
+<dd><p>
+PCP 認証のユーザ名を指定します。(デフォルト: OS のユーザ)
+</p></dd>
+
+<dt><code>
+-w, --no-password
+</code></dt>
+<dd><p>
+パスワード入力プロンプトを表示しません。
+もしパスワードが .pcppass ファイルから取得できない場合には接続は失敗します。
+このオプションはバッチジョブやスクリプトなど、パスワード入力が行うユーザいない場合に有用です。</p>
+</p></dd>
+
+<dt><code>
+-W, --password
+</code></dt>
+<dd><p>
+パスワード入力プロンプトを表示します。（自動的に選択される動作です）
+</p></dd>
+
+<dt><code>
+-d, --debug
+</code></dt>
+<dd><p>
+デバッグメッセージを表示します。
+</p></dd>
+
+<dt><code>
+-v, --verbose
+</code></dt>
+<dd><p>
+冗長出力を有効にします。
+</p></dd>
+
+<dt><code>
+-V, --version
+</code></dt>
+<dd><p>
+バージョンを表示して終了します。
+</p></dd>
+
+<dt><code>
+-?, --help
+</code></dt>
+<dd><p>
+コマンドラインのヘルプを表示して終了します。
+</p></dd>
+</dl>
<h2>情報を取得するコマンド群</h2>
<p>
@@ -4932,37 +4998,62 @@ pcp.conf ファイルの場所がデフォルト以外の場所にある場合
<h3 id="pcp_node_count">pcp_node_count</h3>
-<dl class="flat">
-<dt>書式</dt>
-<dd><code>pcp_node_count _timeout_ _host_ _port_ _userid_ _passwd_</code></dd>
+<dl class="options">
+<dt>書式<dt>
+<dd>
+<pre><code>pcp_node_count [options...] </code></pre>
+</dd>
<dt>説明</dt>
-<dd>pgpool-II の pgpool.conf で定義されたノードの総数を表示します。
- 切り離されているノードの区別はしません。</dd>
+<dd>
+ <p>pgpool-II の pgpool.conf で定義されたノードの総数を表示します。
+ 切り離されているノードの区別はしません。</p>
+</dd>
+<dt>オプション</dt>
+<dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+</dd>
</dl>
-
<h3><a name="pcp_node_info"></a>pcp_node_info</h3>
-<dl class="flat">
+<dl class="options">
<dt>書式</dt>
-<dd><code>pcp_node_info _timeout_ _host_ _port_ _userid_ _passwd_ _nodeid_</code></dd>
-</pre>
+<dd>
+<pre><code>pcp_node_info [options...] [node_id] </code></pre>
+</dd>
<dt>説明</dt>
-<dd>pgpool-II の pgpool.conf で定義されたノードの情報を表示します。出力結果は以下の例のとおりです。
+<dd>
+ <p>指定されたノードの情報を表示します。</p>
+</dd>
+<dt>オプション</dt>
+<dd>
+ <dl>
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>情報を表示するバックエンドノードのインデックスを指定します。</p>
+ </dd>
+ <dt>その他</dt>
+ <dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+ </dd>
+ </dl>
+</dd>
+<dt>出力例</dt>
+<dd>
<pre>
-$ pcp_node_info 10 localhost 9898 postgres hogehoge 0
+$ pcp_node_info -h localhost -U postgres 0
host1 5432 1 1073741823.500000
</pre>
<p>結果は以下の順のとおりです。</p>
-<ul>
-<li>1. ノードのホスト名</li>
-<li>2. ノードのポート番号</li>
-<li>3. ステータス</li>
-<li>4. ロードバランスウェイト</li>
-</ul>
+<ol>
+<li>ノードのホスト名</li>
+<li>ノードのポート番号</li>
+<li>ステータス</li>
+<li>ロードバランスウェイト</li>
+</ol>
-<p>ステータスは [0..3] までの数字で表わされます。各数字の意味は：</p>
+<p>ステータスは [0..3] までの数字で表わされます。各数字の意味は以下のとおりです。</p>
<ul>
<li>0 - 初期化時のみに表われる。PCP コマンドで表示されることはない。</li>
<li>1 - ノード稼働中。接続無し</li>
@@ -4971,37 +5062,49 @@ host1 5432 1 1073741823.500000
</ul>
<p>ロードバランスウェイトは Normalize されたフォーマットで出力されます。</p>
-<p>定義されていないノード ID を指定すると BackendError と表示され、
-<a href="#exit_status">終了コード 12</a> で終了します。</p>
+
+<p><code>--verbose</code> オプションは出力内容を理解するのに役に立ちます。例：</p>
+
+ <pre>
+$ pcp_node_info --verbose -h localhost -U postgres 0
+Hostname: host1
+Port : 5432
+Status : 1
+Weight : 0.5
+</pre>
+
</dd>
</dl>
<h3><a name="pcp_watchdog_info"></a>pcp_watchdog_info</h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_watchdog_info _timeout_ _host_ _port_ _userid_ _passwd_ [_watchdogid_]</code></dd>
+<dd>
+ <pre><code>pcp_watchdog_info [options...] [watchdog_id]</code></pre>
+</dd>
<dt>説明</dt>
<dd>
<p>pgpool-II の pgpool.conf の watchdog セクションで定義された pgpool-II の watchdog ステータスを表示します。</p>
<p>_watchdogid_ は other_pgpool_hostname パラメータの添字です。
省略された場合には、_host_:_port_ で動作している pgpool-II の watchdog ステータスが表示されます。</p>
-<p>出力結果は以下の例のとおりです。</p>
+<dt>出力例</dt>
+<dd>
<pre>
-$ pcp_watchdog_info 10 localhost 9898 postgres hogehoge 0
+$ pcp_watchdog_info -h localhost -p 9898 -u postgres 0
host1 9999 9000 2
</pre>
<p>結果は以下の順のとおりです。</p>
-<ul>
-<li>1. pgpool-II のホスト名</li>
-<li>2. pgpool-II ポート番号</li>
-<li>3. watchdog ポート番号</li>
-<li>4. watchdog ステータス</li>
-</ul>
+<ol>
+<li>pgpool-II のホスト名</li>
+<li>pgpool-II ポート番号</li>
+<li>watchdog ポート番号</li>
+<li>watchdog ステータス</li>
+</ol>
-<p>ステータスは [1..4] までの数字で表わされます。各数字の意味は：</p>
+<p>ステータスは [1..4] までの数字で表わされます。各数字の意味は以下のとおりです。</p>
<ul>
<li>1 - 初期化時のみに表われる。指定された pgpool-II が未起動の場合に表示される。</li>
<li>2 - スタンバイ: 仮想 IP を保持していない</li>
@@ -5009,26 +5112,47 @@ host1 9999 9000 2
<li>4 - ダウン</li>
</ul>
-<p>定義されていない watchdog ID を指定すると BackendError と表示され、
-<a href="#exit_status">終了コード 12</a> で終了します。</p>
</dd>
</dl>
<h3 id="pcp_proc_count">pcp_proc_count</h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_proc_count _timeout_ _host_ _port_ _userid_ _passwd_</code></dd>
+<dd>
+ <pre><code>pcp_proc_count [options...] </code></pre>
+</dd>
<dt>説明</dt>
-<dd>pgpool-II の子プロセスのプロセス ID を一覧表示します。複数ある場合は空白文字で区切られます。</dd>
+<dd><p>pgpool-II の子プロセスのプロセス ID を一覧表示します。複数ある場合は空白文字で区切られます。<p></dd>
+<dt>オプション</dt>
+<dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+</dd>
</dl>
<h3 id="pcp_proc_info">pcp_proc_info</h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_proc_info _timeout_ _host_ _port_ _userid_ _passwd_ _processid_</code></dd>
+<dd>
+ <pre><code>pcp_proc_info [options...] [processid] </code></pre>
+</dd>
<dt>説明</dt>
<dd>
-<p>pgpool-II の子プロセス情報を表示します。出力結果は以下の例のとおりです。</p>
+<p>pgpool-II の子プロセス情報を表示します。</p>
+</dd>
+<dt>オプション</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-P <strong>PID</strong>, --process-id=<strong>PID</strong></code></dt>
+ <dd>
+ <p>pgpool-II 子プロセスの PID を指定します。</p>
+ </dd>
+ <dt>その他</dt>
+ <dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+ </dd>
+</dd>
+</dd>
+<dt>出力例</dt>
<pre>
$ pcp_proc_info 10 localhost 9898 postgres hogehoge 3815
postgres_db postgres 1150769932 1150767351 3 0 1 14067 1
@@ -5036,35 +5160,66 @@ postgres_db postgres 1150769932 1150767351 3 0 1 14068 1
</pre>
<p>結果は以下の順のとおりです。</p>
-<ul>
-<li>1. 接続しているデータベース名</li>
-<li>2. 接続しているユーザ名</li>
-<li>3. プロセススタート時刻</li>
-<li>4. コネクション作成時刻</li>
-<li>5. プロトコルメジャーバージョン</li>
-<li>6. プロトコルマイナーバージョン</li>
-<li>7. コネクション使用回数</li>
-<li>8. PostgreSQL バックエンドプロセスID</li>
-<li>9. フロントエンドから接続がある場合は 1、そうでなければ 0</li>
-</ul>
+<ol>
+<li>接続しているデータベース名</li>
+<li>接続しているユーザ名</li>
+<li>プロセススタート時刻</li>
+<li>コネクション作成時刻</li>
+<li>プロトコルメジャーバージョン</li>
+<li>プロトコルマイナーバージョン</li>
+<li>コネクション使用回数</li>
+<li>PostgreSQL バックエンドプロセスID</li>
+<li>フロントエンドから接続がある場合は 1、そうでなければ 0</li>
+</ol>
<p>
コネクションがバックエンドに対して張られていない場合、データは表示されません。
コネクション情報が複数ある場合、複数行に 1 行 1 コネクション情報で表示されます。
時刻は EPOCH タイムからの秒数で表わされます。
</p>
-<p>定義されていないプロセスIDを指定するとBackendErrorと表示され、
-<a href="#exit_status">終了コード 12</a>で終了します。</p>
+
+<p><code>--verbose</code> オプションは出力内容を理解するのに役に立ちます。例：</p>
+
+<pre>
+$ pcp_proc_info --verbose -U postgres 3815
+Database : postgres_db
+Username : postgres
+Start time : 1150769932
+Creation time: 1150767351
+Major : 3
+Minor : 0
+Counter : 1
+PID : 1467
+Connected : 1
+Database : postgres_db
+Username : postgres
+Start time : 1150769932
+Creation time: 1150767351
+Major : 3
+Minor : 0
+Counter : 1
+PID : 1468
+Connected : 1
+</pre>
</dd>
</dl>
<h3 id="pcp_pool_status">pcp_pool_status <span class="version">V3.1 〜</span></h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_pool_status _timeout_ _host_ _port_ _userid_ _passwd_</code></dd>
+<dd>
+ <pre><code>pcp_pool_status [options...]</code></pre>
+</dd>
<dt>説明</dt>
<dd>
-<p>pgpool.conf のパラメータ設定値を取得します。出力結果は以下のとおりです。</p>
+<p>pgpool.conf のパラメータ設定値を取得します。</p>
+</dd>
+<dt>オプション</dt>
+<dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+</dd>
+<dt>出力例</dt>
+<dd>
<pre>
$ pcp_pool_status 10 localhost 9898 postgres hogehoge
name : listen_addresses
@@ -5087,12 +5242,21 @@ desc : PCP port # to bind
</dl>
<h3 id="pcp_systemdb_info">pcp_systemdb_info</h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_systemdb_info _timeout_ _host_ _port_ _userid_ _passwd_</code></dd>
+<dd>
+ <pre><code>pcp_systemdb_info [options...]</code></pre>
+</dd>
<dt>説明</dt>
<dd>
-<p>pgpool-II のシステム DB 情報を表示します。出力結果は以下のとおりです。</p>
+<p>pgpool-II のシステム DB 情報を表示します。</p>
+</dd>
+<dt>オプション</dt>
+<dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+</dd>
+<dt>出力例</dt>
+<dd>
<pre>
$ pcp_systemdb_info 10 localhost 9898 postgres hogehoge
localhost 5432 yamaguti '' pgpool_catalog pgpool 3
@@ -5102,146 +5266,183 @@ yamaguti public tellers bid 4 tid bid tbalance filler integer integer integer ch
</pre>
<p>まず 1 行目にシステム DB の情報が表示されます。結果は以下の順のとおりです。</p>
-<ul>
-<li>1. ホスト名</li>
-<li>2. ポート番号</li>
-<li>3. ユーザ名</li>
-<li>4. パスワード。空の場合は '' で表示されます。</li>
-<li>5. スキーマ名</li>
-<li>6. データベース名</li>
-<li>7. 分散定義関数の数</li>
-</ul>
+<ol>
+<li>ホスト名</li>
+<li>ポート番号</li>
+<li>ユーザ名</li>
+<li>パスワード。空の場合は '' で表示されます。</li>
+<li>スキーマ名</li>
+<li>データベース名</li>
+<li>分散定義関数の数</li>
+</ol>
<p>
2 行目以降は分散定義が表示されます。複数の定義がある場合は、1 つの定義につき 1 行表示されます。
結果は以下の順のとおりです。
</p>
-<ul>
-<li>1. 分散対象のデータベース名</li>
-<li>2. 分散対象のスキーマ名</li>
-<li>3. 分散対象のテーブル名</li>
-<li>4. 分散キーカラム名</li>
-<li>5. 分散対象テーブル中のカラム数</li>
-<li>6. カラム名リスト（5. のカラム数分表示されます）</li>
-<li>7. カラム型リスト（5. のカラム数分表示されます）</li>
-<li>8. 分散定義関数名</li>
-</ul>
+<ol>
+<li>分散対象のデータベース名</li>
+<li>分散対象のスキーマ名</li>
+<li>分散対象のテーブル名</li>
+<li>分散キーカラム名</li>
+<li>分散対象テーブル中のカラム数</li>
+<li>カラム名リスト（5. のカラム数分表示されます）</li>
+<li>カラム型リスト（5. のカラム数分表示されます）</li>
+<li>分散定義関数名</li>
+</ol>
-<p>
-システム DB が定義されていない（pgpool-II モードでない、かつクエリキャッシュがオフの）場合に実行すると、
-BackendErrorと表示され、<a href="#exit_status">終了コード 12</a> で終了します。
-</p>
</dd>
</dl>
<h2>ノード等を操作するコマンド群</h2>
<h3 id="pcp_detach_node">pcp_detach_node</h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_detach_node [-g] _timeout_ _host_ _port_ _userid_ _passwd_ _nodeid_</code></dd>
+<dd>
+ <pre><code>pcp_detach_node [options...] [node_id] [grecefully]</code></pre>
+</dd>
<dt>説明</dt>
<dd>
<p>pgpool-II のノードを切り離します。</p>
-<p>すでにpgpool-IIに接続しているセッションは強制的に切断されます。
-<p><code>-g</code> を指定すると、すべてのクライアントが接続を終了するまでノードを復帰しません。
-（ただし、<a href="#CLIENT_IDLE_LIMIT_IN_RECOVERY">client_idle_limit_in_recovery</a> が -1
-あるいは、<a href="#RECOVERY_TIMEOUT">recovery_timeout</a> が設定されている場合を除く）
-</p>
+<p>すでにpgpool-IIに接続しているセッションは強制的に切断されます。</p>
+</dd>
+<dt>オプション</dt>
+<dd>
+ <dl class="option">
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>切り離すバックエンドノードのインデックスを指定します。</p>
+ </dd>
+ <dt><code>-g, --gracefully</code></dt>
+ <dd>
+ <p>すべてのクライアントが接続を終了するまでノードを復帰しません。
+ （ただし、<a href="#CLIENT_IDLE_LIMIT_IN_RECOVERY">client_idle_limit_in_recovery</a> が -1
+ あるいは、<a href="#RECOVERY_TIMEOUT">recovery_timeout</a> が設定されている場合を除く）</p>
+ </dd>
+ <dt>その他</dt>
+ <dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+ </dd>
+ </dl>
</dd>
</dl>
<h3 id="pcp_attach_node">pcp_attach_node</h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_attach_node _timeout_ _host_ _port_ _userid_ _passwd_ _nodeid_</code></dd>
+<dd>
+ <pre><code>pcp_attach_node [options...] [node_id]</code></pre>
+</dd>
<dt>説明</dt>
-<dd>pgpool-II のノードを復帰させます。</dd>
+<dd><p>pgpool-II のノードを復帰させます。</p></dd>
+<dt>オプション</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>復帰させるバックエンドノードのインデックスを指定します。</p>
+ </dd>
+ <dt>その他</dt>
+ <dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+ </dd>
+ </dl>
+</dd>
</dl>
<h3 id="pcp_promote_node">pcp_promote_node <span class="version">V3.1 〜</span></h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_promote_node [-g] _timeout_ _host_ _port_ _userid_ _passwd_ _nodeid_</code></dd>
+<dd>
+ <pre><code>pcp_promote_node [options...] [node_id] [gracefully]</code></pre>
+</dd>
<dt>説明</dt>
<dd>
<p>pgpool-II のノードをマスターに昇格させます。これは、マスタースレーブモードで
ストリーミングレプリケーション構成の場合のみ使用できます。
</p>
-<p><code>-g</code> を指定すると、すべてのクライアントが接続を終了するまでノードを復帰しません。
-（ただし、<a href="#CLIENT_IDLE_LIMIT_IN_RECOVERY">client_idle_limit_in_recovery</a> が -1
-あるいは、<a href="#RECOVERY_TIMEOUT">recovery_timeout</a> が設定されている場合を除く）
-</p>
+</dd>
+<dt>オプション</dt>
+<dd>
+ <dl class="option">
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>マスターに昇格させるバックエンドノードのインデックスを指定します。</p>
+ </dd>
+ <dt><code>-g, --gracefully</code></dt>
+ <dd>
+ <p>すべてのクライアントが接続を終了するまでノードを復帰しません。
+ （ただし、<a href="#CLIENT_IDLE_LIMIT_IN_RECOVERY">client_idle_limit_in_recovery</a> が -1
+ あるいは、<a href="#RECOVERY_TIMEOUT">recovery_timeout</a> が設定されている場合を除く）</p>
+ </dd>
+ <dt>その他</dt>
+ <dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+ </dd>
+ </dl>
</dd>
</dl>
<h3 id="pcp_stop_pgpool">pcp_stop_pgpool</h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_stop_pgpool _timeout_ _host_ _port_ _userid_ _passwd_ _mode_</code></dd>
+<dd>
+ <pre><code>pcp_stop_pgpool [options...] [mode]</code></pre>
+</dd>
<dt>説明</dt>
-<dd><p>pgpool-IIを指定されたモードでシャットダウンします。指定できるモードは以下のとおりです。</p>
-<ul>
-<li>s - smart モード</li>
-<li>f - fast モード</li>
-<li>i - immediate モード</li>
-</ul>
-
-<p>pgpool-II が起動していない場合は ConnectionError と表示され、
-<a href="#exit_status">終了コード 8</a> で終了します。</p>
-
-<p>
-※ 現在は fast モードと immediate シャットダウンの処理に区別はありません。
-命令を送った時点でクライアントがいる・いないに関わらずシャットダウン処理を即座に行います。
-</p>
+<dd>
+ <p>pgpool-IIを指定されたモードでシャットダウンします。</p>
+</dd>
+<dt>オプション</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-m <strong>mode</strong>, --mode=<strong>mode</strong></code></p>
+ <dd>
+ <p>シャットダウンモードを指定します。指定できるモードは以下のとおりです。</p>
+ <ul>
+ <li>s, smart : smart モード</li>
+ <li>f, fast : fast モード</li>
+ <li>i, immediate : immediate モード</li>
+ </ul>
+ <p>
+ ※ 現在は fast モードと immediate シャットダウンの処理に区別はありません。
+ 命令を送った時点でクライアントがいる・いないに関わらずシャットダウン処理を即座に行います。
+ </p>
+ </dd>
+ <dt>その他</dt>
+ <dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。 </p>
+ </dd>
+ </dl>
</dd>
</dl>
<h3 id="pcp_recovery_node">pcp_recovery_node</h3>
-<dl class="flat">
+<dl>
<dt>書式</dt>
-<dd><code>pcp_recovery_node _timeout_ _host_ _port_ _userid_ _passwd_ _nodeid_</code></dd>
-<dt>説明</dt>
<dd>
+ <pre><code>pcp_recovery_node [options...] [node_id] </code></pre>
+</dd>
+<dt>説明</dt>
+<dd><p>
pgpool-II のノードをデータを再同期させた上で復帰させます。
+</p></dd>
+<dt>オプション</dt>
+<dd>
+ <dl class="options">
+ <dt><code>-n <strong>node_id</strong>, --node-id=<strong>node_id</strong></code></dt>
+ <dd>
+ <p>バックエンドノードのインデックスを指定します。</p>
+ </dd>
+ <dt>その他</dt>
+ <dd>
+ <p><a href="#pcp_common_options">common options</a> を参照してください。</p>
+ </dd>
+ </dl>
</dd>
</dl>
-<h2 id="exit_status">終了ステータス</h2>
-<p>
-PCPコマンドは正常に処理を終了した場合、ステータス'0'で終了します。エラーが起
-きた場合は以下のステータスにより終了します。
-</p>
-
-<table border>
-<tr><th>UNKNOWNERR</th>
- <td>1</td><td>不明なエラー</td></tr>
-<tr><th>EOFER</th>
- <td>2</td><td>EOFエラー</td></tr>
-<tr><th>NOMEMERR</th>
- <td>3</td><td>メモリ不足</td></tr>
-<tr><th>READERR</th>
- <td>4</td><td>サーバからのデータ読み込みエラー</td></tr>
-<tr><th>WRITEERR</th>
- <td>5</td><td>サーバへのデータ書き込みエラー</td></tr>
-<tr><th>TIMEOUTERR</th>
- <td>6</td><td>タイムアウト</td></tr>
-<tr><th>INVALERR</th>
- <td>7</td><td>PCPコマンドへの不正なオプション</td></tr>
-<tr><th>CONNERR</th>
- <td>8</td><td>サーバ接続エラー</td></tr>
-<tr><th>NOCONNERR</th>
- <td>9</td><td>接続が存在しない</td></tr>
-<tr><th>SOCKERR</th>
- <td>10</td><td>ソケットエラー</td></tr>
-<tr><th>HOSTERR</th>
- <td>11</td><td>ホスト名解決エラー</td></tr>
-<tr><th>BACKENDERR</th>
- <td>12</td><td>サーバでのPCP処理エラー。存在しないプロセスIDの情報を取得しようとした場合など</td></tr>
-<tr><th>AUTHERR</th>
- <td>13</td><td>認証エラー</td></tr>
-</table>
-
<p class="top_link"><a href="#Top">△ back to top</a></p>
<!-- ================================================================================ -->
@@ -14388,6 +14589,10 @@ HINT: check data consistency between master and other db node
</li><li> コネクションプール再利用時に、ソケットが壊れている場合は再接続するようにしました(Yoshiyuki Asaba)
</li><li> PostgreSQL 7.4.x の libpq を使ってビルドしようとすると、
configure スクリプトでエラーとなってしまう不具合を修正しました(Yoshiyuki Asaba)
+ <dl>
+ <dt>hoge</dt><dd>HOGE</dd>
+ <dt>hoge</dt><dd>HOGE</dd>
+ </dl>
</li></ul>
<!-- ================================================================================ -->
diff --git a/doc/pgpool.css b/doc/pgpool.css
index afafbb4d0..fa8ff913b 100644
--- a/doc/pgpool.css
+++ b/doc/pgpool.css
@@ -257,6 +257,15 @@ dl.flat dd {
dl.flat dd * {
margin-left: 0px;
}
+dl.options {
+ margin: 10px 0px 10px 40px;
+}
+dl.options dt {
+ font-weight:normal;
+}
+dl.options dd {
+ margin: 10px 0px 10px 0px;
+}
li dl dt {
font-weight: normal;
display: list-item;
[parent: 84c9c074104f]