From 665066f3944495bfaf661e23f82d978d9a0dc2c6 Mon Sep 17 00:00:00 2001 From: Tom Lane Date: Sun, 25 Nov 2001 01:11:36 +0000 Subject: [PATCH] Further work on postmaster and postgres reference pages. --- doc/src/sgml/ref/postgres-ref.sgml | 65 ++++++++++++++++++++++++------ doc/src/sgml/ref/postmaster.sgml | 57 +++++++++++++++++++------- doc/src/sgml/ref/reindex.sgml | 8 ++-- 3 files changed, 101 insertions(+), 29 deletions(-) diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index 9c4266d7d6..00207b20f7 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -1,5 +1,5 @@ @@ -43,6 +43,7 @@ Postgres documentation -S sort-mem -W seconds + --name=value database @@ -67,6 +68,7 @@ Postgres documentation -S sort-mem -v protocol-version -W seconds + --name=value @@ -87,8 +89,9 @@ Postgres documentation conceptually, since both postmaster and postgres 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 . + the server directly in interactive single-user mode. The primary use + for this mode is during bootstrapping by . + Sometimes it is used for debugging or disaster recovery. @@ -138,8 +141,8 @@ Postgres documentation The options , , , , , - and have the same meaning as with the . + , and @@ -163,12 +166,10 @@ Postgres documentation Sends all debugging and error output to filename. - If the backend is running under the postmaster, - error messages are still sent to the frontend process as well as to - filename, - but debugging output is sent to the controlling tty of the - postmaster - (since only one file descriptor can be sent to an actual file). + If the backend is running under the + postmaster, this option is ignored, + and the stderr inherited from the + postmaster is used. @@ -177,7 +178,7 @@ Postgres documentation -P - Ignore system indexes to scan/update system tuples. The + Ignore system indexes while scanning/updating system tuples. The REINDEX command for system tables/indexes requires this option to be used. @@ -350,6 +351,46 @@ Postgres documentation + + Usage + + + Start a standalone backend with a command like + +postgres -D $PGDATA other-options my_database + + Provide the correct path to the database area with + + + Normally, the standalone backend treats newline as the command + entry terminator; there is no intelligence about semicolons, + as there is in psql. To continue a command + across multiple lines, you must type backslash just before each + newline except the last one. + + + + But if you use the + + + The standalone backend does not have readline input processing + (no command history, for example). + + + + To quit the backend, type EOF (control-D, usually). If you've + used + + + See Also diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index 39fff15e53..386434c2fa 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,5 +1,5 @@ @@ -36,6 +36,7 @@ Postgres documentation -o extra-options -p port -S + --name=value -n-s @@ -115,12 +116,8 @@ Postgres documentation Sets a named run-time parameter. Consult the Administrator's Guide for a list and descriptions. Most of the other command line options are in - fact short forms of such a parameter assignment. - - - - These options may also be specified using the GNU-style long option - format, . + fact short forms of such a parameter assignment. @@ -131,7 +128,8 @@ Postgres documentation Sets the debug level. The higher this value is set, the more debugging output is written to the server log. The default is - 0, which means no debugging. Values up to 4 make sense. + 0, which means no debugging. Values up to 4 are useful; higher + numbers produce no additional output. @@ -151,8 +149,8 @@ Postgres documentation Disables fsync calls for performance - improvement at the risk of data corruption. Read the detailed - documentation before using this! + improvement, at the risk of data corruption in event of a + system crash. Read the detailed documentation before using this! @@ -209,10 +207,12 @@ 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 + default, this value is 32, but it can be set as high as your + system will support. (Note that is required to be at least twice - .) + . See the Administrator's + Guide for a discussion of system resource requirements + for large numbers of client connections.) @@ -267,6 +267,15 @@ Postgres documentation + + --name=value + + + Sets a named run-time parameter; a shorter form of + + + @@ -417,7 +426,7 @@ StreamServerPort: cannot bind to port 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 + immediately without proper shutdown, resulting in a recovery run during restart. @@ -458,6 +467,26 @@ StreamServerPort: cannot bind to port $ psql + + + Named runtime parameters can be set in either of these styles: + +$ postmaster -c sort_mem=1234 +$ postmaster --sort-mem=1234 + + Either form overrides whatever setting might exist for sort_mem + in postgresql.conf. Notice that underscores in parameter + names can be written as either underscore or dash on the command line. + + + + + Except for short-term experiments, + it's probably better practice to edit the setting in + postgresql.conf than to rely on a command-line switch + to set a parameter. + + diff --git a/doc/src/sgml/ref/reindex.sgml b/doc/src/sgml/ref/reindex.sgml index 5ed857f742..67ba9a6011 100644 --- a/doc/src/sgml/ref/reindex.sgml +++ b/doc/src/sgml/ref/reindex.sgml @@ -1,5 +1,5 @@ @@ -183,8 +183,10 @@ REINDEX Be aware that the standalone backend treats newline as the command - entry terminator, not semicolon; you can't continue commands across - lines, as you can in psql. + entry terminator; there is no intelligence about semicolons, + as there is in psql. To continue a command + across multiple lines, you must type backslash just before each + newline except the last one. Also, you won't have any of the conveniences of readline processing (no command history, for example). -- 2.40.0