From fd4f3b3b62febbd360ad9b75409f7dde22546c23 Mon Sep 17 00:00:00 2001 From: Neil Conway Date: Tue, 23 Mar 2004 02:47:35 +0000 Subject: [PATCH] Improve the locale and character set docs, add some s pointing to the character set docs where appropriate, and improve the postmaster reference page. Character set cross-refs suggested by Gavin Kistner. --- doc/src/sgml/charset.sgml | 32 ++++++------- doc/src/sgml/datatype.sgml | 7 ++- doc/src/sgml/ref/create_database.sgml | 8 ++-- doc/src/sgml/ref/createdb.sgml | 7 ++- doc/src/sgml/ref/initdb.sgml | 12 +++-- doc/src/sgml/ref/postmaster.sgml | 66 +++++++++++++++------------ 6 files changed, 76 insertions(+), 56 deletions(-) diff --git a/doc/src/sgml/charset.sgml b/doc/src/sgml/charset.sgml index 869c4fafd9..ce4a1f81e1 100644 --- a/doc/src/sgml/charset.sgml +++ b/doc/src/sgml/charset.sgml @@ -1,4 +1,4 @@ - + Localization</> @@ -52,24 +52,24 @@ Locale support is automatically initialized when a database cluster is created using <command>initdb</command>. <command>initdb</command> will initialize the database cluster - with the locale setting of its execution environment; so if your - system is already set to use the locale that you want in your - database cluster then there is nothing else you need to do. If - you want to use a different locale (or you are not sure which - locale your system is set to), you can tell - <command>initdb</command> exactly which locale you want with the - option <option>--locale</option>. For example: + with the locale setting of its execution environment by default, + so if your system is already set to use the locale that you want + in your database cluster then there is nothing else you need to + do. If you want to use a different locale (or you are not sure + which locale your system is set to), you can instruct + <command>initdb</command> exactly which locale to use by + specifying the <option>--locale</option> option. For example: <screen> initdb --locale=sv_SE </screen> </para> <para> - This example sets the locale to Swedish (<literal>sv</>) as spoken in - Sweden (<literal>SE</>). Other possibilities might be - <literal>en_US</> (U.S. English) and <literal>fr_CA</> (Canada, - French). If more than one character set can be useful for a locale - then the specifications look like this: + This example sets the locale to Swedish (<literal>sv</>) as spoken + in Sweden (<literal>SE</>). Other possibilities might be + <literal>en_US</> (U.S. English) and <literal>fr_CA</> (French + Canadian). If more than one character set can be useful for a + locale then the specifications look like this: <literal>cs_CZ.ISO8859-2</>. What locales are available under what names on your system depends on what was provided by the operating system vendor and what was installed. @@ -141,7 +141,7 @@ initdb --locale=sv_SE The other locale categories can be changed as desired whenever the server is running by setting the run-time configuration variables that have the same name as the locale categories (see <xref - linkend="runtime-config"> for details). The defaults that are + linkend="runtime-config-client-format"> for details). The defaults that are chosen by <command>initdb</command> are actually only written into the configuration file <filename>postgresql.conf</filename> to serve as defaults when the server is started. If you delete the @@ -196,7 +196,7 @@ initdb --locale=sv_SE <itemizedlist> <listitem> <para> - Sort order in queries using <command>ORDER BY</> + Sort order in queries using <literal>ORDER BY</> <indexterm><primary>ORDER BY</><secondary>and locales</></indexterm> </para> </listitem> @@ -286,7 +286,7 @@ initdb --locale=sv_SE databases each with a different character set. </para> - <sect2> + <sect2 id="multibyte-charset-supported"> <title>Supported Character Sets diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml index f0cda23196..769357ae5d 100644 --- a/doc/src/sgml/datatype.sgml +++ b/doc/src/sgml/datatype.sgml @@ -1,5 +1,5 @@ @@ -945,7 +945,10 @@ CREATE TABLE tablename ( Refer to for information about the syntax of string literals, and to - for information about available operators and functions. + for information about available operators and functions. The + database character set determines the character set used to store + textual values; for more information on character set support, + refer to . diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index 35ae8a75ad..065ee47936 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -1,5 +1,5 @@ @@ -139,10 +139,12 @@ CREATE DATABASE name encoding - Character set encoding to use in the new database. Specify + Character set encoding to use in the new database. Specify a string constant (e.g., 'SQL_ASCII'), or an integer encoding number, or DEFAULT - to use the default encoding. + to use the default encoding. The character sets supported by the + PostgreSQL server are described in + . diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index 6a5581bcab..a6b2c8d383 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -1,5 +1,5 @@ @@ -112,7 +112,10 @@ PostgreSQL documentation - Specifies the character encoding scheme to be used in this database. + Specifies the character encoding scheme to be used in this + database. The character sets supported by the + PostgreSQL server are described in + . diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 92a1301cee..189a427977 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -1,5 +1,5 @@ @@ -120,8 +120,11 @@ PostgreSQL documentation Selects the encoding of the template database. This will also - be the default encoding of any database you create later, unless you - override it there. The default is SQL_ASCII. + be the default encoding of any database you create later, + unless you override it there. The default is + SQL_ASCII. The character sets supported by + the PostgreSQL server are described + in . @@ -132,7 +135,8 @@ PostgreSQL documentation Sets the default locale for the database cluster. If this option is not specified, the locale is inherited from the - environment that initdb runs in. + environment that initdb runs in. Locale + support is described in . diff --git a/doc/src/sgml/ref/postmaster.sgml b/doc/src/sgml/ref/postmaster.sgml index cf74272b9b..0d6b6dba08 100644 --- a/doc/src/sgml/ref/postmaster.sgml +++ b/doc/src/sgml/ref/postmaster.sgml @@ -1,5 +1,5 @@ @@ -93,8 +93,9 @@ PostgreSQL documentation Enables run-time assertion checks, which is a debugging aid to - detect programming mistakes. This is only available if it was - enabled during compilation. If so, the default is on. + detect programming mistakes. This option is only available if + assertions were enabled when PostgreSQL was + compiled. If so, the default is on. @@ -104,8 +105,9 @@ PostgreSQL documentation Sets the number of shared buffers for use by the server - processes. This value defaults to 64 buffers, where each - buffer is 8 kB. + processes. The default value of this parameter is chosen + automatically by initdb; refer to for more information. @@ -114,11 +116,12 @@ PostgreSQL documentation - Sets a named run-time parameter. Consult for - a list and descriptions. Most of the other command line - options are in fact short forms of such a parameter - assignment. @@ -129,7 +132,7 @@ PostgreSQL documentation Sets the debug level. The higher this value is set, the more debugging output is written to the server log. Values are from - 1 to 5. + 1 to 5. @@ -150,10 +153,11 @@ PostgreSQL documentation Disables fsync calls for performance improvement, at the risk of data corruption in event of a - system crash. This option corresponds to setting - fsync=false in postgresql.conf. Read the detailed - documentation before using this! + system crash. Specifying this option is equivalent to + disabling the configuration + parameter. Read the detailed documentation before using this! + has the opposite effect of this option. @@ -167,15 +171,15 @@ PostgreSQL documentation Specifies the IP host name or address on which the postmaster is to listen for TCP/IP - connections from client applications. The value can also be - a space-separated list of addresses, or * to specify - listening on all available interfaces. An empty value specifies - not listening on any IP addresses, in which case only Unix-domain - sockets can be used to connect to the postmaster. - Defaults to listening only - on localhost. - This option is equivalent to setting listen_addresses in - postgresql.conf. + connections from client applications. The value can also be a + space-separated list of addresses, or * to specify + listening on all available interfaces. An empty value + specifies not listening on any IP addresses, in which case + only Unix-domain sockets can be used to connect to the + postmaster. Defaults to listening only on + localhost. + Specifying this option is equivalent to setting the . @@ -187,13 +191,13 @@ PostgreSQL documentation Allows remote clients to connect via TCP/IP (Internet domain) connections. Without this option, only local connections are accepted. This option is equivalent to setting - listen_addresses to * in + listen_addresses to * in postgresql.conf or via This option is deprecated since it does not allow access to the - full functionality of listen_addresses. It's usually - better to set listen_addresses directly. + full functionality of . + It's usually better to set listen_addresses directly. @@ -214,8 +218,11 @@ PostgreSQL documentation - Enables secure connections using SSL. You must have compiled with SSL - enabled to use this option. + Enables secure connections using SSL. + PostgreSQL must have been compiled with + support for SSL for this option to be + available. For more information on using SSL, + refer to . @@ -231,7 +238,8 @@ PostgreSQL documentation is required to be at least twice . See for a discussion of system resource requirements for large numbers of client - connections.) + connections.) Specifying this option is equivalent to setting the + configuration parameter.