Skip to content

P
Postgres FD Implementation
Commit c0865903 authored by Peter Eisentraut's avatar Peter Eisentraut
Browse files
Options

Assorted reference page updates

parent 3379f7b9
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 570 additions and 563 deletions
doc/src/sgml/ref/clusterdb.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.4 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.5 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -33,8 +33,8 @@ PostgreSQL documentation
<title>Description</title>
<para>
<application>clusterdb</application> is a utility for re-clustering tables
in a <productname>PostgreSQL</productname> database. It finds table(s)
<application>clusterdb</application> is a utility for reclustering tables
in a <productname>PostgreSQL</productname> database. It finds tables
that have previously been clustered, and clusters them again on the same
index that was last used. Tables that have never been clustered are not
touched.
......@@ -67,12 +67,22 @@ PostgreSQL documentation
<title>Options</title>
<para>
<application>clusterdb</application> accepts the following command line arguments:
<application>clusterdb</application> accepts the following command-line arguments:
<variablelist>
<varlistentry>
<term><option>-d <replaceable class="parameter">dbname</replaceable></></term>
<term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term>
<term><option>-a</></term>
<term><option>--all</></term>
<listitem>
<para>
Cluster all databases.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></></term>
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
<listitem>
<para>
Specifies the name of the database to be clustered.
......@@ -86,11 +96,22 @@ PostgreSQL documentation
</varlistentry>
<varlistentry>
<term><option>-a</></term>
<term><option>--all</></term>
<term><option>-e</></term>
<term><option>--echo</></term>
<listitem>
<para>
Cluster all databases.
Echo the commands that <application>clusterdb</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Do not display a response.
</para>
</listitem>
</varlistentry>
......@@ -110,8 +131,8 @@ PostgreSQL documentation
<para>
<application>clusterdb</application> also accepts
the following command line arguments for connection parameters:
the following command-line arguments for connection parameters:
<variablelist>
<varlistentry>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
......@@ -157,27 +178,6 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</></term>
<term><option>--echo</></term>
<listitem>
<para>
Echo the commands that <application>clusterdb</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Do not display a response.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
......@@ -250,7 +250,7 @@ PostgreSQL documentation
<literal>foo</literal> in a database named
<literal>xyzzy</literal>:
<screen>
<prompt>$ </prompt><userinput>clusterdb --verbose --table foo xyzzy</userinput>
<prompt>$ </prompt><userinput>clusterdb --table foo xyzzy</userinput>
</screen>
</para>
......
doc/src/sgml/ref/createdb.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.29 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.30 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -59,46 +59,39 @@ PostgreSQL documentation
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<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.
</para>
</listitem>
</varlistentry>
<para>
<application>createdb</application> accepts the following command-line arguments:
<variablelist>
<varlistentry>
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<term><replaceable class="parameter">dbname</replaceable></term>
<listitem>
<para>
Specifies the Internet TCP/IP port or the local Unix domain socket file
extension on which the server is listening for connections.
Specifies the name of the database to be created. The name must be
unique among all <productname>PostgreSQL</productname> databases in this installation.
The default is to create a database with the same name as the
current system user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<term><replaceable class="parameter">description</replaceable></term>
<listitem>
<para>
User name to connect as
This optionally specifies a comment to be associated with the newly created
database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-W</></term>
<term><option>--password</></term>
<term><option>-D <replaceable class="parameter">location</replaceable></></term>
<term><option>--location <replaceable class="parameter">location</replaceable></></term>
<listitem>
<para>
Force password prompt.
Specifies the alternative location for the database. See also <xref
linkend="app-initlocation">.
</para>
</listitem>
</varlistentry>
......@@ -115,11 +108,11 @@ PostgreSQL documentation
</varlistentry>
<varlistentry>
<term><option>-q</></term>
<term><option>--quiet</></term>
<term><option>-E <replaceable class="parameter">encoding</replaceable></></term>
<term><option>--encoding <replaceable class="parameter">encoding</replaceable></></term>
<listitem>
<para>
Do not display a response.
Specifies the character encoding scheme to be used in this database.
</para>
</listitem>
</varlistentry>
......@@ -135,12 +128,11 @@ PostgreSQL documentation
</varlistentry>
<varlistentry>
<term><option>-D <replaceable class="parameter">datadir</replaceable></></term>
<term><option>--location <replaceable class="parameter">datadir</replaceable></></term>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Specifies the alternative location for the database. See also <xref
linkend="app-initlocation">.
Do not display a response.
</para>
</listitem>
</varlistentry>
......@@ -154,53 +146,68 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The options <option>-D</option>, <option>-E</option>,
<option>-O</option>, and
<option>-T</option> correspond to options of the underlying
SQL command <xref linkend="SQL-CREATEDATABASE"
endterm="SQL-CREATEDATABASE-title">; see there for more information
about them.
</para>
<para>
<application>createdb</application> also accepts the following
command-line arguments for connection parameters:
<variablelist>
<varlistentry>
<term><option>-E <replaceable class="parameter">encoding</replaceable></></term>
<term><option>--encoding <replaceable class="parameter">encoding</replaceable></></term>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para>
Specifies the character encoding scheme to be used in this database.
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>
<varlistentry>
<term><replaceable class="parameter">dbname</replaceable></term>
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem>
<para>
Specifies the name of the database to be created. The name must be
unique among all <productname>PostgreSQL</productname> databases in this installation.
The default is to create a database with the same name as the
current system user.
Specifies the Internet TCP/IP port or the local Unix domain socket file
extension on which the server is listening for connections.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">description</replaceable></term>
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<listitem>
<para>
This optionally specifies a comment to be associated with the newly created
database.
User name to connect as
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-W</></term>
<term><option>--password</></term>
<listitem>
<para>
Force password prompt.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The options <option>-h</option>, <option>-p</option>, <option>-U</option>,
<option>-W</option>, and <option>-e</option> are passed on literally to
<xref linkend="app-psql">.
The options <option>-O</option>, <option>-D</option>,
<option>-T</option>, and
<option>-E</option> are converted into options for the underlying
SQL command <xref linkend="SQL-CREATEDATABASE"
endterm="SQL-CREATEDATABASE-title">; see there for more information
about them.
</para>
</refsect1>
......
doc/src/sgml/ref/createlang.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.27 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.28 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -46,7 +46,7 @@ PostgreSQL documentation
<application>createlang</application> because it performs a number
of checks and is much easier to use. See
<xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
for more.
for additional information.
</para>
</refsect1>
......@@ -55,7 +55,7 @@ PostgreSQL documentation
<title>Options</title>
<para>
<application>createlang</application> accepts the following command line arguments:
<application>createlang</application> accepts the following command-line arguments:
<variablelist>
<varlistentry>
......@@ -69,8 +69,8 @@ PostgreSQL documentation
</varlistentry>
<varlistentry>
<term><option>-d <replaceable class="parameter">dbname</replaceable></></term>
<term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term>
<term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></></term>
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
<listitem>
<para>
Specifies to which database the language should be added.
......@@ -117,7 +117,7 @@ PostgreSQL documentation
<para>
<application>createlang</application> also accepts
the following command line arguments for connection parameters:
the following command-line arguments for connection parameters:
<variablelist>
<varlistentry>
......
doc/src/sgml/ref/createuser.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.28 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.29 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -33,7 +33,7 @@ PostgreSQL documentation
the <literal>pg_shadow</literal> table) can create
new <productname>PostgreSQL</productname> users,
so <application>createuser</application> must be
invoked by someone who is a <productname>PostgreSQL</productname>
invoked by someone who can connect as a <productname>PostgreSQL</productname>
superuser.
</para>
......@@ -62,92 +62,103 @@ PostgreSQL documentation
<refsect1>
<title>Options</title>
<para>
<application>createuser</> accepts the following command-line arguments:
<variablelist>
<varlistentry>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<term><replaceable class="parameter">username</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 name of the <productname>PostgreSQL</productname> user to be created.
This name must be unique among all <productname>PostgreSQL</productname> users.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a</></term>
<term><option>--adduser</></term>
<listitem>
<para>
The new user is allowed to create other users.
(Note: Actually, this makes the new user a <firstterm>superuser</>.
The option is poorly named.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<term><option>-A</></term>
<term><option>--no-adduser</></term>
<listitem>
<para>
Specifies the Internet TCP/IP port or local Unix domain socket file
extension on which the server
is listening for connections.
The new user is not allowed to create other users (i.e.,
the new user is a regular user, not a superuser).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</></term>
<term><option>--echo</></term>
<term><option>-d</></term>
<term><option>--createdb</></term>
<listitem>
<para>
Echo the queries that <application>createuser</application> generates
and sends to the server.
The new user is allowed to create databases.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</></term>
<term><option>--quiet</></term>
<term><option>-D</></term>
<term><option>--no-createdb</></term>
<listitem>
<para>
Do not display a response.
The new user is not allowed to create databases.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</></term>
<term><option>--createdb</></term>
<term><option>-e</></term>
<term><option>--echo</></term>
<listitem>
<para>
The new user is allowed to create databases.
Echo the queries that <application>createuser</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D</></term>
<term><option>--no-createdb</></term>
<term><option>-E</></term>
<term><option>--encrypted</></term>
<listitem>
<para>
The new user is not allowed to create databases.
Encrypts the user's password stored in the database. If not
specified, the default is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a</></term>
<term><option>--adduser</></term>
<term><option>-i <replaceable class="parameter">uid</replaceable></></term>
<term><option>--sysid <replaceable class="parameter">uid</replaceable></></term>
<listitem>
<para>
The new user is allowed to create other users.
(Note: Actually, this makes the new user a <firstterm>superuser</>.
The option is poorly named.)
Allows you to pick a non-default user ID for the new user. This is not
necessary, but some people like it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-A</></term>
<term><option>--no-adduser</></term>
<term><option>-N</></term>
<term><option>--unencrypted</></term>
<listitem>
<para>
The new user is not allowed to create other users (i.e.,
the new user is a regular user not a superuser).
Does not encrypt the user's password stored in the database. If
not specified, the default is used.
</para>
</listitem>
</varlistentry>
......@@ -165,60 +176,74 @@ PostgreSQL documentation
</varlistentry>
<varlistentry>
<term><option>-i <replaceable class="parameter">uid</replaceable></></term>
<term><option>--sysid <replaceable class="parameter">uid</replaceable></></term>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Allows you to pick a non-default user id for the new user. This is not
necessary, but some people like it.
Do not display a response.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
You will be prompted for a name and other missing information if it
is not specified on the command line.
</para>
<para>
<application>createuser</application> also accepts the following
command-line arguments for connection parameters:
<variablelist>
<varlistentry>
<term><option>-E</></term>
<term><option>--encrypted</></term>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para>
Encrypts the user's password stored in the database. If not
specified, the default is used.
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>
<varlistentry>
<term><option>-N</></term>
<term><option>--unencrypted</></term>
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem>
<para>
Does not encrypt the user's password stored in the database. If
not specified, the default is used.
Specifies the Internet TCP/IP port or local Unix domain socket file
extension on which the server
is listening for connections.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">username</replaceable></term>
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<listitem>
<para>
Specifies the name of the <productname>PostgreSQL</productname> user to be created.
This name must be unique among all <productname>PostgreSQL</productname> users.
User name to connect as (not the user name to create)
</para>
</listitem>
</varlistentry>
</variablelist>
</varlistentry>
<para>
You will be prompted for a name and other missing information if it is not
specified on the command line.
</para>
<para>
The options <literal>-h</literal>, <literal>-p</literal>, and <literal>-e</literal>,
are passed on literally to <xref linkend="APP-PSQL">. The
<application>psql</application> options <literal>-U</literal> and <literal>-W</literal>
are available as well, but their use can be confusing in this context.
</para>
<varlistentry>
<term><option>-W</></term>
<term><option>--password</></term>
<listitem>
<para>
Force password prompt (to connect to the server, not for the
password of the new user).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
......
doc/src/sgml/ref/dropdb.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.18 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.19 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -50,102 +50,107 @@ PostgreSQL documentation
<refsect1>
<title>Options</title>
<title>Options</title>
<para>
<application>dropdb</> accepts the following command-line arguments:
<variablelist>
<varlistentry>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<term><replaceable class="parameter">dbname</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 name of the database to be removed. The database
must be one of the existing <productname>PostgreSQL</productname> databases
in this installation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<term><option>-e</></term>
<term><option>--echo</></term>
<listitem>
<para>
Specifies the Internet TCP/IP port or local Unix domain socket file
extension on which the server
is listening for connections.
Echo the queries that <application>dropdb</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<term><option>-i</></term>
<term><option>--interactive</></term>
<listitem>
<para>
User name to connect as
Issues a verification prompt before doing anything destructive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-W</></term>
<term><option>--password</></term>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Force password prompt.
Do not display a response.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<application>createdb</application> also accepts the following
command-line arguments for connection parameters:
<variablelist>
<varlistentry>
<term><option>-e</></term>
<term><option>--echo</></term>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para>
Echo the queries that <application>dropdb</application> generates
and sends to the server.
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>
<varlistentry>
<term><option>-q</></term>
<term><option>--quiet</></term>
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem>
<para>
Do not display a response.
Specifies the Internet TCP/IP port or local Unix domain socket file
extension on which the server
is listening for connections.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-i</></term>
<term><option>--interactive</></term>
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<listitem>
<para>
Issues a verification prompt before doing anything destructive.
User name to connect as
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="parameter">dbname</replaceable></term>
<term><option>-W</></term>
<term><option>--password</></term>
<listitem>
<para>
Specifies the name of the database to be removed. The database
must be one of the existing <productname>PostgreSQL</productname> databases
in this installation.
Force password prompt.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The options <literal>-h</literal>, <literal>-p</literal>, <literal>-U</literal>,
<literal>-W</literal>, and <literal>-e</literal> are passed on literally to
<xref linkend="APP-PSQL">.
</para>
</variablelist>
</para>
</refsect1>
......
doc/src/sgml/ref/dropuser.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.21 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.22 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -54,39 +54,38 @@ PostgreSQL documentation
<refsect1>
<title>Options</title>
<para>
<application>dropuser</application> accepts the following command-line arguments:
<variablelist>
<varlistentry>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<term><replaceable class="parameter">username</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 name of the <productname>PostgreSQL</productname> user to be removed.
This name must exist in the <productname>PostgreSQL</productname> installation.
You will be prompted for a name if none is specified on the command line.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<term><option>-e</></term>
<term><option>--echo</></term>
<listitem>
<para>
Specifies the Internet TCP/IP port or local Unix domain socket file
extension on which the server
is listening for connections.
Echo the queries that <application>dropuser</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</></term>
<term><option>--echo</></term>
<term><option>-i</></term>
<term><option>--interactive</></term>
<listitem>
<para>
Echo the queries that <application>dropuser</application> generates
and sends to the server.
Prompt for confirmation before actually removing the user.
</para>
</listitem>
</varlistentry>
......@@ -100,35 +99,61 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<application>createuser</application> also accepts the following
command-line arguments for connection parameters:
<variablelist>
<varlistentry>
<term><option>-i</></term>
<term><option>--interactive</></term>
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
<listitem>
<para>
Prompt for confirmation before actually removing the user.
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>
<varlistentry>
<term><replaceable class="parameter">username</replaceable></term>
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
<listitem>
<para>
Specifies the name of the <productname>PostgreSQL</productname> user to be removed.
This name must exist in the <productname>PostgreSQL</productname> installation.
You will be prompted for a name if none is specified on the command line.
Specifies the Internet TCP/IP port or local Unix domain socket file
extension on which the server
is listening for connections.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The options <literal>-h</literal>, <literal>-p</literal>, and <literal>-e</literal>,
are passed on literally to <xref linkend="APP-PSQL">. The
<application>psql</application> options <literal>-U</literal> and <literal>-W</literal>
are available as well, but they can be confusing in this context.
</para>
<varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
<listitem>
<para>
User name to connect as (not the user name to drop)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-W</></term>
<term><option>--password</></term>
<listitem>
<para>
Force password prompt (to connect to the server, not for the
password of the user to be dropped).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
......
doc/src/sgml/ref/initdb.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.22 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.23 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -18,32 +18,12 @@ PostgreSQL documentation
<refsynopsisdiv>
<cmdsynopsis>
<command>initdb</command>
<group choice="plain">
<arg>--pgdata </arg>
<arg>-D </arg>
<replaceable>directory</replaceable>
</group>
<group>
<arg>--username </arg>
<arg>-U </arg>
<replaceable>username</replaceable>
</group>
<group><arg>--pwprompt</arg><arg>-W</arg></group>
<group>
<arg>--encoding </arg>
<arg>-E </arg>
<replaceable>encoding</replaceable>
</group>
<arg>--locale <replaceable>locale</replaceable></arg>
<arg>--lc-collate <replaceable>locale</replaceable></arg>
<arg>--lc-ctype <replaceable>locale</replaceable></arg>
<arg>--lc-messages <replaceable>locale</replaceable></arg>
<arg>--lc-monetary <replaceable>locale</replaceable></arg>
<arg>--lc-numeric <replaceable>locale</replaceable></arg>
<arg>--lc-time <replaceable>locale</replaceable></arg>
<arg>-L <replaceable>directory</replaceable></arg>
<group><arg>--noclean</arg><arg>-n</arg></group>
<group><arg>--debug</arg><arg>-d</arg></group>
<arg rep="repeat">options</arg>
<group choice="plain">
<arg>--pgdata </arg>
<arg>-D </arg>
<replaceable>directory</replaceable>
</group>
</cmdsynopsis>
</refsynopsisdiv>
......@@ -107,15 +87,16 @@ PostgreSQL documentation
<command>su</command> to become the database user, and
finally run <command>initdb</command> as the database user.
</para>
</refsect1>
<refsect2>
<title>Options</title>
<refsect1>
<title>Options</title>
<para>
<variablelist>
<varlistentry>
<term><option>--pgdata=<replaceable class="parameter">directory</replaceable></option></term>
<term><option>-D <replaceable class="parameter">directory</replaceable></option></term>
<term><option>--pgdata=<replaceable class="parameter">directory</replaceable></option></term>
<listitem>
<para>
This option specifies the directory where the database system
......@@ -130,37 +111,8 @@ PostgreSQL documentation
</varlistentry>
<varlistentry>
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
<listitem>
<para>
Selects the user name of the database superuser. This defaults
to the name of the effective user running
<command>initdb</command>. It is really not important what the
superuser's name is, but one might choose to keep the
customary name <systemitem>postgres</systemitem>, even if the operating
system user's name is different.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--pwprompt</option></term>
<term><option>-W</option></term>
<listitem>
<para>
Makes <command>initdb</command> prompt for a password
to give the database superuser. If you don't plan on using password
authentication, this is not important. Otherwise you won't be
able to use password authentication until you have a password
set up.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--encoding=<replaceable class="parameter">encoding</replaceable></option></term>
<term><option>-E <replaceable class="parameter">encoding</replaceable></option></term>
<term><option>--encoding=<replaceable class="parameter">encoding</replaceable></option></term>
<listitem>
<para>
Selects the encoding of the template database. This will also
......@@ -198,13 +150,56 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
<listitem>
<para>
Selects the user name of the database superuser. This defaults
to the name of the effective user running
<command>initdb</command>. It is really not important what the
superuser's name is, but one might choose to keep the
customary name <systemitem>postgres</systemitem>, even if the operating
system user's name is different.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-W</option></term>
<term><option>--pwprompt</option></term>
<listitem>
<para>
Makes <command>initdb</command> prompt for a password
to give the database superuser. If you don't plan on using password
authentication, this is not important. Otherwise you won't be
able to use password authentication until you have a password
set up.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Other, less commonly used, parameters are also available:
<variablelist>
<varlistentry>
<term><option>-d</option></term>
<term><option>--debug</option></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-L <replaceable class="parameter">directory</replaceable></option></term>
<listitem>
......@@ -230,25 +225,9 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<term><option>--debug</option></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsect1>
<refsect1>
......
doc/src/sgml/ref/initlocation.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.16 2002/07/28 15:22:20 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.17 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -41,7 +41,6 @@ PostgreSQL documentation
<refsect1 id="R1-APP-INITLOCATION-2">
<title>Examples</title>
<informalexample>
<para>
To create a database in an alternate location, using an
environment variable:
......@@ -56,9 +55,7 @@ PostgreSQL documentation
<prompt>$</prompt> <userinput>createdb -D PGDATA2 testdb</userinput>
</screen>
</para>
</informalexample>
<informalexample>
<para>
Alternatively, if you allow absolute paths you could write:
<screen>
......@@ -66,7 +63,6 @@ PostgreSQL documentation
<prompt>$</prompt> <userinput>createdb -D /opt/postgres/data/testdb testdb</userinput>
</screen>
</para>
</informalexample>
</refsect1>
<refsect1>
......
doc/src/sgml/ref/pg_config-ref.sgml
View file @ c0865903
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.10 2002/04/21 19:02:39 thomas Exp $ -->
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_config-ref.sgml,v 1.11 2002/10/11 23:03:48 petere Exp $ -->
<refentry id="app-pgconfig">
<refmeta>
......@@ -60,7 +60,7 @@
<term><option>--includedir</option></>
<listitem>
<para>
Print the location of C and C++ header files of the client interfaces.
Print the location of C header files of the client interfaces.
</para>
</listitem>
</varlistentry>
......@@ -69,7 +69,7 @@
<term><option>--includedir-server</option></>
<listitem>
<para>
Print the location of C and C++ header files for server
Print the location of C header files for server
programming.
</para>
</listitem>
......
doc/src/sgml/ref/pg_ctl-ref.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.16 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.17 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -125,10 +125,12 @@ PostgreSQL documentation
and if so displays the <acronym>PID</acronym> and the command line
options that were used to invoke it.
</para>
</refsect1>
<refsect2 id="app-pg-ctl-options">
<title>Options</title>
<para>
<refsect1 id="app-pg-ctl-options">
<title>Options</title>
<para>
<variablelist>
<varlistentry>
......@@ -224,7 +226,6 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsect1>
......
doc/src/sgml/ref/pg_dump.sgml
View file @ c0865903
This diff is collapsed.
doc/src/sgml/ref/pg_restore.sgml
View file @ c0865903
This diff is collapsed.
doc/src/sgml/ref/postgres-ref.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.27 2002/07/28 15:22:21 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.28 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -101,15 +101,16 @@ PostgreSQL documentation
<para>
When running a stand-alone backend, the session user will be set to
the user with id 1. This user does not actually have to exist, so
the user with ID 1. This user does not actually have to exist, so
a stand-alone backend can be used to manually recover from certain
kinds of accidental damage to the system catalogs. Implicit
superuser powers are granted to the user with id 1 in stand-alone
superuser powers are granted to the user with ID 1 in stand-alone
mode.
</para>
</refsect1>
<refsect2>
<title>Options</title>
<refsect1>
<title>Options</title>
<para>
When <application>postgres</application> is started by a <xref
......@@ -131,7 +132,7 @@ PostgreSQL documentation
<application>postgres</application> command-line options.
</para>
<refsect3>
<refsect2>
<title>General Purpose</title>
<para>
......@@ -210,9 +211,9 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect3>
<refsect2>
<title>Options for stand-alone mode</title>
<variablelist>
......@@ -244,9 +245,9 @@ PostgreSQL documentation
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect3>
<refsect2>
<title>Semi-internal Options</title>
<para>
......@@ -345,8 +346,7 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
</refsect2>
</refsect1>
<refsect1>
......
doc/src/sgml/ref/postmaster.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.32 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.33 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -72,9 +72,11 @@ PostgreSQL documentation
communication ports (see below). A data area is created with <xref
linkend="app-initdb">.
</para>
</refsect1>
<refsect1 id="app-postmaster-options">
<title>Options</title>
<refsect2 id="app-postmaster-options">
<title>Options</title>
<para>
<application>postmaster</application> accepts the following
command line arguments. For a detailed discussion of the options
......@@ -336,7 +338,6 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsect1>
......@@ -580,6 +581,15 @@ StreamServerPort: cannot bind to port
</para>
</tip>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<xref linkend="app-initdb">,
<xref linkend="app-pg-ctl">
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/psql-ref.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.77 2002/09/22 20:44:22 tgl Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.78 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -43,12 +43,6 @@ PostgreSQL documentation
<refsect1 id="R1-APP-PSQL-3">
<title>Options</title>
<para>
If so configured, <application>psql</application> understands both
standard Unix short options, and <acronym>GNU</acronym>-style long
options. The latter are not available on all systems.
</para>
<variablelist>
<varlistentry>
<term><option>-a</></term>
......@@ -452,6 +446,10 @@ PostgreSQL documentation
</listitem>
</varlistentry>
</variablelist>
<para>
Long options are not available on all platforms.
</para>
</refsect1>
......
doc/src/sgml/ref/vacuumdb.sgml
View file @ c0865903
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.26 2002/09/21 18:32:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.27 2002/10/11 23:03:48 petere Exp $
PostgreSQL documentation
-->
......@@ -75,12 +75,12 @@ PostgreSQL documentation
<title>Options</title>
<para>
<application>vacuumdb</application> accepts the following command line arguments:
<application>vacuumdb</application> accepts the following command-line arguments:
<variablelist>
<varlistentry>
<term><option>-d <replaceable class="parameter">dbname</replaceable></option></term>
<term><option>--dbname <replaceable class="parameter">dbname</replaceable></option></term>
<term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></option></term>
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></option></term>
<listitem>
<para>
Specifies the name of the database to be cleaned or analyzed.
......@@ -103,32 +103,34 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option></term>
<term><option>--full</option></term>
<term><option>-e</></term>
<term><option>--echo</></term>
<listitem>
<para>
Perform <quote>full</quote> vacuuming.
Echo the commands that <application>vacuumdb</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<term><option>-f</option></term>
<term><option>--full</option></term>
<listitem>
<para>
Print detailed information during processing.
Perform <quote>full</quote> vacuuming.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-z</option></term>
<term><option>--analyze</option></term>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Calculate statistics for use by the optimizer.
Do not display a response.
</para>
</listitem>
</varlistentry>
......@@ -151,12 +153,31 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem>
<para>
Print detailed information during processing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-z</option></term>
<term><option>--analyze</option></term>
<listitem>
<para>
Calculate statistics for use by the optimizer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<application>vacuumdb</application> also accepts
the following command line arguments for connection parameters:
the following command-line arguments for connection parameters:
<variablelist>
<varlistentry>
......@@ -203,27 +224,6 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</></term>
<term><option>--echo</></term>
<listitem>
<para>
Echo the commands that <application>vacuumdb</application> generates
and sends to the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</></term>
<term><option>--quiet</></term>
<listitem>
<para>
Do not display a response.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment