in the future.
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.19 2007/02/20 18:10:58 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.20 2007/02/21 23:21:11 momjian Exp $
PostgreSQL documentation
-->
<term><option>--all</></term>
<listitem>
<para>
- Cluster all databases.
+ Cluster all databases.
</para>
</listitem>
</varlistentry>
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
<listitem>
<para>
- Specifies the name of the database to be clustered.
- If this is not specified and <option>-a</option> (or
- <option>--all</option>) is not used, the database name is read
- from the environment variable <envar>PGDATABASE</envar>. If
- that is not set, the user name specified for the connection is
- used.
+ Specifies the name of the database to be clustered.
+ If this is not specified and <option>-a</option> (or
+ <option>--all</option>) is not used, the database name is read
+ from the environment variable <envar>PGDATABASE</envar>. If
+ that is not set, the user name specified for the connection is
+ used.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Echo the commands that <application>clusterdb</application> generates
- and sends to the server.
+ and sends to the server.
</para>
</listitem>
</varlistentry>
<term><option>--table <replaceable class="parameter">table</replaceable></></term>
<listitem>
<para>
- Cluster <replaceable class="parameter">table</replaceable> only.
+ Cluster <replaceable class="parameter">table</replaceable> only.
</para>
</listitem>
</varlistentry>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para>
- 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 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.
</para>
</listitem>
</varlistentry>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem>
<para>
- Specifies the TCP port or local Unix domain socket file
- extension on which the server
- is listening for connections.
+ Specifies the TCP port or local Unix domain socket file
+ extension on which the server
+ is listening for connections.
</para>
</listitem>
</varlistentry>
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.29 2007/02/20 18:10:58 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.30 2007/02/21 23:21:11 momjian Exp $
PostgreSQL documentation
-->
<term><replaceable class="parameter">dbname</replaceable></term>
<listitem>
<para>
- Specifies the name of the database to be removed.
+ Specifies the name of the database to be removed.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Echo the commands that <application>dropdb</application> generates
- and sends to the server.
+ and sends to the server.
</para>
</listitem>
</varlistentry>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para>
- 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 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.
</para>
</listitem>
</varlistentry>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem>
<para>
- Specifies the TCP port or local Unix domain socket file
- extension on which the server
- is listening for connections.
+ Specifies the TCP port or local Unix domain socket file
+ extension on which the server
+ is listening for connections.
</para>
</listitem>
</varlistentry>
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.28 2007/02/20 18:10:58 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.29 2007/02/21 23:21:11 momjian Exp $
PostgreSQL documentation
-->
<term><replaceable class="parameter">langname</replaceable></term>
<listitem>
<para>
- Specifies the name of the backend programming language to be removed.
+ Specifies the name of the backend programming language to be removed.
</para>
</listitem>
</varlistentry>
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
<listitem>
<para>
- Specifies from which database the language should be removed.
+ Specifies from which database the language should be removed.
The default is to use the database with the same name as the
current system user.
</para>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para>
- Specifies the host name of the machine on which the
- server
- is running. If host begins with a slash, it is used
- as the directory for the Unix domain socket.
+ Specifies the host name of the machine on which the
+ server
+ is running. If host begins with a slash, it is used
+ as the directory for the Unix domain socket.
</para>
</listitem>
</varlistentry>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem>
<para>
- Specifies the Internet TCP/IP port or local Unix domain socket file
- extension on which the server
- is listening for connections.
+ Specifies the Internet TCP/IP port or local Unix domain socket file
+ extension on which the server
+ is listening for connections.
</para>
</listitem>
</varlistentry>
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.41 2007/02/20 18:10:58 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.42 2007/02/21 23:21:11 momjian Exp $
PostgreSQL documentation
-->
<term><option>--debug</option></term>
<listitem>
<para>
- Print debugging output from the bootstrap backend and a few other
+ Print debugging output from the bootstrap backend and a few other
messages of lesser interest for the general public.
- The bootstrap backend is the program <command>initdb</command>
- uses to create the catalog tables. This option generates a tremendous
- amount of extremely boring output.
+ The bootstrap backend is the program <command>initdb</command>
+ uses to create the catalog tables. This option generates a tremendous
+ amount of extremely boring output.
</para>
</listitem>
</varlistentry>
<term><option>--noclean</option></term>
<listitem>
<para>
- By default, when <command>initdb</command>
- determines that an error prevented it from completely creating the database
- cluster, it removes any files it might have created before discovering
- that it cannot finish the job. This option inhibits tidying-up and is
- thus useful for debugging.
+ By default, when <command>initdb</command>
+ determines that an error prevented it from completely creating the database
+ cluster, it removes any files it might have created before discovering
+ that it cannot finish the job. This option inhibits tidying-up and is
+ thus useful for debugging.
</para>
</listitem>
</varlistentry>
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.39 2007/02/20 18:10:58 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.40 2007/02/21 23:21:11 momjian Exp $
PostgreSQL documentation
-->
<term><option>-D <replaceable class="parameter">datadir</replaceable></option></term>
<listitem>
<para>
- Specifies the file system location of the database files. If
- this is omitted, the environment variable
- <envar>PGDATA</envar> is used.
+ Specifies the file system location of the database files. If
+ this is omitted, the environment variable
+ <envar>PGDATA</envar> is used.
</para>
</listitem>
</varlistentry>
<term><option>-m <replaceable class="parameter">mode</replaceable></option></term>
<listitem>
<para>
- Specifies the shutdown mode. <replaceable>mode</replaceable>
- can be <literal>smart</literal>, <literal>fast</literal>, or
- <literal>immediate</literal>, or the first letter of one of
- these three.
+ Specifies the shutdown mode. <replaceable>mode</replaceable>
+ can be <literal>smart</literal>, <literal>fast</literal>, or
+ <literal>immediate</literal>, or the first letter of one of
+ these three.
</para>
</listitem>
</varlistentry>
<command>postgres</command> command.
</para>
<para>
- The options are usually surrounded by single or double
- quotes to ensure that they are passed through as a group.
+ The options are usually surrounded by single or double
+ quotes to ensure that they are passed through as a group.
</para>
</listitem>
</varlistentry>
<term><option>-p <replaceable class="parameter">path</replaceable></option></term>
<listitem>
<para>
- Specifies the location of the <filename>postgres</filename>
- executable. By default the <filename>postgres</filename> executable is taken from the same
- directory as <command>pg_ctl</command>, or failing that, the hard-wired
- installation directory. It is not necessary to use this
- option unless you are doing something unusual and get errors
- that the <filename>postgres</filename> executable was not found.
+ Specifies the location of the <filename>postgres</filename>
+ executable. By default the <filename>postgres</filename> executable is taken from the same
+ directory as <command>pg_ctl</command>, or failing that, the hard-wired
+ installation directory. It is not necessary to use this
+ option unless you are doing something unusual and get errors
+ that the <filename>postgres</filename> executable was not found.
</para>
</listitem>
</varlistentry>
<para>
Attempt to allow server crashes to produce core files, on platforms
where this available, by lifting any soft resource limit placed on
- them.
- This is useful in debugging or diagnosing problems by allowing a
- stack trace to be obtained from a failed server process.
+ them.
+ This is useful in debugging or diagnosing problems by allowing a
+ stack trace to be obtained from a failed server process.
</para>
</listitem>
</varlistentry>
<term><option>-w</option></term>
<listitem>
<para>
- Wait for the start or shutdown to complete. Times out after
- 60 seconds. This is the default for shutdowns. A successful
+ Wait for the start or shutdown to complete. Times out after
+ 60 seconds. This is the default for shutdowns. A successful
shutdown is indicated by removal of the <acronym>PID</acronym>
file. For starting up, a successful <command>psql -l</command>
indicates success. <command>pg_ctl</command> will attempt to
<productname>PostgreSQL</productname> was compiled with
(5432 by default). When waiting, <command>pg_ctl</command> will
return an accurate exit code based on the success of the startup
- or shutdown.
+ or shutdown.
</para>
</listitem>
</varlistentry>
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.66 2007/02/20 18:10:58 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.67 2007/02/21 23:21:12 momjian Exp $
PostgreSQL documentation
-->
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term><option>-f <replaceable class="parameter">filename</replaceable></option></term>
<term><option>--file=<replaceable class="parameter">filename</replaceable></option></term>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>-l <replaceable>dbname</replaceable></term>
<term>--database=<replaceable>dbname</replaceable></term>
<!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.184 2007/02/20 18:10:58 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.185 2007/02/21 23:21:12 momjian Exp $
PostgreSQL documentation
-->
<term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term>
<listitem>
<para>
- Specifies the name of the database to connect to. This is
- equivalent to specifying <replaceable
- class="parameter">dbname</replaceable> as the first non-option
- argument on the command line.
+ Specifies the name of the database to connect to. This is
+ equivalent to specifying <replaceable
+ class="parameter">dbname</replaceable> as the first non-option
+ argument on the command line.
+ </para>
+ <para>
+ If this parameter contains an <symbol>=</symbol> sign, it it treated as a
+ <parameter>conninfo</parameter> string. See <xref linkend="libpq-connect"> for more information.
</para>
- <para>
- If this parameter contains an <symbol>=</symbol> sign, it it treated as a
- <parameter>conninfo</parameter> string. See <xref linkend="libpq-connect"> for more information.
- </para>
</listitem>
</varlistentry>
passwords. See <xref linkend="libpq-pgpass"> for more information.
</para>
- An alternative way to specify connection parameters is in a
- <parameter>conninfo</parameter> string, which is used instead of a
- database name. This mechanism give you very wide control over the
- connection. For example:
+ <para>
+ An alternative way to specify connection parameters is in a
+ <parameter>conninfo</parameter> string, which is used instead of a
+ database name. This mechanism give you very wide control over the
+ connection. For example:
<programlisting>
$ <userinput>psql "service=myservice sslmode=require"</userinput>
</programlisting>
- See <xref linkend="libpq-connect"> for more information on all the
- available connection options.
- </para>
+ See <xref linkend="libpq-connect"> for more information on all the
+ available connection options.
+ </para>
<para>
If the connection could not be made for any reason (e.g., insufficient
<term><option>--all</></term>
<listitem>
<para>
- Reindex all databases.
+ Reindex all databases.
</para>
</listitem>
</varlistentry>
<term><option>--system</></term>
<listitem>
<para>
- Reindex database's system catalogs.
+ Reindex database's system catalogs.
</para>
</listitem>
</varlistentry>
<term><option>--table <replaceable class="parameter">table</replaceable></></term>
<listitem>
<para>
- Reindex <replaceable class="parameter">table</replaceable> only.
+ Reindex <replaceable class="parameter">table</replaceable> only.
</para>
</listitem>
</varlistentry>
<term><option>--index <replaceable class="parameter">index</replaceable></></term>
<listitem>
<para>
- Recreate <replaceable class="parameter">index</replaceable> only.
+ Recreate <replaceable class="parameter">index</replaceable> only.
</para>
</listitem>
</varlistentry>
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
<listitem>
<para>
- Specifies the name of the database to be reindexed.
- If this is not specified and <option>-a</option> (or
- <option>--all</option>) is not used, the database name is read
- from the environment variable <envar>PGDATABASE</envar>. If
- that is not set, the user name specified for the connection is
- used.
+ Specifies the name of the database to be reindexed.
+ If this is not specified and <option>-a</option> (or
+ <option>--all</option>) is not used, the database name is read
+ from the environment variable <envar>PGDATABASE</envar>. If
+ that is not set, the user name specified for the connection is
+ used.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Echo the commands that <application>reindexdb</application> generates
- and sends to the server.
+ and sends to the server.
</para>
</listitem>
</varlistentry>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para>
- 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 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.
</para>
</listitem>
</varlistentry>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem>
<para>
- Specifies the TCP port or local Unix domain socket file
- extension on which the server
- is listening for connections.
+ Specifies the TCP port or local Unix domain socket file
+ extension on which the server
+ is listening for connections.
</para>
</listitem>
</varlistentry>
projects / postgresql / commitdiff