First pass over client applications documentation proofreading.
authorBruce Momjian
Fri, 19 Feb 2010 03:50:03 +0000 (03:50 +0000)
committerBruce Momjian
Fri, 19 Feb 2010 03:50:03 +0000 (03:50 +0000)
gabrielle

13 files changed:
doc/src/sgml/ref/clusterdb.sgml
doc/src/sgml/ref/createdb.sgml
doc/src/sgml/ref/createlang.sgml
doc/src/sgml/ref/createuser.sgml
doc/src/sgml/ref/dropdb.sgml
doc/src/sgml/ref/dropuser.sgml
doc/src/sgml/ref/ecpg-ref.sgml
doc/src/sgml/ref/pg_dump.sgml
doc/src/sgml/ref/pg_dumpall.sgml
doc/src/sgml/ref/pg_restore.sgml
doc/src/sgml/ref/psql-ref.sgml
doc/src/sgml/ref/vacuumdb.sgml
doc/src/sgml/reference.sgml

index 6dd448dca59ce788e84df08c83edcce5fb2e59a3..055f0a5a26f70919134cfc6926c9e3d98a6e3a40 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -29,8 +29,8 @@ PostgreSQL documentation
    
    clusterdb
    connection-option
-   --all-a
    --verbose-v
+   --all-a
   
  
  
index 59f108c4cddf26b8384f18c5ab847c80166def77..0856e0f621a41466afd1c8d79b9a07990fdd8985 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -22,6 +22,7 @@ PostgreSQL documentation
  
   
    createdb
+   connection-option
    option
    dbname
    description
@@ -41,7 +42,7 @@ PostgreSQL documentation
   
    Normally, the database user who executes this command becomes the owner of
    the new database.
-   However a different owner can be specified via the 
+   However, a different owner can be specified via the 
    option, if the executing user has appropriate privileges.
   
 
@@ -171,7 +172,7 @@ PostgreSQL documentation
    
 
    
-    The options ,
+    The options 
     , and
      correspond to options of the underlying
     SQL command 
index afe380dc135c4b993e3a7c7e61bd93f7d2a7766e..52aabdc3d0a9d3bb691dc6877e13d0efddecd072 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -69,7 +69,7 @@ PostgreSQL documentation
       
       
        
-        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.
        
@@ -213,7 +213,7 @@ PostgreSQL documentation
    
     Most error messages are self-explanatory. If not, run
     createlang with the 
-    option and see under the respective SQL command
+    option and see the respective SQL command
     for details.  Also, any default connection settings and environment
     variables used by the libpq front-end
     library will apply.
index 1e8a1fc3fbd85a607a0f6f2d7b7bf262def61350..eecf8c4fe253fcb17755b0392fba482c6a3a355d 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -22,6 +22,7 @@ PostgreSQL documentation
  
   
    createuser
+   connection-option
    option
    username
   
index 260241058c2d46cc08395e38093542992a0cb9a9..2451a198a932fbbef103b77755546b836e9b41d1 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -22,6 +22,7 @@ PostgreSQL documentation
  
   
    dropdb
+   connection-option
    option
    dbname
   
index b66a76f95630904e6ceff25f4c6752ab9e6bc919..9df53ddc1072c35fae6acc27e572b1eafb508163 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -22,6 +22,7 @@ PostgreSQL documentation
  
   
    dropuser
+   connection-option
    option
    username
   
index 466c52897689864dc99e5d51a96547e3a85411ec..626dc406e637dcf4cdd28c14b32b07e9fadbd899 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -192,7 +192,7 @@ PostgreSQL documentation
   
    When compiling the preprocessed C code files, the compiler needs to
    be able to find the ECPG header files in the
-   PostgreSQL include directory.  Therefore, one might
+   PostgreSQL include directory.  Therefore, you might
    have to use the 
    (e.g., -I/usr/local/pgsql/include).
   
index 9386ff8109a3aea2e2c633db3c3a10f7b5dfe215..86d75b973f2db0b0ce86663e9e768dc3e447d270 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -25,6 +25,7 @@ PostgreSQL documentation
  
   
    pg_dump
+   connection-option
    option
    dbname
   
@@ -51,7 +52,7 @@ PostgreSQL documentation
    saved. To restore from such a script, feed it to 
    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.
   
 
@@ -530,7 +531,7 @@ PostgreSQL documentation
         than COPY).  This will make restoration very slow;
         it is mainly useful for making dumps that can be loaded into
         non-PostgreSQL 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
         ...).  This will make restoration very slow; it is mainly
         useful for making dumps that can be loaded into
         non-PostgreSQL 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.
        
@@ -636,7 +637,7 @@ PostgreSQL documentation
        
         Output SQL-standard SET SESSION AUTHORIZATION commands
         instead of 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 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
    ANALYZE after restoring from a dump file
