diff options
| author | Peter Eisentraut <peter_e@gmx.net> | 2012-06-13 13:41:25 +0300 |
|---|---|---|
| committer | Peter Eisentraut <peter_e@gmx.net> | 2012-06-13 13:41:25 +0300 |
| commit | c0a6f9c84bedc745af2a3bf1dee5e2a4e79b46af (patch) | |
| tree | fc63102259d0b1c284eb3b104a5dc20f976ba89a | |
| parent | f871ef74a5560377d541e6d94704f30bcbcdb779 (diff) | |
| download | postgresql-c0a6f9c84bedc745af2a3bf1dee5e2a4e79b46af.tar.gz postgresql-c0a6f9c84bedc745af2a3bf1dee5e2a4e79b46af.zip | |
Improve documentation of postgres -C option
Clarify help (s/return/print/), and explain that this option is for
use by other programs, not for user-facing use (it does not print
units).
| -rw-r--r-- | doc/src/sgml/ref/postgres-ref.sgml | 9 | ||||
| -rw-r--r-- | src/backend/main/main.c | 2 |
2 files changed, 9 insertions, 2 deletions
diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index 9869a1f5262..d8e9825d13e 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -144,13 +144,20 @@ PostgreSQL documentation <term><option>-C <replaceable>name</replaceable></option></term> <listitem> <para> - Returns the value of a named run-time parameter, and exits. + Prints the value of the named run-time parameter, and exits. (See the <option>-c</> option above for details.) This can be used on a running server, and returns values from <filename>postgresql.conf</>, modified by any parameters supplied in this invocation. It does not reflect parameters supplied when the cluster was started. </para> + + <para> + This option is meant for other programs that interact with a server + instance, such as <xref linkend="app-pg-ctl">, to query configuration + parameter values. User-facing applications should instead use <xref + linkend="sql-show"> or the <structname>pg_settings</structname> view. + </para> </listitem> </varlistentry> diff --git a/src/backend/main/main.c b/src/backend/main/main.c index a63ebe3d108..7203481a04b 100644 --- a/src/backend/main/main.c +++ b/src/backend/main/main.c @@ -279,7 +279,7 @@ help(const char *progname) #endif printf(_(" -B NBUFFERS number of shared buffers\n")); printf(_(" -c NAME=VALUE set run-time parameter\n")); - printf(_(" -C NAME return run-time parameter\n")); + printf(_(" -C NAME print value of run-time parameter, then exit\n")); printf(_(" -d 1-5 debugging level\n")); printf(_(" -D DATADIR database directory\n")); printf(_(" -e use European date input format (DMY)\n")); |