Skip to content

Commit 2f6b456

Browse files
bmomjianbmomjian
committed
First pass over client applications documentation proofreading.
gabrielle
1 parent 4e3a616 commit 2f6b456

13 files changed

+59
-52
lines changed

‎doc/src/sgml/ref/clusterdb.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.25 2009/02/26 16:02:37 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.26 2010/02/19 03:50:03 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -29,8 +29,8 @@ PostgreSQL documentation
2929
<sbr>
3030
<command>clusterdb</command>
3131
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
32-
<group><arg>--all</arg><arg>-a</arg></group>
3332
<group><arg>--verbose</arg><arg>-v</arg></group>
33+
<group><arg>--all</arg><arg>-a</arg></group>
3434
</cmdsynopsis>
3535
</refsynopsisdiv>
3636

‎doc/src/sgml/ref/createdb.sgml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.49 2009/02/26 16:02:37 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.50 2010/02/19 03:50:03 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -22,6 +22,7 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>createdb</command>
25+
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2526
<arg rep="repeat"><replaceable>option</replaceable></arg>
2627
<arg><replaceable>dbname</replaceable></arg>
2728
<arg><replaceable>description</replaceable></arg>
@@ -41,7 +42,7 @@ PostgreSQL documentation
4142
<para>
4243
Normally, the database user who executes this command becomes the owner of
4344
the new database.
44-
However a different owner can be specified via the <option>-O</option>
45+
However, a different owner can be specified via the <option>-O</option>
4546
option, if the executing user has appropriate privileges.
4647
</para>
4748

@@ -171,7 +172,7 @@ PostgreSQL documentation
171172
</para>
172173

173174
<para>
174-
The options <option>-D</option>, <option>-E</option>, <option>-l</option>,
175+
The options <option>-D</option>, <option>-l</option>, <option>-E</option>,
175176
<option>-O</option>, and
176177
<option>-T</option> correspond to options of the underlying
177178
SQL command <xref linkend="SQL-CREATEDATABASE"

‎doc/src/sgml/ref/createlang.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.43 2009/02/26 16:02:37 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.44 2010/02/19 03:50:03 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -69,7 +69,7 @@ PostgreSQL documentation
6969
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
7070
<listitem>
7171
<para>
72-
Specifies to which database the language should be added.
72+
Specifies the database to which the language should be added.
7373
The default is to use the database with the same name as the
7474
current system user.
7575
</para>
@@ -213,7 +213,7 @@ PostgreSQL documentation
213213
<para>
214214
Most error messages are self-explanatory. If not, run
215215
<application>createlang</application> with the <option>--echo</option>
216-
option and see under the respective <acronym>SQL</acronym> command
216+
option and see the respective <acronym>SQL</acronym> command
217217
for details. Also, any default connection settings and environment
218218
variables used by the <application>libpq</application> front-end
219219
library will apply.

‎doc/src/sgml/ref/createuser.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.52 2009/02/26 16:02:37 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.53 2010/02/19 03:50:03 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -22,6 +22,7 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>createuser</command>
25+
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2526
<arg rep="repeat"><replaceable>option</replaceable></arg>
2627
<arg><replaceable>username</replaceable></arg>
2728
</cmdsynopsis>

‎doc/src/sgml/ref/dropdb.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.35 2009/02/26 16:02:37 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.36 2010/02/19 03:50:03 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -22,6 +22,7 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>dropdb</command>
25+
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2526
<arg rep="repeat"><replaceable>option</replaceable></arg>
2627
<arg choice="plain"><replaceable>dbname</replaceable></arg>
2728
</cmdsynopsis>

‎doc/src/sgml/ref/dropuser.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.40 2009/02/26 16:02:37 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.41 2010/02/19 03:50:03 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -22,6 +22,7 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>dropuser</command>
25+
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2526
<arg rep="repeat"><replaceable>option</replaceable></arg>
2627
<arg><replaceable>username</replaceable></arg>
2728
</cmdsynopsis>

