mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reformat 'sslmode' options into an SGML table; improve wording.

Browse Source
This commit is contained in:
Bruce Momjian 2009-04-14 20:42:48 +00:00
parent 418fd59663
commit 334f4e12d8
1 changed files with 45 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
doc/src/sgml/libpq.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.283 2009/04/11 16:46:54 momjian Exp $ --> <!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.284 2009/04/14 20:42:48 momjian Exp $ -->
<chapter id="libpq"> <chapter id="libpq">
<title><application>libpq</application> - C Library</title> <title><application>libpq</application> - C Library</title>
@ -254,23 +254,55 @@
<para> <para>
This option determines whether or with what priority a This option determines whether or with what priority a
<acronym>SSL</> TCP/IP connection will be negotiated with the <acronym>SSL</> TCP/IP connection will be negotiated with the
server. There are four modes: <literal>disable</> will attempt server. There are four modes:
only an unencrypted <acronym>SSL</> connection;
<literal>allow</> will negotiate, trying first a <table id="libpq-connect-sslmode-options">
non-<acronym>SSL</> connection, then if that fails, trying an <title><literal>sslmode</literal> options</title>
<acronym>SSL</> connection; <literal>prefer</> (the default) <tgroup cols="2">
will negotiate, trying first an <acronym>SSL</> connection, <thead>
then if that fails, trying a regular non-<acronym>SSL</> <row>
connection; <literal>require</> will try only an <entry>Option</entry>
<acronym>SSL</> connection. <literal>sslmode</> is ignored <entry>Description</entry>
for Unix domain socket communication. </row>
</para> </thead>
<tbody>
<row>
<entry><literal>disable</></entry>
<entry>only try a non-<acronym>SSL</> connection
</row>
<row>
<entry><literal>allow</></entry>
<entry>first try a non-<acronym>SSL</>
connection; if that fails, try an <acronym>SSL</>
connection</entry>
</row>
<row>
<entry><literal>prefer</> (default)</entry>
<entry>first try an <acronym>SSL</> connection; if
that fails, try a non-<acronym>SSL</>
connection</entry>
</row>
<row>
<entry><literal>require</></entry>
<entry>only try an <acronym>SSL</> connection</entry>
</row>
</tbody>
</tgroup>
</table>
<para> <para>
<literal>sslmode</> is ignored for Unix domain socket
communication.
If <productname>PostgreSQL</> is compiled without SSL support, If <productname>PostgreSQL</> is compiled without SSL support,
using option <literal>require</> will cause an error, while using option <literal>require</> will cause an error, while
options <literal>allow</> and <literal>prefer</> will be options <literal>allow</> and <literal>prefer</> will be
accepted but <application>libpq</> will not in fact attempt accepted but <application>libpq</> will not actually attempt
an <acronym>SSL</> an <acronym>SSL</>
connection.<indexterm><primary>SSL</><secondary connection.<indexterm><primary>SSL</><secondary
sortas="libpq">with libpq</></indexterm> sortas="libpq">with libpq</></indexterm>