Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 0c00600

Browse files
Peter SmithCommitfest Bot
Peter Smith
authored and
Commitfest Bot
committed
DOCS - pg_controldata should have Option section with descriptions for -D and -V and -? options.
1 parent f511e3f commit 0c00600

File tree

1 file changed

+42
-5
lines changed

1 file changed

+42
-5
lines changed

doc/src/sgml/ref/pg_controldata.sgml

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,51 @@ PostgreSQL documentation
4747
This utility can only be run by the user who initialized the cluster because
4848
it requires read access to the data directory.
4949
You can specify the data directory on the command line, or use
50-
the environment variable <envar>PGDATA</envar>. This utility supports the options
51-
<option>-V</option> and <option>--version</option>, which print the
52-
<application>pg_controldata</application> version and exit. It also
53-
supports options <option>-?</option> and <option>--help</option>, which output the
54-
supported arguments.
50+
the environment variable <envar>PGDATA</envar>.
5551
</para>
5652
</refsect1>
5753

54+
<refsect1>
55+
<title>Options</title>
56+
57+
<para>
58+
The following command-line options are available:
59+
60+
<variablelist>
61+
<varlistentry>
62+
<term><option>-D <replaceable>datadir</replaceable></option></term>
63+
<term><option>--pgdata=<replaceable>datadir</replaceable></option></term>
64+
<listitem>
65+
<para>
66+
Specifies the location of the database directory.
67+
</para>
68+
</listitem>
69+
</varlistentry>
70+
71+
<varlistentry>
72+
<term><option>-V</option></term>
73+
<term><option>--version</option></term>
74+
<listitem>
75+
<para>
76+
Print the <application>pg_controldata</application> version and exit.
77+
</para>
78+
</listitem>
79+
</varlistentry>
80+
81+
<varlistentry>
82+
<term><option>-?</option></term>
83+
<term><option>--help</option></term>
84+
<listitem>
85+
<para>
86+
Show help about <application>pg_controldata</application> command line
87+
arguments, and exit.
88+
</para>
89+
</listitem>
90+
</varlistentry>
91+
</variablelist>
92+
</para>
93+
</refsect1>
94+
5895
<refsect1>
5996
<title>Environment</title>
6097

0 commit comments

Comments
 (0)