pgpool2.git / summary / log / commit / refs
commit 93053443307bc895bb8bf2cecd6c90c48c6c04b4
Author: Guillaume Lelarge <guillaume at lelarge.info>
Date: Sun Mar 08 15:00:45 2009 +0000
Update usage function, doc and man page.
doc/pgpool-en.html | 24 +++++++++++------------
main.c | 38 +++++++++++++++++++++++-------------
pgpool.8.in | 56 +++++++++++++++++++++++++++++++++++++++---------------
3 files changed, 78 insertions(+), 40 deletions(-)
diff --git a/doc/pgpool-en.html b/doc/pgpool-en.html
index 7f8359adc..2d76a7756 100644
--- a/doc/pgpool-en.html
+++ b/doc/pgpool-en.html
@@ -1274,12 +1274,12 @@ pgpool [-c][-f config_file][-a hba_file][-F pcp_config_file][-n][-d]
</pre>
<p>
<table>
- <tr><td>-c</td><td>deletes query cache</tr>
- <tr><td>-f config_file</td><td>specifies pgpool.conf</tr>
- <tr><td>-a hba_file</td><td>specifies pool_hba.conf</tr>
- <tr><td>-F pcp_config_file</td><td>specifies pcp.conf</tr>
- <tr><td>-n</td><td>no daemon mode (terminal is not detached)</tr>
- <tr><td>-d</td><td>debug mode</tr>
+ <tr><td>-c<br/>--clear-cache</td><td>deletes query cache</tr>
+ <tr><td>-f config_file<br/>--config-file config-file</td><td>specifies pgpool.conf</tr>
+ <tr><td>-a hba_file<br/>--hba-file hba_file</td><td>specifies pool_hba.conf</tr>
+ <tr><td>-F pcp_config_file<br/>--pcp-password-file</td><td>specifies pcp.conf</tr>
+ <tr><td>-n<br/>--no-daemon</td><td>no daemon mode (terminal is not detached)</tr>
+ <tr><td>-d<br/>--debug</td><td>debug mode</tr>
</table>
There are two ways to stop pgpool-II. One is via PCP command
(described later) or pgpool-II command. Below is an example of the
@@ -1291,12 +1291,12 @@ pgpool [-f config_file][-F pcp_config_file] [-m {s[mart]|f[ast]|i[mmediate]}] st
</pre>
<p>
<table>
- <tr><td><code>-m s[mart]</code></td><td>waits for clients to
- disconnect, and shutdown (default)</td></tr>
- <tr><td><code>-m f[ast]</code></td><td>does not wait for clients;
- shutdown immediately</td></tr>
- <tr><td><code>-m i[mmediate]</code></td><td>the same as <code>'-m
- f'</code></td></tr> </table>
+ <tr><td><code>-m s[mart]</code><br/><code>--mode s[mart]</code></td>
+ <td>waits for clients to disconnect, and shutdown (default)</td></tr>
+ <tr><td><code>-m f[ast]</code><br/><code>--mode f[ast]</code></td>
+ <td>does not wait for clients; shutdown immediately</td></tr>
+ <tr><td><code>-m i[mmediate]</code><br/><code>--mode i[mmediate]</code></td>
+ <td>the same as <code>'-m f'</code></td></tr> </table>
</p>
<h1><a name="online-recovery"></a>Online Recovery</h1>
diff --git a/main.c b/main.c
index 634debc75..dab929dbe 100644
--- a/main.c
+++ b/main.c
@@ -619,20 +619,32 @@ static void show_version(void)
static void usage(void)
{
- fprintf(stderr, "%s version %s(%s),\n", PACKAGE, VERSION, PGPOOLVERSION);
+ fprintf(stderr, "%s version %s (%s),\n", PACKAGE, VERSION, PGPOOLVERSION);
fprintf(stderr, " a generic connection pool/replication/load balance server for PostgreSQL\n\n");
- fprintf(stderr, "usage: pgpool [-c][-f config_file][-F pcp_config_file][-a hba_file][-n][-d]\n");
- fprintf(stderr, "usage: pgpool [-f config_file][-F pcp_config_file][-a hba_file] [-m {s[mart]|f[ast]|i[mmediate]}] stop\n");
- fprintf(stderr, "usage: pgpool [-f config_file][-F pcp_config_file][-a hba_file] reload\n");
- fprintf(stderr, "usage: pgpool -h\n");
- fprintf(stderr, " config_file default path: %s/%s\n",DEFAULT_CONFIGDIR, POOL_CONF_FILE_NAME);
- fprintf(stderr, " pcp_config_file default path: %s/%s\n", DEFAULT_CONFIGDIR, PCP_PASSWD_FILE_NAME);
- fprintf(stderr, " hba_file default path: %s/%s\n",DEFAULT_CONFIGDIR, HBA_CONF_FILE_NAME);
- fprintf(stderr, " -c: clears query cache. enable_query_cache must be on\n");
- fprintf(stderr, " -n: don't run in daemon mode. does not detach control tty\n");
- fprintf(stderr, " -d: debug mode. lots of debug information will be printed\n");
- fprintf(stderr, " stop: stop pgpool\n");
- fprintf(stderr, " -h: print this help\n");
+ fprintf(stderr, "Usage:\n");
+ fprintf(stderr, " pgpool [ -c] [ -f CONFIG_FILE ] [ -F PCP_CONFIG_FILE ] [ -a HBA_CONFIG_FILE ]\n");
+ fprintf(stderr, " [ -n ] [ -d ]\n");
+ fprintf(stderr, " pgpool [ -f CONFIG_FILE ] [ -F PCP_CONFIG_FILE ] [ -a HBA_CONFIG_FILE ]\n");
+ fprintf(stderr, " [ -m SHUTDOWN-MODE ] stop\n");
+ fprintf(stderr, " pgpool [ -f CONFIG_FILE ] [ -F PCP_CONFIG_FILE ] [ -a HBA_CONFIG_FILE ] reload\n\n");
+ fprintf(stderr, "Common options:\n");
+ fprintf(stderr, " -a HBA_CONFIG_FILE Sets the path to the pool_hba.conf configuration file\n");
+ fprintf(stderr, " (default: %s/%s)\n",DEFAULT_CONFIGDIR, HBA_CONF_FILE_NAME);
+ fprintf(stderr, " -f CONFIG_FILE Sets the path to the pgpool.conf configuration file\n");
+ fprintf(stderr, " (default: %s/%s)\n",DEFAULT_CONFIGDIR, POOL_CONF_FILE_NAME);
+ fprintf(stderr, " -F PCP_CONFIG_FILE Sets the path to the pcp.conf configuration file\n");
+ fprintf(stderr, " (default: %s/%s)\n",DEFAULT_CONFIGDIR, PCP_PASSWD_FILE_NAME);
+ fprintf(stderr, " -h Prints this help\n\n");
+ fprintf(stderr, "Start options:\n");
+ fprintf(stderr, " -c Clears query cache (enable_query_cache must be on)\n");
+ fprintf(stderr, " -n Don't run in daemon mode, does not detach control tty\n");
+ fprintf(stderr, " -d Debug mode\n\n");
+ fprintf(stderr, "Stop options:\n");
+ fprintf(stderr, " -m SHUTDOWN-MODE Can be \"smart\", \"fast\", or \"immediate\"\n\n");
+ fprintf(stderr, "Shutdown modes are:\n");
+ fprintf(stderr, " smart quit after all clients have disconnected\n");
+ fprintf(stderr, " fast quit directly, with proper shutdown\n");
+ fprintf(stderr, " immediate quit without complete shutdown; will lead to recovery on restart\n");
}
/*
diff --git a/pgpool.8.in b/pgpool.8.in
index ad90b7568..eaac58db4 100644
--- a/pgpool.8.in
+++ b/pgpool.8.in
@@ -1,7 +1,7 @@
-.\" Copyright 2004-2007 by PgPool Global Development Group
+.\" Copyright 2004-2009 by PgPool Global Development Group
.\" This man page is subject to the same license as the rest of pgpool.
.\"
-.TH PGPOOL 8 "27 Jan 2006"
+.TH PGPOOL 8 "08 Mar 2009"
.\" Please adjust this date whenever revising the manpage.
.hy 0
.ad l
@@ -9,13 +9,12 @@
.SH NAME
pgpool \- PostgreSQL connection pool daemon
.SH SYNOPSIS
-\fBpgpool\fR [ \fB\-d\fR ] [ \fB\-f\fR \fIfile\fR ] [ \fB\-n\fR ] [ \fB\-h\fR ]
+\fBpgpool\fR [ \fB\-c\fR] [ \fB\-f config_file\fR ] [ \fB\-F pcp_config_file\fR ] [ \fB\-a hba_file\fR ] [ \fB\-n\fR ] [ \fB\-d\fR ]
.LP
-\fBpgpool\fR [ \fB\-d\fR ] [ \fB\-f\fR \fIfile\fR ] [ \fB\-m\fR \fImode\fR ] \fBstop\fR
+\fBpgpool\fR [ \fB\-f config_file\fR ] [ \fB\-F pcp_config_file\fR ] [ \fB\-a hba_file\fR ] [ \fB\-m\fR \fI{s[mart]|f[ast]|i[mmediate]}\fR ] \fBstop\fR
.LP
-\fBpgpool\fR [ \fB\-d\fR ] [ \fB\-f\fR \fIfile\fR ] \fBreload\fR
+\fBpgpool\fR [ \fB\-f config_file\fR ] [ \fB\-F pcp_config_file\fR ] [ \fB\-a hba_file\fR ] \fBreload\fR
.LP
-\fBpgpool\fR [ \fB\-d\fR ] [ \fB\-f\fR \fIfile\fR ] [ \fB\-m\fR \fImode\fR ] [ \fB-s\fR \fBm\fR[\fBaster\fR] | \fBs\fR[\fBecondary\fR] ] \fBswitch\fR
.SH DESCRIPTION
\fBpgpool\fR is a connection pool server for PostgreSQL.
\fBpgpool\fR runs between PostgreSQL's client and server.
@@ -38,29 +37,52 @@ Starts as a daemon in the background (unless \fB\-n\fR is given).
\fBpgpool\fP [ \fIoptions...\fP ] \fBstop\fP
Shutdown.
.TP
-\fBpgpool\fP [ \fIoptions...\fP ] \fBswitch\fP
-Switch between master
-and secondary servers. If only one server is configured, this will only
-restart the child processes.
+\fBpgpool\fP [ \fIoptions...\fP ] \fBreload\fP
+Reloads the configuration.
..
.SH OPTIONS
.TP
+\fB\-a\fR \fIpath\fR
+.P
+.B \--hba-file\fR \fIpath\fR
+Sets the path to the \fIpool_hba.conf\fR configuration file (default: \fI@sysconfdir@/pgpool_hba.conf\fR).
+.TP
+\fB\-c\fR
+.P
+.B \--clear-cache
+Clears the query cache.
+.TP
\fB\-d\fR
+.P
+.B \--debug
Print lots of debug messages.
.TP
\fB\-f\fR \fIpath\fR
-Sets the path to the configuration file (default: \fI@sysconfdir@/pgpool.conf\fR).
+.P
+.B \--config-file\fR \fIpath\fR
+Sets the path to the \fIpgpool.conf\fR configuration file (default: \fI@sysconfdir@/pgpool.conf\fR).
+.TP
+\fB\-F\fR \fIpath\fR
+.P
+.B \--pcp-config-file\fR \fIpath\fR
+Sets the path to the \fIpcp.conf\fR configuration file (default: \fI@sysconfdir@/pcp.conf\fR).
.TP
\fB\-h\fR
+.P
+.B \--help
Print a help message and exit.
.TP
\fB\-m\fR \fImode\fR
+.P
+.B \--mode\fR \fImode\fR
Shutdown mode:
.B smart, fast,
or
.BR immediate .
.TP
\fB\-n\fR
+.P
+.B \--no-daemon
Foreground mode.
Error messages go to stdout or stderr, which
could be piped out to log processors such as
@@ -71,17 +93,21 @@ To daemonize, explicitly invoke
.B pgpool
in background.
.TP
-\fB\-s\fR \fBm\fR[\fBaster\fR] | \fBs\fR[\fBecondary\fR]
-Determines which server to switch away from.
-Default is to drop the master.
-.TP
.B \-v
+.P
+.B \--version
Print version and exit.
.
.SH FILES
.TP
\fI@sysconfdir@/pgpool.conf\fR
Default configuration file
+.TP
+\fI@sysconfdir@/pool_hba.conf\fR
+Host Based Access configuration file
+.TP
+\fI@sysconfdir@/pcp.conf\fR
+PCP commands configuration file
.SH SEE ALSO
.BR logger (1),
.BR postmaster (1),
[parent: 778a8fff6a4e]