‎doc/src/sgml/ref/ecpg-ref.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.32 2007/01/31 23:26:03 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.33 2010/02/19 03:50:03 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -192,7 +192,7 @@ PostgreSQL documentation
192192
<para>
193193
When compiling the preprocessed C code files, the compiler needs to
194194
be able to find the <application>ECPG</> header files in the
195-
<productname>PostgreSQL</> include directory. Therefore, one might
195+
<productname>PostgreSQL</> include directory. Therefore, you might
196196
have to use the <option>-I</> option when invoking the compiler
197197
(e.g., <literal>-I/usr/local/pgsql/include</literal>).
198198
</para>

‎doc/src/sgml/ref/pg_dump.sgml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.114 2009/08/07 20:54:31 alvherre Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.115 2010/02/19 03:50:03 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -25,6 +25,7 @@ PostgreSQL documentation
2525
<refsynopsisdiv>
2626
<cmdsynopsis>
2727
<command>pg_dump</command>
28+
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2829
<arg rep="repeat"><replaceable>option</replaceable></arg>
2930
<arg><replaceable>dbname</replaceable></arg>
3031
</cmdsynopsis>
@@ -51,7 +52,7 @@ PostgreSQL documentation
5152
saved. To restore from such a script, feed it to <xref
5253
linkend="app-psql">. Script files
5354
can be used to reconstruct the database even on other machines and
54-
other architectures; with some modifications even on other SQL
55+
other architectures; with some modifications, even on other SQL
5556
database products.
5657
</para>
5758

@@ -530,7 +531,7 @@ PostgreSQL documentation
530531
than <command>COPY</command>). This will make restoration very slow;
531532
it is mainly useful for making dumps that can be loaded into
532533
non-<productname>PostgreSQL</productname> databases.
533-
Also, since this option generates a separate command for each row,
534+
However, since this option generates a separate command for each row,
534535
an error in reloading a row causes only that row to be lost rather
535536
than the entire table contents.
536537
Note that
@@ -553,7 +554,7 @@ PostgreSQL documentation
553554
...</literal>). This will make restoration very slow; it is mainly
554555
useful for making dumps that can be loaded into
555556
non-<productname>PostgreSQL</productname> databases.
556-
Also, since this option generates a separate command for each row,
557+
However, since this option generates a separate command for each row,
557558
an error in reloading a row causes only that row to be lost rather
558559
than the entire table contents.
559560
</para>
@@ -636,7 +637,7 @@ PostgreSQL documentation
636637
<para>
637638
Output SQL-standard <command>SET SESSION AUTHORIZATION</> commands
638639
instead of <command>ALTER OWNER</> commands to determine object
639-
ownership. This makes the dump more standards compatible, but
640+
ownership. This makes the dump more standards-compatible, but
640641
depending on the history of the objects in the dump, might not restore
641642
properly. Also, a dump using <command>SET SESSION AUTHORIZATION</>
642643
will certainly require superuser privileges to restore correctly,
@@ -834,7 +835,7 @@ CREATE DATABASE foo WITH TEMPLATE template0;
834835
does not contain the statistics used by the optimizer to make
835836
query planning decisions. Therefore, it is wise to run
836837
<command>ANALYZE</command> after restoring from a dump file
837-
to ensure good performance; see <xref linkend="vacuum-for-statistics">
838+
to ensure optimal performance; see <xref linkend="vacuum-for-statistics">
838839
and <xref linkend="autovacuum"> for more information.
839840
The dump file also does not
840841
contain any <command>ALTER DATABASE ... SET</> commands;

‎doc/src/sgml/ref/pg_dumpall.sgml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.79 2009/03/22 16:44:26 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.80 2010/02/19 03:50:03 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -22,6 +22,7 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>pg_dumpall</command>
25+
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2526
<arg rep="repeat"><replaceable>option</replaceable></arg>
2627
</cmdsynopsis>
2728
</refsynopsisdiv>
@@ -53,8 +54,8 @@ PostgreSQL documentation
5354
</para>
5455

5556
<para>
56-
The SQL script will be written to the standard output. Shell
57-
operators should be used to redirect it into a file.
57+
The SQL script will be written to the standard output. Use the
58+
[-f|file] option or shell operators to redirect it into a file.
5859
</para>
5960

