mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

First pass over client applications documentation proofreading.

Browse Source 
gabrielle
This commit is contained in:
Bruce Momjian 2010-02-19 03:50:03 +00:00
parent 4e3a616355
commit 2f6b4560af
13 changed files with 59 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/src/sgml/ref/clusterdb.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.25 2009/02/26 16:02:37 petere Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.26 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -29,8 +29,8 @@ PostgreSQL documentation
<sbr>
<command>clusterdb</command>
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
<group><arg>--all</arg><arg>-a</arg></group>
<group><arg>--verbose</arg><arg>-v</arg></group>
<group><arg>--all</arg><arg>-a</arg></group>
</cmdsynopsis>
</refsynopsisdiv>

7
doc/src/sgml/ref/createdb.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.49 2009/02/26 16:02:37 petere Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.50 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -22,6 +22,7 @@ PostgreSQL documentation
<refsynopsisdiv>
<cmdsynopsis>
<command>createdb</command>
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
<arg rep="repeat"><replaceable>option</replaceable></arg>
<arg><replaceable>dbname</replaceable></arg>
<arg><replaceable>description</replaceable></arg>
@ -41,7 +42,7 @@ PostgreSQL documentation
<para>
Normally, the database user who executes this command becomes the owner of
the new database.
However a different owner can be specified via the <option>-O</option>
However, a different owner can be specified via the <option>-O</option>
option, if the executing user has appropriate privileges.
</para>
@ -171,7 +172,7 @@ PostgreSQL documentation
</para>
<para>
The options <option>-D</option>, <option>-E</option>, <option>-l</option>,
The options <option>-D</option>, <option>-l</option>, <option>-E</option>,
<option>-O</option>, and
<option>-T</option> correspond to options of the underlying
SQL command <xref linkend="SQL-CREATEDATABASE"

6
doc/src/sgml/ref/createlang.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.43 2009/02/26 16:02:37 petere Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.44 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -69,7 +69,7 @@ PostgreSQL documentation
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
<listitem>
<para>
Specifies to which database the language should be added.
Specifies the database to which the language should be added.
The default is to use the database with the same name as the
current system user.
</para>
@ -213,7 +213,7 @@ PostgreSQL documentation
<para>
Most error messages are self-explanatory. If not, run
<application>createlang</application> with the <option>--echo</option>
option and see under the respective <acronym>SQL</acronym> command
option and see the respective <acronym>SQL</acronym> command
for details. Also, any default connection settings and environment
variables used by the <application>libpq</application> front-end
library will apply.

3
doc/src/sgml/ref/createuser.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.52 2009/02/26 16:02:37 petere Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.53 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -22,6 +22,7 @@ PostgreSQL documentation
<refsynopsisdiv>
<cmdsynopsis>
<command>createuser</command>
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
<arg rep="repeat"><replaceable>option</replaceable></arg>
<arg><replaceable>username</replaceable></arg>
</cmdsynopsis>

3
doc/src/sgml/ref/dropdb.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.35 2009/02/26 16:02:37 petere Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.36 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -22,6 +22,7 @@ PostgreSQL documentation
<refsynopsisdiv>
<cmdsynopsis>
<command>dropdb</command>
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
<arg rep="repeat"><replaceable>option</replaceable></arg>
<arg choice="plain"><replaceable>dbname</replaceable></arg>
</cmdsynopsis>

3
doc/src/sgml/ref/dropuser.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.40 2009/02/26 16:02:37 petere Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.41 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -22,6 +22,7 @@ PostgreSQL documentation
<refsynopsisdiv>
<cmdsynopsis>
<command>dropuser</command>
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
<arg rep="repeat"><replaceable>option</replaceable></arg>
<arg><replaceable>username</replaceable></arg>
</cmdsynopsis>

4
doc/src/sgml/ref/ecpg-ref.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.32 2007/01/31 23:26:03 momjian Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.33 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -192,7 +192,7 @@ PostgreSQL documentation
<para>
When compiling the preprocessed C code files, the compiler needs to
be able to find the <application>ECPG</> header files in the
<productname>PostgreSQL</> include directory. Therefore, one might
<productname>PostgreSQL</> include directory. Therefore, you might
have to use the <option>-I</> option when invoking the compiler
(e.g., <literal>-I/usr/local/pgsql/include</literal>).
</para>

13
doc/src/sgml/ref/pg_dump.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.114 2009/08/07 20:54:31 alvherre Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.115 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -25,6 +25,7 @@ PostgreSQL documentation
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_dump</command>
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
<arg rep="repeat"><replaceable>option</replaceable></arg>
<arg><replaceable>dbname</replaceable></arg>
</cmdsynopsis>
@ -51,7 +52,7 @@ PostgreSQL documentation
saved. To restore from such a script, feed it to <xref
linkend="app-psql">. Script files
can be used to reconstruct the database even on other machines and
other architectures; with some modifications even on other SQL
other architectures; with some modifications, even on other SQL
database products.
</para>
@ -530,7 +531,7 @@ PostgreSQL documentation
than <command>COPY</command>). This will make restoration very slow;
it is mainly useful for making dumps that can be loaded into
non-<productname>PostgreSQL</productname> databases.
Also, since this option generates a separate command for each row,
However, since this option generates a separate command for each row,
an error in reloading a row causes only that row to be lost rather
than the entire table contents.
Note that
@ -553,7 +554,7 @@ PostgreSQL documentation
...</literal>). This will make restoration very slow; it is mainly
useful for making dumps that can be loaded into
non-<productname>PostgreSQL</productname> databases.
Also, since this option generates a separate command for each row,
However, since this option generates a separate command for each row,
an error in reloading a row causes only that row to be lost rather
than the entire table contents.
</para>
@ -636,7 +637,7 @@ PostgreSQL documentation
<para>
Output SQL-standard <command>SET SESSION AUTHORIZATION</> commands
instead of <command>ALTER OWNER</> commands to determine object
ownership. This makes the dump more standards compatible, but
ownership. This makes the dump more standards-compatible, but
depending on the history of the objects in the dump, might not restore
properly. Also, a dump using <command>SET SESSION AUTHORIZATION</>
will certainly require superuser privileges to restore correctly,
@ -834,7 +835,7 @@ CREATE DATABASE foo WITH TEMPLATE template0;
does not contain the statistics used by the optimizer to make
query planning decisions. Therefore, it is wise to run
<command>ANALYZE</command> after restoring from a dump file
to ensure good performance; see <xref linkend="vacuum-for-statistics">
to ensure optimal performance; see <xref linkend="vacuum-for-statistics">
and <xref linkend="autovacuum"> for more information.
The dump file also does not
contain any <command>ALTER DATABASE ... SET</> commands;

17
doc/src/sgml/ref/pg_dumpall.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.79 2009/03/22 16:44:26 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.80 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -22,6 +22,7 @@ PostgreSQL documentation
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_dumpall</command>
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
<arg rep="repeat"><replaceable>option</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -53,8 +54,8 @@ PostgreSQL documentation
</para>
<para>
The SQL script will be written to the standard output. Shell
operators should be used to redirect it into a file.
The SQL script will be written to the standard output. Use the
[-f|file] option or shell operators to redirect it into a file.
</para>
<para>
@ -168,13 +169,13 @@ PostgreSQL documentation
<listitem>
<para>
Do not wait forever to acquire shared table locks at the beginning of
the dump. Instead fail if unable to lock a table within the specified
the dump. Instead, fail if unable to lock a table within the specified
<replaceable class="parameter">timeout</>. The timeout may be
specified in any of the formats accepted by <command>SET
statement_timeout</>. (Allowed values vary depending on the server
statement_timeout</>. Allowed values vary depending on the server
version you are dumping from, but an integer number of milliseconds
is accepted by all versions since 7.3. This option is ignored when
dumping from a pre-7.3 server.)
dumping from a pre-7.3 server.
</para>
</listitem>
</varlistentry>
@ -510,7 +511,7 @@ PostgreSQL documentation
<para>
<application>pg_dumpall</application> requires all needed
tablespace directories to exist before the restore, else
tablespace directories to exist before the restore; otherwise,
database creation will fail for databases in non-default
locations.
</para>
@ -528,7 +529,7 @@ PostgreSQL documentation
</para>
<para>
To reload this database use, for example:
To reload database(s) from this file, you can use:
<screen>
<prompt>$</prompt> <userinput>psql -f db.out postgres</userinput>
</screen>

