Improve markup of cmdsynopsis elements

Add more markup in particular so that the command options appear
consistently in monospace in the HTML output.

On the vacuumdb reference page, remove listing all the possible
options in the synopsis.  They have become too many now; we have the
detailed options list for that.

diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml
index 1573145b9234a0962dc5ec141186b21dbc09cd89..e0246b3bca20a4e89fda4a81e038dfcc8689f97d 100644 (file)
--- a/doc/src/sgml/ref/clusterdb.sgml
+++ b/doc/src/sgml/ref/clusterdb.sgml
@@ -23,16 +23,16 @@ PostgreSQL documentation
   <cmdsynopsis>
    <command>clusterdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
-   <group><arg>--verbose</arg><arg>-v</arg></group>
-   <arg>--table | -t <replaceable>table</replaceable> </arg>
+   <group><arg><option>--verbose</option></arg><arg><option>-v</option></arg></group>
+   <arg><group choice="plain"><arg><option>--table</option></arg><arg><option>-t</option></arg></group> <replaceable>table</replaceable> </arg>
    <arg><replaceable>dbname</replaceable></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>clusterdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
-   <group><arg>--verbose</arg><arg>-v</arg></group>
-   <group><arg>--all</arg><arg>-a</arg></group>
+   <group><arg><option>--verbose</option></arg><arg><option>-v</option></arg></group>
+   <group><arg><option>--all</option></arg><arg><option>-a</option></arg></group>
   </cmdsynopsis>
  </refsynopsisdiv>
 

diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml
index d28cfb772abaddd245cb1c87b918b7727bdc078f..4ca32fba39a70583276075f2f1576e984d9a45e2 100644 (file)
--- a/doc/src/sgml/ref/createlang.sgml
+++ b/doc/src/sgml/ref/createlang.sgml
@@ -30,7 +30,7 @@ PostgreSQL documentation
   <cmdsynopsis>
    <command>createlang</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
-   <group choice="plain"><arg>--list</arg><arg>-l</arg></group>
+   <group choice="plain"><arg><option>--list</option></arg><arg><option>-l</option></arg></group>
    <arg choice="plain"><replaceable>dbname</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>

diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml
index e5d02aa236f86cf3e7842d6aae34be09c0816c57..2bfdbfe8885bfa47c41df3bb53d265c53d5d4215 100644 (file)
--- a/doc/src/sgml/ref/droplang.sgml
+++ b/doc/src/sgml/ref/droplang.sgml
@@ -30,7 +30,7 @@ PostgreSQL documentation
   <cmdsynopsis>
    <command>droplang</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
-   <group choice="plain"><arg>--list</arg><arg>-l</arg></group>
+   <group choice="plain"><arg><option>--list</option></arg><arg><option>-l</option></arg></group>
    <arg choice="plain"><replaceable>dbname</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>

diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml
index 0090f49d9f522795b62f571dcc9ebbc99dd32ce7..092df33d10074f11b3865e77450dc3566f4dc39b 100644 (file)
--- a/doc/src/sgml/ref/initdb.sgml
+++ b/doc/src/sgml/ref/initdb.sgml
@@ -24,9 +24,11 @@ PostgreSQL documentation
    <command>initdb</command>
    <arg rep="repeat"><replaceable>option</replaceable></arg>
    <group choice="plain">
-    <arg>--pgdata</arg>
-    <arg>-D </arg>
-    <replaceable>directory</replaceable>
+    <group choice="opt">
+     <arg><option>--pgdata</option></arg>
+     <arg><option>-D</option></arg>
+    </group>
+    <replaceable> directory</replaceable>
    </group>
   </cmdsynopsis>
  </refsynopsisdiv>

diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml
index 7e54b82c063c6ac26ba223ccd9fa58614323d306..fcc34ecb967dcdeeed0862e59db69b7924d35d68 100644 (file)
--- a/doc/src/sgml/ref/pg_ctl-ref.sgml
+++ b/doc/src/sgml/ref/pg_ctl-ref.sgml
@@ -22,109 +22,109 @@ PostgreSQL documentation
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">init[db]</arg>
-   <arg>-s</arg>
-   <arg>-D <replaceable>datadir</replaceable></arg>
-   <arg>-o <replaceable>initdb-options</replaceable></arg>
+   <arg choice="plain"><option>init[db]</option></arg>
+   <arg><option>-s</option></arg>
+   <arg><option>-D</option> <replaceable>datadir</replaceable></arg>
+   <arg><option>-o</option> <replaceable>initdb-options</replaceable></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">start</arg>
-   <arg>-w</arg>
-   <arg>-t <replaceable>seconds</replaceable></arg>
-   <arg>-s</arg>
-   <arg>-D <replaceable>datadir</replaceable></arg>
-   <arg>-l <replaceable>filename</replaceable></arg>
-   <arg>-o <replaceable>options</replaceable></arg>
-   <arg>-p <replaceable>path</replaceable></arg>
-   <arg>-c</arg>
+   <arg choice="plain"><option>start</option></arg>
+   <arg><option>-w</option></arg>
+   <arg><option>-t</option> <replaceable>seconds</replaceable></arg>
+   <arg><option>-s</option></arg>
+   <arg><option>-D</option> <replaceable>datadir</replaceable></arg>
+   <arg><option>-l</option> <replaceable>filename</replaceable></arg>
+   <arg><option>-o</option> <replaceable>options</replaceable></arg>
+   <arg><option>-p</option> <replaceable>path</replaceable></arg>
+   <arg><option>-c</option></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">stop</arg>
-   <arg>-W</arg>
-   <arg>-t <replaceable>seconds</replaceable></arg>
-   <arg>-s</arg>
-   <arg>-D <replaceable>datadir</replaceable></arg>
-   <arg>-m
+   <arg choice="plain"><option>stop</option></arg>
+   <arg><option>-W</option></arg>
+   <arg><option>-t</option> <replaceable>seconds</replaceable></arg>
+   <arg><option>-s</option></arg>
+   <arg><option>-D</option> <replaceable>datadir</replaceable></arg>
+   <arg><option>-m</option>
      <group choice="plain">
-       <arg>s[mart]</arg>
-       <arg>f[ast]</arg>
-       <arg>i[mmediate]</arg>
+       <arg><option>s[mart]</option></arg>
+       <arg><option>f[ast]</option></arg>
+       <arg><option>i[mmediate]</option></arg>
      </group>
    </arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">restart</arg>
-   <arg>-w</arg>
-   <arg>-t <replaceable>seconds</replaceable></arg>
-   <arg>-s</arg>
-   <arg>-D <replaceable>datadir</replaceable></arg>
-   <arg>-c</arg>
-   <arg>-m
+   <arg choice="plain"><option>restart</option></arg>
+   <arg><option>-w</option></arg>
+   <arg><option>-t</option> <replaceable>seconds</replaceable></arg>
+   <arg><option>-s</option></arg>
+   <arg><option>-D</option> <replaceable>datadir</replaceable></arg>
+   <arg><option>-c</option></arg>
+   <arg><option>-m</option>
      <group choice="plain">
-       <arg>s[mart]</arg>
-       <arg>f[ast]</arg>
-       <arg>i[mmediate]</arg>
+       <arg><option>s[mart]</option></arg>
+       <arg><option>f[ast]</option></arg>
+       <arg><option>i[mmediate]</option></arg>
      </group>
    </arg>
-   <arg>-o <replaceable>options</replaceable></arg>
+   <arg><option>-o</option> <replaceable>options</replaceable></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">reload</arg>
-   <arg>-s</arg>
-   <arg>-D <replaceable>datadir</replaceable></arg>
+   <arg choice="plain"><option>reload</option></arg>
+   <arg><option>-s</option></arg>
+   <arg><option>-D</option> <replaceable>datadir</replaceable></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">status</arg>
-   <arg>-D <replaceable>datadir</replaceable></arg>
+   <arg choice="plain"><option>status</option></arg>
+   <arg><option>-D</option> <replaceable>datadir</replaceable></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">promote</arg>
-   <arg>-s</arg>
-   <arg>-D <replaceable>datadir</replaceable></arg>
+   <arg choice="plain"><option>promote</option></arg>
+   <arg><option>-s</option></arg>
+   <arg><option>-D</option> <replaceable>datadir</replaceable></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">kill</arg>
+   <arg choice="plain"><option>kill</option></arg>
    <arg choice="plain"><replaceable>signal_name</replaceable></arg>
    <arg choice="plain"><replaceable>process_id</replaceable></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">register</arg>
