opensourcemirror
/
postgresql
mirror of git://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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).
This commit is contained in:
Peter Eisentraut 2012-06-13 13:41:25 +03:00
parent f871ef74a5
commit c0a6f9c84b
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/src/sgml/ref/postgres-ref.sgml
View File

@ -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>

2
src/backend/main/main.c
View File

@ -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"));