From dccfd74935254224cff91da66f8bb05f84af04f0 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Mon, 25 Dec 2000 23:15:27 +0000 Subject: [PATCH] Refine some things to create better looking man pages. --- doc/src/sgml/ref/alter_table.sgml | 4 +- doc/src/sgml/ref/begin.sgml | 12 ++-- doc/src/sgml/ref/commit.sgml | 4 +- doc/src/sgml/ref/create_function.sgml | 4 +- doc/src/sgml/ref/create_index.sgml | 4 +- doc/src/sgml/ref/create_table.sgml | 4 +- doc/src/sgml/ref/create_table_as.sgml | 4 +- doc/src/sgml/ref/createdb.sgml | 12 ++-- doc/src/sgml/ref/createlang.sgml | 7 +-- doc/src/sgml/ref/createuser.sgml | 8 +-- doc/src/sgml/ref/declare.sgml | 10 +-- doc/src/sgml/ref/drop_aggregate.sgml | 4 +- doc/src/sgml/ref/drop_function.sgml | 4 +- doc/src/sgml/ref/drop_index.sgml | 4 +- doc/src/sgml/ref/drop_language.sgml | 4 +- doc/src/sgml/ref/drop_operator.sgml | 4 +- doc/src/sgml/ref/dropdb.sgml | 8 +-- doc/src/sgml/ref/droplang.sgml | 7 +-- doc/src/sgml/ref/dropuser.sgml | 8 +-- doc/src/sgml/ref/ecpg-ref.sgml | 21 ++++--- doc/src/sgml/ref/end.sgml | 8 +-- doc/src/sgml/ref/fetch.sgml | 12 ++-- doc/src/sgml/ref/initdb.sgml | 44 ++++++++------ doc/src/sgml/ref/insert.sgml | 4 +- doc/src/sgml/ref/listen.sgml | 4 +- doc/src/sgml/ref/lock.sgml | 4 +- doc/src/sgml/ref/move.sgml | 14 ++--- doc/src/sgml/ref/pg_ctl-ref.sgml | 7 +-- doc/src/sgml/ref/pg_dump.sgml | 9 ++- doc/src/sgml/ref/pg_dumpall.sgml | 13 ++-- doc/src/sgml/ref/pg_passwd.sgml | 6 +- doc/src/sgml/ref/pg_restore.sgml | 1 + doc/src/sgml/ref/pg_upgrade.sgml | 3 +- doc/src/sgml/ref/pgaccess-ref.sgml | 7 ++- doc/src/sgml/ref/pgadmin-ref.sgml | 3 +- doc/src/sgml/ref/pgtclsh.sgml | 20 +++--- doc/src/sgml/ref/pgtksh.sgml | 20 +++--- doc/src/sgml/ref/postgres-ref.sgml | 17 +++--- doc/src/sgml/ref/postmaster.sgml | 88 +++++++++++++-------------- doc/src/sgml/ref/psql-ref.sgml | 15 ++--- doc/src/sgml/ref/reset.sgml | 8 +-- doc/src/sgml/ref/revoke.sgml | 8 +-- doc/src/sgml/ref/rollback.sgml | 6 +- doc/src/sgml/ref/select_into.sgml | 8 +-- doc/src/sgml/ref/show.sgml | 4 +- doc/src/sgml/ref/unlisten.sgml | 4 +- doc/src/sgml/ref/update.sgml | 4 +- doc/src/sgml/ref/vacuumdb.sgml | 6 +- doc/src/sgml/reference.sgml | 6 +- 49 files changed, 252 insertions(+), 238 deletions(-) diff --git a/doc/src/sgml/ref/alter_table.sgml b/doc/src/sgml/ref/alter_table.sgml index 59e3b3a2ad..110b5204cf 100644 --- a/doc/src/sgml/ref/alter_table.sgml +++ b/doc/src/sgml/ref/alter_table.sgml @@ -1,5 +1,5 @@ @@ -194,7 +194,7 @@ ALTER TABLE table new column will be ignored. You can use the SET DEFAULT form of ALTER TABLE to set the default later. (You will also have to update the already existing rows to the - new default value, using .) diff --git a/doc/src/sgml/ref/begin.sgml b/doc/src/sgml/ref/begin.sgml index 86b6620f1f..cc97c728d3 100644 --- a/doc/src/sgml/ref/begin.sgml +++ b/doc/src/sgml/ref/begin.sgml @@ -1,5 +1,5 @@ @@ -105,8 +105,8 @@ NOTICE: BEGIN: already a transaction in progress BEGIN initiates a user transaction in chained mode, i.e., all user statements after BEGIN command will be executed in a single transaction until an explicit - , - , + , + , or execution abort. Statements in chained mode are executed much faster, because transaction start/commit requires significant CPU and disk activity. Execution of multiple statements inside a transaction @@ -142,15 +142,15 @@ NOTICE: BEGIN: already a transaction in progress Notes - Refer to + Refer to for further information about locking tables inside a transaction. - Use + Use or - + to terminate a transaction. diff --git a/doc/src/sgml/ref/commit.sgml b/doc/src/sgml/ref/commit.sgml index 651e649205..97dd13e972 100644 --- a/doc/src/sgml/ref/commit.sgml +++ b/doc/src/sgml/ref/commit.sgml @@ -1,5 +1,5 @@ @@ -110,7 +110,7 @@ NOTICE: COMMIT: no transaction in progress - Use + Use to abort a transaction. diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index bb733b8df2..3050e272d3 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -1,5 +1,5 @@ @@ -123,7 +123,7 @@ CREATE FUNCTION name ( [ plname', where 'plname' is the name of a created procedural language. See - + for details. diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml index 550187ef46..4a8ae459aa 100644 --- a/doc/src/sgml/ref/create_index.sgml +++ b/doc/src/sgml/ref/create_index.sgml @@ -1,5 +1,5 @@ @@ -228,7 +228,7 @@ ERROR: Cannot create index: 'index_name' already exists. - Use + Use to remove an index. diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index 1850ee265e..43ced71e89 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -1,5 +1,5 @@ @@ -242,7 +242,7 @@ ERROR: DEFAULT: type mismatched Each new table or class table is automatically created as a type. Therefore, one or more instances from the class are automatically a type and can be used in - + or other CREATE TABLE statements. diff --git a/doc/src/sgml/ref/create_table_as.sgml b/doc/src/sgml/ref/create_table_as.sgml index 9ecac6b02b..b3ba280271 100644 --- a/doc/src/sgml/ref/create_table_as.sgml +++ b/doc/src/sgml/ref/create_table_as.sgml @@ -1,5 +1,5 @@ @@ -95,7 +95,7 @@ CREATE TABLE table [ (columnCREATE TABLE AS enables a table to be created from the contents of an existing table. It is functionality equivalent to - , + , but with perhaps a more direct syntax. diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index edb5221006..d74941d8c8 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -1,5 +1,5 @@ @@ -99,7 +99,7 @@ Postgres documentation Specifies the alternative database location. See also . + linkend="app-initlocation">. @@ -139,7 +139,7 @@ Postgres documentation The options -h, -p, -U, -W, and -e are passed on literally to - . + . @@ -177,8 +177,8 @@ Postgres documentation If there is an error condition, the backend error message will be displayed. - See - and for possibilities. + See + and for possibilities. @@ -197,7 +197,7 @@ Postgres documentation SQL command via the Postgres interactive terminal - . Thus, there is nothing + . Thus, there is nothing special about creating databases via this or other methods. This means that the psql must be found by the script and that a database server is running at the targeted host. Also, any default diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml index 03aa19d3e7..e1e347ade2 100644 --- a/doc/src/sgml/ref/createlang.sgml +++ b/doc/src/sgml/ref/createlang.sgml @@ -1,5 +1,5 @@ @@ -132,7 +132,7 @@ Postgres documentation Most error messages are self-explanatory. If not, run createlang with the option and see under the respective SQL command - for details. Check also under + for details. Check also under for more possibilities. @@ -165,8 +165,7 @@ Postgres documentation Notes - Use - to remove a language. + Use to remove a language. diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index ee76f73abf..585716c49b 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -1,5 +1,5 @@ @@ -149,7 +149,7 @@ Postgres documentation The options -h, -p, and -e, - are passed on literally to . The + are passed on literally to . The psql options -U and -W are available as well, but their use can be confusing in this context. @@ -183,7 +183,7 @@ Postgres documentation If there is an error condition, the backend error message will be displayed. See - and for possibilities. + and for possibilities. @@ -205,7 +205,7 @@ Postgres documentation SQL command via the Postgres interactive terminal - . Thus, there is nothing + . Thus, there is nothing special about creating users via this or other methods. This means that the psql must be found by the script and that a database server is running at the targeted host. Also, any default diff --git a/doc/src/sgml/ref/declare.sgml b/doc/src/sgml/ref/declare.sgml index 0e0f41ecaa..aef7d3580f 100644 --- a/doc/src/sgml/ref/declare.sgml +++ b/doc/src/sgml/ref/declare.sgml @@ -1,5 +1,5 @@ @@ -191,7 +191,7 @@ ERROR: Named portals may only be used in begin/end transaction blocks can be used to retrieve a small number of rows at a time out of a larger query. Cursors can return data either in text or in binary format using - . + . @@ -253,10 +253,10 @@ ERROR: Named portals may only be used in begin/end transaction blocks Cursors are only available in transactions. Use to - , - + , + and - + to define a transaction block. diff --git a/doc/src/sgml/ref/drop_aggregate.sgml b/doc/src/sgml/ref/drop_aggregate.sgml index d67b4375a3..0e33307686 100644 --- a/doc/src/sgml/ref/drop_aggregate.sgml +++ b/doc/src/sgml/ref/drop_aggregate.sgml @@ -1,5 +1,5 @@ @@ -118,7 +118,7 @@ ERROR: RemoveAggregate: aggregate 'agg Use - + to create aggregate functions. diff --git a/doc/src/sgml/ref/drop_function.sgml b/doc/src/sgml/ref/drop_function.sgml index f3e6645449..09038a1f63 100644 --- a/doc/src/sgml/ref/drop_function.sgml +++ b/doc/src/sgml/ref/drop_function.sgml @@ -1,5 +1,5 @@ @@ -116,7 +116,7 @@ NOTICE RemoveFunction: Function "name Refer to - + for information on creating aggregate functions. diff --git a/doc/src/sgml/ref/drop_index.sgml b/doc/src/sgml/ref/drop_index.sgml index aaf5f1adfa..a72eef030d 100644 --- a/doc/src/sgml/ref/drop_index.sgml +++ b/doc/src/sgml/ref/drop_index.sgml @@ -1,5 +1,5 @@ @@ -108,7 +108,7 @@ ERROR: index "index_name" does not Refer to - + for information on how to create indexes. diff --git a/doc/src/sgml/ref/drop_language.sgml b/doc/src/sgml/ref/drop_language.sgml index eedbc25ef9..4bfd95861d 100644 --- a/doc/src/sgml/ref/drop_language.sgml +++ b/doc/src/sgml/ref/drop_language.sgml @@ -1,5 +1,5 @@ @@ -110,7 +110,7 @@ ERROR: Language "name" doesn't exis Refer to - + for information on how to create procedural languages. diff --git a/doc/src/sgml/ref/drop_operator.sgml b/doc/src/sgml/ref/drop_operator.sgml index ca1ec3be20..b8a24c4e5b 100644 --- a/doc/src/sgml/ref/drop_operator.sgml +++ b/doc/src/sgml/ref/drop_operator.sgml @@ -1,5 +1,5 @@ @@ -154,7 +154,7 @@ ERROR: RemoveOperator: right unary operator 'ope Refer to - + for information on how to create operators. diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml index fba806e035..f02e467033 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -1,5 +1,5 @@ @@ -116,7 +116,7 @@ Postgres documentation The options -h, -p, -U, -W, and -e are passed on literally to - . + . @@ -145,7 +145,7 @@ Postgres documentation If there is an error condition, the backend error message will be displayed. See - and for possibilities. + and for possibilities. @@ -167,7 +167,7 @@ Postgres documentation SQL command via the Postgres interactive terminal - . Thus, there is nothing + . Thus, there is nothing special about dropping databases via this or other methods. This means that the psql must be found by the script and that a database server is running at the targeted host. Also, any default diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml index 41ba3ae042..cf3e2907e1 100644 --- a/doc/src/sgml/ref/droplang.sgml +++ b/doc/src/sgml/ref/droplang.sgml @@ -1,5 +1,5 @@ @@ -132,7 +132,7 @@ Postgres documentation Most error messages are self-explanatory. If not, run droplang with the option and see under the respective SQL command - for details. Check also under + for details. Check also under for more possibilities. @@ -166,8 +166,7 @@ Postgres documentation - Use - to add a language. + Use to add a language. diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml index 4f7d1fc3a8..f4b2cd55ea 100644 --- a/doc/src/sgml/ref/dropuser.sgml +++ b/doc/src/sgml/ref/dropuser.sgml @@ -1,5 +1,5 @@ @@ -99,7 +99,7 @@ Postgres documentation The options -h, -p, and -e, - are passed on literally to . The + are passed on literally to . The psql options -U and -W are available as well, but they can be confusing in this context. @@ -134,7 +134,7 @@ Postgres documentation If there is an error condition, the backend error message will be displayed. See - and for possibilities. + and for possibilities. @@ -157,7 +157,7 @@ Postgres documentation SQL command via the Postgres interactive terminal - . Thus, there is nothing + . Thus, there is nothing special about removing users via this or other methods. This means that the psql must be found by the script and that a database server is running at the targeted host. Also, any default diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml index a5e98e8cfd..baa7fa4ce8 100644 --- a/doc/src/sgml/ref/ecpg-ref.sgml +++ b/doc/src/sgml/ref/ecpg-ref.sgml @@ -1,5 +1,5 @@ @@ -8,6 +8,7 @@ Postgres documentation ecpg + 1 Application @@ -75,7 +76,7 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ] file1 [ file2 ] [ ... ] -o - Specifies that ecpg should write all its output to outfile. + Specifies that ecpg should write all its output to outfile. If no such option is given the output is written to name.c, assuming the input file was @@ -115,7 +116,7 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ] file1 [ file2 ] [ ... ] return value - ecpg returns 0 to the shell on successful completion, -1 + ecpg returns 0 to the shell on successful completion, -1 for errors. @@ -135,12 +136,12 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ] file1 [ file2 ] [ ... ] - Linus Tolke was the + Linus Tolke (linus@epact.se) was the original author of ecpg (up to version 0.2). - Michael Meskes + Michael Meskes (meskes@debian.org) is the current author and maintainer of ecpg. - Thomas Good - is the author of the last revision of the ecpg man page, on which + Thomas Good (tomg@q8.nrnet.org) + is the author of the last revision of the ecpg man page, on which this document is based. @@ -203,7 +204,7 @@ gcc -g -I /usr/local/pgsql/include [ -o file ] Variable Declaration - Variables declared within ecpg source code must be prepended with: + Variables declared within ecpg source code must be prepended with: EXEC SQL BEGIN DECLARE SECTION; @@ -247,8 +248,8 @@ EXEC SQL INCLUDE sqlca; 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 ecpg. - ecpg observes case sensitivity (SQLCA.h will not be found). + prefix indicates that this INCLUDE will be parsed by ecpg. + ecpg observes case sensitivity (SQLCA.h will not be found). EXEC SQL INCLUDE can be used to include other header files as long as case sensitivity is observed. diff --git a/doc/src/sgml/ref/end.sgml b/doc/src/sgml/ref/end.sgml index 10f9f54f13..1df5ea2904 100644 --- a/doc/src/sgml/ref/end.sgml +++ b/doc/src/sgml/ref/end.sgml @@ -1,5 +1,5 @@ @@ -96,7 +96,7 @@ NOTICE: COMMIT: no transaction in progress END is a Postgres extension, and is a synonym for the SQL92-compatible - . + . @@ -111,7 +111,7 @@ NOTICE: COMMIT: no transaction in progress - Use + Use to abort a transaction. @@ -146,7 +146,7 @@ END WORK; END is a PostgreSQL extension which provides functionality equivalent to - . + . diff --git a/doc/src/sgml/ref/fetch.sgml b/doc/src/sgml/ref/fetch.sgml index eb6f3ddd54..bad0c4cdc0 100644 --- a/doc/src/sgml/ref/fetch.sgml +++ b/doc/src/sgml/ref/fetch.sgml @@ -1,5 +1,5 @@ @@ -272,15 +272,15 @@ FETCH RELATIVE 0 FROM cursor. Use - + to change cursor position. - + will define a cursor. Refer to - , - , + , + , and - + for further information about transactions. diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 18343d3b16..09caea1314 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -1,11 +1,11 @@ - 2000-11-11 + 2000-12-25 @@ -58,7 +58,7 @@ Postgres documentation Creating a database system consists of creating the directories in which the database data will live, generating the shared catalog tables - (tables that don't belong to any particular database), and + (tables that do not belong to any particular database), and creating the template1 database. When you create a new database, everything in the template1 database is copied. @@ -94,11 +94,13 @@ Postgres documentation -D dbdir - This option specifies where in the file system the database should be - stored. This is the only information required by initdb, but you can avoid - it by setting the PGDATA environment variable, which - can be convenient since the database server (postmaster) - can find the database directory later by the same variable. + This option specifies where in the file system the database + should be stored. This is the only information required by + initdb, but you can avoid it by + setting the PGDATA environment variable, which + can be convenient since the database server + (postmaster) can find the database + directory later by the same variable. @@ -108,10 +110,11 @@ Postgres documentation -i sysid - Selects the system id of the database superuser. This defaults to - the effective user id of the user running initdb. It is really - not important what the superuser's sysid is, but one might choose - to start the numbering at some number like 1. + Selects the system id of the database superuser. This defaults + to the effective user id of the user running + initdb. It is really not important + what the superuser's sysid is, but one might choose to start + the numbering at some number like 1. @@ -121,10 +124,11 @@ Postgres documentation -W - Makes initdb prompt for a password of the database superuser. If you - don't plan on using password authentication, this is not important. - Otherwise you won't be able to use password authentication until - you have a password set up. + Makes initdb prompt for a password + of the database superuser. If you don't plan on using password + authentication, this is not important. Otherwise you won't be + able to use password authentication until you have a password + set up. @@ -154,10 +158,10 @@ Postgres documentation -L directory - Specifies where initdb should find its input files to - initialize the database system. This is normally not - necessary. You will be told if you need to specify their - location explicitly. + Specifies where initdb should find + its input files to initialize the database system. This is + normally not necessary. You will be told if you need to + specify their location explicitly. diff --git a/doc/src/sgml/ref/insert.sgml b/doc/src/sgml/ref/insert.sgml index d5ff484fe3..6c9f268a86 100644 --- a/doc/src/sgml/ref/insert.sgml +++ b/doc/src/sgml/ref/insert.sgml @@ -1,5 +1,5 @@ @@ -227,7 +227,7 @@ INSERT INTO tictactoe (game, board) Possible limitations in features of the query clause are documented for - . + . diff --git a/doc/src/sgml/ref/listen.sgml b/doc/src/sgml/ref/listen.sgml index 4908ab44ab..c3110686ad 100644 --- a/doc/src/sgml/ref/listen.sgml +++ b/doc/src/sgml/ref/listen.sgml @@ -1,5 +1,5 @@ @@ -128,7 +128,7 @@ NOTICE Async_Listen: We are already listening on - + contains a more extensive discussion of the use of LISTEN and NOTIFY. diff --git a/doc/src/sgml/ref/lock.sgml b/doc/src/sgml/ref/lock.sgml index 32a8e2d0c9..bffbb7c23d 100644 --- a/doc/src/sgml/ref/lock.sgml +++ b/doc/src/sgml/ref/lock.sgml @@ -1,5 +1,5 @@ @@ -434,7 +434,7 @@ COMMIT WORK; There is no LOCK TABLE in SQL92, which instead uses SET TRANSACTION to specify concurrency levels on transactions. We support that too; see - for details. + for details. diff --git a/doc/src/sgml/ref/move.sgml b/doc/src/sgml/ref/move.sgml index f42f738f77..a97267ec98 100644 --- a/doc/src/sgml/ref/move.sgml +++ b/doc/src/sgml/ref/move.sgml @@ -1,5 +1,5 @@ @@ -44,7 +44,7 @@ MOVE [ direction ] [ Refer to - + for details on syntax and usage. @@ -63,16 +63,16 @@ MOVE [ direction ] [ Refer to - + for a description of valid arguments. Refer to - + to define a cursor. Refer to - , - , + , + , and - + for further information about transactions. diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml index 8d7e3eac13..7b628ead93 100644 --- a/doc/src/sgml/ref/pg_ctl-ref.sgml +++ b/doc/src/sgml/ref/pg_ctl-ref.sgml @@ -1,5 +1,5 @@ @@ -64,9 +64,8 @@ Postgres documentation Description pg_ctl is a utility for starting, - stopping, or restarting the , or displaying the status of a - running postmaster. + stopping, or restarting the , or + displaying the status of a running postmaster. diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 465043a9a4..c084188a17 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -1,13 +1,18 @@ + + 2000-12-25 + + pg_dump + 1 Application @@ -443,7 +448,7 @@ dumpSequence(table): SELECT failed and other architectures. - The archive files, new with this v7.1, contain enough information for + The archive files, new with version 7.1, contain enough information for pg_restore to rebuild the database, but also allow pg_restore to be selective about what is restored, or even to reorder the items prior to being restored. The archive files should diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index 3025ad6894..2e270b6dc6 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -1,5 +1,5 @@ @@ -36,9 +36,9 @@ Postgres documentation pg_dumpall is a utility for writing out (dumping) all Postgres databases of a cluster into one script file. The script file contains SQL commands that can be - used as input to + used as input to to restore the databases. It does this by calling for each database + linkend="app-pgdump"> for each database in a cluster. pg_dumpall also dumps global objects that are common to all databases. (pg_dump does not save these objects.) @@ -110,7 +110,7 @@ Postgres documentation Any other command line parameters are passed to the underlying - + calls. This is useful to control some aspects of the output format, but some options such as , , and See Also - , . Check there for - details on possible error conditions. + , . Check + there for details on possible error conditions. diff --git a/doc/src/sgml/ref/pg_passwd.sgml b/doc/src/sgml/ref/pg_passwd.sgml index 3170104178..08b9a24305 100644 --- a/doc/src/sgml/ref/pg_passwd.sgml +++ b/doc/src/sgml/ref/pg_passwd.sgml @@ -1,5 +1,5 @@ @@ -49,7 +49,7 @@ Postgres documentation - Supply the name of the password file as argument to the pg_passwd + Supply the name of the password file as argument to the pg_passwd command. To be of use for client authentication the file needs to be location in the server's data directory, and the base name of the file needs to be specified in the @@ -88,7 +88,7 @@ host unv 133.65.96.250 255.255.255.255 password passwords - It is also useful to have entries in password file with an empty + It is also useful to have entries in a password file with an empty password field. (This is different from an empty password.) These entries cannot be managed by pg_passwd, but it is always possible to diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index f04a6a62c8..5481ff8738 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -3,6 +3,7 @@ pg_restore + 1 Application diff --git a/doc/src/sgml/ref/pg_upgrade.sgml b/doc/src/sgml/ref/pg_upgrade.sgml index 64a2e91b75..7128604a9c 100644 --- a/doc/src/sgml/ref/pg_upgrade.sgml +++ b/doc/src/sgml/ref/pg_upgrade.sgml @@ -1,5 +1,5 @@ @@ -8,6 +8,7 @@ Postgres documentation pg_upgrade + 1 Application diff --git a/doc/src/sgml/ref/pgaccess-ref.sgml b/doc/src/sgml/ref/pgaccess-ref.sgml index 04a9e116eb..1629ca7b9f 100644 --- a/doc/src/sgml/ref/pgaccess-ref.sgml +++ b/doc/src/sgml/ref/pgaccess-ref.sgml @@ -1,5 +1,5 @@ @@ -8,6 +8,7 @@ Postgres documentation pgaccess + 1 Application @@ -69,9 +70,9 @@ pgaccess [ dbname ] Another way of accessing Postgres through tcl is to use - + or - . + . diff --git a/doc/src/sgml/ref/pgadmin-ref.sgml b/doc/src/sgml/ref/pgadmin-ref.sgml index 1f7dcbd135..3648bda412 100644 --- a/doc/src/sgml/ref/pgadmin-ref.sgml +++ b/doc/src/sgml/ref/pgadmin-ref.sgml @@ -1,5 +1,5 @@ @@ -8,6 +8,7 @@ Postgres documentation pgadmin + 1 Application diff --git a/doc/src/sgml/ref/pgtclsh.sgml b/doc/src/sgml/ref/pgtclsh.sgml index ac947ed3b3..c34da0ab8f 100644 --- a/doc/src/sgml/ref/pgtclsh.sgml +++ b/doc/src/sgml/ref/pgtclsh.sgml @@ -1,13 +1,18 @@ + + 2000-12-25 + + pgtclsh + 1 Application @@ -19,12 +24,9 @@ Postgres documentation - - 1999-08-03 - - -pgtclsh [ dbname ] - + + pgtclsh + @@ -66,9 +68,9 @@ pgtclsh [ <replaceable class="parameter">dbname</replaceable> ] <para> Another way of accessing <productname>Postgres</productname> through tcl is to use - <xref linkend="app-pgtksh" endterm="app-pgtksh-title"> + <xref linkend="app-pgtksh"> or - <xref linkend="app-pgaccess" endterm="app-pgaccess-title">. + <xref linkend="app-pgaccess">. </para> </refsect1> </refentry> diff --git a/doc/src/sgml/ref/pgtksh.sgml b/doc/src/sgml/ref/pgtksh.sgml index 9900225f04..a323bda7a2 100644 --- a/doc/src/sgml/ref/pgtksh.sgml +++ b/doc/src/sgml/ref/pgtksh.sgml @@ -1,13 +1,18 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.1 1999/08/06 13:50:31 thomas Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.2 2000/12/25 23:15:26 petere Exp $ Postgres documentation --> <refentry id="APP-PGTKSH"> + <docinfo> + <date>2000-12-25</date> + </docinfo> + <refmeta> <refentrytitle id="app-pgtksh-title"> <application>pgtksh</application> </refentrytitle> + <manvolnum>1</manvolnum> <refmiscinfo>Application</refmiscinfo> </refmeta> <refnamediv> @@ -19,12 +24,9 @@ Postgres documentation </refpurpose> </refnamediv> <refsynopsisdiv> - <refsynopsisdivinfo> - <date>1999-08-03</date> - </refsynopsisdivinfo> - <synopsis> -pgtksh [ <replaceable class="parameter">dbname</replaceable> ] - </synopsis> + <cmdsynopsis> + <command>pgtksh</command> + </cmdsynopsis> <refsect2 id="R2-APP-PGTKSH-1"> <title> @@ -66,9 +68,9 @@ pgtksh [ <replaceable class="parameter">dbname</replaceable> ] <para> Another way of accessing <productname>Postgres</productname> through <acronym>TCL</acronym> is to use - <xref linkend="app-pgtclsh" endterm="app-pgtclsh-title"> + <xref linkend="app-pgtclsh"> or - <xref linkend="app-pgaccess" endterm="app-pgaccess-title">. + <xref linkend="app-pgaccess">. </para> </refsect1> </refentry> diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index be0fa978de..6240e34d63 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.15 2000/11/14 18:11:31 petere Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.16 2000/12/25 23:15:26 petere Exp $ Postgres documentation --> @@ -80,13 +80,12 @@ Postgres documentation <productname>PostgreSQL</productname> server process that processes queries. The second form above is how <application>postgres</application> is invoked by the <xref - linkend="app-postmaster" endterm="app-postmaster-title"> (only + linkend="app-postmaster"> (only conceptually, since both <filename>postmaster</filename> and <filename>postgres</filename> are in fact the same program); it should not be invoked directly this way. The first form invokes the server directly in interactive mode. The primary use for this - mode is for bootstrapping by <xref linkend="app-initdb" - endterm="app-initdb-title">. + mode is for bootstrapping by <xref linkend="app-initdb">. </para> <para> @@ -109,7 +108,7 @@ Postgres documentation <para> When <application>postgres</application> is started by a <xref - linkend="app-postmaster" endterm="app-postmaster-title"> then it + linkend="app-postmaster"> then it inherits all options set by the latter. Additionally, <application>postgres</application>-specific options can be passed from the <application>postmaster</application> with the @@ -134,7 +133,7 @@ Postgres documentation The options <option>-A</option>, <option>-B</option>, <option>-c</option>, <option>-d</option>, <option>-D</option>, and <option>-F</option> have the same meaning as with the <xref - linkend="app-postmaster" endterm="app-postmaster-title">. + linkend="app-postmaster">. </para> <variablelist> @@ -358,9 +357,9 @@ Postgres documentation <title>See also - , - , - + , + , + diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index 8168ada6f4..2d29cb0832 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,11 +1,11 @@ - + - 2000-11-30 + 2000-12-25 @@ -50,31 +50,30 @@ Postgres documentation (over a network or locally) to a running postmaster. The postmaster then starts a separate server - process () to handle the connection. - The postmaster also manages the communication among server - processes. + process () to handle + the connection. The postmaster also + manages the communication among server processes. - By default the postmaster starts in the foreground and prints log - messages to the standard output. In practical applications the - postmaster should be started as a background process, perhaps at - boot time. + By default the postmaster starts in the + foreground and prints log messages to the standard output. In + practical applications the postmaster + should be started as a background process, perhaps at boot time. - One postmaster always manages the data from exactly one database - cluster. A database cluster is a collection of databases that is - stored at a common file system location. When the postmaster - starts it needs to know the location of the database cluster files - (data area). This is done with the - invocation option or the PGDATA - environment variable; there is no default. More than one - postmaster process can run on a system at one time, as long as they - use different data areas and different communication ports (see below). - A data area is created with . + One postmaster always manages the data + from exactly one database cluster. A database cluster is a + collection of databases that is stored at a common file system + location. When the postmaster starts it needs to know the location + of the database cluster files (data area). This is + done with the invocation option or the + PGDATA environment variable; there is no default. + More than one postmaster process can run on a system at one time, + as long as they use different data areas and different + communication ports (see below). A data area is created with . @@ -183,7 +182,7 @@ Postgres documentation - -k directoryname + -k directory Specifies the directory of the Unix-domain socket on which the @@ -210,10 +209,11 @@ Postgres documentation Sets the maximum number of client connections that this - postmaster will accept. By default, this value is 32, but it - can be set as high as 1024 if your system will support that - many processes. (Note that is required to - be at least twice .) + postmaster will accept. By + default, this value is 32, but it can be set as high as 1024 + if your system will support that many processes. (Note that + is required to be at least twice + .) @@ -223,12 +223,11 @@ Postgres documentation The command line-style options specified in EXTRA-OPTIONS are passed to + class="parameter">extra-options are passed to all backend server processes started by this postmaster. See for - possibilities. If the option string contains any spaces, the - entire string must be quoted. + linkend="app-postgres"> for possibilities. If the option + string contains any spaces, the entire string must be quoted. @@ -264,7 +263,7 @@ Postgres documentation Using this switch discards all logging output, which is probably not what you want, since it makes it very difficult to troubleshoot problems. See below for a better way to start - the postmaster in the background. + the postmaster in the background. @@ -367,14 +366,14 @@ StreamServerPort: cannot bind to port other postmaster process already running on the same port number. The easiest way to determine this is by using the command - -$ ps -ax | grep postmaster - -on BSD-based systems, or - -$ ps -e | grep postmast - - for System V-like or POSIX-compliant systems such as HP-UX. + +$ ps ax | grep postmaster + + or + +$ ps -e | grep postmaster + + depending on your system. @@ -414,9 +413,9 @@ $ ps -e | grep postmast - To terminate the postmaster normally, the signals - SIGTERM, SIGINT, or - SIGQUIT can be used. The first will wait for + To terminate the postmaster normally, + the signals SIGTERM, SIGINT, + or SIGQUIT can be used. The first will wait for all clients to terminate before quitting, the second will forcefully disconnect all clients, and the third will quit immediately without lengthy shutdown, resulting in a recovery run @@ -425,7 +424,8 @@ $ ps -e | grep postmast The utility command can be used to - start and shut down the postmaster safely and comfortably. + start and shut down the postmaster + safely and comfortably. diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index a90e98cd7b..f8eb6cfddd 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1,20 +1,21 @@ + + 2000-12-25 + + - - psql - + psql + 1 Application - - psql - + psql Postgres interactive terminal diff --git a/doc/src/sgml/ref/reset.sgml b/doc/src/sgml/ref/reset.sgml index e9f515da7b..7bb87570ad 100644 --- a/doc/src/sgml/ref/reset.sgml +++ b/doc/src/sgml/ref/reset.sgml @@ -1,5 +1,5 @@ @@ -26,7 +26,7 @@ RESET variable The name of a run-time parameter. See for a list. + linkend="sql-set" endterm="sql-set-title"> for a list. @@ -41,7 +41,7 @@ RESET variable RESET restores run-time parameters to their default values. Refer to - + for details. RESET is an alternate form for @@ -53,7 +53,7 @@ SET variable TO DEFAULT Diagnostics - See under the command. diff --git a/doc/src/sgml/ref/revoke.sgml b/doc/src/sgml/ref/revoke.sgml index 5c70f5ed33..d7e83c822d 100644 --- a/doc/src/sgml/ref/revoke.sgml +++ b/doc/src/sgml/ref/revoke.sgml @@ -1,5 +1,5 @@ @@ -90,7 +90,7 @@ REVOKE privilege [, ...] Privilege to define rules on table/view. (See - ). + ). @@ -319,7 +319,7 @@ REVOKE { INSERT | UPDATE | REFERENCES } [, ...] [ ( + for details on individual fields. @@ -338,7 +338,7 @@ REVOKE GRANT OPTION FOR privilege [ Rescinds authority for a user to grant the specified privilege to others. Refer to - + for details on individual fields. diff --git a/doc/src/sgml/ref/rollback.sgml b/doc/src/sgml/ref/rollback.sgml index dcee1df8bb..25daecb9f5 100644 --- a/doc/src/sgml/ref/rollback.sgml +++ b/doc/src/sgml/ref/rollback.sgml @@ -1,5 +1,5 @@ @@ -95,9 +95,9 @@ NOTICE: ROLLBACK: no transaction in progress Notes - Use + Use to successfully terminate a transaction. - is a + is a synonym for ROLLBACK. diff --git a/doc/src/sgml/ref/select_into.sgml b/doc/src/sgml/ref/select_into.sgml index f1a483bfb1..91bb572918 100644 --- a/doc/src/sgml/ref/select_into.sgml +++ b/doc/src/sgml/ref/select_into.sgml @@ -1,5 +1,5 @@ @@ -55,7 +55,7 @@ where from_item can be: All input fields are described in detail for - . + . @@ -68,7 +68,7 @@ where from_item can be: All output fields are described in detail for - . + . @@ -87,7 +87,7 @@ where from_item can be: - + is functionally equivalent to the SELECT INTO command. diff --git a/doc/src/sgml/ref/show.sgml b/doc/src/sgml/ref/show.sgml index fdfc8057f6..934b0567f2 100644 --- a/doc/src/sgml/ref/show.sgml +++ b/doc/src/sgml/ref/show.sgml @@ -1,5 +1,5 @@ @@ -27,7 +27,7 @@ SHOW name The name of a run-time parameter. See - + for a list. diff --git a/doc/src/sgml/ref/unlisten.sgml b/doc/src/sgml/ref/unlisten.sgml index 74305cba60..f7ea70967e 100644 --- a/doc/src/sgml/ref/unlisten.sgml +++ b/doc/src/sgml/ref/unlisten.sgml @@ -1,5 +1,5 @@ @@ -100,7 +100,7 @@ UNLISTEN { notifyname | * } - + contains a more extensive discussion of the use of LISTEN and NOTIFY. diff --git a/doc/src/sgml/ref/update.sgml b/doc/src/sgml/ref/update.sgml index 8ad2e80a0d..0da8174a9a 100644 --- a/doc/src/sgml/ref/update.sgml +++ b/doc/src/sgml/ref/update.sgml @@ -1,5 +1,5 @@ @@ -129,7 +129,7 @@ UPDATE # Array references use the same syntax found in - . + . That is, either single array elements, a range of array elements or the entire array may be replaced with a single query. diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index 438af3159c..c3634ba186 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -1,5 +1,5 @@ @@ -202,7 +202,7 @@ Postgres documentation Something went wrong. vacuumdb is only a wrapper script. See - and for a detailed + and for a detailed discussion of error messages and potential problems. @@ -234,7 +234,7 @@ Postgres documentation backend command via the Postgres interactive terminal - . There is no effective + . There is no effective difference between vacuuming databases via this or other methods. psql must be found by the script and a database server must be running at the targeted host. Also, any default diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml index 0fc9f22eda..63a03b7693 100644 --- a/doc/src/sgml/reference.sgml +++ b/doc/src/sgml/reference.sgml @@ -1,5 +1,5 @@ @@ -119,7 +119,7 @@ Disable this chapter until we have more functions documented. --> - Client Applications + PostgreSQL Client Applications @@ -148,7 +148,7 @@ Disable this chapter until we have more functions documented. - Server Applications and Utilities + PostgreSQL Server Applications