-   to ensure good performance; see 
+   to ensure optimal performance; see 
    and  for more information.
    The dump file also does not
    contain any ALTER DATABASE ... SET commands;
index 3c341bad1a683079e297b81ae671edde6b2d96ca..bf41b5ead87b6fd3744679bd115758a1bd49e21c 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -22,6 +22,7 @@ PostgreSQL documentation
  
   
    pg_dumpall
+   connection-option
    option
   
  
@@ -53,8 +54,8 @@ PostgreSQL documentation
   
 
   
-   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.
   
 
   
@@ -168,13 +169,13 @@ PostgreSQL documentation
       
        
         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
         timeout. The timeout may be
         specified in any of the formats accepted by 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.
        
       
      
@@ -510,7 +511,7 @@ PostgreSQL documentation
 
   
    pg_dumpall 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.
   
@@ -528,7 +529,7 @@ PostgreSQL documentation
   
 
   
-   To reload this database use, for example:
+   To reload database(s) from this file, you can use:
 
 $ psql -f db.out postgres
 
index 73ae4c9438594c03f51f34927280c23ebd021c6f..0e86e0862f7a203d36bfeac356605e16bc5084b9 100644 (file)
@@ -1,4 +1,4 @@
-
+
 
 
  
@@ -23,6 +23,7 @@
  
   
    pg_restore
+   connection-option
    option
    filename
   
         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.
        
 
        
       
        
         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 
         uses the word schema in a different meaning.)
        
        
         Output SQL-standard SET SESSION AUTHORIZATION commands
         instead of 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.
        
@@ -653,7 +654,7 @@ CREATE DATABASE foo WITH TEMPLATE template0;
       When restoring data to a pre-existing table and the option
       
       pg_restore 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.
      
@@ -662,7 +663,7 @@ CREATE DATABASE foo WITH TEMPLATE template0;
     
      
       pg_restore 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 ,
       , or other options.
index a15b6a8df08d31cfdf2c17ddf7177f88780bd618..64d96a218392b94842f417c204188544753fba40 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -54,7 +54,7 @@ PostgreSQL documentation
       
       
       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 ECHO to
       all.
       
@@ -84,7 +84,7 @@ PostgreSQL documentation
       
       command must be either
       a command string that is completely parsable by the server (i.e.,
-      it contains no psql specific features),
+      it contains no psql-specific features),
       or a single backslash command. Thus you cannot mix
       SQL and psql
       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.
       
       
@@ -285,7 +285,7 @@ PostgreSQL documentation
       Specifies printing options, in the style of
       \pset. 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
       -P format=latex.
       
       
@@ -523,8 +523,8 @@ PostgreSQL documentation
 
   
    psql 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 ON_ERROR_STOP was set.
   
@@ -541,14 +541,14 @@ PostgreSQL documentation
     psql is a regular
     PostgreSQL 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. psql can be
     told about those parameters via command line options, namely
     , and
      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, psql will connect via a Unix-domain socket
     to a server on the local host, or via TCP/IP to localhost on
     machines that don't have Unix-domain sockets. The default port number is
@@ -633,7 +633,7 @@ testdb=>
     Anything you enter in psql that begins
     with an unquoted backslash is a psql
     meta-command that is processed by psql
-    itself. These commands help make
+    itself. These commands make
     psql more useful for administration or
     scripting. Meta-commands are often called slash or backslash commands.
     
@@ -1727,7 +1727,7 @@ lo_import 152801
 
           
           aligned format is the standard, human-readable,
-          nicely formatted text output that is default.
+          nicely formatted text output;  this is the default.
           
 
           
@@ -2189,7 +2189,7 @@ lo_import 152801
         
         Escapes to a separate Unix shell or executes the Unix command
         command. The
-        arguments are not further interpreted, the shell will see them
+        arguments are not further interpreted; the shell will see them
         as-is.
         
         
@@ -2351,7 +2351,7 @@ bar
     number of them. A number of these variables are treated specially
     by psql. 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=> INSERT INTO my_table VALUES (:'content');
     Since colons can legally appear in SQL commands, an apparent attempt
     at interpolation (such as :name,
     :'name', or :"name") 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 SQL for
     embedded query languages, such as ECPG.
index 20fb233a4c657ad236cbe9a897682a6f8972216a..f24c02be1b98ad64d95886df952b8da3deed3b20 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -34,13 +34,13 @@ PostgreSQL documentation
    dbname
    
    vacuumdb
-   connection-options
-   --all-a
+   connection-option
    --full-f
    --freeze-F
    --verbose-v
    --analyze-z
    --analyze-only-Z
+   --all-a
   
  
 
index f97bf651ce55fbca51731dd1dc06d63a857e8362..50f1d93d8bb93ffe8b5f96e4534c1c1d9b7bbf93 100644 (file)
@@ -1,4 +1,4 @@
-
+
 
 
  Reference
    
     This part contains reference information for
     PostgreSQL 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.