mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve markup of cmdsynopsis elements

Browse Source 
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.
This commit is contained in:
Peter Eisentraut 2012-04-30 21:15:48 +03:00
parent 61c84b4761
commit 4266509c57
8 changed files with 109 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/src/sgml/ref/clusterdb.sgml
View File

@ -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>

2
doc/src/sgml/ref/createlang.sgml
View File

@ -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>

2
doc/src/sgml/ref/droplang.sgml
View File

@ -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>

8
doc/src/sgml/ref/initdb.sgml
View File

@ -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>

112
doc/src/sgml/ref/pg_ctl-ref.sgml
View File

@ -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>

16
doc/src/sgml/ref/pg_resetxlog.sgml
View File

@ -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>

26
doc/src/sgml/ref/reindexdb.sgml
View File

@ -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>

24
doc/src/sgml/ref/vacuumdb.sgml
View File

@ -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>