This patch makes some SGML markup more consistent and makes a small

improvement to the SSL auth docs.

This patch makes some SGML markup more consistent and makes a small
improvement to the SSL auth docs.
7fb5a999 · Neil Conway · 36b0595d · 7fb5a999 · 7fb5a999 · 7fb5a999
Commit 7fb5a999 authored Dec 13, 2003 by Neil Conway
13 changed files
--- a/doc/src/sgml/client-auth.sgml
+++ b/doc/src/sgml/client-auth.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/client-auth.sgml,v 1.61 2003/11/29 19:51:36 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/client-auth.sgml,v 1.62 2003/12/13 23:59:06 neilc Exp $
 -->

 <chapter id="client-authentication">
@@ -111,10 +111,13 @@ hostnossl  <replaceable>database</replaceable>  <replaceable>user</replaceable>
     <term><literal>host</literal></term>
     <listitem>
      <para>
-       This record matches connection attempts using TCP/IP networks.
+       This record matches connection attempts made using TCP/IP.
       Note that TCP/IP connections are disabled unless the server is
       started with the <option>-i</option> option or the
-       <varname>tcpip_socket</> configuration parameter is enabled.
+       <varname>tcpip_socket</> configuration parameter is
+       enabled. <literal>host</literal> records match either
+       <acronym>SSL</acronym> or non-<acronym>SSL</acronym> connection
+       attempts.
      </para>
     </listitem>
    </varlistentry>
@@ -123,17 +126,17 @@ hostnossl  <replaceable>database</replaceable>  <replaceable>user</replaceable>
     <term><literal>hostssl</literal></term>
     <listitem>
      <para>
-       This record matches connection attempts using SSL over TCP/IP.
-       <literal>host</literal> records will match either SSL or
-       non-SSL connection attempts, but <literal>hostssl</literal>
-       records require SSL connections.
+       This record matches connection attempts made using TCP/IP. In
+       addition, this record requires that the connection is made with
+       <acronym>SSL</acronym>.
      </para>

      <para>
-       To make use of this option the server must be built
-       with SSL support enabled. Furthermore, SSL must be enabled by
-       enabling the <varname>ssl</varname> configuration parameter
-       (see <xref linkend="runtime-config"> for more information).
+       To make use of this option the server must be built with
+       <acronym>SSL</acronym> support enabled. Furthermore,
+       <acronym>SSL</acronym> must be enabled by setting the
+       <varname>ssl</varname> configuration parameter (see <xref
+       linkend="ssl-tcp"> for more information).
      </para>
     </listitem>
    </varlistentry>
@@ -143,8 +146,8 @@ hostnossl  <replaceable>database</replaceable>  <replaceable>user</replaceable>
     <listitem>
      <para>
       This record is similar to <literal>hostssl</> but with the
-	   opposite logic: it matches only regular connection attempts not
-	   using SSL.
+	   opposite logic: it only matches connection attempts made over
+	   TCP/IP that do not use <acronym>SSL</acronym>.
      </para>
     </listitem>
    </varlistentry>
@@ -593,7 +596,7 @@ local   db1,db2,@demodbs  all                                       md5
    <quote>sniffing</> attacks then <literal>md5</> is preferred, with
    <literal>crypt</> a second choice if you must support pre-7.2
    clients. Plain <literal>password</> should especially be avoided for
-    connections over the open Internet (unless you use SSL, SSH, or
+    connections over the open Internet (unless you use <acronym>SSL</acronym>, SSH, or
    other communications security wrappers around the connection).
   </para>


--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.180 2003/11/29 19:51:37 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.181 2003/12/13 23:59:06 neilc Exp $
 PostgreSQL documentation
 -->

@@ -6117,7 +6117,7 @@ SELECT TIMESTAMP 'now';


 <sect1 id="functions-sequence">
-  <title>Sequence-Manipulation Functions</title>
+  <title>Sequence Manipulation Functions</title>

  <indexterm>
   <primary>sequence</primary>

--- a/doc/src/sgml/information_schema.sgml
+++ b/doc/src/sgml/information_schema.sgml
--- a/doc/src/sgml/installation.sgml
+++ b/doc/src/sgml/installation.sgml
-<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.188 2003/12/11 19:56:54 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.189 2003/12/13 23:59:06 neilc Exp $ -->

 <chapter id="installation">
 <title><![%standalone-include[<productname>PostgreSQL</>]]>
@@ -268,7 +268,7 @@ JAVACMD=$JAVA_HOME/bin/java

    <listitem>
     <para>
-      <application>Kerberos</>, <application>OpenSSL</>, or <application>PAM</>,
+      <application>Kerberos</>, <productname>OpenSSL</>, or <application>PAM</>,
      if you want to support authentication using these services.
     </para>
    </listitem>
@@ -893,11 +893,14 @@ JAVACMD=$JAVA_HOME/bin/java
       <term><option>--disable-spinlocks</option></term>
       <listitem>
        <para>
-         Allow the builds to succeed even if PostgreSQL has no CPU
-         spinlock support for the platform.  The lack of spinlock
-         support will result in poor performance; therefore, this
-         option should only be used if the build aborts and informs
-         you that the platform lacks spinlock support.
+         Allow the build to succeed even if <productname>PostgreSQL</>
+         has no CPU spinlock support for the platform.  The lack of
+         spinlock support will result in poor performance; therefore,
+         this option should only be used if the build aborts and
+         informs you that the platform lacks spinlock support. If this
+         option is required to build <productname>PostgreSQL</> on
+         your platform, please report the problem to the
+         <productname>PostgreSQL</> developers.
        </para>
       </listitem>
      </varlistentry>

--- a/doc/src/sgml/jdbc.sgml
+++ b/doc/src/sgml/jdbc.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/jdbc.sgml,v 1.51 2003/11/29 19:51:37 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/jdbc.sgml,v 1.52 2003/12/13 23:59:06 neilc Exp $
 -->

 <chapter id="jdbc">
@@ -98,8 +98,8 @@ $PostgreSQL: pgsql/doc/src/sgml/jdbc.sgml,v 1.51 2003/11/29 19:51:37 pgsql Exp $
    For instance, assume we have an application that uses the
    <acronym>JDBC</acronym> driver to access a database, and that
    application is installed as
-    <filename>/usr/local/lib/myapp.jar</filename>.  The PostgreSQL
-    <acronym>JDBC</> driver installed as
+    <filename>/usr/local/lib/myapp.jar</filename>.  The
+    <productname>PostgreSQL</> <acronym>JDBC</> driver installed as
    <filename>/usr/local/pgsql/share/java/postgresql.jar</>.  To run
    the application, we would use:
 <programlisting>
@@ -119,9 +119,9 @@ java MyApp

   <para>
    Because Java only uses TCP/IP connections, the
-    <application>PostgreSQL</application> server must be configured to
-    accept TCP/IP connections.  This can be done by setting 
-    <literal>tcpip_socket = true</literal> in the 
+    <productname>PostgreSQL</productname> server must be configured to
+    accept TCP/IP connections.  This can be done by setting
+    <literal>tcpip_socket = true</literal> in the
    <filename>postgresql.conf</filename> file or by supplying the
    <option>-i</option> option flag when starting
    <command>postmaster</command>.
@@ -239,7 +239,7 @@ java -Djdbc.drivers=org.postgresql.Driver example.ImageViewer
   <para>
    With <acronym>JDBC</acronym>, a database is represented by a
    <acronym>URL</acronym> (Uniform Resource Locator).  With
-    <application>PostgreSQL</application>, this takes one of the
+    <productname>PostgreSQL</productname>, this takes one of the
    following forms:

    <itemizedlist>
@@ -720,7 +720,7 @@ st.close();
  </indexterm>

  <para>
-    <application>PostgreSQL</application> provides two distinct ways to 
+    <productname>PostgreSQL</productname> provides two distinct ways to 
    store binary data.  Binary data can be stored in a table using 
    the data type <type>bytea</type> or by using the Large Object
    feature which stores the binary data in a separate table in a special 
@@ -770,12 +770,11 @@ st.close();
  </para>

  <para>
-    To use the Large Object functionality you can use either the 
-    <classname>LargeObject</classname> class
-    provided by the <application>PostgreSQL</application> 
-    <acronym>JDBC</acronym> driver, or by using the 
-    <function>getBLOB()</function> and <function>setBLOB()</function>
-    methods.
+    To use the Large Object functionality you can use either the
+    <classname>LargeObject</classname> class provided by the
+    <productname>PostgreSQL</> <acronym>JDBC</acronym> driver, or by
+    using the <function>getBLOB()</function> and
+    <function>setBLOB()</function> methods.
  </para>

  <important>
@@ -800,7 +799,8 @@ st.close();

  <para>
   <xref linkend="jdbc-binary-data-example"> contains some examples on
-   how to process binary data using the PostgreSQL <acronym>JDBC</> driver.
+   how to process binary data using the <productname>PostgreSQL</>
+   <acronym>JDBC</> driver.
  </para>

  <example id="jdbc-binary-data-example">
@@ -948,7 +948,7 @@ ps.close();


 <sect1 id="jdbc-ext">
-  <title><application>PostgreSQL</application> Extensions to the
+  <title><productname>PostgreSQL</productname> Extensions to the
    <acronym>JDBC</acronym> <acronym>API</acronym></title>

  <para>

--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.143 2003/11/29 19:51:37 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.144 2003/12/13 23:59:06 neilc Exp $
 -->

 <chapter id="libpq">
@@ -3575,12 +3575,12 @@ If the permissions are less strict than this, the file will be ignored.
 <para>
 <application>libpq</application> is reentrant and thread-safe if the
 <filename>configure</filename> command-line option
-<literal>--enable-thread-safety</> has been used when the PostgreSQL
-distribution was built.
-In addition, you might need to use additional compiler command-line 
-options when you compile your application code.  Refer to your system's
-documentation for information about how to build thread-enabled
-applications.
+<literal>--enable-thread-safety</> has been used when the
+<productname>PostgreSQL</productname> distribution was built.  In
+addition, you might need to use additional compiler command-line
+options when you compile your application code.  Refer to your
+system's documentation for information about how to build
+thread-enabled applications.
 </para>

 <para>

--- a/doc/src/sgml/mvcc.sgml
+++ b/doc/src/sgml/mvcc.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/mvcc.sgml,v 2.42 2003/11/29 19:51:37 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/mvcc.sgml,v 2.43 2003/12/13 23:59:06 neilc Exp $
 -->

 <chapter id="mvcc">
@@ -215,11 +215,11 @@ $PostgreSQL: pgsql/doc/src/sgml/mvcc.sgml,v 2.42 2003/11/29 19:51:37 pgsql Exp $
    isolation level may be stricter than what you select.  This is
    permitted by the SQL standard: the four isolation levels only
    define which phenomena must not happen, they do not define which
-    phenomena must happen.  The reason that PostgreSQL only provides
-    two isolation levels is that this is the only sensible way to map
-    the isolation levels to the multiversion concurrency control
-    architecture.  The behavior of the available isolation levels is
-    detailed in the following subsections.
+    phenomena must happen.  The reason that <productname>PostgreSQL</>
+    only provides two isolation levels is that this is the only
+    sensible way to map the isolation levels to the multiversion
+    concurrency control architecture.  The behavior of the available
+    isolation levels is detailed in the following subsections.
   </para>

   <para>

--- a/doc/src/sgml/ref/copy.sgml
+++ b/doc/src/sgml/ref/copy.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/copy.sgml,v 1.54 2003/11/29 19:51:38 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/copy.sgml,v 1.55 2003/12/13 23:59:07 neilc Exp $
 PostgreSQL documentation
 -->

@@ -584,8 +584,8 @@ ZW      ZIMBABWE
  </para>

  <para>
-   The following syntax was used before PostgreSQL version 7.3 and is
-   still supported:
+   The following syntax was used before <productname>PostgreSQL</>
+   version 7.3 and is still supported:

 <synopsis>
 COPY [ BINARY ] <replaceable class="parameter">tablename</replaceable> [ WITH OIDS ]

--- a/doc/src/sgml/ref/create_table_as.sgml
+++ b/doc/src/sgml/ref/create_table_as.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.18 2003/12/01 22:07:58 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.19 2003/12/13 23:59:07 neilc Exp $
 PostgreSQL documentation
 -->

@@ -125,17 +125,19 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE <replaceable>table_name
  </para>

  <para>
-   Prior to PostgreSQL 7.5, <command>CREATE TABLE AS</command> always
-   included OIDs in the table it produced. Furthermore, these OIDs
-   were newly generated: they were distinct from the OIDs of any of
-   the rows in the source tables of the <command>SELECT</command> or
-   <command>EXECUTE</command> statement. Therefore, if <command>CREATE
-   TABLE AS</command> was frequently executed, the OID counter would
-   be rapidly incremented. As of PostgreSQL 7.5, the inclusion of OIDs
-   in the table generated by <command>CREATE TABLE AS</command> is
-   controlled by the <varname>default_with_oids</varname> configuration
-   variable. This variable currently defaults to true, but will likely
-   default to false in a future release of <productname>PostgreSQL</>.
+   Prior to <productname>PostgreSQL</> 7.5, <command>CREATE TABLE
+   AS</command> always included OIDs in the table it
+   produced. Furthermore, these OIDs were newly generated: they were
+   distinct from the OIDs of any of the rows in the source tables of
+   the <command>SELECT</command> or <command>EXECUTE</command>
+   statement. Therefore, if <command>CREATE TABLE AS</command> was
+   frequently executed, the OID counter would be rapidly
+   incremented. As of <productname>PostgreSQL</> 7.5, the inclusion of
+   OIDs in the table generated by <command>CREATE TABLE AS</command>
+   is controlled by the <varname>default_with_oids</varname>
+   configuration variable. This variable currently defaults to true,
+   but will likely default to false in a future release of
+   <productname>PostgreSQL</>.
  </para>
 </refsect1>


--- a/doc/src/sgml/ref/postmaster.sgml
+++ b/doc/src/sgml/ref/postmaster.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.42 2003/11/29 19:51:39 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.43 2003/12/13 23:59:07 neilc Exp $
 PostgreSQL documentation
 -->

@@ -452,17 +452,17 @@ PostgreSQL documentation
   </para>

   <para>
-    A failure message indicating inability to bind to a port may indicate
-    that that port is already in use by some non-PostgreSQL process.
-    You may also get this error if you terminate the
-    <command>postmaster</command>
-    and immediately restart it using the same port; in this case, you must
-    simply wait a few seconds until the operating system closes the port
-    before trying again.  Finally, you may get this error if you specify
-    a port number that your operating system considers to be reserved.
-    For example, many versions of Unix consider port numbers under 1024 to
-    be <quote>trusted</quote>
-    and only permit the Unix superuser to access them.
+    A failure message indicating inability to bind to a port may
+    indicate that that port is already in use by some
+    non-<productname>PostgreSQL</productname> process.  You may also
+    get this error if you terminate the <command>postmaster</command>
+    and immediately restart it using the same port; in this case, you
+    must simply wait a few seconds until the operating system closes
+    the port before trying again.  Finally, you may get this error if
+    you specify a port number that your operating system considers to
+    be reserved.  For example, many versions of Unix consider port
+    numbers under 1024 to be <quote>trusted</quote> and only permit
+    the Unix superuser to access them.
   </para>

 </refsect1>

--- a/doc/src/sgml/ref/select_into.sgml
+++ b/doc/src/sgml/ref/select_into.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/select_into.sgml,v 1.26 2003/12/01 22:07:58 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/select_into.sgml,v 1.27 2003/12/13 23:59:07 neilc Exp $
 PostgreSQL documentation
 -->

@@ -94,17 +94,18 @@ SELECT [ ALL | DISTINCT [ ON ( <replaceable class="PARAMETER">expression</replac
  </para>

  <para>
-   Prior to PostgreSQL 7.5, the table created by <command>SELECT
-   INTO</command> always included OIDs. Furthermore, these OIDs were
-   newly generated: they were distinct from the OIDs of any of the
-   rows in the source tables of the <command>SELECT INTO</command>
-   statement. Therefore, if <command>SELECT INTO</command> was
-   frequently executed, the OID counter would be rapidly
-   incremented. As of PostgreSQL 7.5, the inclusion of OIDs in the
-   table created by <command>SELECT INTO</command> is controlled by
-   the <varname>default_with_oids</varname> configuration
-   variable. This variable currently defaults to true, but will likely
-   default to false in a future release of <productname>PostgreSQL</>.
+   Prior to <productname>PostgreSQL</> 7.5, the table created by
+   <command>SELECT INTO</command> always included OIDs. Furthermore,
+   these OIDs were newly generated: they were distinct from the OIDs
+   of any of the rows in the source tables of the <command>SELECT
+   INTO</command> statement. Therefore, if <command>SELECT
+   INTO</command> was frequently executed, the OID counter would be
+   rapidly incremented. As of <productname>PostgreSQL</> 7.5, the
+   inclusion of OIDs in the table created by <command>SELECT
+   INTO</command> is controlled by the
+   <varname>default_with_oids</varname> configuration variable. This
+   variable currently defaults to true, but will likely default to
+   false in a future release of <productname>PostgreSQL</>.
  </para>
 </refsect1>


--- a/doc/src/sgml/rules.sgml
+++ b/doc/src/sgml/rules.sgml
-<!-- $PostgreSQL: pgsql/doc/src/sgml/rules.sgml,v 1.32 2003/11/29 19:51:37 pgsql Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/rules.sgml,v 1.33 2003/12/13 23:59:06 neilc Exp $ -->

 <Chapter Id="rules">
 <Title>The Rule System</Title>
@@ -1825,9 +1825,9 @@ GRANT SELECT ON phone_number TO secretary;
     </listitem>
    </itemizedlist>

-    (This system was established in PostgreSQL 7.3.  In versions
-    before that, the command status might show different results when
-    rules exist.)
+    (This system was established in <productname>PostgreSQL</> 7.3.
+    In versions before that, the command status might show different
+    results when rules exist.)
 </Para>

 <Para>

--- a/doc/src/sgml/runtime.sgml
+++ b/doc/src/sgml/runtime.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.226 2003/12/06 23:10:23 joe Exp $
+$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.227 2003/12/13 23:59:06 neilc Exp $
 -->

 <Chapter Id="runtime">
@@ -3551,7 +3551,7 @@ $ <userinput>kill -INT `head -1 /usr/local/pgsql/data/postmaster.pid`</userinput
   The server will listen for both standard and <acronym>SSL</>
   connections on the same TCP port, and will negotiate with any
   connecting client on whether to use <acronym>SSL</>. See <xref
-   linkend="client-authentication"> about how to force the server to
+   linkend="auth-pg-hba-conf"> about how to force the server to
   require use of <acronym>SSL</> for certain connections.
  </para>