diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml index 6dd448dca5..055f0a5a26 100644 --- a/doc/src/sgml/ref/clusterdb.sgml +++ b/doc/src/sgml/ref/clusterdb.sgml @@ -1,5 +1,5 @@ @@ -29,8 +29,8 @@ PostgreSQL documentation clusterdb connection-option - --all-a --verbose-v + --all-a diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index 59f108c4cd..0856e0f621 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -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 @@ -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. diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index 1e8a1fc3fb..eecf8c4fe2 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -1,5 +1,5 @@ @@ -22,6 +22,7 @@ PostgreSQL documentation createuser + connection-option option username diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml index 260241058c..2451a198a9 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -1,5 +1,5 @@ @@ -22,6 +22,7 @@ PostgreSQL documentation dropdb + connection-option option dbname diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml index b66a76f956..9df53ddc10 100644 --- a/doc/src/sgml/ref/dropuser.sgml +++ b/doc/src/sgml/ref/dropuser.sgml @@ -1,5 +1,5 @@ @@ -22,6 +22,7 @@ PostgreSQL documentation dropuser + connection-option option username diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml index 466c528976..626dc406e6 100644 --- a/doc/src/sgml/ref/ecpg-ref.sgml +++ b/doc/src/sgml/ref/ecpg-ref.sgml @@ -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 diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 9386ff8109..86d75b973f 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -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 . 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; diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index 3c341bad1a..bf41b5ead8 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -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 diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 73ae4c9438..0e86e0862f 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -1,4 +1,4 @@ - + @@ -23,6 +23,7 @@ pg_restore + connection-option option filename @@ -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. @@ -353,7 +354,7 @@ 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 @@ -440,7 +441,7 @@ 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 @@ -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. diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index a15b6a8df0..64d96a2183 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -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. diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index 20fb233a4c..f24c02be1b 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -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 diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml index f97bf651ce..50f1d93d8b 100644 --- a/doc/src/sgml/reference.sgml +++ b/doc/src/sgml/reference.sgml @@ -1,4 +1,4 @@ - + Reference @@ -184,7 +184,7 @@ 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.