From 86c23a6eb28b0588644dcefeb33ef5a2aa8b9453 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Thu, 5 Jan 2006 10:07:46 +0000 Subject: Make all command-line options of postmaster and postgres the same. See http://archives.postgresql.org/pgsql-hackers/2006-01/msg00151.php for the complete plan. --- doc/src/sgml/config.sgml | 137 +++++++++++++------- doc/src/sgml/ref/postgres-ref.sgml | 259 ++++++++----------------------------- doc/src/sgml/ref/postmaster.sgml | 189 +++++++++++++++++++-------- 3 files changed, 283 insertions(+), 302 deletions(-) (limited to 'doc/src') diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index acc1ec99c37..293ee355827 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -1,5 +1,5 @@ Server Configuration @@ -2407,8 +2407,7 @@ SELECT * FROM parent WHERE key = 2400; Runs the server silently. If this option is set, the server will automatically run in background and any controlling - terminals are disassociated (same effect as - postmaster's option). + terminals are disassociated. The server's standard output and standard error are redirected to /dev/null, so any messages sent to them will be lost. Unless syslog logging is selected or @@ -4054,6 +4053,19 @@ plruby.use_strict = true # generates error: unknown class name + + allow_system_table_mods (boolean) + + allow_system_table_mods configuration parameter + + + + Allows the modification of the structure of system tables. + This is used by initdb. + + + + debug_assertions (boolean) @@ -4075,6 +4087,35 @@ plruby.use_strict = true # generates error: unknown class name + + ignore_system_indexes (boolean) + + ignore_system_indexes configuration parameter + + + + Ignore system indexes when reading system tables (but still + update the indexes when modifying the tables). This is useful + when recovering from damaged system indexes. + + + + + + post_auth_delay (integer) + + post_auth_delay configuration parameter + + + + If nonzero, a delay of this many seconds occurs when a new + server process is started, after it conducts the + authentication procedure. This is intended to give an + opportunity to attach to the server process with a debugger. + + + + pre_auth_delay (integer) @@ -4082,11 +4123,11 @@ plruby.use_strict = true # generates error: unknown class name - If nonzero, a delay of this many seconds occurs just after a new - server process is forked, before it conducts the authentication - process. This is intended to give an opportunity to attach to the - server process with a debugger to trace down misbehavior in - authentication. + If nonzero, a delay of this many seconds occurs just after a + new server process is forked, before it conducts the + authentication procedure. This is intended to give an + opportunity to attach to the server process with a debugger to + trace down misbehavior in authentication. @@ -4182,9 +4223,12 @@ plruby.use_strict = true # generates error: unknown class name Short Options - For convenience there are also single letter command-line option switches - available for some parameters. They are described in . + For convenience there are also single letter command-line option + switches available for some parameters. They are described in + . Some of these + options exist for historical reasons, and their presence as a + single-letter option does not necessarily indicate an endorsement + to use the option heavily. @@ -4198,6 +4242,10 @@ plruby.use_strict = true # generates error: unknown class name + + + debug_assertions = x + shared_buffers = x @@ -4206,6 +4254,26 @@ plruby.use_strict = true # generates error: unknown class name log_min_messages = DEBUGx + + + datestyle = euro + + + + , , , + , , + , + + + enable_bitmapscan = off, + enable_hashjoin = off, + enable_indexscan = off, + enable_mergejoin = off, + enable_nestloop = off, + enable_seqscan = off, + enable_tidscan = off + + fsync = off @@ -4230,57 +4298,36 @@ plruby.use_strict = true # generates error: unknown class name max_connections = x + + + allow_system_table_mods = on + port = x - - - , , , - , , - , - - For historical reasons, these options must be passed to - the individual server process via the - postmaster option, for example, - -$ postmaster -o '-S 1024 -s' - - or via PGOPTIONS from the client side, as - explained above. - - - - - enable_bitmapscan = off, - enable_hashjoin = off, - enable_indexscan = off, - enable_mergejoin = off, - enable_nestloop = off, - enable_seqscan = off, - enable_tidscan = off - + + ignore_system_indexes = on - - + log_statement_stats = on - - - + work_mem = x - - , , + , , log_parser_stats = on, log_planner_stats = on, log_executor_stats = on + + + post_auth_delay = x +
diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index 4baecaf2eda..1cf8521bebb 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -1,5 +1,5 @@ @@ -21,53 +21,9 @@ PostgreSQL documentation - postgres - -A 01 - -B nbuffers - -c name=value - -d debug-level - --describe-config - -D datadir - -e - -E - -fsitnmh - -F - -N - -o filename - -O - -P - - -s - -tpaplex - - -S work-mem - -W seconds - --name=value + option database - - - postgres - -A 01 - -B nbuffers - -c name=value - -d debug-level - -D datadir - -e - -fsitnmh - -F - -o filename - -O - -p database - -P - - -s - -tpaplex - - -S work-mem - -v protocol - -W seconds - --name=value @@ -77,23 +33,21 @@ PostgreSQL documentation The postgres executable is the actual PostgreSQL server process that processes - queries. It is normally not called directly; instead a multiuser server is started. - - - - The second form above is how - postgres is invoked by the (only - 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 single-user mode. The primary use - for this mode is during bootstrapping by . - Sometimes it is used for debugging or disaster recovery. + SQL statements. It is normally not called directly; instead a + multiuser server is started. + Conceptually, the postmaster starts a new + postgres process for each connection. + (postmaster and postgres + are in fact the same program, and on most platforms the connection + process is forked). + If the postgres command is called directly, it + invokes the server in interactive single-user mode. The primary + use for this mode is during bootstrapping by . Sometimes it is used for debugging or + disaster recovery. When invoked in interactive mode from the shell, the user can enter queries and the results will be printed to the screen, but in a form that is more useful for developers than end users. But note @@ -117,11 +71,9 @@ PostgreSQL documentation When postgres is started by a then it - inherits all options set by the latter. Additionally, - postgres-specific options can be passed - from the postmaster with the - switch. + linkend="app-postmaster"> then it inherits all options set by the + latter. In single-user mode, postgres accepts + all the options that postmaster would accept. @@ -141,74 +93,17 @@ PostgreSQL documentation The options , , , , , - , and have the same meanings - as the except that - -d 0 prevents the server log level of - the postmaster from being propagated to postgres. + , , , + , and + have the same meanings as with the + except that -d 0 prevents the server log level of the + postmaster from being propagated to + postgres. Other postmaster + options are also accepted but will have no noticeable effect + because they only apply to the multiuser server mode, namely + , , , + , and . - - - - - - - Sets the default date style to European, that is - DMY ordering of input date fields. This also causes - the day to be printed before the month in certain date output formats. - See for more information. - - - - - - filename - - - Send all server log output to - filename. - If postgres is running under the - postmaster, this option is ignored, - and the stderr inherited from the - postmaster is used. - - - - - - - - - Ignore system indexes when reading system tables (but still update - the indexes when modifying the tables). This is useful when - recovering from damaged system indexes. - - - - - - - - - Print time information and other statistics at the end of each command. - This is useful for benchmarking or for use in tuning the number of - buffers. - - - - - - work-mem - - - Specifies the amount of memory to be used by internal sorts and hashes - before resorting to temporary disk files. See the description of the - work_mem configuration parameter in . - - - - - @@ -235,83 +130,41 @@ PostgreSQL documentation - + Disables use of newline as a statement delimiter. - - - - - Semi-internal Options - - - There are several other options that may be specified, used - mainly for debugging purposes. These are listed here only for - the use by PostgreSQL system - developers. Use of any of these options is highly - discouraged. Furthermore, any of these options may - disappear or change in a future release without notice. - - - - - { s | i | m | n | h } - - - Forbids the use of particular scan and join methods: - s and i - disable sequential and index scans respectively, while - n, m, and h - disable nested-loop, merge and hash joins respectively. - - - - - Neither sequential scans nor nested-loop joins can be disabled completely; - the -fs and -fn - options simply discourage the optimizer from using those - plan types if it has any other alternative. - - - - - + filename - Allows the structure of system tables to be modified. This is - used by initdb. + Send all server log output to + filename. + If postgres is running under the + postmaster, this option is ignored, + and the stderr inherited from the + postmaster is used. + + - - database - - - Indicates that this process has been started by a - postmaster and specifies the database to use. - etc. - - - + + Semi-internal Options - - pa[rser] | pl[anner] | e[xecutor] - - - Print timing statistics for each query relating to each of the - major system modules. This option cannot be used together - with the option. - - - + + The options , , + , , and + have the same meanings as with the and are reserved for debugging and + disaster recovery. Further options for internal use are: + protocol @@ -323,12 +176,12 @@ PostgreSQL documentation - seconds + database - As soon as this option is encountered, the process sleeps for - the specified amount of seconds. This gives developers time - to attach a debugger to the server process. + Indicates that this process has been started by a + postmaster and specifies the database to use. + etc. @@ -343,8 +196,8 @@ PostgreSQL documentation - + @@ -361,13 +214,7 @@ PostgreSQL documentation - - - - For others, which have little influence during single-user mode, - see . - @@ -423,7 +270,7 @@ PostgreSQL documentation - But if you use the diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index aa332ed2f22..77275e8d93a 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,5 +1,5 @@ @@ -22,22 +22,7 @@ PostgreSQL documentation postmaster - -A 01 - -B nbuffers - -c name=value - -d debug-level - -D datadir - -F - -h hostname - -i - -k directory - -l - -N max-connections - -o extra-options - -p port - -S - --name=value - -n-s + option @@ -70,8 +55,7 @@ PostgreSQL documentation location (the data area). More than one postmaster process can run on a system at one time, so long as they use different data areas and different - communication ports (see below). A data area is created with . + communication ports (see below). @@ -83,6 +67,7 @@ PostgreSQL documentation directly to the data area directory created by initdb. Other possible file layouts are discussed in . + A data area is created with . @@ -92,8 +77,12 @@ PostgreSQL documentation postmaster accepts the following command line arguments. For a detailed discussion of the options - consult . You can also save typing most of these + consult . You can save typing most of these options by setting up a configuration file. + + + + General Purpose @@ -156,6 +145,18 @@ PostgreSQL documentation + + + + + Sets the default date style to European, that is + DMY ordering of input date fields. This also causes + the day to be printed before the month in certain date output formats. + See for more information. + + + + @@ -264,6 +265,12 @@ PostgreSQL documentation linkend="app-postgres"> for possibilities. If the option string contains any spaces, the entire string must be quoted. + + + The use of this option is obsolete; all command-line options + for server processes can be specified directly on the + postmaster command line + @@ -284,6 +291,17 @@ PostgreSQL documentation + + + + + Print time information and other statistics at the end of each command. + This is useful for benchmarking or for use in tuning the number of + buffers. + + + + @@ -318,55 +336,124 @@ PostgreSQL documentation - + - - Two additional command line options are available for debugging - problems that cause a server process to die abnormally. The - ordinary strategy in this situation is to notify all other server - processes that they must terminate and then reinitialize the - shared memory and semaphores. This is because an errant server - process could have corrupted some shared state before terminating. - These options select alternative behaviors of the - postmaster in this situation. - Neither option is intended for use in ordinary - operation. - + + Semi-internal Options - - - - - These special-case options are: + + There are several other options that may be specified, used + mainly for debugging purposes and in some cases to assist with + recovery of severely damaged databases. There should be no reason + to use them in a production database setup. These are listed + here only for the use by PostgreSQL + system developers. Use of any of these options is + highly discouraged. Furthermore, any of these options + may disappear or change in a future release without notice. + + + { s | i | m | n | h } + + + Forbids the use of particular scan and join methods: + s and i + disable sequential and index scans respectively, while + n, m, and h + disable nested-loop, merge and hash joins respectively. + + + + Neither sequential scans nor nested-loop joins can be disabled + completely; the -fs and + -fn options simply discourage the optimizer + from using those plan types if it has any other alternative. + + + + - postmaster - will not reinitialize shared data structures. A knowledgeable system - programmer can then use a debugger - to examine shared memory and semaphore state. + This option is for debugging problems that cause a server + process to die abnormally. The ordinary strategy in this + situation is to notify all other server processes that they + must terminate and then reinitialize the shared memory and + semaphores. This is because an errant server process could + have corrupted some shared state before terminating. This + option specifies that the postmaster will + not reinitialize shared data structures. A knowledgeable + system programmer can then use a debugger to examine shared + memory and semaphore state. - - + + - postmaster - will stop all other server processes by sending the signal - SIGSTOP, - but will not cause them to terminate. This permits system programmers - to collect core dumps from all server processes by hand. + Allows the structure of system tables to be modified. This is + used by initdb. + + + + + + + + + Ignore system indexes when reading system tables (but still update + the indexes when modifying the tables). This is useful when + recovering from damaged system indexes. - - + + pa[rser] | pl[anner] | e[xecutor] + + + Print timing statistics for each query relating to each of the + major system modules. This option cannot be used together + with the option. + + + + + + + + + This option is for debugging problems that cause a server + process to die abnormally. The ordinary strategy in this + situation is to notify all other server processes that they + must terminate and then reinitialize the shared memory and + semaphores. This is because an errant server process could + have corrupted some shared state before terminating. This + option specifies that the postmaster will + stop all other server processes by sending the signal + SIGSTOP, but will not cause them to + terminate. This permits system programmers to collect core + dumps from all server processes by hand. + + + + + + seconds + + + A delay of this many seconds occurs when a new server process + is started, after it conducts the authentication procedure. + This is intended to give an opportunity to attach to the + server process with a debugger. + + + + -- cgit v1.2.3