6061
<para>
@@ -168,13 +169,13 @@ PostgreSQL documentation
168169
<listitem>
169170
<para>
170171
Do not wait forever to acquire shared table locks at the beginning of
171-
the dump. Instead fail if unable to lock a table within the specified
172+
the dump. Instead, fail if unable to lock a table within the specified
172173
<replaceable class="parameter">timeout</>. The timeout may be
173174
specified in any of the formats accepted by <command>SET
174-
statement_timeout</>. (Allowed values vary depending on the server
175+
statement_timeout</>. Allowed values vary depending on the server
175176
version you are dumping from, but an integer number of milliseconds
176177
is accepted by all versions since 7.3. This option is ignored when
177-
dumping from a pre-7.3 server.)
178+
dumping from a pre-7.3 server.
178179
</para>
179180
</listitem>
180181
</varlistentry>
@@ -510,7 +511,7 @@ PostgreSQL documentation
510511

511512
<para>
512513
<application>pg_dumpall</application> requires all needed
513-
tablespace directories to exist before the restore, else
514+
tablespace directories to exist before the restore; otherwise,
514515
database creation will fail for databases in non-default
515516
locations.
516517
</para>
@@ -528,7 +529,7 @@ PostgreSQL documentation
528529
</para>
529530

530531
<para>
531-
To reload this database use, for example:
532+
To reload database(s) from this file, you can use:
532533
<screen>
533534
<prompt>$</prompt> <userinput>psql -f db.out postgres</userinput>
534535
</screen>

‎doc/src/sgml/ref/pg_restore.sgml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.82 2009/08/07 20:54:31 alvherre Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.83 2010/02/19 03:50:03 momjian Exp $ -->
22

33
<refentry id="APP-PGRESTORE">
44
<refmeta>
@@ -23,6 +23,7 @@
2323
<refsynopsisdiv>
2424
<cmdsynopsis>
2525
<command>pg_restore</command>
26+
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
2627
<arg rep="repeat"><replaceable>option</replaceable></arg>
2728
<arg><replaceable>filename</replaceable></arg>
2829
</cmdsynopsis>
@@ -241,7 +242,7 @@
241242
good place to start is the number of CPU cores on the server,
242243
but values larger than that can also lead to faster restore
243244
times in many cases. Of course, values that are too high will
244-
lead to decreasing performance because of thrashing.
245+
lead to decreased performance because of thrashing.
245246
</para>
246247

247248
<para>
@@ -353,7 +354,7 @@
353354
<listitem>
354355
<para>
355356
Restore only the schema (data definitions), not the data (table
356-
contents). Sequence current values will not be restored, either.
357+
contents). Current sequence values will not be restored, either.
357358
(Do not confuse this with the <option>--schema</> option, which
358359
uses the word <quote>schema</> in a different meaning.)
359360
</para>
@@ -440,7 +441,7 @@
440441
<para>
441442
Output SQL-standard <command>SET SESSION AUTHORIZATION</> commands
442443
instead of <command>ALTER OWNER</> commands to determine object
443-
ownership. This makes the dump more standards compatible, but
444+
ownership. This makes the dump more standards-compatible, but
444445
depending on the history of the objects in the dump, might not restore
445446
properly.
446447
</para>
@@ -653,7 +654,7 @@ CREATE DATABASE foo WITH TEMPLATE template0;
653654
When restoring data to a pre-existing table and the option
654655
<option>--disable-triggers</> is used,
655656
<application>pg_restore</application> emits commands
656-
to disable triggers on user tables before inserting the data then emits commands to
657+
to disable triggers on user tables before inserting the data, then emits commands to
657658
re-enable them after the data has been inserted. If the restore is stopped in the
658659
middle, the system catalogs might be left in the wrong state.
659660
</para>
@@ -662,7 +663,7 @@ CREATE DATABASE foo WITH TEMPLATE template0;
662663
<listitem>
663664
<para>
664665
<application>pg_restore</application> cannot restore large objects
665-
selectively, for instance only those for a specific table. If
666+
selectively; for instance, only those for a specific table. If
666667
an archive contains large objects, then all large objects will be
667668
restored, or none of them if they are excluded via <option>-L</option>,
668669
<option>-t</option>, or other options.

0 commit comments

Comments
 (0)