diff options
| author | Peter Eisentraut <peter_e@gmx.net> | 2001-11-28 20:49:10 +0000 |
|---|---|---|
| committer | Peter Eisentraut <peter_e@gmx.net> | 2001-11-28 20:49:10 +0000 |
| commit | 651a639b8b900a1f9f7ffc27161d2866ddc00a2a (patch) | |
| tree | bcb4315fa066ddd0b8d0f57c3d7fe035342a3a0e /doc/src/sgml/ref | |
| parent | cde7dc82ca35d9c80cc302b86f10e04641b83af3 (diff) | |
| download | postgresql-651a639b8b900a1f9f7ffc27161d2866ddc00a2a.tar.gz | |
proof-reading
Diffstat (limited to 'doc/src/sgml/ref')
| -rw-r--r-- | doc/src/sgml/ref/createdb.sgml | 22 | ||||
| -rw-r--r-- | doc/src/sgml/ref/createlang.sgml | 24 | ||||
| -rw-r--r-- | doc/src/sgml/ref/createuser.sgml | 24 | ||||
| -rw-r--r-- | doc/src/sgml/ref/dropdb.sgml | 20 | ||||
| -rw-r--r-- | doc/src/sgml/ref/droplang.sgml | 18 | ||||
| -rw-r--r-- | doc/src/sgml/ref/dropuser.sgml | 22 | ||||
| -rw-r--r-- | doc/src/sgml/ref/ecpg-ref.sgml | 100 | ||||
| -rw-r--r-- | doc/src/sgml/ref/initdb.sgml | 8 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_ctl-ref.sgml | 34 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_dump.sgml | 33 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_dumpall.sgml | 6 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_passwd.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pg_restore.sgml | 12 | ||||
| -rw-r--r-- | doc/src/sgml/ref/pgaccess-ref.sgml | 32 | ||||
| -rw-r--r-- | doc/src/sgml/ref/postgres-ref.sgml | 21 | ||||
| -rw-r--r-- | doc/src/sgml/ref/postmaster.sgml | 26 | ||||
| -rw-r--r-- | doc/src/sgml/ref/vacuumdb.sgml | 22 |
17 files changed, 218 insertions, 210 deletions
diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index 4149af6466..57c244b271 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.21 2001/11/18 20:35:02 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.22 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -38,9 +38,8 @@ Postgres documentation <term>-h, --host <replaceable class="parameter">host</replaceable></term> <listitem> <para> - Specifies the hostname of the machine on which the - <application>postmaster</application> - is running. If host begins with a slash, it 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> @@ -51,8 +50,7 @@ Postgres documentation <listitem> <para> Specifies the Internet TCP/IP port or the local Unix domain socket file - extension on which the <command>postmaster</command> - is listening for connections. + extension on which the server is listening for connections. </para> </listitem> </varlistentry> @@ -61,7 +59,7 @@ Postgres documentation <term>-U, --username <replaceable class="parameter">username</replaceable></term> <listitem> <para> - Username to connect as. + User name to connect as </para> </listitem> </varlistentry> @@ -80,7 +78,7 @@ Postgres documentation <listitem> <para> Echo the queries that <application>createdb</application> generates - and sends to the backend. + and sends to the server. </para> </listitem> </varlistentry> @@ -127,7 +125,7 @@ Postgres documentation <listitem> <para> Specifies the name of the database to be created. The name must be - unique among all <productname>Postgres</productname> databases in this installation. + 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> @@ -203,7 +201,7 @@ Postgres documentation Description </title> <para> - <application>createdb</application> creates a new <productname>Postgres</productname> + <application>createdb</application> creates a new <productname>PostgreSQL</productname> database. The user who executes this command becomes the database owner. </para> @@ -211,7 +209,7 @@ Postgres documentation <application>createdb</application> is a shell script wrapper around the <acronym>SQL</acronym> command <xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-title"> via - the <productname>Postgres</productname> interactive terminal + the <productname>PostgreSQL</productname> interactive terminal <xref linkend="APP-PSQL">. Thus, there is nothing special about creating databases via this or other methods. This means that the <application>psql</application> program must be found by the script and that @@ -240,7 +238,7 @@ Postgres documentation <informalexample> <para> To create the database <literal>demo</literal> using the - postmaster on host eden, port 5000, using the + server on host eden, port 5000, using the <literal>LATIN1</literal> encoding scheme with a look at the underlying query: <screen> diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml index c4d215d7c7..4d267f75d1 100644 --- a/doc/src/sgml/ref/createlang.sgml +++ b/doc/src/sgml/ref/createlang.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.19 2001/10/26 21:17:03 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.20 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -86,8 +86,8 @@ Postgres documentation <listitem> <para> Specifies the directory in which the language interpreter is - to be found. Use of this option is deprecated; the directory - is normally found automatically. + to be found. The directory is normally found automatically; this + option is primarily for debugging purposes. </para> </listitem> </varlistentry> @@ -104,10 +104,10 @@ Postgres documentation <term>-h, --host <replaceable class="parameter">host</replaceable></term> <listitem> <para> - Specifies the hostname of the machine on which the - <application>postmaster</application> + 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. + as the directory for the Unix domain socket. </para> </listitem> </varlistentry> @@ -117,7 +117,7 @@ Postgres documentation <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file - extension on which the <application>postmaster</application> + extension on which the server is listening for connections. </para> </listitem> @@ -127,7 +127,7 @@ Postgres documentation <term>-U, --username <replaceable class="parameter">username</replaceable></term> <listitem> <para> - Username to connect as. + User name to connect as </para> </listitem> </varlistentry> @@ -166,10 +166,10 @@ Postgres documentation <para> <application>createlang</application> is a utility for adding a new - programming language to a <productname>Postgres</productname> database. - <application>createlang</application> currently accepts several - languages, <literal>plpgsql, pltcl, pltclu,</literal> and <literal> - plperl</literal>. + programming language to a <productname>PostgreSQL</productname> database. + <application>createlang</application> can handle all the languages + supplied in the default <productname>PostgreSQL</> distribution, but + not languages provided by other parties. </para> <para> Although backend programming languages can be added directly using diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index 729945de01..8efa8c3937 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.20 2001/09/03 12:57:49 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.21 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -37,10 +37,10 @@ Postgres documentation <term>-h, --host <replaceable class="parameter">host</replaceable></term> <listitem> <para> - Specifies the hostname of the machine on which the - <application>postmaster</application> + 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. + as the directory for the Unix domain socket. </para> </listitem> </varlistentry> @@ -50,7 +50,7 @@ Postgres documentation <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file - extension on which the <application>postmaster</application> + extension on which the server is listening for connections. </para> </listitem> @@ -61,7 +61,7 @@ Postgres documentation <listitem> <para> Echo the queries that <application>createuser</application> generates - and sends to the backend. + and sends to the server. </para> </listitem> </varlistentry> @@ -156,8 +156,8 @@ Postgres documentation <term><replaceable class="parameter">username</replaceable></term> <listitem> <para> - Specifies the name of the <productname>Postgres</productname> user to be created. - This name must be unique among all <productname>Postgres</productname> users. + 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> @@ -214,17 +214,17 @@ Postgres documentation </title> <para> <application>createuser</application> creates a - new <productname>Postgres</productname> user. + new <productname>PostgreSQL</productname> user. Only users with <literal>usesuper</literal> set in the <literal>pg_shadow</literal> table can create - new <productname>Postgres</productname> users. + new <productname>PostgreSQL</productname> users. </para> <para> <application>createuser</application> is a shell script wrapper around the <acronym>SQL</acronym> command <xref linkend="SQL-CREATEUSER" endterm="SQL-CREATEUSER-title"> via - the <productname>Postgres</productname> interactive terminal + the <productname>PostgreSQL</productname> interactive terminal <xref linkend="APP-PSQL">. Thus, there is nothing special about creating users via this or other methods. This means that the <application>psql</application> must be found by the script and that @@ -255,7 +255,7 @@ Postgres documentation <informalexample> <para> To create the same user <literal>joe</literal> using the - postmaster on host eden, port 5000, avoiding the prompts and + server on host eden, port 5000, avoiding the prompts and taking a look at the underlying query: <screen> <prompt>$ </prompt><userinput>createuser -p 5000 -h eden -D -A -e joe</userinput> diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml index 10fd58321e..c9df28445b 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.11 2001/09/03 12:57:50 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.12 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -37,8 +37,8 @@ Postgres documentation <term>-h, --host <replaceable class="parameter">host</replaceable></term> <listitem> <para> - Specifies the hostname of the machine on which the - <application>postmaster</application> + 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> @@ -50,7 +50,7 @@ Postgres documentation <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file - extension on which the <application>postmaster</application> + extension on which the server is listening for connections. </para> </listitem> @@ -60,7 +60,7 @@ Postgres documentation <term>-U, --username <replaceable class="parameter">username</replaceable></term> <listitem> <para> - Username to connect as. + User name to connect as </para> </listitem> </varlistentry> @@ -79,7 +79,7 @@ Postgres documentation <listitem> <para> Echo the queries that <application>dropdb</application> generates - and sends to the backend. + and sends to the server. </para> </listitem> </varlistentry> @@ -107,7 +107,7 @@ Postgres documentation <listitem> <para> Specifies the name of the database to be removed. The database - must be one of the existing <productname>Postgres</productname> databases + must be one of the existing <productname>PostgreSQL</productname> databases in this installation. </para> </listitem> @@ -157,7 +157,7 @@ Postgres documentation </title> <para> <application>dropdb</application> destroys an existing - <productname>Postgres</productname> database. + <productname>PostgreSQL</productname> database. The user who executes this command must be a database superuser or the owner of the database. </para> @@ -166,7 +166,7 @@ Postgres documentation <application>dropdb</application> is a shell script wrapper around the <acronym>SQL</acronym> command <xref linkend="SQL-DROPDATABASE" endterm="SQL-DROPDATABASE-title"> via - the <productname>Postgres</productname> interactive terminal + the <productname>PostgreSQL</productname> interactive terminal <xref linkend="APP-PSQL">. Thus, there is nothing special about dropping databases via this or other methods. This means that the <application>psql</application> must be found by the script and that @@ -193,7 +193,7 @@ Postgres documentation <informalexample> <para> To destroy the database <literal>demo</literal> using the - postmaster on host eden, port 5000, with verification and a peek + server on host eden, port 5000, with verification and a peek at the underlying query: <screen> <prompt>$ </prompt><userinput>dropdb -p 5000 -h eden -i -e demo</userinput> diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml index 0f30621e7f..3fe3dc8ad6 100644 --- a/doc/src/sgml/ref/droplang.sgml +++ b/doc/src/sgml/ref/droplang.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.13 2001/09/14 09:49:00 ishii Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.14 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -92,10 +92,10 @@ Postgres documentation <term>-h, --host <replaceable class="parameter">host</replaceable></term> <listitem> <para> - Specifies the hostname of the machine on which the - <application>postmaster</application> + 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. + as the directory for the Unix domain socket. </para> </listitem> </varlistentry> @@ -105,7 +105,7 @@ Postgres documentation <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file - extension on which the <application>postmaster</application> + extension on which the server is listening for connections. </para> </listitem> @@ -115,7 +115,7 @@ Postgres documentation <term>-U, --username <replaceable class="parameter">username</replaceable></term> <listitem> <para> - Username to connect as. + User name to connect as </para> </listitem> </varlistentry> @@ -155,9 +155,9 @@ Postgres documentation <para> <application>droplang</application> is a utility for removing an existing programming language from a - <productname>Postgres</productname> database. - <application>droplang</application> currently accepts two - languages, <literal>plsql</literal> and <literal>pltcl</literal>. + <productname>PostgreSQL</productname> database. + <application>droplang</application> can drop any procedural language, + even those not supplied by the <productname>PostgreSQL</> distribution. </para> <para> Although backend programming languages can be removed directly using diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml index 73c8524999..217040403d 100644 --- a/doc/src/sgml/ref/dropuser.sgml +++ b/doc/src/sgml/ref/dropuser.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.13 2001/09/03 12:57:50 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.14 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -37,10 +37,10 @@ Postgres documentation <term>-h, --host <replaceable class="parameter">host</replaceable></term> <listitem> <para> - Specifies the hostname of the machine on which the - <application>postmaster</application> + 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. + as the directory for the Unix domain socket. </para> </listitem> </varlistentry> @@ -50,7 +50,7 @@ Postgres documentation <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file - extension on which the <application>postmaster</application> + extension on which the server is listening for connections. </para> </listitem> @@ -61,7 +61,7 @@ Postgres documentation <listitem> <para> Echo the queries that <application>createdb</application> generates - and sends to the backend. + and sends to the server. </para> </listitem> </varlistentry> @@ -88,8 +88,8 @@ Postgres documentation <term><replaceable class="parameter">username</replaceable></term> <listitem> <para> - Specifies the name of the <productname>Postgres</productname> user to be removed. - This name must exist in the <productname>Postgres</productname> installation. + 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> @@ -145,18 +145,18 @@ Postgres documentation </title> <para> <application>dropuser</application> removes an existing - <productname>Postgres</productname> user + <productname>PostgreSQL</productname> user <emphasis>and</emphasis> the databases which that user owned. Only users with <literal>usesuper</literal> set in the <literal>pg_shadow</literal> table can destroy - <productname>Postgres</productname> users. + <productname>PostgreSQL</productname> users. </para> <para> <application>dropuser</application> is a shell script wrapper around the <acronym>SQL</acronym> command <xref linkend="SQL-DROPUSER" endterm="SQL-DROPUSER-title"> via - the <productname>Postgres</productname> interactive terminal + the <productname>PostgreSQL</productname> interactive terminal <xref linkend="APP-PSQL">. Thus, there is nothing special about removing users via this or other methods. This means that the <application>psql</application> must be found by the script and that diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml index 766f53c598..a9d2706178 100644 --- a/doc/src/sgml/ref/ecpg-ref.sgml +++ b/doc/src/sgml/ref/ecpg-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.12 2001/11/18 20:35:02 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.13 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -67,11 +67,11 @@ Postgres documentation <listitem> <para> Specify an additional include path. - Defaults are <filename>.</filename>, + Defaults are <filename>.</filename> (current directory), <filename>/usr/local/include</filename>, the - <productname>Postgres</productname> include path which is + <productname>PostgreSQL</productname> include path which is defined at compile time (default: - <filename>/usr/local/pgsql/lib</filename>), and + <filename>/usr/local/pgsql/include</filename>), and <filename>/usr/include</filename>. </para> </listitem> @@ -118,7 +118,7 @@ Postgres documentation <variablelist> <varlistentry> - <term><replaceable>return value</replaceable></term> + <term>Return value</term> <listitem> <para> <application>ecpg</application> returns 0 to the shell on successful completion, non-zero @@ -136,7 +136,7 @@ Postgres documentation <para> <application>ecpg</application> is an embedded SQL preprocessor for the C language and the - <productname>Postgres</productname>. It + <productname>PostgreSQL</productname>. It enables development of C programs with embedded SQL code. </para> @@ -160,9 +160,9 @@ Postgres documentation <para> An embedded SQL source file must be preprocessed before compilation: - <programlisting> +<synopsis> ecpg [ -d ] [ -o <replaceable>file</replaceable> ] <replaceable>file</replaceable>.pgc - </programlisting> +</synopsis> where the optional <option>-d</option> flag turns on debugging. The <literal>.pgc</literal> extension is an @@ -178,13 +178,13 @@ ecpg [ -d ] [ -o <replaceable>file</replaceable> ] <replaceable>file</replaceabl <title>Compiling and Linking</title> <para> - Assuming the <productname>Postgres</productname> binaries are in + Assuming the <productname>PostgreSQL</productname> binaries are in <filename>/usr/local/pgsql</filename>, you will need to compile and link your preprocessed source file: - <programlisting> +<synopsis> gcc -g -I /usr/local/pgsql/include [ -o <replaceable>file</replaceable> ] <replaceable>file</replaceable>.c -L /usr/local/pgsql/lib -lecpg -lpq - </programlisting> +</synopsis> </para> </refsect2> </refsect1> @@ -198,10 +198,10 @@ gcc -g -I /usr/local/pgsql/include [ -o <replaceable>file</replaceable> ] <repla <para> The preprocessor will prepend two directives to the source: - <programlisting> +<programlisting> #include <ecpgtype.h> #include <ecpglib.h> - </programlisting> +</programlisting> </para> </refsect2> @@ -211,26 +211,26 @@ gcc -g -I /usr/local/pgsql/include [ -o <replaceable>file</replaceable> ] <repla <para> Variables declared within <application>ecpg</application> source code must be prepended with: - <programlisting> +<programlisting> EXEC SQL BEGIN DECLARE SECTION; - </programlisting> +</programlisting> </para> <para> Similarly, variable declaration sections must terminate with: - <programlisting> +<programlisting> EXEC SQL END DECLARE SECTION; - </programlisting> +</programlisting> <note> <para> Prior to version 2.1.0, each variable had to be declared on a separate line. As of version 2.1.0 multiple variables may be declared on a single line: - <programlisting> +<programlisting> char foo[16], bar[16]; - </programlisting> +</programlisting> </para> </note> </para> @@ -242,51 +242,53 @@ char foo[16], bar[16]; <para> The SQL communication area is defined with: - <programlisting> +<programlisting> EXEC SQL INCLUDE sqlca; - </programlisting> +</programlisting> + </para> <note> <para> The <literal>sqlca</literal> is in lowercase. While SQL convention may be followed, i.e., using uppercase to separate embedded SQL - from C statements, sqlca (which includes the sqlca.h - header file) MUST be lowercase. This is because the EXEC SQL - prefix indicates that this INCLUDE will be parsed by <application>ecpg</application>. - <application>ecpg</application> observes case sensitivity (SQLCA.h will not be found). + from C statements, sqlca (which includes the <filename>sqlca.h</> + header file) <emphasis>must</> be lowercase. This is because the + EXEC SQL prefix indicates that this inclusion will be parsed by + <application>ecpg</application>. + <application>ecpg</application> observes case sensitivity + (<filename>SQLCA.h</> will not be found). <command>EXEC SQL INCLUDE</command> can be used to include other header files as long as case sensitivity is observed. </para> </note> - </para> <para> The sqlprint command is used with the EXEC SQL WHENEVER statement to turn on error handling throughout the program: - <programlisting> +<programlisting> EXEC SQL WHENEVER sqlerror sqlprint; - </programlisting> +</programlisting> and - <programlisting> +<programlisting> EXEC SQL WHENEVER not found sqlprint; - </programlisting> +</programlisting> + </para> <note> <para> This is <emphasis>not</emphasis> an exhaustive example of usage for the <command>EXEC SQL WHENEVER</command> statement. Further examples of usage may - be found in SQL manuals (e.g., `The LAN TIMES Guide to SQL' by + be found in SQL manuals (e.g., <citetitle>The LAN TIMES Guide to SQL</> by Groff and Weinberg). </para> </note> - </para> </refsect2> <refsect2 id="R2-APP-ECPG-connecting"> @@ -295,9 +297,9 @@ EXEC SQL WHENEVER not found sqlprint; <para> One connects to a database using the following: - <programlisting> +<programlisting> EXEC SQL CONNECT TO <replaceable>dbname</replaceable>; - </programlisting> +</programlisting> where the database name is not quoted. Prior to version 2.1.0, the database name was required to be inside single quotes. @@ -307,15 +309,15 @@ EXEC SQL CONNECT TO <replaceable>dbname</replaceable>; Specifying a server and port name in the connect statement is also possible. The syntax is: - <programlisting> +<synopsis> <replaceable>dbname</replaceable>[@<replaceable>server</replaceable>][:<replaceable>port</replaceable>] - </programlisting> +</synopsis> or - <programlisting> +<synopsis> <tcp|unix>:postgresql://<replaceable>server</replaceable>[:<replaceable>port</replaceable>][/<replaceable>dbname</replaceable>][?<replaceable>options</replaceable>] - </programlisting> +</synopsis> </para> </refsect2> @@ -331,20 +333,20 @@ EXEC SQL CONNECT TO <replaceable>dbname</replaceable>; <para> Create Table: - <programlisting> +<programlisting> EXEC SQL CREATE TABLE foo (number int4, ascii char(16)); EXEC SQL CREATE UNIQUE index num1 on foo(number); EXEC SQL COMMIT; - </programlisting> +</programlisting> </para> <para> Insert: - <programlisting> +<programlisting> EXEC SQL INSERT INTO foo (number, ascii) VALUES (9999, 'doodad'); EXEC SQL COMMIT; - </programlisting> +</programlisting> </para> <para> @@ -353,21 +355,21 @@ EXEC SQL COMMIT; <programlisting> EXEC SQL DELETE FROM foo WHERE number = 9999; EXEC SQL COMMIT; - </programlisting> +</programlisting> </para> <para> Singleton Select: - <programlisting> +<programlisting> EXEC SQL SELECT foo INTO :FooBar FROM table1 WHERE ascii = 'doodad'; - </programlisting> +</programlisting> </para> <para> Select using Cursors: - <programlisting> +<programlisting> EXEC SQL DECLARE foo_bar CURSOR FOR SELECT number, ascii FROM foo ORDER BY ascii; @@ -375,17 +377,17 @@ EXEC SQL FETCH foo_bar INTO :FooBar, DooDad; ... EXEC SQL CLOSE foo_bar; EXEC SQL COMMIT; - </programlisting> +</programlisting> </para> <para> Updates: - <programlisting> +<programlisting> EXEC SQL UPDATE foo SET ascii = 'foobar' WHERE number = 9999; EXEC SQL COMMIT; - </programlisting> +</programlisting> </para> </refsect2> </refsect1> diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index bab8dcf108..a52a63e53b 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.17 2001/09/08 15:24:00 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.18 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -141,10 +141,10 @@ Postgres documentation <term>-E <replaceable class="parameter">encoding</replaceable></term> <listitem> <para> - Selects the multibyte encoding of the template database. This will also + Selects the encoding of the template database. This will also be the default encoding of any database you create later, unless you - override it there. To use the multibyte encoding feature, you must - specify so at build time, at which time you also select the default + override it there. To use the encoding feature, you must + have enabled it at build time, at which time you also select the default for this option. </para> </listitem> diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml index 10f9a2a5f4..8bcb64e007 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.10 2001/11/19 03:58:25 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.11 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -79,7 +79,7 @@ Postgres documentation started manually, <application>pg_ctl</application> encapulates tasks such as redirecting log output, properly detaching from the terminal and process group, and it provides convenient options for - controlled shut down. + controlled shutdown. </para> <para> @@ -117,10 +117,10 @@ Postgres documentation </para> <para> - <option>reload</option> mode simply sends the postmaster a SIGHUP signal, + <option>reload</option> mode simply sends the postmaster a <systemitem>SIGHUP</> signal, causing it to reread its configuration files (<filename>postgresql.conf</filename>, <filename>pg_hba.conf</filename>, - etc). This allows changing of configuration-file options that do not + etc.). This allows changing of configuration-file options that do not require a complete restart to take effect. </para> @@ -199,30 +199,30 @@ Postgres documentation </varlistentry> <varlistentry> - <term>-w</term> + <term>-s</term> <listitem> <para> - Wait for the start or shutdown to complete. Times out after - 60 seconds. This is the default for shutdowns. + Only print errors, no informational messages. </para> </listitem> </varlistentry> <varlistentry> - <term>-W</term> + <term>-w</term> <listitem> <para> - Do not wait for start or shutdown to complete. This is the - default for starts and restarts. + Wait for the start or shutdown to complete. Times out after + 60 seconds. This is the default for shutdowns. </para> </listitem> </varlistentry> <varlistentry> - <term>-s</term> + <term>-W</term> <listitem> <para> - Only print errors, no informational messages. + Do not wait for start or shutdown to complete. This is the + default for starts and restarts. </para> </listitem> </varlistentry> @@ -251,7 +251,7 @@ Postgres documentation <title>Starting the postmaster</title> <para> - To start up <application>postmaster</application>: + To start up a <application>postmaster</application>: <screen> <prompt>$</prompt> <userinput>pg_ctl start</userinput> </screen> @@ -259,7 +259,7 @@ Postgres documentation <para> An example of starting the <application>postmaster</application>, - blocking until postmaster comes up is: + blocking until the postmaster comes up is: <screen> <prompt>$</prompt> <userinput>pg_ctl -w start</userinput> </screen> @@ -280,7 +280,7 @@ Postgres documentation <screen> <prompt>$</prompt> <userinput>pg_ctl stop</userinput> </screen> - stops postmaster. Using the <option>-m</option> switch allows one + stops the postmaster. Using the <option>-m</option> switch allows one to control <emphasis>how</emphasis> the backend shuts down. </para> </refsect2> @@ -290,10 +290,10 @@ Postgres documentation <para> This is almost equivalent to stopping the - <application>postmaster</application> then starting it again + <application>postmaster</application> and starting it again except that pg_ctl saves and reuses the command line options that were passed to the previously running instance. To restart - <application>postmaster</application> in the simplest form: + the <application>postmaster</application> in the simplest form: <screen> <prompt>$</prompt> <userinput>pg_ctl restart</userinput> </screen> diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 61b0b26c93..dff18523e0 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.39 2001/11/18 20:35:02 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.40 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -62,12 +62,13 @@ Postgres documentation <para> <command>pg_dump</command> is a utility for saving a <productname>PostgreSQL</productname> database into a script or an - archive file. The script files are in plain text format and + archive file. The script files are in plain-text format and contain the SQL commands required to reconstruct the database to the state it was in at the time it was saved. They can be used to reconstruct the database even on other machines and other architectures, with some modifications even on other RDBMS - products. The alternative archive file formats are meant to be + products. Furthermore, there are alternative archive file formats that + are meant to be used with <xref linkend="app-pgrestore"> to rebuild the database, and they also allow <command>pg_restore</command> to be selective about what is restored, or even to reorder the items prior to being @@ -86,7 +87,7 @@ Postgres documentation <para> <command>pg_dump</command> is useful for dumping out the contents of a database to move from one - <productname>Postgres</productname> installation to another. + <productname>PostgreSQL</productname> installation to another. </para> <para> @@ -145,7 +146,7 @@ Postgres documentation </para> <para> - This option is only meaningful for the plain text format. For + This option is only meaningful for the plain-text format. For the other formats, you may specify the option when you call <command>pg_restore</command>. </para> @@ -172,7 +173,7 @@ Postgres documentation </para> <para> - This option is only meaningful for the plain text format. For + This option is only meaningful for the plain-text format. For the other formats, you may specify the option when you call <command>pg_restore</command>. </para> @@ -191,7 +192,7 @@ Postgres documentation </para> <para> - This option is only meaningful for the plain text format. For + This option is only meaningful for the plain-text format. For the other formats, you may specify the option when you call <command>pg_restore</command>. </para> @@ -251,7 +252,7 @@ Postgres documentation <term>p</term> <listitem> <para> - output a plain text <acronym>SQL</acronym> script file (default) + Output a plain-text <acronym>SQL</acronym> script file (default) </para> </listitem> </varlistentry> @@ -260,7 +261,7 @@ Postgres documentation <term>t</term> <listitem> <para> - output a <filename>tar</filename> archive suitable for input into + Output a <filename>tar</filename> archive suitable for input into <command>pg_restore</command>. Using this archive format allows reordering and/or exclusion of schema elements at the time the database is restored. It is also possible to limit @@ -273,7 +274,7 @@ Postgres documentation <term>c</term> <listitem> <para> - output a custom archive suitable for input into + Output a custom archive suitable for input into <command>pg_restore</command>. This is the most flexible format in that it allows reordering of data load as well as schema elements. This format is also compressed by default. @@ -360,7 +361,7 @@ Postgres documentation </para> <para> - This option is only meaningful for the plain text format. For + This option is only meaningful for the plain-text format. For the other formats, you may specify the option when you call <command>pg_restore</command>. </para> @@ -390,7 +391,7 @@ Postgres documentation </para> <para> - This option is only meaningful for the plain text format. For + This option is only meaningful for the plain-text format. For the other formats, you may specify the option when you call <command>pg_restore</command>. </para> @@ -456,7 +457,7 @@ Postgres documentation <term>--use-set-session-authorization</term> <listitem> <para> - Normally, if a (plain text mode) script generated by + Normally, if a (plain-text mode) script generated by <command>pg_dump</command> must alter the current database user (e.g., to set correct object ownerships), it uses the <xref linkend="app-psql"> <command>\connect</command> command. @@ -479,7 +480,7 @@ Postgres documentation </para> <para> - This option is only meaningful for the plain text format. For + This option is only meaningful for the plain-text format. For the other formats, you may specify the option when you call <command>pg_restore</command>. </para> @@ -511,7 +512,7 @@ Postgres documentation <listitem> <para> Specifies the host name of the machine on which the - <command>postmaster</command> + server is running. If host begins with a slash, it is used as the directory for the Unix domain socket. </para> @@ -524,7 +525,7 @@ Postgres documentation <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file - extension on which the <command>postmaster</command> + extension on which the server is listening for connections. The port number defaults to 5432, or the value of the <envar>PGPORT</envar> environment variable (if set). diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index 76518b8646..9039b36318 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.25 2001/10/23 22:11:22 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.26 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -36,7 +36,7 @@ Postgres documentation <para> <application>pg_dumpall</application> is a utility for writing out - (<quote>dumping</quote>) all Postgres databases of a cluster into + (<quote>dumping</quote>) all PostgreSQL databases of a cluster into one script file. The script file contains SQL commands that can be used as input to <xref linkend="app-psql"> to restore the databases. It does this by calling <xref @@ -104,7 +104,7 @@ Postgres documentation <term>-h <replaceable>host</replaceable></term> <listitem> <para> - Specifies the hostname of the machine on which the database + Specifies the host name of the machine on which the database server is running. If host begins with a slash, it is used as the directory for the Unix domain socket. The default is taken from the <envar>PGHOST</envar> environment variable, if diff --git a/doc/src/sgml/ref/pg_passwd.sgml b/doc/src/sgml/ref/pg_passwd.sgml index 66d666cc68..0b7aba901f 100644 --- a/doc/src/sgml/ref/pg_passwd.sgml +++ b/doc/src/sgml/ref/pg_passwd.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pg_passwd.sgml,v 1.8 2001/09/03 12:57:50 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pg_passwd.sgml,v 1.9 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -16,7 +16,7 @@ Postgres documentation <refnamediv> <refname>pg_passwd</refname> - <refpurpose>change a secondary password file</refpurpose> + <refpurpose>change a secondary <productname>PostgreSQL</> password file</refpurpose> </refnamediv> <refsynopsisdiv> diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 329823d6fa..ef0587c11f 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.20 2001/11/26 23:09:21 tgl Exp $ --> +<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.21 2001/11/28 20:49:10 petere Exp $ --> <refentry id="APP-PGRESTORE"> <docinfo> @@ -60,7 +60,7 @@ <para> <command>pg_restore</command> is a utility for restoring a - <productname>Postgres</productname> database from an archive + <productname>PostgreSQL</productname> database from an archive created by <xref linkend="app-pgdump"> in one of the non-plain-text formats. It will issue the commands necessary to re-generate all user-defined @@ -394,7 +394,7 @@ current database user (e.g., to set correct object ownerships), a new connection to the database must be opened, which might require manual interaction (e.g., passwords). If - you use the <option>-X use-set-session-authorization</option>, + you use the <option>-X use-set-session-authorization</option> option, then <command>pg_restore</command> will instead use the <xref linkend="sql-set-session-authorization"> command. This has the same effect, but it requires that the user restoring the @@ -418,7 +418,7 @@ <listitem> <para> Specifies the host name of the machine on which the - <command>postmaster</command> + server is running. If host begins with a slash, it is used as the directory for the Unix domain socket. </para> @@ -431,7 +431,7 @@ <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file - extension on which the <command>postmaster</command> + extension on which the server is listening for connections. The port number defaults to 5432, or the value of the <envar>PGPORT</envar> environment variable (if set). @@ -487,7 +487,7 @@ connectDBStart() -- connect() failed: No such file or directory <command>pg_restore</command> could not attach to the <command>postmaster</command> process on the specified host and port. If you see this message, - ensure that the <command>postmaster</command> + ensure that the server is running on the proper host and that you have specified the proper port. If your site uses an authentication system, ensure that you have obtained the required authentication credentials. diff --git a/doc/src/sgml/ref/pgaccess-ref.sgml b/doc/src/sgml/ref/pgaccess-ref.sgml index c4bcdb7bba..c2f42527c5 100644 --- a/doc/src/sgml/ref/pgaccess-ref.sgml +++ b/doc/src/sgml/ref/pgaccess-ref.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgaccess-ref.sgml,v 1.11 2001/09/03 12:57:50 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgaccess-ref.sgml,v 1.12 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -47,21 +47,21 @@ Postgres documentation Description </title> <para> - <application>pgaccess</application> provides a graphical interface - for <productname>Postgres</productname> + <application>PgAccess</application> provides a graphical interface + for <productname>PostgreSQL</productname> wherein you can manage your tables, edit them, define queries, sequences and functions. </para> <para> - <application>pgaccess</application> can: + <application>PgAccess</application> can: <itemizedlist mark="bullet" spacing="compact"> <listitem> <para> Open any database on a specified host at the specified port, - username, and password. + user name, and password. </para> </listitem> @@ -80,7 +80,7 @@ Postgres documentation </para> <para> - For tables, <application>pgaccess</application> can: + For tables, <application>PgAccess</application> can: <itemizedlist mark="bullet" spacing="compact"> <listitem> @@ -139,7 +139,7 @@ Postgres documentation <listitem> <para> - Delete records; point to the record, press <keycap>Delete</keycap> key. + Delete records; point to the record, press the <keycap>Delete</keycap> key. </para> </listitem> @@ -170,7 +170,7 @@ Postgres documentation </para> <para> - For queries, <application>pgaccess</application> can: + For queries, <application>PgAccess</application> can: <itemizedlist mark="bullet" spacing="compact"> <listitem> @@ -222,7 +222,7 @@ select * from invoices where year=[parameter "Year of selection"] </para> <para> - For sequences, <application>pgaccess</application> can: + For sequences, <application>PgAccess</application> can: <itemizedlist mark="bullet" spacing="compact"> <listitem> @@ -246,7 +246,7 @@ select * from invoices where year=[parameter "Year of selection"] </para> <para> - For views, <application>pgaccess</application> can: + For views, <application>PgAccess</application> can: <itemizedlist mark="bullet" spacing="compact"> <listitem> @@ -276,7 +276,7 @@ select * from invoices where year=[parameter "Year of selection"] </para> <para> - For functions, <application>pgaccess</application> can: + For functions, <application>PgAccess</application> can: <itemizedlist mark="bullet" spacing="compact"> <listitem> @@ -300,7 +300,7 @@ select * from invoices where year=[parameter "Year of selection"] </para> <para> - For reports, <application>pgaccess</application> can: + For reports, <application>PgAccess</application> can: <itemizedlist mark="bullet" spacing="compact"> <listitem> @@ -330,7 +330,7 @@ select * from invoices where year=[parameter "Year of selection"] </para> <para> - For forms, <application>pgaccess</application> can: + For forms, <application>PgAccess</application> can: <itemizedlist mark="bullet" spacing="compact"> <listitem> @@ -354,7 +354,7 @@ select * from invoices where year=[parameter "Year of selection"] </para> <para> - For scripts, <application>pgaccess</application> can: + For scripts, <application>PgAccess</application> can: <itemizedlist mark="bullet" spacing="compact"> <listitem> @@ -382,9 +382,9 @@ select * from invoices where year=[parameter "Year of selection"] <title>Notes</title> <para> - <application>pgaccess</application> is written in Tcl/Tk. Your + <application>PgAccess</application> is written in Tcl/Tk. Your <productname>PostgreSQL</productname> installation needs to be - built with Tcl support for <application>pgaccess</application> to + built with Tcl support for <application>PgAccess</application> to be available. </para> </refsect1> diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index 00207b20f7..48ff1cb007 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.21 2001/11/25 01:11:36 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.22 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -99,7 +99,7 @@ Postgres documentation queries and the results will be printed to the screen, but in a form that is more useful for developers than end users. But note that running a single-user backend is not truly suitable for - debugging the server since no realistic inter-process communication + debugging the server since no realistic interprocess communication and locking will happen. </para> @@ -355,7 +355,7 @@ Postgres documentation <title>Usage</title> <para> - Start a standalone backend with a command like + Start a stand-alone backend with a command like <screen> <userinput>postgres -D $PGDATA <replaceable>other-options</> my_database</userinput> </screen> @@ -365,7 +365,7 @@ Postgres documentation </para> <para> - Normally, the standalone backend treats newline as the command + Normally, the stand-alone backend treats newline as the command entry terminator; there is no intelligence about semicolons, as there is in <application>psql</>. To continue a command across multiple lines, you must type backslash just before each @@ -374,19 +374,22 @@ Postgres documentation <para> But if you use the <option>-N</> command line switch, then newline does - not terminate command entry. The backend will read stdin until EOF, then + not terminate command entry. The backend will read the standard input + until the end-of-file (EOF) marker, then process the input as a single query string. Backslash-newline is not treated specially in this case. </para> <para> - The standalone backend does not have readline input processing - (no command history, for example). + To quit the session, type EOF + (<keycombo action="simul"><keycap>Control</><keycap>D</></>, usually). + If you've + used <option>-N</>, two consecutive EOFs are needed to exit. </para> <para> - To quit the backend, type EOF (control-D, usually). If you've - used <option>-N</>, two consecutive EOFs are needed to exit. + Note that the stand-alone backend does not provide sophisticated + line-editing features (no command history, for example). </para> </refsect1> diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index 1da4e01b28..6399d3558e 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.24 2001/11/26 19:41:55 momjian Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.25 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -159,10 +159,11 @@ Postgres documentation <term>-h <replaceable class="parameter">hostname</replaceable></term> <listitem> <para> - Specifies the TCP/IP hostname or address on which the + Specifies the TCP/IP host name or address on which the <application>postmaster</application> is to listen for connections from client applications. Defaults to - listening on all configured addresses (including localhost). + listening on all configured addresses (including + <systemitem class="systemname">localhost</systemitem>). </para> </listitem> </varlistentry> @@ -274,11 +275,6 @@ Postgres documentation Sets a named run-time parameter; a shorter form of <option>-c</>. </para> - <para> - The <option>--</> option will not work on FreeBSD or OpenBSD. - Use <option>-c</> instead. This should be fixed in - <productname>PostgreSQL</productname> 7.3. - </para> </listitem> </varlistentry> @@ -360,9 +356,9 @@ semget: No space left on device <tip> <para> You may be able to postpone - reconfiguring your kernel by decreasing -B to reduce - <productname>Postgres</productname>' shared memory - consumption, and/or by reducing -N to reduce Postgres' semaphore + reconfiguring your kernel by decreasing <option>-B</option> to reduce + the shared memory consumption of <productname>PostgreSQL</>, + and/or by reducing <option>-N</option> to reduce the semaphore consumption. </para> </tip> @@ -441,6 +437,14 @@ StreamServerPort: cannot bind to port start and shut down the <application>postmaster</application> safely and comfortably. </para> + + <para> + The <option>--</> options will not work on FreeBSD or OpenBSD. + Use <option>-c</> instead. This is a bug in the affected operating + systems; a future release of <productname>PostgreSQL</productname> will + provide a workaround if this is not fixed. + </para> + </refsect1> <refsect1 id="app-postmaster-usage"> diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index a4d1a4c26e..487401b1e1 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.18 2001/09/03 12:57:50 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.19 2001/11/28 20:49:10 petere Exp $ Postgres documentation --> @@ -59,7 +59,7 @@ Postgres documentation <varlistentry> <term>-a</term> - <term>--alldb</term> + <term>--all</term> <listitem> <para> Vacuum all databases. @@ -128,10 +128,10 @@ Postgres documentation <term>--host <replaceable class="parameter">host</replaceable></term> <listitem> <para> - Specifies the hostname of the machine on which the - <application>postmaster</application> + 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. + as the directory for the Unix domain socket. </para> </listitem> </varlistentry> @@ -142,7 +142,7 @@ Postgres documentation <listitem> <para> Specifies the Internet TCP/IP port or local Unix domain socket file - extension on which the <application>postmaster</application> + extension on which the server is listening for connections. </para> </listitem> @@ -153,7 +153,7 @@ Postgres documentation <term>--username <replaceable class="parameter">username</replaceable></term> <listitem> <para> - Username to connect as. + User name to connect as </para> </listitem> </varlistentry> @@ -174,7 +174,7 @@ Postgres documentation <listitem> <para> Echo the commands that <application>vacuumdb</application> generates - and sends to the backend. + and sends to the server. </para> </listitem> </varlistentry> @@ -235,16 +235,16 @@ Postgres documentation <para> <application>vacuumdb</application> is a utility for cleaning a - <productname>Postgres</productname> database. + <productname>PostgreSQL</productname> database. <application>vacuumdb</application> will also generate internal statistics - used by the <productname>Postgres</productname> query optimizer. + used by the <productname>PostgreSQL</productname> query optimizer. </para> <para> <application>vacuumdb</application> is a shell script wrapper around the backend command <xref linkend="SQL-VACUUM" endterm="SQL-VACUUM-title"> via - the <productname>Postgres</productname> interactive terminal + the <productname>PostgreSQL</productname> interactive terminal <xref linkend="APP-PSQL">. There is no effective difference between vacuuming databases via this or other methods. <application>psql</application> must be found by the script and |
