git.8kb.co.uk Git - pgpool-ii/pgpool-ii_2.2.5/blob - pgpool.8.in

   1 .\" Copyright 2004-2009 by PgPool Global Development Group
   2 .\" This man page is subject to the same license as the rest of pgpool.
   3 .\"
   4 .TH PGPOOL 8 "08 Mar 2009"
   5 .\" Please adjust this date whenever revising the manpage.
   6 .hy 0
   7 .ad l
   8 .nf
   9 .SH NAME
  10 pgpool \- PostgreSQL connection pool daemon
  11 .SH SYNOPSIS
  12 \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 ]
  13 .LP
  14 \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
  15 .LP
  16 \fBpgpool\fR [ \fB\-f config_file\fR ] [ \fB\-F pcp_config_file\fR ] [ \fB\-a hba_file\fR ] \fBreload\fR
  17 .LP
  18 .SH DESCRIPTION
  19 \fBpgpool\fR is a connection pool server for PostgreSQL.
  20 \fBpgpool\fR runs between PostgreSQL's client and server.
  21 Any PostgreSQL client can connect to \fBpgpool\fR as if it's a real PostgreSQL server.
  22 \fBpgpool\fR caches the connection to the PostgreSQL server to reduce the overhead
  23 involved in establishing the connection to it.
  24 .P
  25 \fBpgpool\fR can also be
  26 used with two PostgreSQL servers for fail over purposes.  If the first
  27 server goes down, \fBpgpool\fR will automatically switch to the secondary server.
  28 .P
  29 \fBpgpool\fR is typically started and stopped via system initialization scripts.
  30 .
  31 .P
  32 .SH INVOCATION
  33 .TP
  34 \fBpgpool\fP [ \fIoptions...\fP ]
  35 Starts as a daemon in the background (unless \fB\-n\fR is given).
  36 .TP
  37 \fBpgpool\fP [ \fIoptions...\fP ] \fBstop\fP
  38 Shutdown.
  39 .TP
  40 \fBpgpool\fP [ \fIoptions...\fP ] \fBreload\fP
  41 Reloads the configuration.
  42 ..
  43 .SH OPTIONS
  44 .TP
  45 \fB\-a\fR \fIpath\fR
  46 Sets the path to the \fIpool_hba.conf\fR configuration file (default: \fI@sysconfdir@/pgpool_hba.conf\fR).
  47 .TP
  48 \fB\-c\fR
  49 Clears the query cache.
  50 .TP
  51 \fB\-d\fR
  52 Print lots of debug messages.
  53 .TP
  54 \fB\-f\fR \fIpath\fR
  55 Sets the path to the \fIpgpool.conf\fR configuration file (default: \fI@sysconfdir@/pgpool.conf\fR).
  56 .TP
  57 \fB\-F\fR \fIpath\fR
  58 Sets the path to the \fIpcp.conf\fR configuration file (default: \fI@sysconfdir@/pcp.conf\fR).
  59 .TP
  60 \fB\-h\fR
  61 Print a help message and exit.
  62 .TP
  63 \fB\-m\fR \fImode\fR
  64 Shutdown mode:
  65 .B smart, fast,
  66 or
  67 .BR immediate .
  68 .TP
  69 \fB\-n\fR
  70 Foreground mode.
  71 Error messages go to stdout or stderr, which
  72 could be piped out to log processors such as
  73 .BR logger (1)
  74 or
  75 .BR rotatelogs (8).
  76 To daemonize, explicitly invoke
  77 .B pgpool
  78 in background.
  79 .TP
  80 .B \-v
  81 Print version and exit.
  82 .
  83 .SH FILES
  84 .TP
  85 \fI@sysconfdir@/pgpool.conf\fR
  86 Default configuration file
  87 .TP
  88 \fI@sysconfdir@/pool_hba.conf\fR
  89 Host Based Access configuration file
  90 .TP
  91 \fI@sysconfdir@/pcp.conf\fR
  92 PCP commands configuration file
  93 .SH SEE ALSO
  94 .BR logger (1),
  95 .BR postmaster (1),
  96 .BR rotatelogs (8)
  97 .PP
  98 Additional information can be found in the \fBpgpool\fR \fIREADME\fR file.