diff options
| author | Peter Eisentraut | 2012-06-13 10:41:25 +0000 |
|---|---|---|
| committer | Peter Eisentraut | 2012-06-13 10:41:25 +0000 |
| commit | c0a6f9c84bedc745af2a3bf1dee5e2a4e79b46af (patch) | |
| tree | fc63102259d0b1c284eb3b104a5dc20f976ba89a /doc/src | |
| parent | f871ef74a5560377d541e6d94704f30bcbcdb779 (diff) | |
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).
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/ref/postgres-ref.sgml | 9 |
1 files changed, 8 insertions, 1 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> |