-   <arg>-N <replaceable>servicename</replaceable></arg>
-   <arg>-U <replaceable>username</replaceable></arg>
-   <arg>-P <replaceable>password</replaceable></arg>
-   <arg>-D <replaceable>datadir</replaceable></arg>
-   <arg>-S
+   <arg choice="plain"><option>register</option></arg>
+   <arg><option>-N</option> <replaceable>servicename</replaceable></arg>
+   <arg><option>-U</option> <replaceable>username</replaceable></arg>
+   <arg><option>-P</option> <replaceable>password</replaceable></arg>
+   <arg><option>-D</option> <replaceable>datadir</replaceable></arg>
+   <arg><option>-S</option>
      <group choice="plain">
-       <arg>a[uto]</arg>
-       <arg>d[emand]</arg>
+       <arg><option>a[uto]</option></arg>
+       <arg><option>d[emand]</option></arg>
      </group>
    </arg>
-   <arg>-w</arg>
-   <arg>-t <replaceable>seconds</replaceable></arg>
-   <arg>-s</arg>
-   <arg>-o <replaceable>options</replaceable></arg>
+   <arg><option>-w</option></arg>
+   <arg><option>-t</option> <replaceable>seconds</replaceable></arg>
+   <arg><option>-s</option></arg>
+   <arg><option>-o</option> <replaceable>options</replaceable></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>pg_ctl</command>
-   <arg choice="plain">unregister</arg>
-   <arg>-N <replaceable>servicename</replaceable></arg>
+   <arg choice="plain"><option>unregister</option></arg>
+   <arg><option>-N</option> <replaceable>servicename</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
 

diff --git a/doc/src/sgml/ref/pg_resetxlog.sgml b/doc/src/sgml/ref/pg_resetxlog.sgml
index 2ff1479b4e46ec39c3ee696491f77953f6107f0e..3a7dfb3c73e7bc593e07c31ffddde1164ba727df 100644 (file)
--- a/doc/src/sgml/ref/pg_resetxlog.sgml
+++ b/doc/src/sgml/ref/pg_resetxlog.sgml
@@ -22,14 +22,14 @@ PostgreSQL documentation
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>pg_resetxlog</command>
-   <arg>-f</arg>
-   <arg>-n</arg>
-   <arg>-o<replaceable class="parameter">oid</replaceable> </arg>
-   <arg>-x <replaceable class="parameter">xid</replaceable> </arg>
-   <arg>-e <replaceable class="parameter">xid_epoch</replaceable> </arg>
-   <arg>-m <replaceable class="parameter">mxid</replaceable> </arg>
-   <arg>-O <replaceable class="parameter">mxoff</replaceable> </arg>
-   <arg>-l <replaceable class="parameter">timelineid</replaceable>,<replaceable class="parameter">fileid</replaceable>,<replaceable class="parameter">seg</replaceable> </arg>
+   <arg><option>-f</option></arg>
+   <arg><option>-n</option></arg>
+   <arg><option>-o</option> <replaceable class="parameter">oid</replaceable></arg>
+   <arg><option>-x</option> <replaceable class="parameter">xid</replaceable></arg>
+   <arg><option>-e</option> <replaceable class="parameter">xid_epoch</replaceable></arg>
+   <arg><option>-m</option> <replaceable class="parameter">mxid</replaceable></arg>
+   <arg><option>-O</option> <replaceable class="parameter">mxoff</replaceable></arg>
+   <arg><option>-l</option> <replaceable class="parameter">timelineid</replaceable>,<replaceable class="parameter">fileid</replaceable>,<replaceable class="parameter">seg</replaceable></arg>
    <arg choice="plain"><replaceable>datadir</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>

diff --git a/doc/src/sgml/ref/reindexdb.sgml b/doc/src/sgml/ref/reindexdb.sgml
index 9caaa952668642912d26deca7390d76944250939..526fd7681789a30cecdb5c91548796598472e9be 100644 (file)
--- a/doc/src/sgml/ref/reindexdb.sgml
+++ b/doc/src/sgml/ref/reindexdb.sgml
@@ -23,21 +23,39 @@ PostgreSQL documentation
   <cmdsynopsis>
    <command>reindexdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
-   <arg>--table | -t <replaceable>table</replaceable> </arg>
-   <arg>--index | -i <replaceable>index</replaceable> </arg>
+   <group choice="opt">
+    <group choice="plain">
+     <arg><option>--table</option></arg>
+     <arg><option>-t</option></arg>
+    </group>
+    <replaceable>table</replaceable>
+   </group>
+   <group choice="opt">
+    <group choice="plain">
+     <arg><option>--index</option></arg>
+     <arg><option>-i</option></arg>
+    </group>
+    <replaceable>index</replaceable>
+   </group>
    <arg><replaceable>dbname</replaceable></arg>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>reindexdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
-   <arg>--all | -a</arg>
+   <group choice="plain">
+    <arg><option>--all</option></arg>
+    <arg><option>-a</option></arg>
+   </group>
   </cmdsynopsis>
 
   <cmdsynopsis>
    <command>reindexdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
-   <arg>--system | -s</arg>
+   <group choice="plain">
+    <arg><option>--system</option></arg>
+    <arg><option>-s</option></arg>
+   </group>
    <arg><replaceable>dbname</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>

diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml
index 89d634747dd1cfb8dc93473806a856f49d995ec0..c008611a5af3866eedfaa37a71c023bb3ead2e65 100644 (file)
--- a/doc/src/sgml/ref/vacuumdb.sgml
+++ b/doc/src/sgml/ref/vacuumdb.sgml
@@ -23,12 +23,13 @@ PostgreSQL documentation
   <cmdsynopsis>
    <command>vacuumdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
-   <group><arg>--full</arg><arg>-f</arg></group>
-   <group><arg>--freeze</arg><arg>-F</arg></group>
-   <group><arg>--verbose</arg><arg>-v</arg></group>
-   <group><arg>--analyze</arg><arg>-z</arg></group>
-   <group><arg>--analyze-only</arg><arg>-Z</arg></group>
-   <arg>--table | -t <replaceable>table</replaceable>
+   <arg rep="repeat"><replaceable>option</replaceable></arg>
+   <arg>
+    <group choice="plain">
+     <arg><option>--table</option></arg>
+     <arg><option>-t</option></arg>
+    </group>
+    <replaceable>table</replaceable>
     <arg>( <replaceable class="parameter">column</replaceable> [,...] )</arg>
    </arg>
    <arg><replaceable>dbname</replaceable></arg>
@@ -37,12 +38,11 @@ PostgreSQL documentation
   <cmdsynopsis>
    <command>vacuumdb</command>
    <arg rep="repeat"><replaceable>connection-option</replaceable></arg>
-   <group><arg>--full</arg><arg>-f</arg></group>
-   <group><arg>--freeze</arg><arg>-F</arg></group>
-   <group><arg>--verbose</arg><arg>-v</arg></group>
-   <group><arg>--analyze</arg><arg>-z</arg></group>
-   <group><arg>--analyze-only</arg><arg>-Z</arg></group>
-   <group><arg>--all</arg><arg>-a</arg></group>
+   <arg rep="repeat"><replaceable>option</replaceable></arg>
+   <group choice="plain">
+    <arg><option>--all</option></arg>
+    <arg><option>-a</option></arg>
+   </group>
   </cmdsynopsis>
  </refsynopsisdiv>