Improve wording of initdb and pg_controldata manual pages.

[pg-rex/syncrep.git] / doc / src / sgml / ref / pg_controldata.sgml

diff --git a/doc/src/sgml/ref/pg_controldata.sgml b/doc/src/sgml/ref/pg_controldata.sgml
index 96e1bea..d39b6e1 100644 (file)
--- a/doc/src/sgml/ref/pg_controldata.sgml
+++ b/doc/src/sgml/ref/pg_controldata.sgml
@@ -1,23 +1,28 @@
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.2 2002/08/16 20:36:25 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>
 
  <refnamediv>
   <refname>pg_controldata</refname>
-  <refpurpose>display server-wide control information</refpurpose>
+  <refpurpose>display control information of a <productname>PostgreSQL</productname> database cluster</refpurpose>
  </refnamediv>
 
+ <indexterm zone="app-pgcontroldata">
+  <primary>pg_controldata</primary>
+ </indexterm>
+
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>pg_controldata</command>
+   <arg><replaceable class="parameter">option</replaceable></arg>
    <arg><replaceable class="parameter">datadir</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
@@ -25,17 +30,22 @@ PostgreSQL documentation
  <refsect1 id="R1-APP-PGCONTROLDATA-1">
   <title>Description</title>
   <para>
-   <command>pg_controldata</command> returns information initialized during
-   <application>initdb</>. such as the catalog version and server encoding.
-   It also shows information about write-ahead logging and checkpoint 
-   processing.  This information is server-wide, and not specific to any one
+   <command>pg_controldata</command> prints information initialized during
+   <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>
 
   <para>
-   This utility may only be run by the user who installed the server.
-   You can specify the data directory on the command line, or use 
-   the environment variable <envar>PGDATA</>.
+   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</>.  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>
 
@@ -48,28 +58,10 @@ PostgreSQL documentation
 
     <listitem>
      <para>
-      Default data direction location
+      Default data directory location
      </para>
     </listitem>
    </varlistentry>
-
   </variablelist>
  </refsect1>
 </refentry>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:nil
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-default-dtd-file:"../reference.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:"/usr/lib/sgml/catalog"
-sgml-local-ecat-files:nil
-End:
--->