Commit c0a6f9c8 authored by Peter Eisentraut's avatar Peter Eisentraut

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).
parent f871ef74
...@@ -144,13 +144,20 @@ PostgreSQL documentation ...@@ -144,13 +144,20 @@ PostgreSQL documentation
<term><option>-C <replaceable>name</replaceable></option></term> <term><option>-C <replaceable>name</replaceable></option></term>
<listitem> <listitem>
<para> <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 (See the <option>-c</> option above for details.) This can
be used on a running server, and returns values from be used on a running server, and returns values from
<filename>postgresql.conf</>, modified by any parameters <filename>postgresql.conf</>, modified by any parameters
supplied in this invocation. It does not reflect parameters supplied in this invocation. It does not reflect parameters
supplied when the cluster was started. supplied when the cluster was started.
</para> </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> </listitem>
</varlistentry> </varlistentry>
......
...@@ -279,7 +279,7 @@ help(const char *progname) ...@@ -279,7 +279,7 @@ help(const char *progname)
#endif #endif
printf(_(" -B NBUFFERS number of shared buffers\n")); printf(_(" -B NBUFFERS number of shared buffers\n"));
printf(_(" -c NAME=VALUE set run-time parameter\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 1-5 debugging level\n"));
printf(_(" -D DATADIR database directory\n")); printf(_(" -D DATADIR database directory\n"));
printf(_(" -e use European date input format (DMY)\n")); printf(_(" -e use European date input format (DMY)\n"));
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment