postgres.git / summary / log / commit / refs

commit    ee465848846efe6da0c73c99a0fcde6982831468
Author:   Michael Paquier <michael@paquier.xyz>
Date:     Mon Feb 23 04:42:38 2026 +0000

    doc: Add section "Options" for pg_controldata
    
    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 | 45 ++++++++++++++++++++++++++++++++----
 1 file changed, 40 insertions(+), 5 deletions(-)

diff --git a/doc/src/sgml/ref/pg_controldata.sgml b/doc/src/sgml/ref/pg_controldata.sgml
index b47fdca9dfc..22dc6161008 100644
--- a/doc/src/sgml/ref/pg_controldata.sgml
+++ b/doc/src/sgml/ref/pg_controldata.sgml
@@ -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>
 


[parent: 412f78c66eed]