]> git.ipfire.org Git - thirdparty/postgresql.git/commitdiff
doc: Add section "Options" for pg_controldata
authorMichael Paquier <michael@paquier.xyz>
Mon, 23 Feb 2026 04:42:38 +0000 (13:42 +0900)
committerMichael Paquier <michael@paquier.xyz>
Mon, 23 Feb 2026 04:42:38 +0000 (13:42 +0900)
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

doc/src/sgml/ref/pg_controldata.sgml

index b47fdca9dfcb2527a8e7e0bc177a635aee9052d0..22dc61610083ec7bc10751c5eddbc42170e83223 100644 (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>