13
doc/src/sgml/ref/pg_restore.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.82 2009/08/07 20:54:31 alvherre Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.83 2010/02/19 03:50:03 momjian Exp $ -->
<refentry id="APP-PGRESTORE">
<refmeta>
@ -23,6 +23,7 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_restore</command>
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
<arg rep="repeat"><replaceable>option</replaceable></arg>
<arg><replaceable>filename</replaceable></arg>
</cmdsynopsis>
@ -241,7 +242,7 @@
good place to start is the number of CPU cores on the server,
but values larger than that can also lead to faster restore
times in many cases. Of course, values that are too high will
lead to decreasing performance because of thrashing.
lead to decreased performance because of thrashing.
</para>
<para>
@ -353,7 +354,7 @@
<listitem>
<para>
Restore only the schema (data definitions), not the data (table
contents). Sequence current values will not be restored, either.
contents). Current sequence values will not be restored, either.
(Do not confuse this with the <option>--schema</> option, which
uses the word <quote>schema</> in a different meaning.)
</para>
@ -440,7 +441,7 @@
<para>
Output SQL-standard <command>SET SESSION AUTHORIZATION</> commands
instead of <command>ALTER OWNER</> commands to determine object
ownership. This makes the dump more standards compatible, but
ownership. This makes the dump more standards-compatible, but
depending on the history of the objects in the dump, might not restore
properly.
</para>
@ -653,7 +654,7 @@ CREATE DATABASE foo WITH TEMPLATE template0;
When restoring data to a pre-existing table and the option
<option>--disable-triggers</> is used,
<application>pg_restore</application> emits commands
to disable triggers on user tables before inserting the data then emits commands to
to disable triggers on user tables before inserting the data, then emits commands to
re-enable them after the data has been inserted. If the restore is stopped in the
middle, the system catalogs might be left in the wrong state.
</para>
@ -662,7 +663,7 @@ CREATE DATABASE foo WITH TEMPLATE template0;
<listitem>
<para>
<application>pg_restore</application> cannot restore large objects
selectively, for instance only those for a specific table. If
selectively; for instance, only those for a specific table. If
an archive contains large objects, then all large objects will be
restored, or none of them if they are excluded via <option>-L</option>,
<option>-t</option>, or other options.

