Move client encoding libpq function docs into libpq doc section, and

just reference them from the localization doc section.

Backpatch to 8.3.X.

diff --git a/doc/src/sgml/charset.sgml b/doc/src/sgml/charset.sgml
index f54201fd268739f926d90609d6865cbff527894e..ad9a7db13781ca7775e1dffc7fdaa6a8d6319648 100644 (file)
--- a/doc/src/sgml/charset.sgml
+++ b/doc/src/sgml/charset.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/charset.sgml,v 2.84 2007/09/28 22:25:49 tgl Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/charset.sgml,v 2.84.2.1 2008/03/06 15:38:02 momjian Exp $ -->
 
 <chapter id="charset">
  <title>Localization</>
@@ -1110,31 +1110,7 @@ $ <userinput>psql -l</userinput>
 
       <listitem>
        <para>
-        Using <application>libpq</> functions.
-        <command>\encoding</command> actually calls
-        <function>PQsetClientEncoding()</function> for its purpose.
-
-<synopsis>
-int PQsetClientEncoding(PGconn *<replaceable>conn</replaceable>, const char *<replaceable>encoding</replaceable>);
-</synopsis>
-
-        where <replaceable>conn</replaceable> is a connection to the server,
-        and <replaceable>encoding</replaceable> is the encoding you
-        want to use. If the function successfully sets the encoding, it returns 0,
-        otherwise -1. The current encoding for this connection can be determined by
-        using:
-
-<synopsis>
-int PQclientEncoding(const PGconn *<replaceable>conn</replaceable>);
-</synopsis>
-
-        Note that it returns the encoding ID, not a symbolic string
-        such as <literal>EUC_JP</literal>. To convert an encoding ID to an encoding name, you
-        can use:
-
-<synopsis>
-char *pg_encoding_to_char(int <replaceable>encoding_id</replaceable>);
-</synopsis>
+        <application>libpq</> (<xref linkend="libpq-control">) has functions to control the client encoding.
        </para>
       </listitem>
 

diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 25b23dcd200f31d5a9b6f6841c5d374d3539ea0e..56b89b5cd92f684f6e4c6c9d6d5b5d79a04aa1b5 100644 (file)
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.255 2008/01/31 23:31:33 momjian Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.255.2.1 2008/03/06 15:38:02 momjian Exp $ -->
 
 <chapter id="libpq">
  <title><application>libpq</application> - C Library</title>
@@ -4415,6 +4415,56 @@ typedef struct {
   </para>
 
   <variablelist>
+   <varlistentry>
+    <term>
+     <function>PQclientEncoding</function>
+     <indexterm>
+      <primary>PQclientEncoding</primary>
+     </indexterm>
+    </term>
+
+    <listitem>
+     <para>
+      Returns the client encoding.
+      <synopsis>
+      int PQclientEncoding(const PGconn *<replaceable>conn</replaceable>);
+      </synopsis>
+
+      Note that it returns the encoding ID, not a symbolic string
+      such as <literal>EUC_JP</literal>. To convert an encoding ID to an encoding name, you
+      can use:
+
+<synopsis>
+char *pg_encoding_to_char(int <replaceable>encoding_id</replaceable>);
+</synopsis>
+     </para>
+    </listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>
+     <function>PQsetClientEncoding</function>
+     <indexterm>
+      <primary>PQsetClientEncoding</primary>
+     </indexterm>
+    </term>
+
+    <listitem>
+     <para>
+      Sets the client encoding.
+      <synopsis>
+      int PQsetClientEncoding(PGconn *<replaceable>conn</replaceable>, const char *<replaceable>encoding</replaceable>);
+      </synopsis>
+
+      <replaceable>conn</replaceable> is a connection to the server,
+      and <replaceable>encoding</replaceable> is the encoding you want to
+      use. If the function successfully sets the encoding, it returns 0,
+      otherwise -1. The current encoding for this connection can be
+      determined by using <function>PQclientEncoding</>.
+     </para>
+    </listitem>
+   </varlistentry>
+
    <varlistentry>
     <term>
      <function>PQsetErrorVerbosity</function>