OSDN Git Service

Improve wording of initdb and pg_controldata manual pages.
[pg-rex/syncrep.git] / doc / src / sgml / ref / pg_controldata.sgml
index 466c03e..d39b6e1 100644 (file)
@@ -1,11 +1,11 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.10 2007/02/20 18:10:58 momjian Exp $
+doc/src/sgml/ref/pg_controldata.sgml
 PostgreSQL documentation
 -->
 
 <refentry id="APP-PGCONTROLDATA">
  <refmeta>
-  <refentrytitle id="APP-PGCONTROLDATA-TITLE"><application>pg_controldata</application></refentrytitle>
+  <refentrytitle><application>pg_controldata</application></refentrytitle>
   <manvolnum>1</manvolnum>
   <refmiscinfo>Application</refmiscinfo>
  </refmeta>
@@ -22,6 +22,7 @@ PostgreSQL documentation
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>pg_controldata</command>
+   <arg><replaceable class="parameter">option</replaceable></arg>
    <arg><replaceable class="parameter">datadir</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
@@ -30,8 +31,8 @@ PostgreSQL documentation
   <title>Description</title>
   <para>
    <command>pg_controldata</command> prints information initialized during
-   <command>initdb</>, such as the catalog version and server locale.
-   It also shows information about write-ahead logging and checkpoint 
+   <command>initdb</>, such as the catalog version.
+   It also shows information about write-ahead logging and checkpoint
    processing.  This information is cluster-wide, and not specific to any one
    database.
   </para>
@@ -39,8 +40,12 @@ PostgreSQL documentation
   <para>
    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</>.
+   You can specify the data directory on the command line, or use
+   the environment variable <envar>PGDATA</>.  This utility supports the options
+   <literal>-V</> and <literal>--version</>, which print the
+   <application>pg_controldata</application> version and exit.  It also
+   supports options <literal>-?</> and <literal>--help</>, which output the
+   supported arguments.
   </para>
  </refsect1>