Commit 7fb5a999 authored by Neil Conway's avatar Neil Conway

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

improvement to the SSL auth docs.
parent 36b0595d
<!-- <!--
$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"> <chapter id="client-authentication">
...@@ -111,10 +111,13 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable> ...@@ -111,10 +111,13 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable>
<term><literal>host</literal></term> <term><literal>host</literal></term>
<listitem> <listitem>
<para> <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 Note that TCP/IP connections are disabled unless the server is
started with the <option>-i</option> option or the 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> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -123,17 +126,17 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable> ...@@ -123,17 +126,17 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable>
<term><literal>hostssl</literal></term> <term><literal>hostssl</literal></term>
<listitem> <listitem>
<para> <para>
This record matches connection attempts using SSL over TCP/IP. This record matches connection attempts made using TCP/IP. In
<literal>host</literal> records will match either SSL or addition, this record requires that the connection is made with
non-SSL connection attempts, but <literal>hostssl</literal> <acronym>SSL</acronym>.
records require SSL connections.
</para> </para>
<para> <para>
To make use of this option the server must be built To make use of this option the server must be built with
with SSL support enabled. Furthermore, SSL must be enabled by <acronym>SSL</acronym> support enabled. Furthermore,
enabling the <varname>ssl</varname> configuration parameter <acronym>SSL</acronym> must be enabled by setting the
(see <xref linkend="runtime-config"> for more information). <varname>ssl</varname> configuration parameter (see <xref
linkend="ssl-tcp"> for more information).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -143,8 +146,8 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable> ...@@ -143,8 +146,8 @@ hostnossl <replaceable>database</replaceable> <replaceable>user</replaceable>
<listitem> <listitem>
<para> <para>
This record is similar to <literal>hostssl</> but with the This record is similar to <literal>hostssl</> but with the
opposite logic: it matches only regular connection attempts not opposite logic: it only matches connection attempts made over
using SSL. TCP/IP that do not use <acronym>SSL</acronym>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -593,7 +596,7 @@ local db1,db2,@demodbs all md5 ...@@ -593,7 +596,7 @@ local db1,db2,@demodbs all md5
<quote>sniffing</> attacks then <literal>md5</> is preferred, with <quote>sniffing</> attacks then <literal>md5</> is preferred, with
<literal>crypt</> a second choice if you must support pre-7.2 <literal>crypt</> a second choice if you must support pre-7.2
clients. Plain <literal>password</> should especially be avoided for 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). other communications security wrappers around the connection).
</para> </para>
......
<!-- <!--
$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 PostgreSQL documentation
--> -->
...@@ -6117,7 +6117,7 @@ SELECT TIMESTAMP 'now'; ...@@ -6117,7 +6117,7 @@ SELECT TIMESTAMP 'now';
<sect1 id="functions-sequence"> <sect1 id="functions-sequence">
<title>Sequence-Manipulation Functions</title> <title>Sequence Manipulation Functions</title>
<indexterm> <indexterm>
<primary>sequence</primary> <primary>sequence</primary>
......
This diff is collapsed.
<!-- $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"> <chapter id="installation">
<title><![%standalone-include[<productname>PostgreSQL</>]]> <title><![%standalone-include[<productname>PostgreSQL</>]]>
...@@ -268,7 +268,7 @@ JAVACMD=$JAVA_HOME/bin/java ...@@ -268,7 +268,7 @@ JAVACMD=$JAVA_HOME/bin/java
<listitem> <listitem>
<para> <para>
<application>Kerberos</>, <application>OpenSSL</>, or <application>PAM</>, <application>Kerberos</>, <productname>OpenSSL</>, or <application>PAM</>,
if you want to support authentication using these services. if you want to support authentication using these services.
</para> </para>
</listitem> </listitem>
...@@ -893,11 +893,14 @@ JAVACMD=$JAVA_HOME/bin/java ...@@ -893,11 +893,14 @@ JAVACMD=$JAVA_HOME/bin/java
<term><option>--disable-spinlocks</option></term> <term><option>--disable-spinlocks</option></term>
<listitem> <listitem>
<para> <para>
Allow the builds to succeed even if PostgreSQL has no CPU Allow the build to succeed even if <productname>PostgreSQL</>
spinlock support for the platform. The lack of spinlock has no CPU spinlock support for the platform. The lack of
support will result in poor performance; therefore, this spinlock support will result in poor performance; therefore,
option should only be used if the build aborts and informs this option should only be used if the build aborts and
you that the platform lacks spinlock support. 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> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
......
<!-- <!--
$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"> <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 $ ...@@ -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 For instance, assume we have an application that uses the
<acronym>JDBC</acronym> driver to access a database, and that <acronym>JDBC</acronym> driver to access a database, and that
application is installed as application is installed as
<filename>/usr/local/lib/myapp.jar</filename>. The PostgreSQL <filename>/usr/local/lib/myapp.jar</filename>. The
<acronym>JDBC</> driver installed as <productname>PostgreSQL</> <acronym>JDBC</> driver installed as
<filename>/usr/local/pgsql/share/java/postgresql.jar</>. To run <filename>/usr/local/pgsql/share/java/postgresql.jar</>. To run
the application, we would use: the application, we would use:
<programlisting> <programlisting>
...@@ -119,7 +119,7 @@ java MyApp ...@@ -119,7 +119,7 @@ java MyApp
<para> <para>
Because Java only uses TCP/IP connections, the Because Java only uses TCP/IP connections, the
<application>PostgreSQL</application> server must be configured to <productname>PostgreSQL</productname> server must be configured to
accept TCP/IP connections. This can be done by setting accept TCP/IP connections. This can be done by setting
<literal>tcpip_socket = true</literal> in the <literal>tcpip_socket = true</literal> in the
<filename>postgresql.conf</filename> file or by supplying the <filename>postgresql.conf</filename> file or by supplying the
...@@ -239,7 +239,7 @@ java -Djdbc.drivers=org.postgresql.Driver example.ImageViewer ...@@ -239,7 +239,7 @@ java -Djdbc.drivers=org.postgresql.Driver example.ImageViewer
<para> <para>
With <acronym>JDBC</acronym>, a database is represented by a With <acronym>JDBC</acronym>, a database is represented by a
<acronym>URL</acronym> (Uniform Resource Locator). With <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: following forms:
<itemizedlist> <itemizedlist>
...@@ -720,7 +720,7 @@ st.close(); ...@@ -720,7 +720,7 @@ st.close();
</indexterm> </indexterm>
<para> <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 store binary data. Binary data can be stored in a table using
the data type <type>bytea</type> or by using the Large Object 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 feature which stores the binary data in a separate table in a special
...@@ -771,11 +771,10 @@ st.close(); ...@@ -771,11 +771,10 @@ st.close();
<para> <para>
To use the Large Object functionality you can use either the To use the Large Object functionality you can use either the
<classname>LargeObject</classname> class <classname>LargeObject</classname> class provided by the
provided by the <application>PostgreSQL</application> <productname>PostgreSQL</> <acronym>JDBC</acronym> driver, or by
<acronym>JDBC</acronym> driver, or by using the using the <function>getBLOB()</function> and
<function>getBLOB()</function> and <function>setBLOB()</function> <function>setBLOB()</function> methods.
methods.
</para> </para>
<important> <important>
...@@ -800,7 +799,8 @@ st.close(); ...@@ -800,7 +799,8 @@ st.close();
<para> <para>
<xref linkend="jdbc-binary-data-example"> contains some examples on <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> </para>
<example id="jdbc-binary-data-example"> <example id="jdbc-binary-data-example">
...@@ -948,7 +948,7 @@ ps.close(); ...@@ -948,7 +948,7 @@ ps.close();
<sect1 id="jdbc-ext"> <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> <acronym>JDBC</acronym> <acronym>API</acronym></title>
<para> <para>
......
<!-- <!--
$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"> <chapter id="libpq">
...@@ -3575,12 +3575,12 @@ If the permissions are less strict than this, the file will be ignored. ...@@ -3575,12 +3575,12 @@ If the permissions are less strict than this, the file will be ignored.
<para> <para>
<application>libpq</application> is reentrant and thread-safe if the <application>libpq</application> is reentrant and thread-safe if the
<filename>configure</filename> command-line option <filename>configure</filename> command-line option
<literal>--enable-thread-safety</> has been used when the PostgreSQL <literal>--enable-thread-safety</> has been used when the
distribution was built. <productname>PostgreSQL</productname> distribution was built. In
In addition, you might need to use additional compiler command-line addition, you might need to use additional compiler command-line
options when you compile your application code. Refer to your system's options when you compile your application code. Refer to your
documentation for information about how to build thread-enabled system's documentation for information about how to build
applications. thread-enabled applications.
</para> </para>
<para> <para>
......
<!-- <!--
$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"> <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 $ ...@@ -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 isolation level may be stricter than what you select. This is
permitted by the SQL standard: the four isolation levels only permitted by the SQL standard: the four isolation levels only
define which phenomena must not happen, they do not define which define which phenomena must not happen, they do not define which
phenomena must happen. The reason that PostgreSQL only provides phenomena must happen. The reason that <productname>PostgreSQL</>
two isolation levels is that this is the only sensible way to map only provides two isolation levels is that this is the only
the isolation levels to the multiversion concurrency control sensible way to map the isolation levels to the multiversion
architecture. The behavior of the available isolation levels is concurrency control architecture. The behavior of the available
detailed in the following subsections. isolation levels is detailed in the following subsections.
</para> </para>
<para> <para>
......
<!-- <!--
$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 PostgreSQL documentation
--> -->
...@@ -584,8 +584,8 @@ ZW ZIMBABWE ...@@ -584,8 +584,8 @@ ZW ZIMBABWE
</para> </para>
<para> <para>
The following syntax was used before PostgreSQL version 7.3 and is The following syntax was used before <productname>PostgreSQL</>
still supported: version 7.3 and is still supported:
<synopsis> <synopsis>
COPY [ BINARY ] <replaceable class="parameter">tablename</replaceable> [ WITH OIDS ] COPY [ BINARY ] <replaceable class="parameter">tablename</replaceable> [ WITH OIDS ]
......
<!-- <!--
$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 PostgreSQL documentation
--> -->
...@@ -125,17 +125,19 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE <replaceable>table_name ...@@ -125,17 +125,19 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE <replaceable>table_name
</para> </para>
<para> <para>
Prior to PostgreSQL 7.5, <command>CREATE TABLE AS</command> always Prior to <productname>PostgreSQL</> 7.5, <command>CREATE TABLE
included OIDs in the table it produced. Furthermore, these OIDs AS</command> always included OIDs in the table it
were newly generated: they were distinct from the OIDs of any of produced. Furthermore, these OIDs were newly generated: they were
the rows in the source tables of the <command>SELECT</command> or distinct from the OIDs of any of the rows in the source tables of
<command>EXECUTE</command> statement. Therefore, if <command>CREATE the <command>SELECT</command> or <command>EXECUTE</command>
TABLE AS</command> was frequently executed, the OID counter would statement. Therefore, if <command>CREATE TABLE AS</command> was
be rapidly incremented. As of PostgreSQL 7.5, the inclusion of OIDs frequently executed, the OID counter would be rapidly
in the table generated by <command>CREATE TABLE AS</command> is incremented. As of <productname>PostgreSQL</> 7.5, the inclusion of
controlled by the <varname>default_with_oids</varname> configuration OIDs in the table generated by <command>CREATE TABLE AS</command>
variable. This variable currently defaults to true, but will likely is controlled by the <varname>default_with_oids</varname>
default to false in a future release of <productname>PostgreSQL</>. configuration variable. This variable currently defaults to true,
but will likely default to false in a future release of
<productname>PostgreSQL</>.
</para> </para>
</refsect1> </refsect1>
......
<!-- <!--
$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 PostgreSQL documentation
--> -->
...@@ -452,17 +452,17 @@ PostgreSQL documentation ...@@ -452,17 +452,17 @@ PostgreSQL documentation
</para> </para>
<para> <para>
A failure message indicating inability to bind to a port may indicate A failure message indicating inability to bind to a port may
that that port is already in use by some non-PostgreSQL process. indicate that that port is already in use by some
You may also get this error if you terminate the non-<productname>PostgreSQL</productname> process. You may also
<command>postmaster</command> get this error if you terminate the <command>postmaster</command>
and immediately restart it using the same port; in this case, you must and immediately restart it using the same port; in this case, you
simply wait a few seconds until the operating system closes the port must simply wait a few seconds until the operating system closes
before trying again. Finally, you may get this error if you specify the port before trying again. Finally, you may get this error if
a port number that your operating system considers to be reserved. you specify a port number that your operating system considers to
For example, many versions of Unix consider port numbers under 1024 to be reserved. For example, many versions of Unix consider port
be <quote>trusted</quote> numbers under 1024 to be <quote>trusted</quote> and only permit
and only permit the Unix superuser to access them. the Unix superuser to access them.
</para> </para>
</refsect1> </refsect1>
......
<!-- <!--
$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 PostgreSQL documentation
--> -->
...@@ -94,17 +94,18 @@ SELECT [ ALL | DISTINCT [ ON ( <replaceable class="PARAMETER">expression</replac ...@@ -94,17 +94,18 @@ SELECT [ ALL | DISTINCT [ ON ( <replaceable class="PARAMETER">expression</replac
</para> </para>
<para> <para>
Prior to PostgreSQL 7.5, the table created by <command>SELECT Prior to <productname>PostgreSQL</> 7.5, the table created by
INTO</command> always included OIDs. Furthermore, these OIDs were <command>SELECT INTO</command> always included OIDs. Furthermore,
newly generated: they were distinct from the OIDs of any of the these OIDs were newly generated: they were distinct from the OIDs
rows in the source tables of the <command>SELECT INTO</command> of any of the rows in the source tables of the <command>SELECT
statement. Therefore, if <command>SELECT INTO</command> was INTO</command> statement. Therefore, if <command>SELECT
frequently executed, the OID counter would be rapidly INTO</command> was frequently executed, the OID counter would be
incremented. As of PostgreSQL 7.5, the inclusion of OIDs in the rapidly incremented. As of <productname>PostgreSQL</> 7.5, the
table created by <command>SELECT INTO</command> is controlled by inclusion of OIDs in the table created by <command>SELECT
the <varname>default_with_oids</varname> configuration INTO</command> is controlled by the
variable. This variable currently defaults to true, but will likely <varname>default_with_oids</varname> configuration variable. This
default to false in a future release of <productname>PostgreSQL</>. variable currently defaults to true, but will likely default to
false in a future release of <productname>PostgreSQL</>.
</para> </para>
</refsect1> </refsect1>
......
<!-- $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"> <Chapter Id="rules">
<Title>The Rule System</Title> <Title>The Rule System</Title>
...@@ -1825,9 +1825,9 @@ GRANT SELECT ON phone_number TO secretary; ...@@ -1825,9 +1825,9 @@ GRANT SELECT ON phone_number TO secretary;
</listitem> </listitem>
</itemizedlist> </itemizedlist>
(This system was established in PostgreSQL 7.3. In versions (This system was established in <productname>PostgreSQL</> 7.3.
before that, the command status might show different results when In versions before that, the command status might show different
rules exist.) results when rules exist.)
</Para> </Para>
<Para> <Para>
......
<!-- <!--
$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"> <Chapter Id="runtime">
...@@ -3551,7 +3551,7 @@ $ <userinput>kill -INT `head -1 /usr/local/pgsql/data/postmaster.pid`</userinput ...@@ -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</> The server will listen for both standard and <acronym>SSL</>
connections on the same TCP port, and will negotiate with any connections on the same TCP port, and will negotiate with any
connecting client on whether to use <acronym>SSL</>. See <xref 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. require use of <acronym>SSL</> for certain connections.
</para> </para>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment