<!-- doc/src/sgml/reference.sgml -->
<part id="reference">
- <title>Reference</title>
-
- <partintro>
- <para>
- This part contains reference information for the <productname>Pgool-II</productname>.
- </para>
-
- <para>
- The reference entries are also available as traditional
- <quote>man</quote> pages.
- </para>
- </partintro>
-
- <reference id="server-commands">
- <title>Server commands</title>
-
- <partintro>
- <para>
- This part contains reference information for server
- commands. Currently only <command>pgpool</command> falls into
- this category.
- </para>
- </partintro>
- &pgpool;
- </reference>
-
- <reference id="pcp-commands">
- <title>PCP commands</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.
- </para>
-
- <sect1 id="pcp-connection-authentication">
- <title>PCP connection authentication</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.
- </para>
- </sect1>
-
- <sect1 id="pcp-password-file">
- <title>PCP password file</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.
- </para>
- <para>
- This file should contain lines of the following format:
-
- <programlisting>
- 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
- 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.
- </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.
- </para>
-
- </sect1>
-
- </partintro>
-
- &pcpCommonOptions;
- &pcpNodeCount;
- &pcpNodeInfo;
- &pcpWatchdogInfo;
- &pcpProcCount;
- &pcpProcInfo;
- &pcpPoolStatus;
- &pcpDetachNode;
- &pcpAttachNode;
- &pcpPromoteNode;
- &pcpStopPgpool;
- &pcpRecoveryNode;
-
- </reference>
-
- <reference id="other-commands">
- <title>Other commands</title>
-
- <partintro>
- <para>
- This part contains reference information for various Pgpool-II commands.
- </para>
-
- </partintro>
-
- &pgMd5;
- &pgpoolSetup;
- &watchdoglSetup;
-
- </reference>
-
- <reference id="sql-commands">
- <title>SQL type commands</title>
-
- <partintro>
- <para>
- This part contains reference information for various SQL type
- <productname>Pgpool-II</productname> commands. These commands
- can be issued inside the SQL session using the
- standard <productname>PostgreSQL</productname> client
- like <literal>psql</literal>. They are not forwarded to the
- backend DB: instead they are processed
- by <productname>Pgpool-II</productname> server. Please note
- that SQL type commands cannot be used in extended query
- mode. You will get parse errors
- from <productname>PostgreSQL</productname>.
- </para>
-
- </partintro>
-
- &pgpoolShow
- &pgpoolSet
- &pgpoolReset
- &showPoolStatus
- &showPoolNodes
- &showPoolProcesses
- &showPoolPools
- &showPoolVersion
- &showPoolCache
-
- </reference>
+ <title>Reference</title>
+
+
This part contains reference information for the <productname>Pgool-II</productname>.
+ </para>
+
+ The reference entries are also available as traditional
+ <quote>man</quote> pages.
+ </para>
+ </partintro>
+
+ <reference id="server-commands">
+ <title>Server commands</title>
+
+ This part contains reference information for server
+ commands. Currently only <command>pgpool</command> falls into
+ this category.
+ </para>
+ </partintro>
+ &pgpool;
+ </reference>
+
+ <reference id="pcp-commands">
+ <title>PCP commands</title>
+
+ 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.
+ </para>
+
+ <sect1 id="pcp-connection-authentication">
+ <title>PCP connection authentication</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.
+ </para>
+ </sect1>
+
+ <sect1 id="pcp-password-file">
+ <title>PCP password file</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.
+ </para>
+ <para>
+ This file should contain lines of the following format:
+
+ 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
+ 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.
+ </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.
+ </para>
+
+ </sect1>
+
+ </partintro>
+
+ &pcpCommonOptions;
+ &pcpNodeCount;
+ &pcpNodeInfo;
+ &pcpWatchdogInfo;
+ &pcpProcCount;
+ &pcpProcInfo;
+ &pcpPoolStatus;
+ &pcpDetachNode;
+ &pcpAttachNode;
+ &pcpPromoteNode;
+ &pcpStopPgpool;
+ &pcpRecoveryNode;
+
+ </reference>
+
+ <reference id="other-commands">
+ <title>Other commands</title>
+
+ This part contains reference information for various Pgpool-II commands.
+ </para>
+
+ </partintro>
+
+ &pgMd5;
+ &pgpoolSetup;
+ &watchdoglSetup;
+
+ </reference>
+
+ <reference id="sql-commands">
+ <title>SQL type commands</title>
+
+ This part contains reference information for various SQL type
+ <productname>Pgpool-II</productname> commands. These commands
+ can be issued inside the SQL session using the
+ standard <productname>PostgreSQL</productname> client
+ like <literal>psql</literal>. They are not forwarded to the
+ backend DB: instead they are processed
+ by <productname>Pgpool-II</productname> server. Please note
+ that SQL type commands cannot be used in extended query
+ mode. You will get parse errors
+ from <productname>PostgreSQL</productname>.
+ </para>
+
+ </partintro>
+
+ &pgpoolShow
+ &pgpoolSet
+ &pgpoolReset
+ &showPoolStatus
+ &showPoolNodes
+ &showPoolProcesses
+ &showPoolPools
+ &showPoolVersion
+ &showPoolCache
+
+ </reference>
</part>
projects / pgpool2.git / commitdiff