upstream/postgresql
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2026-03-22 18:33:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Add section "Options" for pg_controldata

Browse source 
Adding this section brings consistency with the pages of other tools,
potentially easing the introduction of new options in the future as
these are now showing in the shape of a list.

Author: Peter Smith <smithpb2250@gmail.com>
Reviewed-by: Andreas Karlsson <andreas@proxel.se>
Discussion: https://postgr.es/m/CAHut+PtSF5AW3DHpYA-_muDLms2xBUzHpd545snVj8vFpmsmGg@mail.gmail.com
This commit is contained in:
Michael Paquier 2026-02-23 13:42:38 +09:00
parent 412f78c66e
commit ee46584884
1 changed files with 40 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
doc/src/sgml/ref/pg_controldata.sgml
View file

@ -47,14 +47,49 @@ PostgreSQL documentation
This utility can only be run by the user who initialized the cluster because
it requires read access to the data directory.
You can specify the data directory on the command line, or use
the environment variable <envar>PGDATA</envar>. This utility supports the options
<option>-V</option> and <option>--version</option>, which print the
<application>pg_controldata</application> version and exit. It also
supports options <option>-?</option> and <option>--help</option>, which output the
supported arguments.
the environment variable <envar>PGDATA</envar>.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>
<variablelist>
<varlistentry>
<term><option>-D <replaceable>datadir</replaceable></option></term>
<term><option>--pgdata=<replaceable>datadir</replaceable></option></term>
<listitem>
<para>
Specifies the directory where the database cluster is stored.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</option></term>
<term><option>--version</option></term>
<listitem>
<para>
Print the <application>pg_controldata</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</option></term>
<term><option>--help</option></term>
<listitem>
<para>
Show help about <application>pg_controldata</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1>
<title>Environment</title>