diff options
Diffstat (limited to 'doc/src/sgml/ref')
| -rw-r--r-- | doc/src/sgml/ref/alter_user.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/copy.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_function.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_index.sgml | 16 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_operator.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_rule.sgml | 6 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_sequence.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/create_table.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/explain.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_ctl-ref.sgml | 10 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_dump.sgml | 102 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_restore.sgml | 104 | ||||
| -rw-r--r-- | doc/src/sgml/ref/postgres-ref.sgml | 44 | ||||
| -rw-r--r-- | doc/src/sgml/ref/postmaster.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/psql-ref.sgml | 18 | ||||
| -rw-r--r-- | doc/src/sgml/ref/reindex.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/select.sgml | 8 |
17 files changed, 172 insertions, 172 deletions
diff --git a/doc/src/sgml/ref/alter_user.sgml b/doc/src/sgml/ref/alter_user.sgml index 3819bf8d96..d8461c4f4f 100644 --- a/doc/src/sgml/ref/alter_user.sgml +++ b/doc/src/sgml/ref/alter_user.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.20 2002/03/01 22:45:07 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.21 2002/03/22 19:20:36 petere Exp $ PostgreSQL documentation --> @@ -189,7 +189,7 @@ ALTER USER <replaceable class="PARAMETER">username</replaceable> RESET <replacea <para> Use <xref linkend="SQL-CREATEUSER" endterm="SQL-CREATEUSER-title"> to add new users, and <xref linkend="SQL-DROPUSER" - endterm="SQL-DROPUSER-title"> to remoe a user. + endterm="SQL-DROPUSER-title"> to remove a user. </para> <para> diff --git a/doc/src/sgml/ref/copy.sgml b/doc/src/sgml/ref/copy.sgml index b4a226876a..a2bbd1c0aa 100644 --- a/doc/src/sgml/ref/copy.sgml +++ b/doc/src/sgml/ref/copy.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/copy.sgml,v 1.28 2002/02/12 21:25:34 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/copy.sgml,v 1.29 2002/03/22 19:20:37 petere Exp $ PostgreSQL documentation --> @@ -279,7 +279,7 @@ ERROR: <replaceable>reason</replaceable> </para> <para> - It is recommended that the filename used in <command>COPY</command> + It is recommended that the file name used in <command>COPY</command> always be specified as an absolute path. This is enforced by the backend in the case of <command>COPY TO</command>, but for <command>COPY FROM</command> you do have the option of reading from a file specified diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index 25c33c7b6c..c6ee3e25ef 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.33 2002/03/01 20:38:12 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.34 2002/03/22 19:20:37 petere Exp $ --> <refentry id="SQL-CREATEFUNCTION"> @@ -332,7 +332,7 @@ CREATE TABLE product ( user-defined type complex, and the internal type point. The function is implemented by a dynamically loaded object that was compiled from C source (we illustrate the now-deprecated alternative - of specifying the exact pathname to the shared object file). + of specifying the absolute file name to the shared object file). For <productname>PostgreSQL</productname> to find a type conversion function automatically, the SQL function has to have the same name as the return type, and so overloading is diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml index a3f11d8b0e..ed4bb66aad 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.26 2002/01/20 22:19:56 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.27 2002/03/22 19:20:38 petere Exp $ PostgreSQL documentation --> @@ -82,7 +82,7 @@ CREATE [ UNIQUE ] INDEX <replaceable class="parameter">index_name</replaceable> <variablelist> <varlistentry> - <term>BTREE</term> + <term><literal>BTREE</></term> <listitem> <para> an implementation of Lehman-Yao @@ -92,7 +92,7 @@ CREATE [ UNIQUE ] INDEX <replaceable class="parameter">index_name</replaceable> </varlistentry> <varlistentry> - <term>RTREE</term> + <term><literal>RTREE</></term> <listitem> <para>implements standard R-trees using Guttman's quadratic split algorithm. @@ -101,7 +101,7 @@ CREATE [ UNIQUE ] INDEX <replaceable class="parameter">index_name</replaceable> </varlistentry> <varlistentry> - <term>HASH</term> + <term><literal>HASH</></term> <listitem> <para> an implementation of Litwin's linear hashing. @@ -110,7 +110,7 @@ CREATE [ UNIQUE ] INDEX <replaceable class="parameter">index_name</replaceable> </varlistentry> <varlistentry> - <term>GIST</term> + <term><literal>GIST</></term> <listitem> <para> Generalized Index Search Trees. @@ -270,11 +270,11 @@ ERROR: Cannot create index: 'index_name' already exists. <para> All functions and operators used in an index definition must be - <firstterm>cachable</>, that is, their results must depend only on + <firstterm>cacheable</>, that is, their results must depend only on their input arguments and never on any outside influence (such as the contents of another table or the current time). This restriction ensures that the behavior of the index is well-defined. To use a - user-defined function in an index, remember to mark the function cachable + user-defined function in an index, remember to mark the function cacheable when you create it. </para> @@ -329,7 +329,7 @@ ERROR: Cannot create index: 'index_name' already exists. </para> <para> - Currently, only the B-tree and gist access methods support multi-column + Currently, only the B-tree and gist access methods support multicolumn indexes. Up to 16 keys may be specified by default (this limit can be altered when building <application>PostgreSQL</application>). Only B-tree currently supports diff --git a/doc/src/sgml/ref/create_operator.sgml b/doc/src/sgml/ref/create_operator.sgml index 7f33ca47fa..e3b41ec5da 100644 --- a/doc/src/sgml/ref/create_operator.sgml +++ b/doc/src/sgml/ref/create_operator.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.24 2002/01/20 22:19:56 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_operator.sgml,v 1.25 2002/03/22 19:20:39 petere Exp $ PostgreSQL documentation --> @@ -309,7 +309,7 @@ MYBOXES.description !== box '((0,0), (1,1))' furthermore, equality of the data type must mean bitwise equality of the representation of the type. (For example, a data type that contains unused bits that don't matter for equality tests could - not be hashjoined.) + not be hash-joined.) The HASHES flag indicates to the query optimizer that a hash join may safely be used with this operator.</para> <para> diff --git a/doc/src/sgml/ref/create_rule.sgml b/doc/src/sgml/ref/create_rule.sgml index ab1a8eeba1..c9cc209843 100644 --- a/doc/src/sgml/ref/create_rule.sgml +++ b/doc/src/sgml/ref/create_rule.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_rule.sgml,v 1.32 2002/03/10 06:00:13 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_rule.sgml,v 1.33 2002/03/22 19:20:39 petere Exp $ PostgreSQL documentation --> @@ -78,7 +78,7 @@ NOTHING <term><replaceable class="parameter">condition</replaceable></term> <listitem> <para> - Any SQL boolean-condition expression. The condition expression may not + Any SQL conditional expression (returning <type>boolean</type>). The condition expression may not refer to any tables except <literal>new</literal> and <literal>old</literal>. </para> @@ -269,7 +269,7 @@ CREATE RULE "_RETtoyemp" AS SELECT * FROM emp; </programlisting> - This attempt to select from EMP will cause + This attempt to select from <literal>EMP</literal> will cause <productname>PostgreSQL</productname> to issue an error because the queries cycled too many times: diff --git a/doc/src/sgml/ref/create_sequence.sgml b/doc/src/sgml/ref/create_sequence.sgml index 115b833d49..ae69bf5b2a 100644 --- a/doc/src/sgml/ref/create_sequence.sgml +++ b/doc/src/sgml/ref/create_sequence.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.24 2002/01/20 22:19:56 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_sequence.sgml,v 1.25 2002/03/22 19:20:40 petere Exp $ PostgreSQL documentation --> @@ -268,7 +268,7 @@ SELECT * FROM <replaceable>seqname</replaceable>; setting of 10, backend A might reserve values 1..10 and return <function>nextval</function>=1, then backend B might reserve values 11..20 and return <function>nextval</function>=11 before backend - A has generated nextval=2.) Thus, with a <replaceable class="parameter">cache</replaceable> setting of one it is safe + A has generated <literal>nextval</literal>=2.) Thus, with a <replaceable class="parameter">cache</replaceable> setting of one it is safe to assume that <function>nextval</> values are generated sequentially; with a <replaceable class="parameter">cache</replaceable> setting greater than one you should only assume that the <function>nextval</> values are all distinct, not that they are generated purely sequentially. diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index 0ae9222d0f..671a49d739 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.52 2002/01/20 22:19:56 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.53 2002/03/22 19:20:40 petere Exp $ PostgreSQL documentation --> @@ -520,7 +520,7 @@ and <replaceable class="PARAMETER">table_constraint</replaceable> is: accompanied by some descriptive text, such as: <computeroutput>ERROR: Relation '<replaceable class="parameter">table</replaceable>' already - exists</computeroutput>, which occurs at runtime if the table + exists</computeroutput>, which occurs at run time if the table specified already exists in the database. </para> </msgexplan> diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml index d9ed871b28..33c9add453 100644 --- a/doc/src/sgml/ref/explain.sgml +++ b/doc/src/sgml/ref/explain.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.15 2002/03/06 06:48:04 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/explain.sgml,v 1.16 2002/03/22 19:20:40 petere Exp $ PostgreSQL documentation --> @@ -41,7 +41,7 @@ EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="PARAMETER">query</replaceabl <term>ANALYZE</term> <listitem> <para> - Flag to carry out the query and show actual runtimes. + Flag to carry out the query and show actual run times. </para> </listitem> </varlistentry> diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml index 63b57fc11d..3ef1a1a7a2 100644 --- a/doc/src/sgml/ref/pg_ctl-ref.sgml +++ b/doc/src/sgml/ref/pg_ctl-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.12 2001/12/08 03:24:37 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.13 2002/03/22 19:20:41 petere Exp $ PostgreSQL documentation --> @@ -76,7 +76,7 @@ PostgreSQL documentation stopping, or restarting <xref linkend="app-postmaster">, the <productname>PostgreSQL</productname> backend server, or displaying the status of a running postmaster. Although the postmaster can be - started manually, <application>pg_ctl</application> encapulates + started manually, <application>pg_ctl</application> encapsulates tasks such as redirecting log output, properly detaching from the terminal and process group, and it provides convenient options for controlled shutdown. @@ -190,7 +190,7 @@ PostgreSQL documentation <para> Specifies the location of the <filename>postmaster</filename> executable. By default the postmaster is taken from the same - directory as pg_ctl, or failing that, the hard-wired + directory as <command>pg_ctl</>, 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 postmaster was not found. @@ -291,7 +291,7 @@ PostgreSQL documentation <para> This is almost equivalent to stopping the <application>postmaster</application> and starting it again - except that pg_ctl saves and reuses the command line options that + except that <command>pg_ctl</command> saves and reuses the command line options that were passed to the previously running instance. To restart the <application>postmaster</application> in the simplest form: <screen> @@ -308,7 +308,7 @@ PostgreSQL documentation </para> <para> - To restart using port 5433 and disabling fsync after restarting: + To restart using port 5433 and disabling <function>fsync</> after restarting: <screen> <prompt>$</prompt> <userinput>pg_ctl -o "-F -p 5433" restart</userinput> </screen> diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 0169043e96..f58d3c39f4 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.42 2002/02/11 00:14:10 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.43 2002/03/22 19:20:42 petere Exp $ PostgreSQL documentation --> @@ -138,8 +138,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-a</term> - <term>--data-only</term> + <term><option>-a</></term> + <term><option>--data-only</></term> <listitem> <para> Dump only the data, not the schema (data definitions). @@ -154,8 +154,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-b</term> - <term>--blobs</term> + <term><option>-b</></term> + <term><option>--blobs</></term> <listitem> <para> Include large objects in dump. @@ -164,8 +164,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-c</term> - <term>--clean</term> + <term><option>-c</option></term> + <term><option>--clean</option></term> <listitem> <para> Output commands to clean (drop) @@ -181,8 +181,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-C</term> - <term>--create</term> + <term><option>-C</></term> + <term><option>--create</></term> <listitem> <para> Begin the output with a command to create the @@ -200,8 +200,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-d</term> - <term>--inserts</term> + <term><option>-d</option></term> + <term><option>--inserts</option></term> <listitem> <para> Dump data as <command>INSERT</command> commands (rather @@ -213,9 +213,9 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-D</term> - <term>--column-inserts</term> - <term>--attribute-inserts</term> + <term><option>-D</option></term> + <term><option>--column-inserts</option></term> + <term><option>--attribute-inserts</option></term> <listitem> <para> Dump data as <command>INSERT</command> commands with explicit @@ -229,8 +229,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-f <replaceable class="parameter">file</replaceable></term> - <term>--file=<replaceable class="parameter">file</replaceable></term> + <term><option>-f <replaceable class="parameter">file</replaceable></option></term> + <term><option>--file=<replaceable class="parameter">file</replaceable></option></term> <listitem> <para> Send output to the specified file. If this is omitted, the @@ -240,8 +240,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-F <replaceable class="parameter">format</replaceable></term> - <term>--format=<replaceable class="parameter">format</replaceable></term> + <term><option>-F <replaceable class="parameter">format</replaceable></option></term> + <term><option>--format=<replaceable class="parameter">format</replaceable></option></term> <listitem> <para> Selects the format of the output. @@ -289,8 +289,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-i</term> - <term>--ignore-version</term> + <term><option>-i</></term> + <term><option>--ignore-version</></term> <listitem> <para> Ignore version mismatch between <command>pg_dump</command> @@ -306,8 +306,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-n</term> - <term>--no-quotes</term> + <term><option>-n</></term> + <term><option>--no-quotes</></term> <listitem> <para> Suppress double quotes around identifiers unless absolutely necessary. @@ -320,8 +320,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-N</term> - <term>--quotes</term> + <term><option>-N</></term> + <term><option>--quotes</></term> <listitem> <para> Include double quotes around identifiers. @@ -331,8 +331,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-o</term> - <term>--oids</term> + <term><option>-o</></term> + <term><option>--oids</></term> <listitem> <para> Dump object identifiers (<acronym>OID</acronym>s) for every @@ -344,8 +344,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-O</term> - <term>--no-owner</term> + <term><option>-O</></term> + <term><option>--no-owner</option></term> <listitem> <para> Do not output commands to set the @@ -369,8 +369,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-R</term> - <term>--no-reconnect</term> + <term><option>-R</option></term> + <term><option>--no-reconnect</option></term> <listitem> <para> Prohibit <command>pg_dump</command> @@ -399,8 +399,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-s</term> - <term>--schema-only</term> + <term><option>-s</option></term> + <term><option>--schema-only</option></term> <listitem> <para> Dump only the schema (data definitions), no data. @@ -409,8 +409,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-S <replaceable class="parameter">username</replaceable></term> - <term>--superuser=<replaceable class="parameter">username</replaceable></term> + <term><option>-S <replaceable class="parameter">username</replaceable></option></term> + <term><option>--superuser=<replaceable class="parameter">username</replaceable></option></term> <listitem> <para> The scripts or archives created by <command>pg_dump</command> @@ -422,8 +422,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-t <replaceable class="parameter">table</replaceable></term> - <term>--table=<replaceable class="parameter">table</replaceable></term> + <term><option>-t <replaceable class="parameter">table</replaceable></option></term> + <term><option>--table=<replaceable class="parameter">table</replaceable></option></term> <listitem> <para> Dump data for <replaceable class="parameter">table</replaceable> only. @@ -432,8 +432,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-v</term> - <term>--verbose</term> + <term><option>-v</></term> + <term><option>--verbose</></term> <listitem> <para> Specifies verbose mode. @@ -442,9 +442,9 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-x</term> - <term>--no-privileges</term> - <term>--no-acl</term> + <term><option>-x</></term> + <term><option>--no-privileges</></term> + <term><option>--no-acl</></term> <listitem> <para> Prevent dumping of access privileges (grant/revoke commands). @@ -453,8 +453,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-X use-set-session-authorization</term> - <term>--use-set-session-authorization</term> + <term><option>-X use-set-session-authorization</></term> + <term><option>--use-set-session-authorization</></term> <listitem> <para> Normally, if a (plain-text mode) script generated by @@ -488,8 +488,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-Z <replaceable class="parameter">0..9</replaceable></term> - <term>--compress=<replaceable class="parameter">0..9</replaceable></term> + <term><option>-Z <replaceable class="parameter">0..9</replaceable></option></term> + <term><option>--compress=<replaceable class="parameter">0..9</replaceable></option></term> <listitem> <para> Specify the compression level to use in archive formats that support @@ -507,8 +507,8 @@ PostgreSQL documentation <variablelist> <varlistentry> - <term>-h <replaceable class="parameter">host</replaceable></term> - <term>--host=<replaceable class="parameter">host</replaceable></term> + <term><option>-h <replaceable class="parameter">host</replaceable></option></term> + <term><option>--host=<replaceable class="parameter">host</replaceable></option></term> <listitem> <para> Specifies the host name of the machine on which the @@ -520,8 +520,8 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-p <replaceable class="parameter">port</replaceable></term> - <term>--port=<replaceable class="parameter">port</replaceable></term> + <term><option>-p <replaceable class="parameter">port</replaceable></option></term> + <term><option>--port=<replaceable class="parameter">port</replaceable></option></term> <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file @@ -534,7 +534,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-U <replaceable>username</replaceable></term> + <term><option>-U <replaceable>username</replaceable></option></term> <listitem> <para> Connect as the given user. @@ -543,7 +543,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-W</term> + <term><option>-W</option></term> <listitem> <para> Force a password prompt. This should happen automatically if diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index b88bb4ae74..c8d0298acc 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -1,4 +1,4 @@ -<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.22 2002/02/11 00:14:10 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.23 2002/03/22 19:20:42 petere Exp $ --> <refentry id="APP-PGRESTORE"> <docinfo> @@ -117,8 +117,8 @@ </varlistentry> <varlistentry> - <term>-a</term> - <term>--data-only</term> + <term><option>-a</option></term> + <term><option>--data-only</option></term> <listitem> <para> Restore only the data, no schema (definitions). @@ -127,8 +127,8 @@ </varlistentry> <varlistentry> - <term>-c</term> - <term>--clean</term> + <term><option>-c</option></term> + <term><option>--clean</option></term> <listitem> <para> Clean (drop) database objects before recreating them. @@ -137,8 +137,8 @@ </varlistentry> <varlistentry> - <term>-C</term> - <term>--create</term> + <term><option>-C</option></term> + <term><option>--create</option></term> <listitem> <para> Create the database before restoring into it. @@ -151,8 +151,8 @@ </varlistentry> <varlistentry> - <term>-d <replaceable class="parameter">dbname</replaceable></term> - <term>--dbname=<replaceable class="parameter">dbname</replaceable></term> + <term><option>-d <replaceable class="parameter">dbname</replaceable></option></term> + <term><option>--dbname=<replaceable class="parameter">dbname</replaceable></option></term> <listitem> <para> Connect to database <replaceable class="parameter">dbname</replaceable> and restore @@ -162,8 +162,8 @@ </varlistentry> <varlistentry> - <term>-f <replaceable>filename</replaceable></term> - <term>--file=<replaceable>filename</replaceable></term> + <term><option>-f <replaceable>filename</replaceable></option></term> + <term><option>--file=<replaceable>filename</replaceable></option></term> <listitem> <para> Specify output file for generated script, or for the listing @@ -173,8 +173,8 @@ </varlistentry> <varlistentry> - <term>-F <replaceable class="parameter">format</replaceable></term> - <term>--format=<replaceable class="parameter">format</replaceable></term> + <term><option>-F <replaceable class="parameter">format</replaceable></option></term> + <term><option>--format=<replaceable class="parameter">format</replaceable></option></term> <listitem> <para> Specify format of the archive. @@ -212,8 +212,8 @@ </varlistentry> <varlistentry> - <term>-i <replaceable class="parameter">index</replaceable></term> - <term>--index=<replaceable class="parameter">index</replaceable></term> + <term><option>-i <replaceable class="parameter">index</replaceable></option></term> + <term><option>--index=<replaceable class="parameter">index</replaceable></option></term> <listitem> <para> Restore definition for named <replaceable class="parameter">index</replaceable> only. @@ -222,8 +222,8 @@ </varlistentry> <varlistentry> - <term>-l</term> - <term>--list</term> + <term><option>-l</option></term> + <term><option>--list</option></term> <listitem> <para> List the contents of the archive. The output of this command can be used with the <option>-L</option> option @@ -233,8 +233,8 @@ </varlistentry> <varlistentry> - <term>-L <replaceable class="parameter">list-file</replaceable></term> - <term>--use-list=<replaceable class="parameter">list-file</replaceable></term> + <term><option>-L <replaceable class="parameter">list-file</replaceable></option></term> + <term><option>--use-list=<replaceable class="parameter">list-file</replaceable></option></term> <listitem> <para> Restore elements in <REPLACEABLE CLASS="PARAMETER">list-file</REPLACEABLE> only, and in the @@ -245,8 +245,8 @@ </varlistentry> <varlistentry> - <term>-N</term> - <term>--orig-order</term> + <term><option>-N</option></term> + <term><option>--orig-order</option></term> <listitem> <para> Restore items in the original dump order. By default <command>pg_dump</command> will dump items in an order convenient @@ -256,8 +256,8 @@ </varlistentry> <varlistentry> - <term>-o</term> - <term>--oid-order</term> + <term><option>-o</option></term> + <term><option>--oid-order</option></term> <listitem> <para> Restore items in the OID order. By default <command>pg_dump</command> will dump items in an order convenient @@ -267,8 +267,8 @@ </varlistentry> <varlistentry> - <term>-O</term> - <term>--no-owner</term> + <term><option>-O</option></term> + <term><option>--no-owner</option></term> <listitem> <para> Prevent any attempt to restore original object ownership. Objects will be owned by the user name used @@ -278,8 +278,8 @@ </varlistentry> <varlistentry> - <term>-P <replaceable class="parameter">function-name</replaceable></term> - <term>--function=<replaceable class="parameter">function-name</replaceable></term> + <term><option>-P <replaceable class="parameter">function-name</replaceable></option></term> + <term><option>--function=<replaceable class="parameter">function-name</replaceable></option></term> <listitem> <para> Specify a procedure or function to be restored. @@ -288,8 +288,8 @@ </varlistentry> <varlistentry> - <term>-r</term> - <term>--rearrange</term> + <term><option>-r</option></term> + <term><option>--rearrange</option></term> <listitem> <para> Restore items in modified OID order. By default <command>pg_dump</command> will dump items in an order convenient @@ -301,8 +301,8 @@ </varlistentry> <varlistentry> - <term>-R</term> - <term>--no-reconnect</term> + <term><option>-R</option></term> + <term><option>--no-reconnect</option></term> <listitem> <para> While restoring an archive, <command>pg_restore</command> @@ -324,8 +324,8 @@ </varlistentry> <varlistentry> - <term>-s</term> - <term>--schema-only</term> + <term><option>-s</option></term> + <term><option>--schema-only</option></term> <listitem> <para> Restore the schema (definitions), no data. Sequence values will be reset. @@ -334,8 +334,8 @@ </varlistentry> <varlistentry> - <term>-S <replaceable class="parameter">username</replaceable></term> - <term>--superuser=<replaceable class="parameter">username</replaceable></term> + <term><option>-S <replaceable class="parameter">username</replaceable></option></term> + <term><option>--superuser=<replaceable class="parameter">username</replaceable></option></term> <listitem> <para> Specify the superuser user name to use when disabling triggers and/or setting ownership of schema elements. @@ -345,8 +345,8 @@ </varlistentry> <varlistentry> - <term>-t <replaceable class="parameter">table</replaceable></term> - <term>--table=<replaceable class="parameter">table</replaceable></term> + <term><option>-t <replaceable class="parameter">table</replaceable></option></term> + <term><option>--table=<replaceable class="parameter">table</replaceable></option></term> <listitem> <para> Restore schema/data for <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> only. @@ -355,8 +355,8 @@ </varlistentry> <varlistentry> - <term>-T <replaceable class="parameter">trigger</replaceable></term> - <term>--trigger=<replaceable class="parameter">trigger</replaceable></term> + <term><option>-T <replaceable class="parameter">trigger</replaceable></option></term> + <term><option>--trigger=<replaceable class="parameter">trigger</replaceable></option></term> <listitem> <para> Restore definition of <REPLACEABLE CLASS="PARAMETER">trigger</REPLACEABLE> only. @@ -365,8 +365,8 @@ </varlistentry> <varlistentry> - <term>-v</term> - <term>--verbose</term> + <term><option>-v</option></term> + <term><option>--verbose</option></term> <listitem> <para> Specifies verbose mode. @@ -375,9 +375,9 @@ </varlistentry> <varlistentry> - <term>-x</term> - <term>--no-privileges</term> - <term>--no-acl</term> + <term><option>-x</option></term> + <term><option>--no-privileges</option></term> + <term><option>--no-acl</option></term> <listitem> <para> Prevent restoration of access privileges (grant/revoke commands). @@ -386,8 +386,8 @@ </varlistentry> <varlistentry> - <term>-X use-set-session-authorization</term> - <term>--use-set-session-authorization</term> + <term><option>-X use-set-session-authorization</option></term> + <term><option>--use-set-session-authorization</option></term> <listitem> <para> Normally, if restoring an archive requires altering the @@ -413,8 +413,8 @@ <variablelist> <varlistentry> - <term>-h <replaceable class="parameter">host</replaceable></term> - <term>--host=<replaceable class="parameter">host</replaceable></term> + <term><option>-h <replaceable class="parameter">host</replaceable></option></term> + <term><option>--host=<replaceable class="parameter">host</replaceable></option></term> <listitem> <para> Specifies the host name of the machine on which the @@ -426,8 +426,8 @@ </varlistentry> <varlistentry> - <term>-p <replaceable class="parameter">port</replaceable></term> - <term>--port=<replaceable class="parameter">port</replaceable></term> + <term><option>-p <replaceable class="parameter">port</replaceable></option></term> + <term><option>--port=<replaceable class="parameter">port</replaceable></option></term> <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file @@ -440,7 +440,7 @@ </varlistentry> <varlistentry> - <term>-U <replaceable>username</replaceable></term> + <term><option>-U <replaceable>username</replaceable></option></term> <listitem> <para> Connect as the given user. @@ -449,7 +449,7 @@ </varlistentry> <varlistentry> - <term>-W</term> + <term><option>-W</option></term> <listitem> <para> Force a password prompt. This should happen automatically if diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index 93cf8de8bd..cf6f785b86 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.24 2002/03/02 21:39:16 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.25 2002/03/22 19:20:43 petere Exp $ PostgreSQL documentation --> @@ -79,7 +79,7 @@ PostgreSQL documentation The <filename>postgres</filename> executable is the actual <productname>PostgreSQL</productname> server process that processes queries. It is normally not called directly; instead a <xref - linkend="app-postmaster"> multi-user server is started. + linkend="app-postmaster"> multiuser server is started. </para> <para> @@ -130,7 +130,7 @@ PostgreSQL documentation Guide</citetitle> for details. Some (safe) options can also be set from the connecting client in an application-dependent way. For example, if the environment variable <envar>PGOPTIONS</envar> - is set, then libpq-based clients will pass that string to the + is set, then <application>libpq</>-based clients will pass that string to the server, which will interpret it as <application>postgres</application> command-line options. </para> @@ -144,12 +144,12 @@ PostgreSQL documentation <option>-F</option>, and <option>--name</> have the same meanings as the <xref linkend="app-postmaster"> except that <option>-d</option> <literal>0</> prevents the debugging level of - the postmaster from being propogated to the backend. + the postmaster from being propagated to the backend. </para> <variablelist> <varlistentry> - <term>-e</term> + <term><option>-e</option></term> <listitem> <para> Sets the default date style to <quote>European</quote>, which @@ -163,21 +163,21 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-o <replaceable class="parameter">filename</replaceable></term> + <term><option>-o</option> <replaceable class="parameter">filename</replaceable></term> <listitem> <para> Sends all debugging and error output to <replaceable class="parameter">filename</replaceable>. If the backend is running under the <application>postmaster</application>, this option is ignored, - and the stderr inherited from the + and the <systemitem>stderr</> inherited from the <application>postmaster</application> is used. </para> </listitem> </varlistentry> <varlistentry> - <term>-P</term> + <term><option>-P</option></term> <listitem> <para> Ignore system indexes while scanning/updating system tuples. The @@ -188,7 +188,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-s</term> + <term><option>-s</option></term> <listitem> <para> Print time information and other statistics at the end of each query. @@ -199,7 +199,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-S <replaceable class="parameter">sort-mem</replaceable></term> + <term><option>-S</option> <replaceable class="parameter">sort-mem</replaceable></term> <listitem> <para> Specifies the amount of memory to be used by internal sorts and hashes @@ -231,7 +231,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-E</term> + <term><option>-E</option></term> <listitem> <para> Echo all queries. @@ -240,7 +240,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-N</term> + <term><option>-N</option></term> <listitem> <para> Disables use of newline as a query delimiter. @@ -264,7 +264,7 @@ PostgreSQL documentation <variablelist> <varlistentry> - <term>-f { s | i | m | n | h }</term> + <term><option>-f</option> <literal>{ s | i | m | n | h }</literal></term> <listitem> <para> Forbids the use of particular scan and join methods: @@ -286,7 +286,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-i</term> + <term><option>-i</option></term> <listitem> <para> Prevents query execution, but shows the plan tree. @@ -295,7 +295,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-O</term> + <term><option>-O</option></term> <listitem> <para> Allows the structure of system tables to be modified. This is @@ -305,7 +305,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-p <replaceable class="parameter">database</replaceable></term> + <term><option>-p</option> <replaceable class="parameter">database</replaceable></term> <listitem> <para> Indicates that this server has been started by a @@ -317,7 +317,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-t pa[rser] | pl[anner] | e[xecutor]</term> + <term><option>-t</option> <literal>pa[rser] | pl[anner] | e[xecutor]</literal></term> <listitem> <para> Print timing statistics for each query relating to each of the @@ -328,7 +328,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-v <replaceable class="parameter">protocol</replaceable></term> + <term><option>-v</option> <replaceable class="parameter">protocol</replaceable></term> <listitem> <para> Specifies the version number of the frontend/backend protocol @@ -338,7 +338,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term>-W <replaceable class="parameter">seconds</replaceable></term> + <term><option>-W</option> <replaceable class="parameter">seconds</replaceable></term> <listitem> <para> As soon as this option is encountered, the process sleeps for @@ -377,16 +377,16 @@ PostgreSQL documentation <para> But if you use the <option>-N</> command line switch, then newline does not terminate command entry. The backend will read the standard input - until the end-of-file (EOF) marker, then + until the end-of-file (<acronym>EOF</>) marker, then process the input as a single query string. Backslash-newline is not treated specially in this case. </para> <para> - To quit the session, type EOF + To quit the session, type <acronym>EOF</acronym> (<keycombo action="simul"><keycap>Control</><keycap>D</></>, usually). If you've - used <option>-N</>, two consecutive EOFs are needed to exit. + used <option>-N</>, two consecutive <acronym>EOF</>s are needed to exit. </para> <para> diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index 011144c1d5..e5f7113f69 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.27 2002/03/02 21:39:16 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.28 2002/03/22 19:20:43 petere Exp $ PostgreSQL documentation --> @@ -478,7 +478,7 @@ StreamServerPort: cannot bind to port </para> <para> - Named runtime parameters can be set in either of these styles: + Named run-time parameters can be set in either of these styles: <screen> <prompt>$</prompt> <userinput>postmaster -c sort_mem=1234</userinput> <prompt>$</prompt> <userinput>postmaster --sort-mem=1234</userinput> diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 40ba18716c..2dede1c99c 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.65 2002/03/20 19:43:30 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.66 2002/03/22 19:20:44 petere Exp $ PostgreSQL documentation --> @@ -66,7 +66,7 @@ PostgreSQL documentation <para> <application>psql</application> is a regular <productname>PostgreSQL</productname> client application. In order to connect to a database you need to know the - name of your target database, the hostname and port number of the server + name of your target database, the host name and port number of the server and what user name you want to connect as. <application>psql</application> can be told about those parameters via command line options, namely <option>-d</option>, <option>-h</option>, <option>-p</option>, and <option>-U</option> respectively. @@ -77,9 +77,9 @@ PostgreSQL documentation to a server on the local host. The default port number is compile-time determined. Since the database server uses the same default, you will not have to specify the port in most - cases. The default user name is your Unix username, as is the default + cases. The default user name is your Unix user name, as is the default database name. - Note that you can't just connect to any database under any username. Your database + Note that you can't just connect to any database under any user name. Your database administrator should have informed you about your access rights. To save you some typing you can also set the environment variables <envar>PGDATABASE</envar>, <envar>PGHOST</envar>, <envar>PGPORT</envar> and <envar>PGUSER</envar> @@ -270,7 +270,7 @@ testdb=> </para> <para> - If the connection attempt failed (wrong username, access denied, etc.), the + If the connection attempt failed (wrong user name, access denied, etc.), the previous connection will be kept if and only if <application>psql</application> is in interactive mode. When executing a non-interactive script, processing will immediately stop with an error. This distinction was chosen as a user @@ -1701,7 +1701,7 @@ bar <application>psql</application>'s internal variable names can consist of letters, numbers, and underscores in any order and any number of them. A number of regular variables are treated specially by <application>psql</application>. - They indicate certain option settings that can be changed at runtime + They indicate certain option settings that can be changed at run time by altering the value of the variable or represent some state of the application. Although you can use these variables for any other purpose, this is not recommended, as the @@ -2037,7 +2037,7 @@ testdb=> <userinput>\set content '\'' `sed -e "s/'/\\\\\\'/g" < my_file.txt` '\' <term><literal>%M</literal></term> <listitem> <para> - The full hostname (with domain name) of the database server, + The full host name (with domain name) of the database server, or <literal>[local]</literal> if the connection is over a Unix domain socket, or <literal>[local:<replaceable>/dir/name</replaceable>]</literal>, @@ -2051,7 +2051,7 @@ testdb=> <userinput>\set content '\'' `sed -e "s/'/\\\\\\'/g" < my_file.txt` '\' <term><literal>%m</literal></term> <listitem> <para> - The hostname of the database server, truncated after the + The host name of the database server, truncated after the first dot, or <literal>[local]</literal> if the connection is over a Unix domain socket. </para> @@ -2065,7 +2065,7 @@ testdb=> <userinput>\set content '\'' `sed -e "s/'/\\\\\\'/g" < my_file.txt` '\' <varlistentry> <term><literal>%n</literal></term> - <listitem><para>The username you are connected as (not your local system + <listitem><para>The user name you are connected as (not your local system user name).</para></listitem> </varlistentry> diff --git a/doc/src/sgml/ref/reindex.sgml b/doc/src/sgml/ref/reindex.sgml index bb443f8d46..f39766a572 100644 --- a/doc/src/sgml/ref/reindex.sgml +++ b/doc/src/sgml/ref/reindex.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/reindex.sgml,v 1.8 2001/12/08 03:24:38 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/reindex.sgml,v 1.9 2002/03/22 19:20:45 petere Exp $ PostgreSQL documentation --> @@ -145,7 +145,7 @@ REINDEX index on a system table. In this case it's important for the backend doing the recovery to not have used any of the suspect indexes itself. (Indeed, in this sort of scenario you may find that backends are - crashing immediately at startup, due to reliance on the corrupted + crashing immediately at start-up, due to reliance on the corrupted indexes.) To recover safely, the postmaster must be shut down and a stand-alone <productname>PostgreSQL</productname> backend must be started instead, giving it diff --git a/doc/src/sgml/ref/select.sgml b/doc/src/sgml/ref/select.sgml index ed080d3534..e1d419e811 100644 --- a/doc/src/sgml/ref/select.sgml +++ b/doc/src/sgml/ref/select.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.51 2001/12/08 03:24:39 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/select.sgml,v 1.52 2002/03/22 19:20:45 petere Exp $ PostgreSQL documentation --> @@ -91,7 +91,7 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be: <term><replaceable class="PARAMETER">condition</replaceable></term> <listitem> <para> - A boolean expression giving a result of true or false. + A Boolean expression giving a result of true or false. See the WHERE and HAVING clause descriptions below. </para> </listitem> @@ -368,7 +368,7 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be: <Productname>PostgreSQL</Productname> 7.1, this was the default result, and adding sub-tables was done by appending <command>*</command> to the table name. - This old behaviour is available via the command + This old behavior is available via the command <command>SET SQL_Inheritance TO OFF;</command> </para> @@ -449,7 +449,7 @@ WHERE <replaceable class="PARAMETER">boolean_expr</replaceable> </synopsis> <replaceable class="PARAMETER">boolean_expr</replaceable> - can consist of any expression which evaluates to a boolean value. + can consist of any expression which evaluates to a Boolean value. In many cases, this expression will be: <synopsis> |