Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 40c1d7c

Browse files
committed
Text search doc updates --- first cut at
syncing the existing docs with the final syntax decisions.
1 parent b77c6c7 commit 40c1d7c

File tree

3 files changed

+409
-309
lines changed

3 files changed

+409
-309
lines changed

doc/src/sgml/config.sgml

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/config.sgml,v 1.140 2007/08/21 15:13:16 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/config.sgml,v 1.141 2007/08/22 04:45:20 tgl Exp $ -->
22

33
<chapter Id="runtime-config">
44
<title>Server Configuration</title>
@@ -4106,6 +4106,26 @@ SET XML OPTION { DOCUMENT | CONTENT };
41064106
</listitem>
41074107
</varlistentry>
41084108

4109+
<varlistentry id="guc-default-text-search-config" xreflabel="default_text_search_config">
4110+
<term><varname>default_text_search_config</varname> (<type>string</type>)</term>
4111+
<indexterm>
4112+
<primary><varname>default_text_search_config</> configuration parameter</primary>
4113+
</indexterm>
4114+
<listitem>
4115+
<para>
4116+
Selects the text search configuration that is used by those variants
4117+
of the text search functions that do not have an explicit argument
4118+
specifying the configuration.
4119+
See <xref linkend="textsearch"> for further information.
4120+
The built-in default is <literal>pg_catalog.simple</>, but
4121+
<application>initdb</application> will initialize the
4122+
configuration file with a setting that corresponds to the
4123+
chosen <varname>lc_ctype</varname> locale, if a configuration
4124+
matching that locale can be identified.
4125+
</para>
4126+
</listitem>
4127+
</varlistentry>
4128+
41094129
</variablelist>
41104130

41114131
</sect2>

doc/src/sgml/ref/psql-ref.sgml

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.193 2007/07/10 00:21:31 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.194 2007/08/22 04:45:20 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -997,6 +997,66 @@ testdb=&gt;
997997
</varlistentry>
998998

999999

1000+
<varlistentry>
1001+
<term><literal>\dF [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1002+
<term><literal>\dF+ [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1003+
<listitem>
1004+
<para>
1005+
Lists available text search configurations.
1006+
If <replaceable class="parameter">pattern</replaceable> is specified,
1007+
only configurations whose names match the pattern are shown.
1008+
If the form <literal>\dF+</literal> is used, a full description of
1009+
each configuration is shown, including the underlying text search
1010+
parser and the dictionary list for each parser token type.
1011+
</para>
1012+
</listitem>
1013+
</varlistentry>
1014+
1015+
<varlistentry>
1016+
<term><literal>\dFd [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1017+
<term><literal>\dFd+ [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1018+
<listitem>
1019+
<para>
1020+
Lists available text search dictionaries.
1021+
If <replaceable class="parameter">pattern</replaceable> is specified,
1022+
only dictionaries whose names match the pattern are shown.
1023+
If the form <literal>\dFd+</literal> is used, additional information
1024+
is shown about each selected dictionary, including the underlying
1025+
text search template and the option values.
1026+
</para>
1027+
</listitem>
1028+
</varlistentry>
1029+
1030+
<varlistentry>
1031+
<term><literal>\dFp [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1032+
<term><literal>\dFp+ [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1033+
<listitem>
1034+
<para>
1035+
Lists available text search parsers.
1036+
If <replaceable class="parameter">pattern</replaceable> is specified,
1037+
only parsers whose names match the pattern are shown.
1038+
If the form <literal>\dFp+</literal> is used, a full description of
1039+
each parser is shown, including the underlying functions and the
1040+
list of recognized token types.
1041+
</para>
1042+
</listitem>
1043+
</varlistentry>
1044+
1045+
<varlistentry>
1046+
<term><literal>\dFt [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1047+
<term><literal>\dFt+ [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
1048+
<listitem>
1049+
<para>
1050+
Lists available text search templates.
1051+
If <replaceable class="parameter">pattern</replaceable> is specified,
1052+
only templates whose names match the pattern are shown.
1053+
If the form <literal>\dFt+</literal> is used, additional information
1054+
is shown about each template, including the underlying function names.
1055+
</para>
1056+
</listitem>
1057+
</varlistentry>
1058+
1059+
10001060
<varlistentry>
10011061
<term><literal>\dg [ <replaceable class="parameter">pattern</replaceable> ]</literal></term>
10021062
<listitem>

0 commit comments

Comments
 (0)