diff options
Diffstat (limited to 'doc/src/sgml/ref')
| -rw-r--r-- | doc/src/sgml/ref/create_database.sgml | 8 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_index.sgml | 12 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_table.sgml | 66 | ||||
| -rw-r--r-- | doc/src/sgml/ref/initdb.sgml | 12 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pgctl-ref.sgml | 5 | ||||
| -rw-r--r-- | doc/src/sgml/ref/postmaster.sgml | 6 | ||||
| -rw-r--r-- | doc/src/sgml/ref/vacuumdb.sgml | 40 |
7 files changed, 79 insertions, 70 deletions
diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index 00dae61b2b3..1c5daa62631 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.13 2000/03/27 17:14:42 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_database.sgml,v 1.14 2000/05/02 20:02:03 thomas Exp $ Postgres documentation --> @@ -132,7 +132,7 @@ CREATE DATABASE <replaceable class="PARAMETER">name</replaceable> [ WITH LOCATIO </varlistentry> <varlistentry> - <term><computeroutput>ERROR: Unable to create database directory 'xxx'.</computeroutput></term> + <term><computeroutput>ERROR: Unable to create database directory '<replaceable>path</replaceable>'.</computeroutput></term> <term><computeroutput>ERROR: Could not initialize database directory.</computeroutput></term> <listitem> <para> @@ -164,8 +164,8 @@ CREATE DATABASE <replaceable class="PARAMETER">name</replaceable> [ WITH LOCATIO <para> An alternate location can be specified in order to, for example, store the database on a different disk. - The path must have been prepared with the <xref - linkend="APP-INITLOCATION" endterm="APP-INITLOCATION-title"> + The path must have been prepared with the + <xref linkend="APP-INITLOCATION" endterm="APP-INITLOCATION-title"> command. </para> <para> diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml index 2029a27a4ea..43d6ffe38ca 100644 --- a/doc/src/sgml/ref/create_index.sgml +++ b/doc/src/sgml/ref/create_index.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.12 2000/04/23 02:08:33 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.13 2000/05/02 20:02:03 thomas Exp $ Postgres documentation --> @@ -227,6 +227,11 @@ ERROR: Cannot create index: 'index_name' already exists. access methods). </para> + <para> + Use <xref linkend="sql-dropindex-title" endterm="sql-dropindex-title"> + to remove an index. + </para> + <refsect2 id="R2-SQL-CREATEINDEX-3"> <refsect2info> <date>1998-09-09</date> @@ -339,11 +344,6 @@ SELECT am.amname AS acc_name, </refsect2> </refsect1> - <para> - Use <xref linkend="sql-dropindex-title" endterm="sql-dropindex-title"> - to remove an index. - </para> - <refsect1 id="R1-SQL-CREATEINDEX-2"> <title> Usage diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index 7208242c26b..0e77618799f 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.28 2000/04/15 23:29:58 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.29 2000/05/02 20:02:03 thomas Exp $ Postgres documentation --> @@ -905,13 +905,12 @@ ERROR: Cannot insert a duplicate key into a unique index. REFERENCES Constraint </title> <synopsis> -[ CONSTRAINT <replaceable class="parameter">name</replaceable> ] REFERENCES -<replaceable class="parameter">reftable</replaceable> [ ( <replaceable class="parameter">refcolumn</replaceable> ) ] -[ MATCH <replaceable class="parameter">matchtype</replaceable> ] -[ ON DELETE <replaceable class="parameter">action</replaceable> ] -[ ON UPDATE <replaceable class="parameter">action</replaceable> ] -[ [ NOT ] DEFERRABLE ] -[ INITIALLY <replaceable class="parameter">checktime</replaceable> ] +[ CONSTRAINT <replaceable class="parameter">name</replaceable> ] REFERENCES <replaceable class="parameter">reftable</replaceable> [ ( <replaceable class="parameter">refcolumn</replaceable> ) ] + [ MATCH <replaceable class="parameter">matchtype</replaceable> ] + [ ON DELETE <replaceable class="parameter">action</replaceable> ] + [ ON UPDATE <replaceable class="parameter">action</replaceable> ] + [ [ NOT ] DEFERRABLE ] + [ INITIALLY <replaceable class="parameter">checktime</replaceable> ] </synopsis> <para> The REFERENCES constraint specifies a rule that a column @@ -1448,14 +1447,13 @@ CREATE TABLE distributors ( REFERENCES Constraint </title> <synopsis> -[ CONSTRAINT <replaceable class="parameter">name</replaceable> ] -FOREIGN KEY ( <replaceable class="parameter">column</replaceable> [, ...] ) REFERENCES -<replaceable class="parameter">reftable</replaceable> [ ( <replaceable class="parameter">refcolumn</replaceable> [, ...] ) ] -[ MATCH <replaceable class="parameter">matchtype</replaceable> ] -[ ON DELETE <replaceable class="parameter">action</replaceable> ] -[ ON UPDATE <replaceable class="parameter">action</replaceable> ] -[ [ NOT ] DEFERRABLE ] -[ INITIALLY <replaceable class="parameter">checktime</replaceable> ] +[ CONSTRAINT <replaceable class="parameter">name</replaceable> ] FOREIGN KEY ( <replaceable class="parameter">column</replaceable> [, ...] ) + REFERENCES <replaceable class="parameter">reftable</replaceable> [ ( <replaceable class="parameter">refcolumn</replaceable> [, ...] ) ] + [ MATCH <replaceable class="parameter">matchtype</replaceable> ] + [ ON DELETE <replaceable class="parameter">action</replaceable> ] + [ ON UPDATE <replaceable class="parameter">action</replaceable> ] + [ [ NOT ] DEFERRABLE ] + [ INITIALLY <replaceable class="parameter">checktime</replaceable> ] </synopsis> <para> The REFERENCES constraint specifies a rule that a column value is @@ -1901,7 +1899,7 @@ CREATE TEMPORARY TABLE actors ( Table Constraint definition: <synopsis> -[ CONSTRAINT name ] UNIQUE ( column [, ...] ) +[ CONSTRAINT <replaceable>name</replaceable> ] UNIQUE ( <replaceable>column</replaceable> [, ...] ) [ { INITIALLY DEFERRED | INITIALLY IMMEDIATE } ] [ [ NOT ] DEFERRABLE ] </synopsis> @@ -1911,7 +1909,7 @@ CREATE TEMPORARY TABLE actors ( Column Constraint definition: <synopsis> -[ CONSTRAINT name ] UNIQUE +[ CONSTRAINT <replaceable>name</replaceable> ] UNIQUE [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] </synopsis> @@ -1928,7 +1926,7 @@ CREATE TEMPORARY TABLE actors ( included for symmetry with the NOT NULL clause. Since it is the default for any column, its presence is simply noise. <synopsis> -[ CONSTRAINT name ] NULL +[ CONSTRAINT <replaceable>name</replaceable> ] NULL </synopsis> </para> </refsect3> @@ -1941,7 +1939,7 @@ CREATE TEMPORARY TABLE actors ( SQL92 specifies some additional capabilities for NOT NULL: <synopsis> -[ CONSTRAINT name ] NOT NULL +[ CONSTRAINT <replaceable>name</replaceable> ] NOT NULL [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] </synopsis> @@ -1965,9 +1963,7 @@ the column. Not our problem... or a domain. </para> <synopsis> - DEFAULT niladic USER function | - niladic datetime function | - NULL +DEFAULT niladic_user_function | niladic_datetime_function | NULL </synopsis> </refsect3> --> @@ -1994,7 +1990,7 @@ the column. Not our problem... as an alternate method for defining a constraint: </para> <synopsis> -CREATE ASSERTION name CHECK ( condition ) +CREATE ASSERTION <replaceable>name</replaceable> CHECK ( <replaceable>condition</replaceable> ) </synopsis> <para> @@ -2005,7 +2001,7 @@ CREATE ASSERTION name CHECK ( condition ) Domain constraint: <synopsis> -[ CONSTRAINT name ] CHECK constraint +[ CONSTRAINT <replaceable>name</replaceable> ] CHECK <replaceable>constraint</replaceable> [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] </synopsis> @@ -2015,7 +2011,7 @@ CREATE ASSERTION name CHECK ( condition ) Table constraint definition: <synopsis> -[ CONSTRAINT name ] { PRIMARY KEY ( <replaceable class="parameter">column</replaceable>, ... ) | FOREIGN KEY constraint | UNIQUE constraint | CHECK constraint } +[ CONSTRAINT <replaceable>name</replaceable> ] { PRIMARY KEY ( <replaceable class="parameter">column</replaceable>, ... ) | FOREIGN KEY <replaceable>constraint</replaceable> | UNIQUE <replaceable>constraint</replaceable> | CHECK <replaceable>constraint</replaceable> } [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] </synopsis> @@ -2025,7 +2021,7 @@ CREATE ASSERTION name CHECK ( condition ) Column constraint definition: <synopsis> -[ CONSTRAINT name ] { NOT NULL | PRIMARY KEY | FOREIGN KEY constraint | UNIQUE | CHECK constraint } +[ CONSTRAINT <replaceable>name</replaceable> ] { NOT NULL | PRIMARY KEY | FOREIGN KEY <replaceable>constraint</replaceable> | UNIQUE | CHECK <replaceable>constraint</replaceable> } [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] </synopsis> @@ -2067,8 +2063,8 @@ CREATE ASSERTION name CHECK ( condition ) <term>INITIALLY IMMEDIATE</term> <listitem> <para> - Check constraint only at the end of the transaction. This - is the default + Check constraint only at the end of the transaction. This + is the default </para> </listitem> </varlistentry> @@ -2076,7 +2072,7 @@ CREATE ASSERTION name CHECK ( condition ) <term>INITIALLY DEFERRED</term> <listitem> <para> - Check constraint after each statement. + Check constraint after each statement. </para> </listitem> </varlistentry> @@ -2106,7 +2102,7 @@ affect a column or a table. <para> table constraint definition: <synopsis> -[ CONSTRAINT name ] CHECK ( VALUE condition ) +[ CONSTRAINT <replaceable>name</replaceable> ] CHECK ( VALUE <replaceable>condition</replaceable> ) [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] </synopsis> @@ -2115,7 +2111,7 @@ affect a column or a table. <para> column constraint definition: <synopsis> -[ CONSTRAINT name ] CHECK ( VALUE condition ) +[ CONSTRAINT <replaceable>name</replaceable> ] CHECK ( VALUE <replaceable>condition</replaceable> ) [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] </synopsis> @@ -2125,7 +2121,7 @@ affect a column or a table. domain constraint definition: </para> <synopsis> - [ CONSTRAINT name ] + [ CONSTRAINT name] CHECK ( VALUE condition ) [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] @@ -2154,7 +2150,7 @@ ALTER DOMAIN cities <para> Table Constraint definition: <synopsis> -[ CONSTRAINT name ] PRIMARY KEY ( column [, ...] ) +[ CONSTRAINT <replaceable>name</replaceable> ] PRIMARY KEY ( <replaceable>column</replaceable> [, ...] ) [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] </synopsis> @@ -2162,7 +2158,7 @@ ALTER DOMAIN cities <para> Column Constraint definition: <synopsis> -[ CONSTRAINT name ] PRIMARY KEY +[ CONSTRAINT <replaceable>name</replaceable> ] PRIMARY KEY [ {INITIALLY DEFERRED | INITIALLY IMMEDIATE} ] [ [ NOT ] DEFERRABLE ] </synopsis> diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 48040c98243..2ee434511b9 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.10 2000/03/27 17:14:43 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.11 2000/05/02 20:02:03 thomas Exp $ Postgres documentation --> @@ -24,11 +24,11 @@ Postgres documentation </refsynopsisdivinfo> <synopsis> initdb [ --pgdata|-D <replaceable class="parameter">dbdir</replaceable> ] - [ --sysid|-i <replaceable class="parameter">sysid</replaceable> ] - [ --pwprompt|-W ] - [ --encoding|-E <replaceable class="parameter">encoding</replaceable> ] - [ --pglib|-L <replaceable class="parameter">libdir</replaceable> ] - [ --noclean | -n ] [ --debug | -d ] [ --template | -t ] + [ --sysid|-i <replaceable class="parameter">sysid</replaceable> ] + [ --pwprompt|-W ] + [ --encoding|-E <replaceable class="parameter">encoding</replaceable> ] + [ --pglib|-L <replaceable class="parameter">libdir</replaceable> ] + [ --noclean | -n ] [ --debug | -d ] [ --template | -t ] </synopsis> <refsect2 id="R2-APP-INITDB-1"> diff --git a/doc/src/sgml/ref/pgctl-ref.sgml b/doc/src/sgml/ref/pgctl-ref.sgml index 897d42179cb..e6a0979b3fd 100644 --- a/doc/src/sgml/ref/pgctl-ref.sgml +++ b/doc/src/sgml/ref/pgctl-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgctl-ref.sgml,v 1.1 2000/04/08 02:16:26 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgctl-ref.sgml,v 1.2 2000/05/02 20:02:03 thomas Exp $ Postgres documentation --> @@ -28,7 +28,8 @@ Postgres documentation <synopsis> pg_ctl [-w] [-D <replaceable class="parameter">datadir</replaceable>][-p <replaceable class="parameter">path</replaceable>] [-o "<replaceable class="parameter">options</replaceable>"] start pg_ctl [-w] [-D <replaceable class="parameter">datadir</replaceable>] [-m [s[mart]|f[ast]|i[mmediate]]] stop -pg_ctl [-w] [-D <replaceable class="parameter">datadir</replaceable>] [-m [s[mart]|f[ast]|i[mmediate]] [-o "<replaceable class="parameter">options</replaceable>"] restart +pg_ctl [-w] [-D <replaceable class="parameter">datadir</replaceable>] [-m [s[mart]|f[ast]|i[mmediate]] + [-o "<replaceable class="parameter">options</replaceable>"] restart pg_ctl [-D <replaceable class="parameter">datadir</replaceable>] status </synopsis> diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index 958bcd3b3da..beb3fb046ce 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.8 2000/03/26 07:04:54 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.9 2000/05/02 20:02:03 thomas Exp $ Postgres documentation --> @@ -24,8 +24,8 @@ Postgres documentation </refsynopsisdivinfo> <synopsis> postmaster [ -B <replaceable class="parameter">nBuffers</replaceable> ] [ -D <replaceable class="parameter">DataDir</replaceable> ] [ -N <replaceable class="parameter">maxBackends</replaceable> ] [ -S ] - [ -d <replaceable class="parameter">DebugLevel</replaceable> ] [ -i ] [ -l ] - [ -o <replaceable class="parameter">BackendOptions</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ] [ -n | -s ] + [ -d <replaceable class="parameter">DebugLevel</replaceable> ] [ -i ] [ -l ] + [ -o <replaceable class="parameter">BackendOptions</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ] [ -n | -s ] </synopsis> <refsect2 id="R2-APP-POSTMASTER-1"> diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index 1b4a1eed29c..f6aae0d949d 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.8 2000/03/27 17:14:43 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.9 2000/05/02 20:02:03 thomas Exp $ Postgres documentation --> @@ -23,8 +23,9 @@ Postgres documentation <date>1999-12-04</date> </refsynopsisdivinfo> <synopsis> -vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ --analyze | -z ] [ --alldb | -a ] [ --verbose | -v ] - [ --table '<replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column</replaceable> [,...] ) ]' ] [ [-d] <replaceable class="parameter">dbname</replaceable> ] +vacuumdb [ <replaceable class="parameter">options</replaceable> ] [ --analyze | -z ] + [ --alldb | -a ] [ --verbose | -v ] + [ --table '<replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column</replaceable> [,...] ) ]' ] [ [-d] <replaceable class="parameter">dbname</replaceable> ] </synopsis> <refsect2 id="R2-APP-VACUUMDB-1"> @@ -39,7 +40,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - <variablelist> <varlistentry> - <term>[-d, --dbname] <replaceable class="parameter">dbname</replaceable></term> + <term>-d <replaceable class="parameter">dbname</replaceable></term> + <term>--dbname <replaceable class="parameter">dbname</replaceable></term> <listitem> <para> Specifies the name of the database to be cleaned or analyzed. @@ -48,7 +50,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - </varlistentry> <varlistentry> - <term>-z, --analyze</term> + <term>-z</term> + <term>--analyze</term> <listitem> <para> Calculate statistics on the database for use by the optimizer. @@ -57,7 +60,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - </varlistentry> <varlistentry> - <term>-a, --alldb</term> + <term>-a</term> + <term>--alldb</term> <listitem> <para> Vacuum all databases. @@ -66,7 +70,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - </varlistentry> <varlistentry> - <term>-v, --verbose</term> + <term>-v</term> + <term>--verbose</term> <listitem> <para> Print detailed information during processing. @@ -75,7 +80,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - </varlistentry> <varlistentry> - <term>-t, --table <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]</term> + <term>-t <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]</term> + <term>--table <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]</term> <listitem> <para> Clean or analyze <replaceable class="parameter">table</replaceable> only. @@ -100,7 +106,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - <variablelist> <varlistentry> - <term>-h, --host <replaceable class="parameter">host</replaceable></term> + <term>-h <replaceable class="parameter">host</replaceable></term> + <term>--host <replaceable class="parameter">host</replaceable></term> <listitem> <para> Specifies the hostname of the machine on which the @@ -111,7 +118,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - </varlistentry> <varlistentry> - <term>-p, --port <replaceable class="parameter">port</replaceable></term> + <term>-p <replaceable class="parameter">port</replaceable></term> + <term>--port <replaceable class="parameter">port</replaceable></term> <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file @@ -122,7 +130,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - </varlistentry> <varlistentry> - <term>-U, --username <replaceable class="parameter">username</replaceable></term> + <term>-U <replaceable class="parameter">username</replaceable></term> + <term>--username <replaceable class="parameter">username</replaceable></term> <listitem> <para> Username to connect as. @@ -131,7 +140,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - </varlistentry> <varlistentry> - <term>-W, --password</term> + <term>-W</term> + <term>--password</term> <listitem> <para> Force password prompt. @@ -140,7 +150,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - </varlistentry> <varlistentry> - <term>-e, --echo</term> + <term>-e</term> + <term>--echo</term> <listitem> <para> Echo the commands that <application>vacuumdb</application> generates @@ -150,7 +161,8 @@ vacuumdb [ <replaceable class="parameter">connection options</replaceable> ] [ - </varlistentry> <varlistentry> - <term>-q, --quiet</term> + <term>-q</term> + <term>--quiet</term> <listitem> <para> Do not display a response. |