database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-11-24 00:23:06 +03:00
Code Activity

Convert documentation to DocBook XML

Browse Source 
Since some preparation work had already been done, the only source
changes left were changing empty-element tags like <xref linkend="foo">
to <xref linkend="foo"/>, and changing the DOCTYPE.

The source files are still named *.sgml, but they are actually XML files
now.  Renaming could be considered later.

In the build system, the intermediate step to convert from SGML to XML
is removed.  Everything is build straight from the source files again.
The OpenSP (or the old SP) package is no longer needed.

The documentation toolchain instructions are updated and are much
simpler now.

Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
This commit is contained in:
Peter Eisentraut
2017-11-23 09:39:47 -05:00
parent 2f8d6369e6
commit 3c49c6facb
346 changed files with 4260 additions and 4588 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
doc/src/sgml/ref/psql-ref.sgml
View File

@@ -125,7 +125,7 @@ echo '\x \\ SELECT * FROM foo;' | psql
if the string contains multiple <acronym>SQL</acronym> commands,
unless there are explicit <command>BEGIN</command>/<command>COMMIT</command>
commands included in the string to divide it into multiple
transactions. (See <xref linkend="protocol-flow-multi-statement">
transactions. (See <xref linkend="protocol-flow-multi-statement"/>
for more details about how the server handles multi-query strings.)
Also, <application>psql</application> only prints the
result of the last <acronym>SQL</acronym> command in the string.
@@ -167,7 +167,7 @@ EOF
(<literal>postgresql://</literal>
or <literal>postgres://</literal>), it is treated as a
<parameter>conninfo</parameter> string. See <xref
linkend="libpq-connstring"> for more information.
linkend="libpq-connstring"/> for more information.
</para>
</listitem>
</varlistentry>
@@ -662,9 +662,9 @@ EOF
<envar>PGDATABASE</envar>, <envar>PGHOST</envar>,
<envar>PGPORT</envar> and/or <envar>PGUSER</envar> to appropriate
values. (For additional environment variables, see <xref
linkend="libpq-envars">.) It is also convenient to have a
linkend="libpq-envars"/>.) It is also convenient to have a
<filename>~/.pgpass</filename> file to avoid regularly having to type in
passwords. See <xref linkend="libpq-pgpass"> for more information.
passwords. See <xref linkend="libpq-pgpass"/> for more information.
</para>
<para>
@@ -678,8 +678,8 @@ $ <userinput>psql "service=myservice sslmode=require"</userinput>
$ <userinput>psql postgresql://dbmaster:5433/mydb?sslmode=require</userinput>
</programlisting>
This way you can also use <acronym>LDAP</acronym> for connection
parameter lookup as described in <xref linkend="libpq-ldap">.
See <xref linkend="libpq-paramkeywords"> for more information on all the
parameter lookup as described in <xref linkend="libpq-ldap"/>.
See <xref linkend="libpq-paramkeywords"/> for more information on all the
available connection options.
</para>
@@ -730,8 +730,8 @@ testdb=&gt;
<para>
Whenever a command is executed, <application>psql</application> also polls
for asynchronous notification events generated by
<xref linkend="sql-listen"> and
<xref linkend="sql-notify">.
<xref linkend="sql-listen"/> and
<xref linkend="sql-notify"/>.
</para>
<para>
@@ -779,7 +779,7 @@ testdb=&gt;
If an unquoted colon (<literal>:</literal>) followed by a
<application>psql</application> variable name appears within an argument, it is
replaced by the variable's value, as described in <xref
linkend="app-psql-interpolation" endterm="app-psql-interpolation-title">.
linkend="app-psql-interpolation" endterm="app-psql-interpolation-title"/>.
The forms <literal>:'<replaceable>variable_name</replaceable>'</literal> and
<literal>:"<replaceable>variable_name</replaceable>"</literal> described there
work as well.
@@ -864,7 +864,7 @@ testdb=&gt;
Establishes a new connection to a <productname>PostgreSQL</productname>
server. The connection parameters to use can be specified either
using a positional syntax, or using <replaceable>conninfo</replaceable> connection
strings as detailed in <xref linkend="libpq-connstring">.
strings as detailed in <xref linkend="libpq-connstring"/>.
</para>
<para>
@@ -958,7 +958,7 @@ testdb=&gt;
<listitem>
<para>
Performs a frontend (client) copy. This is an operation that
runs an <acronym>SQL</acronym> <xref linkend="sql-copy">
runs an <acronym>SQL</acronym> <xref linkend="sql-copy"/>
command, but instead of the server
reading or writing the specified file,
<application>psql</application> reads or writes the file and
@@ -995,9 +995,9 @@ testdb=&gt;
<para>
The syntax of this command is similar to that of the
<acronym>SQL</acronym> <xref linkend="sql-copy">
<acronym>SQL</acronym> <xref linkend="sql-copy"/>
command. All options other than the data source/destination are
as specified for <xref linkend="sql-copy">.
as specified for <xref linkend="sql-copy"/>.
Because of this, special parsing rules apply to the <command>\copy</command>
meta-command. Unlike most other meta-commands, the entire remainder
of the line is always taken to be the arguments of <command>\copy</command>,
@@ -1116,7 +1116,7 @@ testdb=&gt;
also shown. For foreign tables, the associated foreign
server is shown as well.
(<quote>Matching the pattern</quote> is defined in
<xref linkend="app-psql-patterns" endterm="app-psql-patterns-title">
<xref linkend="app-psql-patterns" endterm="app-psql-patterns-title"/>
below.)
</para>
@@ -1255,7 +1255,7 @@ testdb=&gt;
<para>
Descriptions for objects can be created with the <xref
linkend="sql-comment">
linkend="sql-comment"/>
<acronym>SQL</acronym> command.
</para>
</listitem>
@@ -1292,10 +1292,10 @@ testdb=&gt;
</para>
<para>
The <xref linkend="sql-alterdefaultprivileges"> command is used to set
The <xref linkend="sql-alterdefaultprivileges"/> command is used to set
default access privileges. The meaning of the
privilege display is explained under
<xref linkend="sql-grant">.
<xref linkend="sql-grant"/>.
</para>
</listitem>
</varlistentry>
@@ -1606,11 +1606,11 @@ testdb=&gt;
</para>
<para>
The <xref linkend="sql-grant"> and
<xref linkend="sql-revoke">
The <xref linkend="sql-grant"/> and
<xref linkend="sql-revoke"/>
commands are used to set access privileges. The meaning of the
privilege display is explained under
<xref linkend="sql-grant">.
<xref linkend="sql-grant"/>.
</para>
</listitem>
</varlistentry>
@@ -1629,8 +1629,8 @@ testdb=&gt;
</para>
<para>
The <xref linkend="sql-alterrole"> and
<xref linkend="sql-alterdatabase">
The <xref linkend="sql-alterrole"/> and
<xref linkend="sql-alterdatabase"/>
commands are used to define per-role and per-database configuration
settings.
</para>
@@ -1770,7 +1770,7 @@ testdb=&gt;
<tip>
<para>
See under <xref linkend="app-psql-environment"
endterm="app-psql-environment-title"> for how to configure and
endterm="app-psql-environment-title"/> for how to configure and
customize your editor.
</para>
</tip>
@@ -1844,7 +1844,7 @@ Tue Oct 26 21:40:57 CEST 1999
<tip>
<para>
See under <xref linkend="app-psql-environment"
endterm="app-psql-environment-title"> for how to configure and
endterm="app-psql-environment-title"/> for how to configure and
customize your editor.
</para>
</tip>
@@ -2027,7 +2027,7 @@ CREATE INDEX
<para>
Sends the current query buffer to the server and stores the
query's output into <application>psql</application> variables (see <xref
linkend="app-psql-variables" endterm="app-psql-variables-title">).
linkend="app-psql-variables" endterm="app-psql-variables-title"/>).
The query to be executed must return exactly one row. Each column of
the row is stored into a separate variable, named the same as the
column. For example:
@@ -2832,7 +2832,7 @@ lo_import 152801
<para>
Illustrations of how these different formats look can be seen in
the <xref linkend="app-psql-examples"
endterm="app-psql-examples-title"> section.
endterm="app-psql-examples-title"/> section.
</para>
<tip>
@@ -2918,7 +2918,7 @@ lo_import 152801
Valid variable names can contain letters, digits, and
underscores. See the section <xref
linkend="app-psql-variables"
endterm="app-psql-variables-title"> below for details.
endterm="app-psql-variables-title"/> below for details.
Variable names are case-sensitive.
</para>
@@ -2927,13 +2927,13 @@ lo_import 152801
control <application>psql</application>'s behavior or are
automatically set to reflect connection state. These variables are
documented in <xref linkend="app-psql-variables"
endterm="app-psql-variables-title">, below.
endterm="app-psql-variables-title"/>, below.
</para>
<note>
<para>
This command is unrelated to the <acronym>SQL</acronym>
command <xref linkend="sql-set">.
command <xref linkend="sql-set"/>.
</para>
</note>
</listitem>
@@ -3071,7 +3071,7 @@ testdb=&gt; <userinput>\setenv LESS -imx4F</userinput>
cannot be unset; instead, an <literal>\unset</literal> command is interpreted
as setting them to their default values.
See <xref linkend="app-psql-variables"
endterm="app-psql-variables-title">, below.
endterm="app-psql-variables-title"/>, below.
</para>
</listitem>
</varlistentry>
@@ -3216,7 +3216,7 @@ select 1\; select 2\; select 3;
The server executes such a request as a single transaction,
unless there are explicit <command>BEGIN</command>/<command>COMMIT</command>
commands included in the string to divide it into multiple
transactions. (See <xref linkend="protocol-flow-multi-statement">
transactions. (See <xref linkend="protocol-flow-multi-statement"/>
for more details about how the server handles multi-query strings.)
<application>psql</application> prints only the last query result
it receives for each request; in this example, although all
@@ -3295,7 +3295,7 @@ select 1\; select 2\; select 3;
Advanced users can use regular-expression notations such as character
classes, for example <literal>[0-9]</literal> to match any digit. All regular
expression special characters work as specified in
<xref linkend="functions-posix-regexp">, except for <literal>.</literal> which
<xref linkend="functions-posix-regexp"/>, except for <literal>.</literal> which
is taken as a separator as mentioned above, <literal>*</literal> which is
translated to the regular-expression notation <literal>.*</literal>,
<literal>?</literal> which is translated to <literal>.</literal>, and
@@ -3348,7 +3348,7 @@ bar
</programlisting>
This works in both regular SQL commands and meta-commands; there is
more detail in <xref linkend="app-psql-interpolation"
endterm="app-psql-interpolation-title">, below.
endterm="app-psql-interpolation-title"/>, below.
</para>
<para>
@@ -3743,7 +3743,7 @@ bar
These specify what the prompts <application>psql</application>
issues should look like. See <xref
linkend="app-psql-prompting"
endterm="app-psql-prompting-title"> below.
endterm="app-psql-prompting-title"/> below.
</para>
</listitem>
</varlistentry>
@@ -3825,7 +3825,7 @@ bar
<term><varname>SQLSTATE</varname></term>
<listitem>
<para>
The error code (see <xref linkend="errcodes-appendix">) associated
The error code (see <xref linkend="errcodes-appendix"/>) associated
with the last SQL query's failure, or <literal>00000</literal> if it
succeeded.
</para>
@@ -4119,7 +4119,7 @@ testdb=&gt; <userinput>INSERT INTO my_table VALUES (:'content');</userinput>
The value of the <application>psql</application> variable
<replaceable class="parameter">name</replaceable>. See the
section <xref linkend="app-psql-variables"
endterm="app-psql-variables-title"> for details.
endterm="app-psql-variables-title"/> for details.
</para>
</listitem>
</varlistentry>
@@ -4230,7 +4230,7 @@ $endif
<listitem>
<para>
Default connection parameters (see <xref linkend="libpq-envars">).
Default connection parameters (see <xref linkend="libpq-envars"/>).
</para>
</listitem>
</varlistentry>
@@ -4346,7 +4346,7 @@ PSQL_EDITOR_LINENUMBER_ARG='--line '
<para>
This utility, like most other <productname>PostgreSQL</productname> utilities,
also uses the environment variables supported by <application>libpq</application>
(see <xref linkend="libpq-envars">).
(see <xref linkend="libpq-envars"/>).
</para>
</refsect1>