28
doc/src/sgml/ref/psql-ref.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.237 2010/01/29 17:44:12 rhaas Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.238 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -54,7 +54,7 @@ PostgreSQL documentation
<listitem>
<para>
Print all input lines to standard output as they are read. This is more
useful for script processing rather than interactive mode. This is
useful for script processing than interactive mode. This is
equivalent to setting the variable <varname>ECHO</varname> to
<literal>all</literal>.
</para>
@ -84,7 +84,7 @@ PostgreSQL documentation
<para>
<replaceable class="parameter">command</replaceable> must be either
a command string that is completely parsable by the server (i.e.,
it contains no <application>psql</application> specific features),
it contains no <application>psql</application>-specific features),
or a single backslash command. Thus you cannot mix
<acronym>SQL</acronym> and <application>psql</application>
meta-commands with this option. To achieve that, you could
@ -173,7 +173,7 @@ PostgreSQL documentation
numbers. There is also a slight chance that using this option will
reduce the start-up overhead. On the other hand, the variant using
the shell's input redirection is (in theory) guaranteed to yield
exactly the same output that you would have gotten had you entered
exactly the same output you would have received had you entered
everything by hand.
</para>
</listitem>
@ -285,7 +285,7 @@ PostgreSQL documentation
Specifies printing options, in the style of
<command>\pset</command>. Note that here you
have to separate name and value with an equal sign instead of a
space. Thus to set the output format to LaTeX, you could write
space. For example, to set the output format to LaTeX, you could write
<literal>-P format=latex</literal>.
</para>
</listitem>
@ -523,8 +523,8 @@ PostgreSQL documentation
<para>
<application>psql</application> returns 0 to the shell if it
finished normally, 1 if a fatal error of its own (out of memory,
file not found) occurs, 2 if the connection to the server went bad
finished normally, 1 if a fatal error of its own occurs (e.g. out of memory,
file not found), 2 if the connection to the server went bad
and the session was not interactive, and 3 if an error occurred in a
script and the variable <varname>ON_ERROR_STOP</varname> was set.
</para>
@ -541,14 +541,14 @@ PostgreSQL documentation
<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 host name and port number of the server and what user
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. If an argument is found that does
not belong to any option it will be interpreted as the database name
(or the user name, if the database name is already given). Not all
these options are required; there are useful defaults. If you omit the host
of these options are required; there are useful defaults. If you omit the host
name, <application>psql</> will connect via a Unix-domain socket
to a server on the local host, or via TCP/IP to <literal>localhost</> on
machines that don't have Unix-domain sockets. The default port number is
@ -633,7 +633,7 @@ testdb=&gt;
Anything you enter in <application>psql</application> that begins
with an unquoted backslash is a <application>psql</application>
meta-command that is processed by <application>psql</application>
itself. These commands help make
itself. These commands make
<application>psql</application> more useful for administration or
scripting. Meta-commands are often called slash or backslash commands.
</para>
@ -1727,7 +1727,7 @@ lo_import 152801
<para>
<literal>aligned</literal> format is the standard, human-readable,
nicely formatted text output that is default.
nicely formatted text output; this is the default.
</para>
<para>
@ -2189,7 +2189,7 @@ lo_import 152801
<para>
Escapes to a separate Unix shell or executes the Unix command
<replaceable class="parameter">command</replaceable>. The
arguments are not further interpreted, the shell will see them
arguments are not further interpreted; the shell will see them
as-is.
</para>
</listitem>
@ -2351,7 +2351,7 @@ bar
number of them. A number of these variables are treated specially
by <application>psql</application>. 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
the variable or that represent some state of the application. Although
you can use these variables for any other purpose, this is not
recommended, as the program behavior might grow really strange
really quickly. By convention, all specially treated variables
@ -2763,7 +2763,7 @@ testdb=&gt; <userinput>INSERT INTO my_table VALUES (:'content');</userinput>
Since colons can legally appear in SQL commands, an apparent attempt
at interpolation (such as <literal>:name</literal>,
<literal>:'name'</literal>, or <literal>:"name"</literal>) is not
changed unless the named variable is currently set. In any case you
changed unless the named variable is currently set. In any case, you
can escape a colon with a backslash to protect it from substitution.
(The colon syntax for variables is standard <acronym>SQL</acronym> for
embedded query languages, such as <application>ECPG</application>.

6
doc/src/sgml/ref/vacuumdb.sgml
View File

@ -1,5 +1,5 @@
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.50 2010/02/08 04:33:51 tgl Exp $
$PostgreSQL: pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.51 2010/02/19 03:50:03 momjian Exp $
PostgreSQL documentation
-->
@ -34,13 +34,13 @@ PostgreSQL documentation
<arg><replaceable>dbname</replaceable></arg>
<sbr>
<command>vacuumdb</command>
<arg rep="repeat"><replaceable>connection-options</replaceable></arg>
<group><arg>--all</arg><arg>-a</arg></group>
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
<group><arg>--full</arg><arg>-f</arg></group>
<group><arg>--freeze</arg><arg>-F</arg></group>
<group><arg>--verbose</arg><arg>-v</arg></group>
<group><arg>--analyze</arg><arg>-z</arg></group>
<group><arg>--analyze-only</arg><arg>-Z</arg></group>
<group><arg>--all</arg><arg>-a</arg></group>
</cmdsynopsis>
</refsynopsisdiv>

4
doc/src/sgml/reference.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/reference.sgml,v 1.70 2009/12/11 03:34:55 itagaki Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/reference.sgml,v 1.71 2010/02/19 03:50:02 momjian Exp $ -->
<part id="reference">
<title>Reference</title>
@ -184,7 +184,7 @@
<para>
This part contains reference information for
<productname>PostgreSQL</productname> client applications and
utilities. Not all of these commands are of general utility, some
utilities. Not all of these commands are of general utility; some
might require special privileges. The common feature of these
applications is that they can be run on any host, independent of
where the database server resides.