diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml new file mode 100644 index df84054..b3fc57d *** a/doc/src/sgml/ref/allfiles.sgml --- b/doc/src/sgml/ref/allfiles.sgml *************** Complete list of usable sgml source file *** 175,180 **** --- 175,181 ---- + diff --git a/doc/src/sgml/ref/pg_isready.sgml b/doc/src/sgml/ref/pg_isready.sgml new file mode 100644 index ...4b25fd9 *** a/doc/src/sgml/ref/pg_isready.sgml --- b/doc/src/sgml/ref/pg_isready.sgml *************** *** 0 **** --- 1,200 ---- + + + + + pg_isready + 1 + Application + + + + pg_isready + checks the connection status of a PostgreSQL server + + + + pg_isready + + + + + pg_isready + connection-option + option + + + + + + Description + + pg_isready is a utility for checking the connection + status of a PostgreSQL database server. The exit + status specifies the result of the connection check. + + + + + Options + + + + + + + + + Specifies the name of the database to connect to. + + + If this parameter contains an = sign or starts + with a valid URI prefix + (postgresql:// + or postgres://), it is treated as a + conninfo string. See for more information. + + + + + + + + + + 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. + + + + + + + + + + Specifies the TCP port or the local Unix-domain + socket file extension on which the server is listening for + connections. Defaults to the value of the PGPORT + environment variable or, if not set, to the port specified at + compile time, usually 5432. + + + + + + + + + + Do not display status message. This is useful when scripting. + + + + + + + + + + Connect to the database as the user username instead of the default. + + + + + + + + + + Print the pg_isready version and exit. + + + + + + + + + + Show help about pg_isready command line + arguments, and exit. + + + + + + + + Exit Status + + + pg_isready returns 0 to the shell if the server + is accepting connections normally, 1 if the server is rejecting + connections (for example during startup), 2 if there was no response to the + connection attempt, and 3 if no attempt was made (for example due to invalid + parameters). + + + + + Environment + + + pg_isready, like most other PostgreSQL + utilities, + also uses the environment variables supported by libpq + (see ). + + + + + Notes + + + The options + + + + Examples + + + Standard Usage: + + $ pg_isready + /tmp:5432 - Accepting Connections + $ echo $? + 0 + + + + + Running with connection parameters to a PostgreSQL cluster in startup: + + $ pg_isready -h localhost -p 5433 + localhost:5433 - Rejecting Connections + $ echo $? + 1 + + + + + Running with connection parameters to a non-responsive PostgreSQL cluster: + + $ pg_isready -h someremotehost + someremotehost:5432 - No Response + $ echo $? + 2 + + + + + + diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml new file mode 100644 index 0872168..fe90227 *** a/doc/src/sgml/reference.sgml --- b/doc/src/sgml/reference.sgml *************** *** 223,228 **** --- 223,229 ---- &pgConfig; &pgDump; &pgDumpall; + &pgIsready; &pgReceivexlog; &pgRestore; &psqlRef;