Skip to content

P
Postgres FD Implementation
Commit dccfd749 authored by Peter Eisentraut's avatar Peter Eisentraut
Browse files
Options

Refine some things to create better looking man pages.

parent e58badfb
Hide whitespace changes
Inline Side-by-side
Showing with 252 additions and 238 deletions
doc/src/sgml/ref/alter_table.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.16 2000/12/20 03:19:24 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.17 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -194,7 +194,7 @@ ALTER TABLE <replaceable class="PARAMETER">table</replaceable>
new column will be ignored. You can use the <literal>SET DEFAULT</literal>
form of <command>ALTER TABLE</command> to set the default later.
(You will also have to update the already existing rows to the
new default value, using <xref linkend="sql-update-title"
new default value, using <xref linkend="sql-update"
endterm="sql-update-title">.)
</para>
......
doc/src/sgml/ref/begin.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.12 2000/10/07 14:16:01 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.13 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -105,8 +105,8 @@ NOTICE: BEGIN: already a transaction in progress
<command>BEGIN</command> initiates a user transaction in chained mode,
i.e., all user statements after <command>BEGIN</command> command will
be executed in a single transaction until an explicit
<xref linkend="sql-commit-title" endterm="sql-commit-title">,
<xref linkend="sql-rollback-title" endterm="sql-rollback-title">,
<xref linkend="sql-commit" endterm="sql-commit-title">,
<xref linkend="sql-rollback" endterm="sql-rollback-title">,
or execution abort. Statements in chained mode are executed much faster,
because transaction start/commit requires significant CPU and disk
activity. Execution of multiple statements inside a transaction
......@@ -142,15 +142,15 @@ NOTICE: BEGIN: already a transaction in progress
Notes
</title>
<para>
Refer to <xref linkend="sql-lock-title" endterm="sql-lock-title">
Refer to <xref linkend="sql-lock" endterm="sql-lock-title">
for further information
about locking tables inside a transaction.
</para>
<para>
Use <xref linkend="SQL-COMMIT-TITLE" endterm="SQL-COMMIT-TITLE">
Use <xref linkend="SQL-COMMIT" endterm="SQL-COMMIT-TITLE">
or
<xref linkend="SQL-ROLLBACK-TITLE" endterm="SQL-ROLLBACK-TITLE">
<xref linkend="SQL-ROLLBACK" endterm="SQL-ROLLBACK-TITLE">
to terminate a transaction.
</para>
</refsect2>
......
doc/src/sgml/ref/commit.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/commit.sgml,v 1.9 2000/01/29 16:58:27 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/commit.sgml,v 1.10 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -110,7 +110,7 @@ NOTICE: COMMIT: no transaction in progress
</para>
<para>
Use <xref linkend="SQL-ROLLBACK-TITLE" endterm="SQL-ROLLBACK-TITLE">
Use <xref linkend="SQL-ROLLBACK" endterm="SQL-ROLLBACK-TITLE">
to abort a transaction.
</para>
</refsect2>
......
doc/src/sgml/ref/create_function.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.20 2000/11/20 20:36:46 tgl Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_function.sgml,v 1.21 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -123,7 +123,7 @@ CREATE FUNCTION <replaceable class="parameter">name</replaceable> ( [ <replaceab
or '<replaceable class="parameter">plname</replaceable>',
where '<replaceable class="parameter">plname</replaceable>'
is the name of a created procedural language. See
<xref linkend="sql-createlanguage-title" endterm="sql-createlanguage-title">
<xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
for details.
</para>
</listitem>
......
doc/src/sgml/ref/create_index.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.16 2000/10/05 19:48:17 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_index.sgml,v 1.17 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -228,7 +228,7 @@ ERROR: Cannot create index: 'index_name' already exists.
</para>
<para>
Use <xref linkend="sql-dropindex-title" endterm="sql-dropindex-title">
Use <xref linkend="sql-dropindex" endterm="sql-dropindex-title">
to remove an index.
</para>
......
doc/src/sgml/ref/create_table.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.36 2000/10/08 13:22:24 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table.sgml,v 1.37 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -242,7 +242,7 @@ ERROR: DEFAULT: type mismatched
Each new table or class <replaceable class="PARAMETER">table</replaceable>
is automatically created as a type. Therefore, one or more instances
from the class are automatically a type and can be used in
<xref linkend="sql-altertable-title" endterm="sql-altertable-title">
<xref linkend="sql-altertable" endterm="sql-altertable-title">
or other <command>CREATE TABLE</command> statements.
</para>
......
doc/src/sgml/ref/create_table_as.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.3 1999/07/22 15:09:08 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_table_as.sgml,v 1.4 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -95,7 +95,7 @@ CREATE TABLE <replaceable>table</replaceable> [ (<replaceable>column</replaceabl
<command>CREATE TABLE AS</command> enables a table to be created
from the contents of an existing table.
It is functionality equivalent to
<xref linkend="sql-selectinto-title" endterm="sql-selectinto-title">,
<xref linkend="sql-selectinto" endterm="sql-selectinto-title">,
but with perhaps a more direct syntax.
</para>
</refsect1>
......
doc/src/sgml/ref/createdb.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.15 2000/11/22 01:41:13 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.16 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -99,7 +99,7 @@ Postgres documentation
<listitem>
<para>
Specifies the alternative database location. See also <xref
linkend="app-initlocation" endterm="app-initlocation-title">.
linkend="app-initlocation">.
</para>
</listitem>
</varlistentry>
......@@ -139,7 +139,7 @@ Postgres documentation
The options <literal>-h</literal>, <literal>-p</literal>, <literal>-U</literal>,
<literal>-W</literal>, and <literal>-e</literal> are passed on literally to
<xref linkend="APP-PSQL" endterm="APP-PSQL-title">.
<xref linkend="app-psql">.
</para>
</refsect2>
......@@ -177,8 +177,8 @@ Postgres documentation
</variablelist>
If there is an error condition, the backend error message will be displayed.
See <xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-title">
and <xref linkend="APP-PSQL" endterm="APP-PSQL-title"> for possibilities.
See <xref linkend="SQL-CREATEDATABASE">
and <xref linkend="APP-PSQL"> for possibilities.
</para>
</refsect2>
</refsynopsisdiv>
......@@ -197,7 +197,7 @@ Postgres documentation
<acronym>SQL</acronym> command
<xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-title"> via
the <productname>Postgres</productname> interactive terminal
<xref linkend="APP-PSQL" endterm="APP-PSQL-title">. Thus, there is nothing
<xref linkend="APP-PSQL">. Thus, there is nothing
special about creating databases via this or other methods. This means
that the <application>psql</application> must be found by the script and that
a database server is running at the targeted host. Also, any default
......
doc/src/sgml/ref/createlang.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.14 2000/11/22 01:41:13 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.15 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -132,7 +132,7 @@ Postgres documentation
Most error messages are self-explanatory. If not, run
<application>createlang</application> with the <option>--echo</option>
option and see under the respective <acronym>SQL</acronym> command
for details. Check also under <xref linkend="APP-PSQL" endterm="APP-PSQL-title">
for details. Check also under <xref linkend="APP-PSQL">
for more possibilities.
</para>
</refsect2>
......@@ -165,8 +165,7 @@ Postgres documentation
Notes
</title>
<para>
Use <xref linkend="app-droplang" endterm="app-droplang-title">
to remove a language.
Use <xref linkend="app-droplang"> to remove a language.
</para>
</refsect1>
......
doc/src/sgml/ref/createuser.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.14 2000/11/22 01:41:13 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.15 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -149,7 +149,7 @@ Postgres documentation
<para>
The options <literal>-h</literal>, <literal>-p</literal>, and <literal>-e</literal>,
are passed on literally to <xref linkend="APP-PSQL" endterm="APP-PSQL-title">. The
are passed on literally to <xref linkend="APP-PSQL">. The
<application>psql</application> options <literal>-U</literal> and <literal>-W</literal>
are available as well, but their use can be confusing in this context.
</para>
......@@ -183,7 +183,7 @@ Postgres documentation
If there is an error condition, the backend error message will be displayed.
See <xref linkend="SQL-CREATEUSER" endterm="SQL-CREATEUSER-title">
and <xref linkend="APP-PSQL" endterm="APP-PSQL-title"> for possibilities.
and <xref linkend="APP-PSQL"> for possibilities.
</para>
</refsect2>
</refsynopsisdiv>
......@@ -205,7 +205,7 @@ Postgres documentation
<acronym>SQL</acronym> command
<xref linkend="SQL-CREATEUSER" endterm="SQL-CREATEUSER-title"> via
the <productname>Postgres</productname> interactive terminal
<xref linkend="APP-PSQL" endterm="APP-PSQL-title">. Thus, there is nothing
<xref linkend="APP-PSQL">. Thus, there is nothing
special about creating users via this or other methods. This means
that the <application>psql</application> must be found by the script and that
a database server is running at the targeted host. Also, any default
......
doc/src/sgml/ref/declare.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/declare.sgml,v 1.10 2000/10/05 19:48:18 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/declare.sgml,v 1.11 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -191,7 +191,7 @@ ERROR: Named portals may only be used in begin/end transaction blocks
can be used to retrieve
a small number of rows at a time out of a larger query. Cursors can
return data either in text or in binary format using
<xref linkend="sql-fetch-title" endterm="sql-fetch-title">.
<xref linkend="sql-fetch" endterm="sql-fetch-title">.
</para>
<para>
......@@ -253,10 +253,10 @@ ERROR: Named portals may only be used in begin/end transaction blocks
<para>
Cursors are only available in transactions. Use to
<xref linkend="sql-begin-title" endterm="sql-begin-title">,
<xref linkend="sql-commit-title" endterm="sql-commit-title">
<xref linkend="sql-begin" endterm="sql-begin-title">,
<xref linkend="sql-commit" endterm="sql-commit-title">
and
<xref linkend="sql-rollback-title" endterm="sql-rollback-title">
<xref linkend="sql-rollback" endterm="sql-rollback-title">
to define a transaction block.
</para>
......
doc/src/sgml/ref/drop_aggregate.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.9 2000/10/23 00:46:07 tgl Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_aggregate.sgml,v 1.10 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -118,7 +118,7 @@ ERROR: RemoveAggregate: aggregate '<replaceable class="parameter">agg</replaceab
<para>
Use
<xref linkend="sql-createaggregate-title" endterm="sql-createaggregate-title">
<xref linkend="sql-createaggregate" endterm="sql-createaggregate-title">
to create aggregate functions.
</para>
</refsect2>
......
doc/src/sgml/ref/drop_function.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_function.sgml,v 1.8 2000/05/18 14:24:33 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_function.sgml,v 1.9 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -116,7 +116,7 @@ NOTICE RemoveFunction: Function "<replaceable class="parameter">name</replaceabl
<para>
Refer to
<xref linkend="sql-createfunction-title" endterm="sql-createfunction-title">
<xref linkend="sql-createfunction" endterm="sql-createfunction-title">
for information on creating aggregate functions.
</para>
......
doc/src/sgml/ref/drop_index.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_index.sgml,v 1.8 2000/10/22 23:32:38 tgl Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_index.sgml,v 1.9 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -108,7 +108,7 @@ ERROR: index "<replaceable class="PARAMETER">index_name</replaceable>" does not
</para>
<para>
Refer to
<xref linkend="sql-createindex-title" endterm="sql-createindex-title">
<xref linkend="sql-createindex" endterm="sql-createindex-title">
for information on how to create indexes.
</para>
</refsect2>
......
doc/src/sgml/ref/drop_language.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_language.sgml,v 1.8 2000/11/04 21:04:54 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_language.sgml,v 1.9 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -110,7 +110,7 @@ ERROR: Language "<replaceable class="parameter">name</replaceable>" doesn't exis
</para>
<para>
Refer to
<xref linkend="sql-createlanguage-title" endterm="sql-createlanguage-title">
<xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
for information on how to create procedural languages.
</para>
......
doc/src/sgml/ref/drop_operator.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_operator.sgml,v 1.8 2000/10/23 00:46:07 tgl Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/drop_operator.sgml,v 1.9 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -154,7 +154,7 @@ ERROR: RemoveOperator: right unary operator '<replaceable class="PARAMETER">ope
</para>
<para>
Refer to
<xref linkend="sql-createoperator-title" endterm="sql-createoperator-title">
<xref linkend="sql-createoperator" endterm="sql-createoperator-title">
for information on how to create operators.
</para>
<para>
......
doc/src/sgml/ref/dropdb.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.8 2000/11/22 01:41:13 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.9 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -116,7 +116,7 @@ Postgres documentation
The options <literal>-h</literal>, <literal>-p</literal>, <literal>-U</literal>,
<literal>-W</literal>, and <literal>-e</literal> are passed on literally to
<xref linkend="APP-PSQL" endterm="APP-PSQL-title">.
<xref linkend="APP-PSQL">.
</para>
</refsect2>
......@@ -145,7 +145,7 @@ Postgres documentation
If there is an error condition, the backend error message will be displayed.
See <xref linkend="SQL-DROPDATABASE" endterm="SQL-DROPDATABASE-title">
and <xref linkend="APP-PSQL" endterm="APP-PSQL-title"> for possibilities.
and <xref linkend="APP-PSQL"> for possibilities.
</para>
</refsect2>
</refsynopsisdiv>
......@@ -167,7 +167,7 @@ Postgres documentation
<acronym>SQL</acronym> command
<xref linkend="SQL-DROPDATABASE" endterm="SQL-DROPDATABASE-title"> via
the <productname>Postgres</productname> interactive terminal
<xref linkend="APP-PSQL" endterm="APP-PSQL-title">. Thus, there is nothing
<xref linkend="APP-PSQL">. Thus, there is nothing
special about dropping databases via this or other methods. This means
that the <application>psql</application> must be found by the script and that
a database server is running at the targeted host. Also, any default
......
doc/src/sgml/ref/droplang.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.8 2000/11/22 01:41:13 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.9 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -132,7 +132,7 @@ Postgres documentation
Most error messages are self-explanatory. If not, run
<application>droplang</application> with the <option>--echo</option>
option and see under the respective <acronym>SQL</acronym> command
for details. Check also under <xref linkend="APP-PSQL" endterm="APP-PSQL-title">
for details. Check also under <xref linkend="APP-PSQL">
for more possibilities.
</para>
</refsect2>
......@@ -166,8 +166,7 @@ Postgres documentation
</title>
<para>
Use <xref linkend="app-createlang" endterm="app-createlang-title">
to add a language.
Use <xref linkend="app-createlang"> to add a language.
</para>
</refsect1>
......
doc/src/sgml/ref/dropuser.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.9 2000/11/22 01:41:13 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.10 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -99,7 +99,7 @@ Postgres documentation
<para>
The options <literal>-h</literal>, <literal>-p</literal>, and <literal>-e</literal>,
are passed on literally to <xref linkend="APP-PSQL" endterm="APP-PSQL-title">. The
are passed on literally to <xref linkend="APP-PSQL">. The
<application>psql</application> options <literal>-U</literal> and <literal>-W</literal>
are available as well, but they can be confusing in this context.
</para>
......@@ -134,7 +134,7 @@ Postgres documentation
If there is an error condition, the backend error message will be displayed.
See <xref linkend="SQL-DROPUSER" endterm="SQL-DROPUSER-title">
and <xref linkend="APP-PSQL" endterm="APP-PSQL-title"> for possibilities.
and <xref linkend="APP-PSQL"> for possibilities.
</para>
</refsect2>
</refsynopsisdiv>
......@@ -157,7 +157,7 @@ Postgres documentation
<acronym>SQL</acronym> command
<xref linkend="SQL-DROPUSER" endterm="SQL-DROPUSER-title"> via
the <productname>Postgres</productname> interactive terminal
<xref linkend="APP-PSQL" endterm="APP-PSQL-title">. Thus, there is nothing
<xref linkend="APP-PSQL">. Thus, there is nothing
special about removing users via this or other methods. This means
that the <application>psql</application> must be found by the script and that
a database server is running at the targeted host. Also, any default
......
doc/src/sgml/ref/ecpg-ref.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.5 2000/10/05 19:48:18 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.6 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -8,6 +8,7 @@ Postgres documentation
<refentrytitle id="app-ecpg-title">
<application>ecpg</application>
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -75,7 +76,7 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ] file1 [ file2 ] [ ... ]
<term>-o</term>
<listitem>
<para>
Specifies that ecpg should write all its output to outfile.
Specifies that <application>ecpg</application> should write all its output to outfile.
If no such option is given the output is written to
<filename><replaceable>name</replaceable>.c</filename>,
assuming the input file was
......@@ -115,7 +116,7 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ] file1 [ file2 ] [ ... ]
<term><replaceable>return value</replaceable></term>
<listitem>
<para>
ecpg returns 0 to the shell on successful completion, -1
<application>ecpg</application> returns 0 to the shell on successful completion, -1
for errors.
</para>
</listitem>
......@@ -135,12 +136,12 @@ ecpg [ -v ] [ -t ] [ -I include-path ] [ -o outfile ] file1 [ file2 ] [ ... ]
</para>
<para>
<ulink url="mailto:linus@epact.se">Linus Tolke</ulink> was the
Linus Tolke (<email>linus@epact.se</email>) was the
original author of <application>ecpg</application> (up to version 0.2).
<ulink url="mailto:meskes@debian.org">Michael Meskes</ulink>
Michael Meskes (<email>meskes@debian.org</email>)
is the current author and maintainer of <application>ecpg</application>.
<ulink url="mailto:tomg@q8.nrnet.org">Thomas Good</ulink>
is the author of the last revision of the ecpg man page, on which
Thomas Good (<email>tomg@q8.nrnet.org</email>)
is the author of the last revision of the <application>ecpg</application> man page, on which
this document is based.
</para>
</refsect1>
......@@ -203,7 +204,7 @@ gcc -g -I /usr/local/pgsql/include [ -o <replaceable>file</replaceable> ] <repla
<title>Variable Declaration</title>
<para>
Variables declared within ecpg source code must be prepended with:
Variables declared within <application>ecpg</application> source code must be prepended with:
<programlisting>
EXEC SQL BEGIN DECLARE SECTION;
......@@ -247,8 +248,8 @@ EXEC SQL INCLUDE sqlca;
followed, i.e., using uppercase to separate embedded SQL
from C statements, sqlca (which includes the sqlca.h
header file) MUST be lowercase. This is because the EXEC SQL
prefix indicates that this INCLUDE will be parsed by ecpg.
ecpg observes case sensitivity (SQLCA.h will not be found).
prefix indicates that this INCLUDE will be parsed by <application>ecpg</application>.
<application>ecpg</application> observes case sensitivity (SQLCA.h will not be found).
<command>EXEC SQL INCLUDE</command>
can be used to include other header files
as long as case sensitivity is observed.
......
doc/src/sgml/ref/end.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/end.sgml,v 1.3 2000/03/27 17:14:43 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/end.sgml,v 1.4 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -96,7 +96,7 @@ NOTICE: COMMIT: no transaction in progress
<para>
<command>END</command> is a <productname>Postgres</productname>
extension, and is a synonym for the SQL92-compatible
<xref linkend="sql-commit-title" endterm="sql-commit-title">.
<xref linkend="sql-commit" endterm="sql-commit-title">.
</para>
<refsect2 id="R2-SQL-END-3">
......@@ -111,7 +111,7 @@ NOTICE: COMMIT: no transaction in progress
</para>
<para>
Use <xref linkend="SQL-ROLLBACK-TITLE" endterm="SQL-ROLLBACK-TITLE">
Use <xref linkend="SQL-ROLLBACK" endterm="SQL-ROLLBACK-TITLE">
to abort a transaction.
</para>
</refsect2>
......@@ -146,7 +146,7 @@ END WORK;
<para>
<command>END</command> is a <productname>PostgreSQL</productname>
extension which provides functionality equivalent to
<xref linkend="sql-commit-title" endterm="sql-commit-title">.
<xref linkend="sql-commit" endterm="sql-commit-title">.
</para>
</refsect2>
</refsect1>
......
doc/src/sgml/ref/fetch.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/fetch.sgml,v 1.13 2000/10/05 19:48:18 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/fetch.sgml,v 1.14 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -272,15 +272,15 @@ FETCH RELATIVE 0 FROM <replaceable class="PARAMETER">cursor</replaceable>.
<para>
Use
<xref linkend="sql-move-title" endterm="sql-move-title">
<xref linkend="sql-move" endterm="sql-move-title">
to change cursor position.
<xref linkend="sql-declare-title" endterm="sql-declare-title">
<xref linkend="sql-declare" endterm="sql-declare-title">
will define a cursor.
Refer to
<xref linkend="sql-begin-title" endterm="sql-begin-title">,
<xref linkend="sql-commit-title" endterm="sql-commit-title">,
<xref linkend="sql-begin" endterm="sql-begin-title">,
<xref linkend="sql-commit" endterm="sql-commit-title">,
and
<xref linkend="sql-rollback-title" endterm="sql-rollback-title">
<xref linkend="sql-rollback" endterm="sql-rollback-title">
for further information about transactions.
</para>
</refsect2>
......
doc/src/sgml/ref/initdb.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.13 2000/11/11 23:01:45 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/initdb.sgml,v 1.14 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
<refentry id="APP-INITDB">
<docinfo>
<date>2000-11-11</date>
<date>2000-12-25</date>
</docinfo>
<refmeta>
......@@ -58,7 +58,7 @@ Postgres documentation
<para>
Creating a database system consists of creating the directories in which
the database data will live, generating the shared catalog tables
(tables that don't belong to any particular database), and
(tables that do not belong to any particular database), and
creating the <literal>template1</literal>
database. When you create a new database, everything in the
<literal>template1</literal> database is copied.
......@@ -94,11 +94,13 @@ Postgres documentation
<term>-D <replaceable class="parameter">dbdir</replaceable></term>
<listitem>
<para>
This option specifies where in the file system the database should be
stored. This is the only information required by initdb, but you can avoid
it by setting the <envar>PGDATA</envar> environment variable, which
can be convenient since the database server (<filename>postmaster</filename>)
can find the database directory later by the same variable.
This option specifies where in the file system the database
should be stored. This is the only information required by
<application>initdb</application>, but you can avoid it by
setting the <envar>PGDATA</envar> environment variable, which
can be convenient since the database server
(<filename>postmaster</filename>) can find the database
directory later by the same variable.
</para>
</listitem>
</varlistentry>
......@@ -108,10 +110,11 @@ Postgres documentation
<term>-i <replaceable class="parameter">sysid</replaceable></term>
<listitem>
<para>
Selects the system id of the database superuser. This defaults to
the effective user id of the user running initdb. It is really
not important what the superuser's sysid is, but one might choose
to start the numbering at some number like 1.
Selects the system id of the database superuser. This defaults
to the effective user id of the user running
<application>initdb</application>. It is really not important
what the superuser's sysid is, but one might choose to start
the numbering at some number like 1.
</para>
</listitem>
</varlistentry>
......@@ -121,10 +124,11 @@ Postgres documentation
<term>-W</term>
<listitem>
<para>
Makes initdb prompt for a password of the database superuser. If you
don't plan on using password authentication, this is not important.
Otherwise you won't be able to use password authentication until
you have a password set up.
Makes <application>initdb</application> prompt for a password
of the database superuser. If you don't plan on using password
authentication, this is not important. Otherwise you won't be
able to use password authentication until you have a password
set up.
</para>
</listitem>
</varlistentry>
......@@ -154,10 +158,10 @@ Postgres documentation
<term>-L <replaceable class="parameter">directory</replaceable></term>
<listitem>
<para>
Specifies where initdb should find its input files to
initialize the database system. This is normally not
necessary. You will be told if you need to specify their
location explicitly.
Specifies where <application>initdb</application> should find
its input files to initialize the database system. This is
normally not necessary. You will be told if you need to
specify their location explicitly.
</para>
</listitem>
</varlistentry>
......
doc/src/sgml/ref/insert.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.11 2000/10/20 14:02:12 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/insert.sgml,v 1.12 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -227,7 +227,7 @@ INSERT INTO tictactoe (game, board)
Possible limitations in features of the
<replaceable class="PARAMETER">query</replaceable>
clause are documented for
<xref linkend="sql-select-title" endterm="sql-select-title">.
<xref linkend="sql-select" endterm="sql-select-title">.
</para>
</refsect2>
</refsect1>
......
doc/src/sgml/ref/listen.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/listen.sgml,v 1.8 2000/03/26 18:32:27 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/listen.sgml,v 1.9 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -128,7 +128,7 @@ NOTICE Async_Listen: We are already listening on <replaceable class="PARAMETER">
</para>
<para>
<xref linkend="sql-notify-title" endterm="sql-notify-title">
<xref linkend="sql-notify" endterm="sql-notify-title">
contains a more extensive
discussion of the use of <command>LISTEN</command> and
<command>NOTIFY</command>.
......
doc/src/sgml/ref/lock.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/lock.sgml,v 1.22 2000/10/05 19:48:18 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/lock.sgml,v 1.23 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -434,7 +434,7 @@ COMMIT WORK;
There is no <command>LOCK TABLE</command> in <acronym>SQL92</acronym>,
which instead uses <command>SET TRANSACTION</command> to specify
concurrency levels on transactions. We support that too; see
<xref linkend="SQL-SET-TITLE" endterm="SQL-SET-TITLE"> for details.
<xref linkend="SQL-SET-TRANSACTION" endterm="SQL-SET-TRANSACTION-TITLE"> for details.
</para>
</refsect2>
</refsect1>
......
doc/src/sgml/ref/move.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/move.sgml,v 1.9 2000/05/11 17:32:33 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/move.sgml,v 1.10 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -44,7 +44,7 @@ MOVE [ <replaceable class="PARAMETER">direction</replaceable> ] [ <replaceable c
</para>
<para>
Refer to
<xref linkend="sql-fetch-title" endterm="sql-fetch-title">
<xref linkend="sql-fetch" endterm="sql-fetch-title">
for details on syntax and usage.
</para>
......@@ -63,16 +63,16 @@ MOVE [ <replaceable class="PARAMETER">direction</replaceable> ] [ <replaceable c
<para>
Refer to
<xref linkend="sql-fetch-title" endterm="sql-fetch-title">
<xref linkend="sql-fetch" endterm="sql-fetch-title">
for a description of valid arguments.
Refer to
<xref linkend="sql-declare-title" endterm="sql-declare-title">
<xref linkend="sql-declare" endterm="sql-declare-title">
to define a cursor.
Refer to
<xref linkend="sql-begin-title" endterm="sql-begin-title">,
<xref linkend="sql-commit-title" endterm="sql-commit-title">,
<xref linkend="sql-begin" endterm="sql-begin-title">,
<xref linkend="sql-commit" endterm="sql-commit-title">,
and
<xref linkend="sql-rollback-title" endterm="sql-rollback-title">
<xref linkend="sql-rollback" endterm="sql-rollback-title">
for further information about transactions.
</para>
</refsect2>
......
doc/src/sgml/ref/pg_ctl-ref.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.4 2000/11/25 17:17:30 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.5 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -64,9 +64,8 @@ Postgres documentation
<title>Description</title>
<para>
<application>pg_ctl</application> is a utility for starting,
stopping, or restarting the <xref linkend="app-postmaster"
endterm="app-postmaster-title">, or displaying the status of a
running postmaster.
stopping, or restarting the <xref linkend="app-postmaster">, or
displaying the status of a running postmaster.
</para>
<refsect2 id="app-pg-ctl-options">
......
doc/src/sgml/ref/pg_dump.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.26 2000/11/30 23:20:50 tgl Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.27 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
<refentry id="APP-PGDUMP">
<docinfo>
<date>2000-12-25</date>
</docinfo>
<refmeta>
<refentrytitle id="app-pgdump-title">
<application>pg_dump</application>
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -443,7 +448,7 @@ dumpSequence(<replaceable class="parameter">table</replaceable>): SELECT failed
and other architectures.
</para>
<para>
The archive files, new with this v7.1, contain enough information for
The archive files, new with version 7.1, contain enough information for
<APPLICATION>pg_restore</APPLICATION> to rebuild the database, but also
allow pg_restore to be selective about what is restored, or even to
reorder the items prior to being restored. The archive files should
......
doc/src/sgml/ref/pg_dumpall.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.17 2000/12/19 22:12:46 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.18 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -36,9 +36,9 @@ Postgres documentation
<application>pg_dumpall</application> is a utility for writing out
(<quote>dumping</quote>) all Postgres databases of a cluster into
one script file. The script file contains SQL commands that can be
used as input to <xref linkend="app-psql" endterm="app-psql-title">
used as input to <xref linkend="app-psql">
to restore the databases. It does this by calling <xref
linkend="app-pgdump" endterm="app-pgdump-title"> for each database
linkend="app-pgdump"> for each database
in a cluster. <application>pg_dumpall</application> also dumps
global objects that are common to all databases.
(<application>pg_dump</application> does not save these objects.)
......@@ -110,7 +110,7 @@ Postgres documentation
<para>
Any other command line parameters are passed to the underlying
<xref endterm="app-pgdump-title" linkend="app-pgdump-title">
<xref linkend="app-pgdump">
calls. This is useful to control some aspects of the output
format, but some options such as <option>-f</option>,
<option>-t</option>, and <replaceable
......@@ -145,9 +145,8 @@ Postgres documentation
<title>See Also</title>
<para>
<xref linkend="app-pgdump" endterm="app-pgdump-title">, <xref
linkend="app-psql" endterm="app-psql-title">. Check there for
details on possible error conditions.
<xref linkend="app-pgdump">, <xref linkend="app-psql">. Check
there for details on possible error conditions.
</para>
</refsect1>
......
doc/src/sgml/ref/pg_passwd.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pg_passwd.sgml,v 1.4 2000/11/18 19:05:58 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pg_passwd.sgml,v 1.5 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -49,7 +49,7 @@ Postgres documentation
</para>
<para>
Supply the name of the password file as argument to the pg_passwd
Supply the name of the password file as argument to the <application>pg_passwd</application>
command. To be of use for client authentication the file needs to
be location in the server's data directory, and the base name of
the file needs to be specified in the
......@@ -88,7 +88,7 @@ host unv 133.65.96.250 255.255.255.255 password passwords
<note>
<para>
It is also useful to have entries in password file with an empty
It is also useful to have entries in a password file with an empty
password field. (This is different from an empty password.)
These entries cannot be managed by
<application>pg_passwd</application>, but it is always possible to
......
doc/src/sgml/ref/pg_restore.sgml
View file @ dccfd749
......@@ -3,6 +3,7 @@
<refentrytitle id="app-pgrestore-title">
<application>pg_restore</application>
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
......
doc/src/sgml/ref/pg_upgrade.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pg_upgrade.sgml,v 1.11 2000/07/22 02:39:10 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pg_upgrade.sgml,v 1.12 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -8,6 +8,7 @@ Postgres documentation
<refentrytitle id="APP-PG-UPGRADE-TITLE">
<application>pg_upgrade</application>
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
......
doc/src/sgml/ref/pgaccess-ref.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgaccess-ref.sgml,v 1.5 2000/10/05 19:48:18 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgaccess-ref.sgml,v 1.6 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -8,6 +8,7 @@ Postgres documentation
<refentrytitle id="app-pgaccess-title">
<application>pgaccess</application>
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -69,9 +70,9 @@ pgaccess [ <replaceable class="parameter">dbname</replaceable> ]
<para>
Another way of accessing <productname>Postgres</productname>
through tcl is to use
<xref linkend="app-pgtclsh" endterm="app-pgtclsh-title">
<xref linkend="app-pgtclsh">
or
<xref linkend="app-pgtksh" endterm="app-pgtksh-title">.
<xref linkend="app-pgtksh">.
</para>
<para>
......
doc/src/sgml/ref/pgadmin-ref.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgadmin-ref.sgml,v 1.6 2000/03/27 17:14:43 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgadmin-ref.sgml,v 1.7 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -8,6 +8,7 @@ Postgres documentation
<refentrytitle id="app-pgadmin-title">
<application>pgadmin</application>
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
......
doc/src/sgml/ref/pgtclsh.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.1 1999/08/06 13:50:31 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtclsh.sgml,v 1.2 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
<refentry id="APP-PGTCLSH">
<docinfo>
<date>2000-12-25</date>
</docinfo>
<refmeta>
<refentrytitle id="app-pgtclsh-title">
<application>pgtclsh</application>
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -19,12 +24,9 @@ Postgres documentation
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<refsynopsisdivinfo>
<date>1999-08-03</date>
</refsynopsisdivinfo>
<synopsis>
pgtclsh [ <replaceable class="parameter">dbname</replaceable> ]
</synopsis>
<cmdsynopsis>
<command>pgtclsh</command>
</cmdsynopsis>
<refsect2 id="R2-APP-PGTCLSH-1">
<title>
......@@ -66,9 +68,9 @@ pgtclsh [ <replaceable class="parameter">dbname</replaceable> ]
<para>
Another way of accessing <productname>Postgres</productname>
through tcl is to use
<xref linkend="app-pgtksh" endterm="app-pgtksh-title">
<xref linkend="app-pgtksh">
or
<xref linkend="app-pgaccess" endterm="app-pgaccess-title">.
<xref linkend="app-pgaccess">.
</para>
</refsect1>
</refentry>
......
doc/src/sgml/ref/pgtksh.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.1 1999/08/06 13:50:31 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/pgtksh.sgml,v 1.2 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
<refentry id="APP-PGTKSH">
<docinfo>
<date>2000-12-25</date>
</docinfo>
<refmeta>
<refentrytitle id="app-pgtksh-title">
<application>pgtksh</application>
</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -19,12 +24,9 @@ Postgres documentation
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<refsynopsisdivinfo>
<date>1999-08-03</date>
</refsynopsisdivinfo>
<synopsis>
pgtksh [ <replaceable class="parameter">dbname</replaceable> ]
</synopsis>
<cmdsynopsis>
<command>pgtksh</command>
</cmdsynopsis>
<refsect2 id="R2-APP-PGTKSH-1">
<title>
......@@ -66,9 +68,9 @@ pgtksh [ <replaceable class="parameter">dbname</replaceable> ]
<para>
Another way of accessing <productname>Postgres</productname>
through <acronym>TCL</acronym> is to use
<xref linkend="app-pgtclsh" endterm="app-pgtclsh-title">
<xref linkend="app-pgtclsh">
or
<xref linkend="app-pgaccess" endterm="app-pgaccess-title">.
<xref linkend="app-pgaccess">.
</para>
</refsect1>
</refentry>
......
doc/src/sgml/ref/postgres-ref.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.15 2000/11/14 18:11:31 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.16 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -80,13 +80,12 @@ Postgres documentation
<productname>PostgreSQL</productname> server process that processes
queries. The second form above is how
<application>postgres</application> is invoked by the <xref
linkend="app-postmaster" endterm="app-postmaster-title"> (only
linkend="app-postmaster"> (only
conceptually, since both <filename>postmaster</filename> and
<filename>postgres</filename> are in fact the same program); it
should not be invoked directly this way. The first form invokes
the server directly in interactive mode. The primary use for this
mode is for bootstrapping by <xref linkend="app-initdb"
endterm="app-initdb-title">.
mode is for bootstrapping by <xref linkend="app-initdb">.
</para>
<para>
......@@ -109,7 +108,7 @@ Postgres documentation
<para>
When <application>postgres</application> is started by a <xref
linkend="app-postmaster" endterm="app-postmaster-title"> then it
linkend="app-postmaster"> then it
inherits all options set by the latter. Additionally,
<application>postgres</application>-specific options can be passed
from the <application>postmaster</application> with the
......@@ -134,7 +133,7 @@ Postgres documentation
The options <option>-A</option>, <option>-B</option>,
<option>-c</option>, <option>-d</option>, <option>-D</option>,
and <option>-F</option> have the same meaning as with the <xref
linkend="app-postmaster" endterm="app-postmaster-title">.
linkend="app-postmaster">.
</para>
<variablelist>
......@@ -358,9 +357,9 @@ Postgres documentation
<title>See also</title>
<para>
<xref linkend="app-initdb" endterm="app-initdb-title">,
<xref linkend="app-ipcclean" endterm="app-ipcclean-title">,
<xref linkend="app-postmaster" endterm="app-postmaster-title">
<xref linkend="app-initdb">,
<xref linkend="app-ipcclean">,
<xref linkend="app-postmaster">
</para>
</refsect1>
......
doc/src/sgml/ref/postmaster.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.18 2000/11/30 23:20:50 tgl Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.19 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
<refentry id="APP-POSTMASTER">
<refentry id="app-postmaster">
<docinfo>
<date>2000-11-30</date>
<date>2000-12-25</date>
</docinfo>
<refmeta>
......@@ -50,31 +50,30 @@ Postgres documentation
(over a network or locally) to a running
<application>postmaster</application>. The
<application>postmaster</application> then starts a separate server
process (<quote><xref linkend="app-postgres"
endterm="app-postgres-title"></quote>) to handle the connection.
The postmaster also manages the communication among server
processes.
process (<quote><xref linkend="app-postgres"></quote>) to handle
the connection. The <application>postmaster</application> also
manages the communication among server processes.
</para>
<para>
By default the postmaster starts in the foreground and prints log
messages to the standard output. In practical applications the
postmaster should be started as a background process, perhaps at
boot time.
By default the <application>postmaster</application> starts in the
foreground and prints log messages to the standard output. In
practical applications the <application>postmaster</application>
should be started as a background process, perhaps at boot time.
</para>
<para>
One postmaster always manages the data from exactly one database
cluster. A database cluster is a collection of databases that is
stored at a common file system location. When the postmaster
starts it needs to know the location of the database cluster files
(<quote>data area</quote>). This is done with the
<option>-D</option> invocation option or the <envar>PGDATA</envar>
environment variable; there is no default. More than one
postmaster process can run on a system at one time, as long as they
use different data areas and different communication ports (see below).
A data area is created with <xref linkend="app-initdb"
endterm="app-initdb-title">.
One <application>postmaster</application> always manages the data
from exactly one database cluster. A database cluster is a
collection of databases that is stored at a common file system
location. When the postmaster starts it needs to know the location
of the database cluster files (<quote>data area</quote>). This is
done with the <option>-D</option> invocation option or the
<envar>PGDATA</envar> environment variable; there is no default.
More than one postmaster process can run on a system at one time,
as long as they use different data areas and different
communication ports (see below). A data area is created with <xref
linkend="app-initdb">.
</para>
<refsect2 id="app-postmaster-options">
......@@ -183,7 +182,7 @@ Postgres documentation
</varlistentry>
<varlistentry>
<term>-k <replaceable class="parameter">directoryname</replaceable></term>
<term>-k <replaceable class="parameter">directory</replaceable></term>
<listitem>
<para>
Specifies the directory of the Unix-domain socket on which the
......@@ -210,10 +209,11 @@ Postgres documentation
<listitem>
<para>
Sets the maximum number of client connections that this
postmaster will accept. By default, this value is 32, but it
can be set as high as 1024 if your system will support that
many processes. (Note that <option>-B</option> is required to
be at least twice <option>-N</option>.)
<application>postmaster</application> will accept. By
default, this value is 32, but it can be set as high as 1024
if your system will support that many processes. (Note that
<option>-B</option> is required to be at least twice
<option>-N</option>.)
</para>
</listitem>
</varlistentry>
......@@ -223,12 +223,11 @@ Postgres documentation
<listitem>
<para>
The command line-style options specified in <replaceable
class="parameter">EXTRA-OPTIONS</replaceable> are passed to
class="parameter">extra-options</replaceable> are passed to
all backend server processes started by this
<application>postmaster</application>. See <xref
linkend="app-postgres" endterm="app-postgres-title"> for
possibilities. If the option string contains any spaces, the
entire string must be quoted.
linkend="app-postgres"> for possibilities. If the option
string contains any spaces, the entire string must be quoted.
</para>
</listitem>
</varlistentry>
......@@ -264,7 +263,7 @@ Postgres documentation
Using this switch discards all logging output, which is
probably not what you want, since it makes it very difficult
to troubleshoot problems. See below for a better way to start
the postmaster in the background.
the <application>postmaster</application> in the background.
</para>
</listitem>
</varlistentry>
......@@ -367,14 +366,14 @@ StreamServerPort: cannot bind to port
other <application>postmaster</application>
process already running on the same port number. The easiest way to
determine this is by using the command
<programlisting>
$ ps -ax | grep postmaster
</programlisting>
on BSD-based systems, or
<programlisting>
$ ps -e | grep postmast
</programlisting>
for System V-like or POSIX-compliant systems such as HP-UX.
<screen>
<prompt>$</prompt> <userinput>ps ax | grep postmaster</userinput>
</screen>
or
<screen>
<prompt>$</prompt> <userinput>ps -e | grep postmaster</userinput>
</screen>
depending on your system.
</para>
<para>
......@@ -414,9 +413,9 @@ $ ps -e | grep postmast
</para>
<para>
To terminate the postmaster normally, the signals
<literal>SIGTERM</literal>, <literal>SIGINT</literal>, or
<literal>SIGQUIT</literal> can be used. The first will wait for
To terminate the <application>postmaster</application> normally,
the signals <literal>SIGTERM</literal>, <literal>SIGINT</literal>,
or <literal>SIGQUIT</literal> can be used. The first will wait for
all clients to terminate before quitting, the second will
forcefully disconnect all clients, and the third will quit
immediately without lengthy shutdown, resulting in a recovery run
......@@ -425,7 +424,8 @@ $ ps -e | grep postmast
<para>
The utility command <xref linkend="app-pg-ctl"> can be used to
start and shut down the postmaster safely and comfortably.
start and shut down the <application>postmaster</application>
safely and comfortably.
</para>
</refsect1>
......
doc/src/sgml/ref/psql-ref.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.44 2000/11/22 01:41:13 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.45 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
<refentry id="APP-PSQL">
<docinfo>
<date>2000-12-25</date>
</docinfo>
<refmeta>
<refentrytitle id="app-psql-title">
<application>psql</application>
</refentrytitle>
<refentrytitle id="app-psql-title"><application>psql</application></refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
<refname>
<application>psql</application>
</refname>
<refname><application>psql</application></refname>
<refpurpose>
<productname>Postgres</productname> interactive terminal
</refpurpose>
......
doc/src/sgml/ref/reset.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.9 2000/06/18 21:24:51 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.10 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -26,7 +26,7 @@ RESET <replaceable class="PARAMETER">variable</replaceable>
<listitem>
<para>
The name of a run-time parameter. See <xref
linkend="sql-set-title" endterm="sql-set-title"> for a list.
linkend="sql-set" endterm="sql-set-title"> for a list.
</para>
</listitem>
</varlistentry>
......@@ -41,7 +41,7 @@ RESET <replaceable class="PARAMETER">variable</replaceable>
<para>
<command>RESET</command> restores run-time parameters to their
default values. Refer to
<xref linkend="sql-set-title" endterm="sql-set-title">
<xref linkend="sql-set" endterm="sql-set-title">
for details. <command>RESET</command> is an alternate form for
<synopsis>
......@@ -53,7 +53,7 @@ SET <replaceable class="parameter">variable</replaceable> TO DEFAULT
<refsect1>
<title>Diagnostics</title>
<para>
See under the <xref linkend="sql-set-title"
See under the <xref linkend="sql-set"
endterm="sql-set-title"> command.
</para>
</refsect1>
......
doc/src/sgml/ref/revoke.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/revoke.sgml,v 1.12 2000/10/12 21:23:34 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/revoke.sgml,v 1.13 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -90,7 +90,7 @@ REVOKE <replaceable class="PARAMETER">privilege</replaceable> [, ...]
<para>
Privilege to define rules on table/view.
(See
<xref linkend="sql-createrule-title" endterm="sql-createrule-title">).
<xref linkend="sql-createrule" endterm="sql-createrule-title">).
</para>
</listitem>
</varlistentry>
......@@ -319,7 +319,7 @@ REVOKE { INSERT | UPDATE | REFERENCES } [, ...] [ ( <replaceable class="paramete
<listitem>
<para>
Refer to
<xref linkend="sql-grant-title" endterm="sql-grant-title">
<xref linkend="sql-grant" endterm="sql-grant-title">
for details on individual fields.
</para>
</listitem>
......@@ -338,7 +338,7 @@ REVOKE GRANT OPTION FOR <replaceable class="parameter">privilege</replaceable> [
Rescinds authority for a user to grant the specified privilege
to others.
Refer to
<xref linkend="sql-grant-title" endterm="sql-grant-title">
<xref linkend="sql-grant" endterm="sql-grant-title">
for details on individual fields.
</para>
</listitem>
......
doc/src/sgml/ref/rollback.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/rollback.sgml,v 1.7 2000/01/29 16:58:27 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/rollback.sgml,v 1.8 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -95,9 +95,9 @@ NOTICE: ROLLBACK: no transaction in progress
Notes
</title>
<para>
Use <xref linkend="SQL-COMMIT-TITLE" endterm="SQL-COMMIT-TITLE">
Use <xref linkend="SQL-COMMIT" endterm="SQL-COMMIT-TITLE">
to successfully terminate a transaction.
<xref linkend="SQL-ABORT-TITLE" endterm="SQL-ABORT-TITLE"> is a
<xref linkend="SQL-ABORT" endterm="SQL-ABORT-TITLE"> is a
synonym for <command>ROLLBACK</command>.
</para>
</refsect2>
......
doc/src/sgml/ref/select_into.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/select_into.sgml,v 1.7 2000/12/12 05:07:59 tgl Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/select_into.sgml,v 1.8 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -55,7 +55,7 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be:
</title>
<para>
All input fields are described in detail for
<xref linkend="sql-select-title" endterm="sql-select-title">.
<xref linkend="sql-select" endterm="sql-select-title">.
</para>
</refsect2>
......@@ -68,7 +68,7 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be:
</title>
<para>
All output fields are described in detail for
<xref linkend="sql-select-title" endterm="sql-select-title">.
<xref linkend="sql-select" endterm="sql-select-title">.
</para>
</refsect2>
</refsynopsisdiv>
......@@ -87,7 +87,7 @@ where <replaceable class="PARAMETER">from_item</replaceable> can be:
<note>
<para>
<xref linkend="sql-createtableas-title" endterm="sql-createtableas-title">
<xref linkend="sql-createtableas" endterm="sql-createtableas-title">
is functionally equivalent to the <command>SELECT INTO</command> command.
</para>
</note>
......
doc/src/sgml/ref/show.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.10 2000/06/18 21:24:54 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.11 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -27,7 +27,7 @@ SHOW <replaceable class="PARAMETER">name</replaceable>
<listitem>
<para>
The name of a run-time parameter. See
<xref linkend="sql-set-title" endterm="sql-set-title">
<xref linkend="sql-set" endterm="sql-set-title">
for a list.
</para>
</listitem>
......
doc/src/sgml/ref/unlisten.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/unlisten.sgml,v 1.12 2000/10/05 19:48:19 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/unlisten.sgml,v 1.13 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -100,7 +100,7 @@ UNLISTEN { <replaceable class="PARAMETER">notifyname</replaceable> | * }
</para>
<para>
<xref endterm="sql-notify-title" linkend="sql-notify-title">
<xref endterm="sql-notify-title" linkend="sql-notify">
contains a more extensive
discussion of the use of <command>LISTEN</command> and
<command>NOTIFY</command>.
......
doc/src/sgml/ref/update.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/update.sgml,v 1.12 2000/10/05 19:57:23 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/update.sgml,v 1.13 2000/12/25 23:15:26 petere Exp $
Postgres documentation
-->
......@@ -129,7 +129,7 @@ UPDATE <replaceable class="parameter">#</replaceable>
<para>
Array references use the same syntax found in
<xref linkend="sql-select-title" endterm="sql-select-title">.
<xref linkend="sql-select" endterm="sql-select-title">.
That is, either single array elements, a range of array
elements or the entire array may be replaced with a single
query.
......
doc/src/sgml/ref/vacuumdb.sgml
View file @ dccfd749
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.14 2000/11/22 01:41:13 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.15 2000/12/25 23:15:27 petere Exp $
Postgres documentation
-->
......@@ -202,7 +202,7 @@ Postgres documentation
<para>
Something went wrong. <application>vacuumdb</application> is only a wrapper
script. See <xref linkend="SQL-VACUUM" endterm="SQL-VACUUM-title">
and <xref linkend="APP-PSQL" endterm="APP-PSQL-title"> for a detailed
and <xref linkend="APP-PSQL"> for a detailed
discussion of error messages and potential problems.
</para>
</listitem>
......@@ -234,7 +234,7 @@ Postgres documentation
backend command
<xref linkend="SQL-VACUUM" endterm="SQL-VACUUM-title"> via
the <productname>Postgres</productname> interactive terminal
<xref linkend="APP-PSQL" endterm="APP-PSQL-title">. There is no effective
<xref linkend="APP-PSQL">. There is no effective
difference between vacuuming databases via this or other methods.
<application>psql</application> must be found by the script and
a database server must be running at the targeted host. Also, any default
......
doc/src/sgml/reference.sgml
View file @ dccfd749
<!-- reference.sgml
$Header: /cvsroot/pgsql/doc/src/sgml/reference.sgml,v 1.10 2000/11/25 13:20:05 petere Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/reference.sgml,v 1.11 2000/12/25 23:15:26 petere Exp $
PostgreSQL Reference Manual
-->
......@@ -119,7 +119,7 @@ Disable this chapter until we have more functions documented.
-->
<reference id="reference-client">
<title>Client Applications</title>
<title>PostgreSQL Client Applications</title>
<partintro>
<para>
......@@ -148,7 +148,7 @@ Disable this chapter until we have more functions documented.
</reference>
<reference id="reference-server">
<title>Server Applications and Utilities</title>
<title>PostgreSQL Server Applications</title>
<partintro>
<para>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment