Initial round of tweakage for man pages

17f0b55d · Peter Eisentraut · 31578cde · 17f0b55d · 17f0b55d · 17f0b55d
Commit 17f0b55d authored Nov 18, 2001 by Peter Eisentraut
12 changed files
--- a/doc/src/sgml/Makefile
+++ b/doc/src/sgml/Makefile
@@ -8,7 +8,7 @@
 #
 #
 # IDENTIFICATION
-#    $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.44 2001/11/16 16:29:56 petere Exp $
+#    $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.45 2001/11/18 20:35:02 petere Exp $
 #
 #----------------------------------------------------------------------------

@@ -67,10 +67,10 @@ DEFAULTSECTION := $(sqlmansect_dummy)

 man: $(ALLSGML)
 	$(NSGMLS) $(NSGMLS_FLAGS) $(srcdir)/book-decl.sgml $(srcdir)/reference.sgml \
-	  | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION)
+	  | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`"
 # One more time, to resolve cross-references
 	$(NSGMLS) $(NSGMLS_FLAGS) $(srcdir)/book-decl.sgml $(srcdir)/reference.sgml \
-	  | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION)
+	  | $(SGMLSPL) $(D2MSCRIPT) --lowercase --section $(DEFAULTSECTION) --date "`date '+%Y-%m-%d'`"
 	$(mkinstalldirs) man1 man$(DEFAULTSECTION)
 	mv *.1 man1/
 	mv *.$(DEFAULTSECTION) man$(DEFAULTSECTION)/

--- a/doc/src/sgml/ref/alter_table.sgml
+++ b/doc/src/sgml/ref/alter_table.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.31 2001/11/10 20:13:37 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.32 2001/11/18 20:35:02 petere Exp $
 Postgres documentation
 -->

@@ -161,14 +161,14 @@ ALTER TABLE <replaceable class="PARAMETER">table</replaceable>
  <para>
   <command>ALTER TABLE</command> changes the definition of an existing table.
   The <literal>ADD COLUMN</literal> form adds a new column to the table
-   using the same syntax as <xref linkend="SQL-CREATETABLE">.
+   using the same syntax as <xref linkend="SQL-CREATETABLE" endterm="SQL-CREATETABLE-TITLE">.
   The <literal>ALTER COLUMN SET/DROP DEFAULT</literal> forms
   allow you to set or remove the default for the column. Note that defaults
   only apply to subsequent <command>INSERT</command> commands; they do not
   cause rows already in the table to change.
   The <literal>ALTER COLUMN SET STATISTICS</literal> form allows you to
   set the statistics-gathering target for subsequent
-   <xref linkend="sql-analyze"> operations.
+   <xref linkend="sql-analyze" endterm="sql-analyze-title"> operations.
   The <literal>RENAME</literal> clause causes the name of a table or column
   to change without changing any of the data contained in
   the affected table. Thus, the table or column will
@@ -176,7 +176,7 @@ ALTER TABLE <replaceable class="PARAMETER">table</replaceable>
   executed.
   The ADD <replaceable class="PARAMETER">table constraint definition</replaceable> clause 
   adds a new constraint to the table using the same syntax as <xref
-   linkend="SQL-CREATETABLE">. 
+   linkend="SQL-CREATETABLE" endterm="SQL-CREATETABLE-TITLE">. 
   The DROP CONSTRAINT <replaceable class="PARAMETER">constraint</replaceable> clause 
   drops all constraints on the table (and its children) that match <replaceable class="PARAMETER">constraint</replaceable>.
   The OWNER clause changes the owner of the table to the user <replaceable class="PARAMETER">
@@ -204,7 +204,7 @@ ALTER TABLE <replaceable class="PARAMETER">table</replaceable>
    You can use the <literal>SET DEFAULT</literal> form
    of <command>ALTER TABLE</command> to set the default later.
    (You may also want to update the already existing rows to the
-    new default value, using <xref linkend="sql-update">.)
+    new default value, using <xref linkend="sql-update" endterm="sql-update-title">.)
   </para>

   <para>
@@ -212,10 +212,10 @@ ALTER TABLE <replaceable class="PARAMETER">table</replaceable>
    dependencies are not yet checked.  The CASCADE option is unsupported.  
    Currently DROP CONSTRAINT drops only CHECK constraints.
    To remove a PRIMARY or UNIQUE constraint, drop the 
-    relevant index using the <xref linkend="SQL-DROPINDEX"> command.
+    relevant index using the <xref linkend="SQL-DROPINDEX" endterm="sql-dropindex-title"> command.
    To remove FOREIGN KEY constraints you need to recreate
    and reload the table, using other parameters to the
-    <xref linkend="SQL-CREATETABLE"> command.
+    <xref linkend="SQL-CREATETABLE" endterm="sql-createtable-title"> command.
   </para>
   <para>
    For example, to drop all constraints on a table <literal>distributors</literal>:

--- a/doc/src/sgml/ref/create_function.sgml
+++ b/doc/src/sgml/ref/create_function.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.28 2001/10/26 21:17:03 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.29 2001/11/18 20:35:02 petere Exp $
 -->

 <refentry id="SQL-CREATEFUNCTION">
 <refmeta>
-  <refentrytitle>CREATE FUNCTION</refentrytitle>
+  <refentrytitle id="SQL-CREATEFUNCTION-TITLE">CREATE FUNCTION</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

@@ -130,7 +130,7 @@ CREATE [ OR REPLACE ] FUNCTION <replaceable class="parameter">name</replaceable>
       class="parameter">plname</replaceable>, where <replaceable
       class="parameter">plname</replaceable> is the name of a
       created procedural language. See
-       <xref linkend="sql-createlanguage">
+       <xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
       for details.  For backward compatibility, the name may be
       enclosed by single quotes.
      </para>
@@ -244,7 +244,7 @@ CREATE [ OR REPLACE ] FUNCTION <replaceable class="parameter">name</replaceable>
    When repeated <command>CREATE FUNCTION</command> calls refer to
    the same object file, the file is only loaded once.  To unload and
    reload the file (perhaps during development), use the <xref
-    linkend="sql-load"> command.
+    linkend="sql-load" endterm="sql-load-title"> command.
   </para>

   <para>

--- a/doc/src/sgml/ref/create_language.sgml
+++ b/doc/src/sgml/ref/create_language.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.18 2001/10/26 21:17:03 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.19 2001/11/18 20:35:02 petere Exp $
 Postgres documentation
 -->

@@ -177,12 +177,12 @@ ERROR:  PL handler function <replaceable class="parameter">funcname</replaceable
  </para>

  <para>
-   Use the <xref linkend="sql-createfunction"> command to create a new
+   Use the <xref linkend="sql-createfunction" endterm="sql-createfunction-title"> command to create a new
   function.
  </para>

  <para>
-   Use <xref linkend="sql-droplanguage">, or better yet the <xref
+   Use <xref linkend="sql-droplanguage" endterm="sql-droplanguage-title">, or better yet the <xref
   linkend="app-droplang"> script, to drop procedural languages.
  </para>


--- a/doc/src/sgml/ref/create_table.sgml
+++ b/doc/src/sgml/ref/create_table.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.48 2001/10/22 18:14:47 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.49 2001/11/18 20:35:02 petere Exp $
 Postgres documentation
 -->

 <refentry id="SQL-CREATETABLE">
 <refmeta>
-  <refentrytitle>CREATE TABLE</refentrytitle>
+  <refentrytitle id="sql-createtable-title">CREATE TABLE</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

@@ -448,7 +448,7 @@ and <replaceable class="PARAMETER">table_constraint</replaceable> is:
      constraint that is not deferrable will be checked immediately
      after every command.  Checking of constraints that are
      deferrable may be postponed until the end of the transaction
-      (using the <xref linkend="sql-set-constraints"> command).
+      (using the <xref linkend="sql-set-constraints" endterm="sql-set-constraints-title"> command).
      <literal>NOT DEFERRABLE</literal> is the default.  Only foreign
      key constraints currently accept this clause.  All other
      constraint types are not deferrable.
@@ -466,7 +466,7 @@ and <replaceable class="PARAMETER">table_constraint</replaceable> is:
      statement. This is the default.  If the constraint is
      <literal>INITIALLY DEFERRED</literal>, it is checked only at the
      end of the transaction.  The constraint check time can be
-      altered with the <xref linkend="sql-set-constraints"> command.
+      altered with the <xref linkend="sql-set-constraints" endterm="sql-set-constraints-title"> command.
     </para>
    </listitem>
   </varlistentry>
@@ -554,7 +554,7 @@ and <replaceable class="PARAMETER">table_constraint</replaceable> is:
     index for each unique constraint and primary key constraint to
     enforce the uniqueness.  Thus, it is not necessary to create an
     explicit index for primary key columns.  (See <xref
-     linkend="sql-createindex"> for more information.)
+     linkend="sql-createindex" endterm="sql-createindex-title"> for more information.)
    </para>
   </listitem>


--- a/doc/src/sgml/ref/createdb.sgml
+++ b/doc/src/sgml/ref/createdb.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.20 2001/09/03 12:57:49 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.21 2001/11/18 20:35:02 petere Exp $
 Postgres documentation
 -->

@@ -192,7 +192,7 @@ Postgres documentation
    </variablelist>

    If there is an error condition, the backend error message will be displayed.
-    See <xref linkend="SQL-CREATEDATABASE">
+    See <xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-TITLE">
    and <xref linkend="APP-PSQL"> for possibilities.
   </para>
  </refsect2>

--- a/doc/src/sgml/ref/ecpg-ref.sgml
+++ b/doc/src/sgml/ref/ecpg-ref.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.11 2001/09/14 10:24:35 ishii Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.12 2001/11/18 20:35:02 petere Exp $
 Postgres documentation
 -->

@@ -23,9 +23,14 @@ Postgres documentation
  <refsynopsisdivinfo>
   <date>1999-07-20</date>
  </refsynopsisdivinfo>
-  <synopsis>
-ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ]  file1 [ file2 ] [ ... ]
-  </synopsis>
+  <cmdsynopsis>
+   <command>ecpg</command>
+   <arg choice="opt">-v</arg>
+   <arg choice="opt">-t</arg>
+   <arg choice="opt">-I <replaceable>include-path</replaceable></arg>
+   <arg choice="opt">-o <replaceable>outfile</replaceable></arg>
+   <arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
+  </cmdsynopsis>

  <refsect2 id="R2-APP-ECPG-1">
   <refsect2info>
@@ -58,7 +63,7 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ]  file1 [ file2 ] [ ... ]
     </varlistentry>

     <varlistentry>
-      <term>-I <replaceable class="parameter">path</replaceable></term>
+      <term>-I <replaceable class="parameter">include-path</replaceable></term>
      <listitem>
       <para>
 	Specify an additional include path.
@@ -73,7 +78,7 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ]  file1 [ file2 ] [ ... ]
     </varlistentry>

     <varlistentry>
-      <term>-o</term>
+      <term>-o <replaceable>outfile</replaceable></term>
      <listitem>
       <para>
 	Specifies that <application>ecpg</application> should write all its output to outfile.

--- a/doc/src/sgml/ref/grant.sgml
+++ b/doc/src/sgml/ref/grant.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/grant.sgml,v 1.14 2001/11/17 22:20:34 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/grant.sgml,v 1.15 2001/11/18 20:35:02 petere Exp $
 Postgres documentation
 -->

 <refentry id="SQL-GRANT">
 <refmeta>
-  <refentrytitle>GRANT</refentrytitle>
+  <refentrytitle id="sql-grant-title">GRANT</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

@@ -49,9 +49,9 @@ GRANT { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER } [,..
     <term>SELECT</term>
     <listitem>
      <para>
-       Allows <xref linkend="sql-select"> from any column of the
+       Allows <xref linkend="sql-select" endterm="sql-select-title"> from any column of the
       specified table, view, or sequence.  Also allows the use of
-       <xref linkend="sql-copy"> FROM.
+       <xref linkend="sql-copy" endterm="sql-copy-title"> FROM.
      </para>
     </listitem>
    </varlistentry>
@@ -60,8 +60,8 @@ GRANT { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER } [,..
     <term>INSERT</term>
     <listitem>
      <para>
-       Allows <xref linkend="sql-insert"> of a new row into the
-       specified table.  Also allows <xref linkend="sql-copy"> TO.
+       Allows <xref linkend="sql-insert" endterm="sql-insert-title"> of a new row into the
+       specified table.  Also allows <xref linkend="sql-copy" endterm="sql-copy-title"> TO.
      </para>
     </listitem>
    </varlistentry>
@@ -70,7 +70,7 @@ GRANT { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER } [,..
     <term>UPDATE</term>
     <listitem>
      <para>
-       Allows <xref linkend="sql-update"> of any column of the
+       Allows <xref linkend="sql-update" endterm="sql-update-title"> of any column of the
       specified table.  <literal>SELECT ... FOR UPDATE</literal>
       also requires this privilege (besides the
       <literal>SELECT</literal> privilege).  For sequences, this
@@ -84,7 +84,7 @@ GRANT { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER } [,..
     <term>DELETE</term>
     <listitem>
      <para>
-       Allows the <xref linkend="sql-delete"> of a row from the
+       Allows the <xref linkend="sql-delete" endterm="sql-delete-title"> of a row from the
       specified table.
      </para>
     </listitem>
@@ -95,7 +95,7 @@ GRANT { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER } [,..
     <listitem>
      <para>
       Allows the creation of a rule on the table/view.  (See <xref
-       linkend="sql-createrule"> statement).
+       linkend="sql-createrule" endterm="sql-createrule-title"> statement).
      </para>
     </listitem>
    </varlistentry>
@@ -116,7 +116,7 @@ GRANT { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER } [,..
     <listitem>
      <para>
       Allows the creation of a trigger on the specified table.  (See
-       <xref linkend="sql-createtrigger"> statement).
+       <xref linkend="sql-createtrigger" endterm="sql-createtrigger-title"> statement).
      </para>
     </listitem>
    </varlistentry>
@@ -177,7 +177,7 @@ GRANT { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER } [,..
   </para>

   <para>
-    The <xref linkend="sql-revoke"> command is used to revoke access
+    The <xref linkend="sql-revoke" endterm="sql-revoke-title"> command is used to revoke access
    privileges.
   </para>
 </refsect1>

--- a/doc/src/sgml/ref/load.sgml
+++ b/doc/src/sgml/ref/load.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.10 2001/10/26 19:58:12 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/load.sgml,v 1.11 2001/11/18 20:35:02 petere Exp $
 -->

 <refentry id="SQL-LOAD">
 <refmeta>
-  <refentrytitle>LOAD</refentrytitle>
+  <refentrytitle id="SQL-LOAD-TITLE">LOAD</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

@@ -29,12 +29,12 @@ LOAD '<replaceable class="PARAMETER">filename</replaceable>'
   shared library file that has been changed since the backend first
   loaded it.  To make use of the
   shared library, function(s) in it need to be declared using the <xref
-   linkend="sql-createfunction"> command.
+   linkend="sql-createfunction" endterm="sql-createfunction-title"> command.
  </para>

  <para>
   The filename is specified in the same way as for shared library
-   names in <xref linkend="sql-createfunction">; in particular, one
+   names in <xref linkend="sql-createfunction" endterm="sql-createfunction-title">; in particular, one
   may rely on a search path and automatic addition of the system's standard
   shared library filename extension.  See the
   <citetitle>Programmer's Guide</citetitle> for more detail.

--- a/doc/src/sgml/ref/pg_dump.sgml
+++ b/doc/src/sgml/ref/pg_dump.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.38 2001/10/23 22:11:22 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.39 2001/11/18 20:35:02 petere Exp $
 Postgres documentation
 -->

@@ -462,9 +462,9 @@ Postgres documentation
        <xref linkend="app-psql"> <command>\connect</command> command.
        This command actually opens a new connection, which might
        require manual interaction (e.g., passwords).  If you use the
-        <option>-X use-set-session-authorization</option>, then
+        <option>-X use-set-session-authorization</option> option, then
        <command>pg_dump</command> will instead output <xref
-        linkend="sql-set-session-authorization"> commands.  This has
+        linkend="sql-set-session-authorization" endterm="sql-set-session-authorization-title"> commands.  This has
        the same effect, but it requires that the user restoring the
        database from the generated script be a database superuser.
        This option effectively overrides the <option>-R</option>
@@ -472,7 +472,7 @@ Postgres documentation
       </para>

       <para>
-        Since <xref linkend="sql-set-session-authorization"> is a
+        Since <xref linkend="sql-set-session-authorization" endterm="sql-set-session-authorization-title"> is a
        standard SQL command, whereas <command>\connect</command> only
        works in <xref linkend="app-psql">, this option also enhances
        the theoretical portability of the output script.

--- a/doc/src/sgml/ref/revoke.sgml
+++ b/doc/src/sgml/ref/revoke.sgml
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/revoke.sgml,v 1.16 2001/09/03 12:57:50 petere Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/revoke.sgml,v 1.17 2001/11/18 20:35:02 petere Exp $
 Postgres documentation
 -->

 <refentry id="SQL-REVOKE">
 <refmeta>
-  <refentrytitle>REVOKE</refentrytitle>
+  <refentrytitle id="sql-revoke-title">REVOKE</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

@@ -33,7 +33,7 @@ REVOKE { { SELECT | INSERT | UPDATE | DELETE | RULE | REFERENCES | TRIGGER } [,.
  </para>

  <para>
-   See the description of the <xref linkend="sql-grant"> command for
+   See the description of the <xref linkend="sql-grant" endterm="sql-grant-title"> command for
   the meaning of the privilege types.
  </para>
 </refsect1>
@@ -76,7 +76,7 @@ REVOKE ALL PRIVILEGES ON kinds FROM manuel;
   <title>SQL92</title>

   <para>
-    The compatibility notes of the <xref linkend="sql-grant"> command
+    The compatibility notes of the <xref linkend="sql-grant" endterm="sql-grant-title"> command
    apply analogously to <command>REVOKE</command>.  The syntax summary is:

 <synopsis>

--- a/doc/src/sgml/ref/set_session_auth.sgml
+++ b/doc/src/sgml/ref/set_session_auth.sgml
-<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_session_auth.sgml,v 1.2 2001/09/03 12:57:50 petere Exp $ -->
+<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/set_session_auth.sgml,v 1.3 2001/11/18 20:35:02 petere Exp $ -->
 <refentry id="SQL-SET-SESSION-AUTHORIZATION">
 <docinfo>
  <date>2001-04-21</date>
 </docinfo>

 <refmeta>
-  <refentrytitle>SET SESSION AUTHORIZATION</refentrytitle>
+  <refentrytitle id="sql-set-session-authorization-title">SET SESSION AUTHORIZATION</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>SET SESSION AUTHORIZATION</refname>
-  <refpurpose>set the session user identifier and the current user identifier
-         of the current session</refpurpose>
+  <refpurpose>set the session user identifier and the current user identifier of the current session</refpurpose>
 </refnamediv>

 <refsynopsisdiv>