Skip to content

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

Structure reference pages consistently. Document that structure. 

Add information about environment variables.
parent b02c56f5
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 2449 additions and 1858 deletions
doc/src/sgml/docguide.sgml
View file @ 06ad580f
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.41 2002/03/22 19:20:08 petere Exp $ -->
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.42 2002/07/28 15:22:20 petere Exp $ -->
<appendix id="docguide">
<title>Documentation</title>
......@@ -1254,6 +1254,196 @@ End:
</sect1>
<sect1 id="doc-style">
<title>Style Guide</title>
<sect2>
<title>Reference Pages</title>
<para>
Reference pages should follow a standard layout. This allows
users to find the desired information more quickly, and it also
encourages writers to document all relevant aspects of a command.
Consistency is not only desired among
<productname>PostgreSQL</productname> reference pages, but also
with reference pages provided by the operating system and other
packages. Hence the following guidelines have been developed.
They are for the most part consistent with similar guidelines
established by various operating systems.
</para>
<para>
Reference pages that describe executable commands should contain
the following sections, in this order. Sections that do not apply
may be omitted. Additional top-level sections should only be used
in special circumstances; often that information belongs in the
<quote>Usage</quote> section.
<variablelist>
<varlistentry>
<term>Name</term>
<listitem>
<para>
This section is generated automatically. It contains the
command name and a half-sentence summary of its functionality.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Synopsis</term>
<listitem>
<para>
This section contains the syntax diagram of the command. The
synopsis should normally not list each command-line option;
that is done below. Instead, list the major components of the
command line, such as where input and output files go.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Description</term>
<listitem>
<para>
Several paragraphs explaining what the command does.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Options</term>
<listitem>
<para>
A list describing each command-line option. If there are a
lot of options, subsections may be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Exit Status</term>
<listitem>
<para>
If the program uses 0 for success and non-zero for failure,
then you don't need to document it. If there is a meaning
behind the different non-zero exit codes, list them here.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Usage</term>
<listitem>
<para>
Describe any sublanguage or run-time interface of the program.
If the program is not interactive, this section can usually be
omitted. Otherwise, this section is a catch-all for
describing run-time features. Use subsections if appropriate.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Environment</term>
<listitem>
<para>
List all environment variables that the program might use.
Try to be complete; even seemingly trivial variables like
<envar>SHELL</envar> might be of interest to the user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Files</term>
<listitem>
<para>
List any files that the program might access implicitly. That
is, do not list input and output files that were specified on
the command line, but list configuration files, etc.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Diagnostics</term>
<listitem>
<para>
Explain any unusual output that the program might create.
Refrain from listing every possible error message. This is a
lot of work and has little use in practice. But if, say, the
error messages have a standard format that the user can parse,
this would be the place to explain it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Notes</term>
<listitem>
<para>
Anything that doesn't fit elsewhere, but in particular bugs,
implementation flaws, security considerations, compatibility
issues.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Examples</term>
<listitem>
<para>
Examples
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>History</term>
<listitem>
<para>
If there were some major milestones in the history of the
program, they might be listed here. Usually, this section can
be omitted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>See Also</term>
<listitem>
<para>
Cross-references, listed in the following order: other
<productname>PostgreSQL</productname> command reference pages,
<productname>PostgreSQL</productname> SQL command reference
pages, citation of <productname>PostgreSQL</productname>
manuals, other reference pages (e.g., operating system, other
packages), other documentation. Items in the same group are
listed alphabetically.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Reference pages describing SQL commands should contain the
following sections: Name, Synopsis, Description, Parameters,
Usage, Diagnostics, Notes, Examples, Compatibility, History, See
Also. The Parameters section is like the Options section, but
there is more freedom about which clauses of the command can be
listed. The Compatibility section should explain to what extent
this command conforms to the SQL standard(s), or to which other
database system it is compatible. The See Also section of SQL
commands should list SQL commands before cross-references to
programs.
</para>
</sect2>
</sect1>
</appendix>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/createdb.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.26 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.27 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -22,12 +22,42 @@ PostgreSQL documentation
<arg><replaceable>dbname</replaceable></arg>
<arg><replaceable>description</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect2 id="R2-APP-CREATEDB-1">
<title>
Inputs
</title>
<para>
<refsect1 id="R1-APP-CREATEDB-1">
<title>
Description
</title>
<para>
<application>createdb</application> creates a new <productname>PostgreSQL</productname>
database.
</para>
<para>
Normally, the database user who executes this command becomes the owner of
the new database.
However a different owner can be specified via the <option>-O</option>
option, if the executing user has appropriate privileges.
</para>
<para>
<application>createdb</application> is a shell script wrapper around the
<acronym>SQL</acronym> command
<xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<xref linkend="APP-PSQL">. Thus, there is nothing
special about creating databases via this or other methods. This means
that the <application>psql</application> program must be found by the script and that
a database server must be running at the targeted port. Also, any default
settings and environment variables available to <application>psql</application>
and the <application>libpq</application> front-end library will apply.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
......@@ -149,6 +179,7 @@ PostgreSQL documentation
</variablelist>
<para>
The options <option>-h</option>, <option>-p</option>, <option>-U</option>,
<option>-W</option>, and <option>-e</option> are passed on literally to
<xref linkend="app-psql">.
......@@ -160,13 +191,12 @@ PostgreSQL documentation
endterm="SQL-CREATEDATABASE-title">; see there for more information
about them.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>Diagnostics</title>
<refsect2 id="R2-APP-CREATEDB-2">
<title>
Outputs
</title>
<para>
<variablelist>
<varlistentry>
<term><computeroutput>CREATE DATABASE</computeroutput></term>
......@@ -195,45 +225,37 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
<para>
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"> for possibilities.
</para>
</refsect2>
</refsynopsisdiv>
</refsect1>
<refsect1 id="R1-APP-CREATEDB-1">
<title>
Description
</title>
<para>
<application>createdb</application> creates a new <productname>PostgreSQL</productname>
database.
</para>
<para>
Normally, the database user who executes this command becomes the owner of
the new database.
However a different owner can be specified via the <option>-O</option>
option, if the executing user has appropriate privileges.
</para>
<refsect1>
<title>Environment</title>
<para>
<application>createdb</application> is a shell script wrapper around the
<acronym>SQL</acronym> command
<xref linkend="SQL-CREATEDATABASE" endterm="SQL-CREATEDATABASE-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<xref linkend="APP-PSQL">. Thus, there is nothing
special about creating databases via this or other methods. This means
that the <application>psql</application> program must be found by the script and that
a database server must be running at the targeted port. Also, any default
settings and environment variables available to <application>psql</application>
and the <application>libpq</application> front-end library will apply.
</para>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters. <envar>PGUSER</envar> also
determines the name of the database to create, if it is not
specified in the command line.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="R1-APP-CREATEDB-2">
<title>Usage</title>
<title>Examples</title>
<informalexample>
<para>
......@@ -262,6 +284,17 @@ PostgreSQL documentation
</para>
</informalexample>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="app-dropdb"></member>
<member><xref linkend="sql-createdatabase" endterm="sql-createdatabase-title"></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/createlang.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.24 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.25 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -11,7 +11,7 @@ PostgreSQL documentation
</refmeta>
<refnamediv>
<refname id="createlang">createlang</refname>
<refname>createlang</refname>
<refpurpose>define a new <productname>PostgreSQL</productname> procedural language</refpurpose>
</refnamediv>
......@@ -27,11 +27,33 @@ PostgreSQL documentation
<group choice="plain"><arg>--list</arg><arg>-l</arg></group>
<arg choice="plain"><replaceable>dbname</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<application>createlang</application> is a utility for adding a new
programming language to a <productname>PostgreSQL</productname> database.
<application>createlang</application> can handle all the languages
supplied in the default <productname>PostgreSQL</> distribution, but
not languages provided by other parties.
</para>
<para>
Although backend programming languages can be added directly using
several <acronym>SQL</acronym> commands, it is recommended to use
<application>createlang</application> because it performs a number
of checks and is much easier to use. See
<xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
for more.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<refsect2 id="R2-APP-CREATELANG-1">
<title>
Inputs
</title>
<para>
<application>createlang</application> accepts the following command line arguments:
......@@ -138,12 +160,31 @@ PostgreSQL documentation
</variablelist>
</para>
</refsect2>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Diagnostics</title>
<refsect2 id="R2-APP-CREATELANG-2">
<title>
Outputs
</title>
<para>
Most error messages are self-explanatory. If not, run
<application>createlang</application> with the <option>--echo</option>
......@@ -151,35 +192,12 @@ PostgreSQL documentation
for details. Check also under <xref linkend="APP-PSQL">
for more possibilities.
</para>
</refsect2>
</refsynopsisdiv>
<refsect1 id="R1-APP-CREATELANG-1">
<title>
Description
</title>
<para>
<application>createlang</application> is a utility for adding a new
programming language to a <productname>PostgreSQL</productname> database.
<application>createlang</application> can handle all the languages
supplied in the default <productname>PostgreSQL</> distribution, but
not languages provided by other parties.
</para>
<para>
Although backend programming languages can be added directly using
several <acronym>SQL</acronym> commands, it is recommended to use
<application>createlang</application> because it performs a number
of checks and is much easier to use. See
<xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
for more.
</para>
</refsect1>
<refsect1 id="R1-APP-CREATELANG-2">
<title>
Notes
</title>
<refsect1>
<title>Notes</title>
<para>
Use <xref linkend="app-droplang"> to remove a language.
</para>
......@@ -192,8 +210,9 @@ PostgreSQL documentation
</para>
</refsect1>
<refsect1 id="R1-APP-CREATELANG-3">
<title>Usage</title>
<refsect1>
<title>Examples</title>
<informalexample>
<para>
......@@ -205,6 +224,16 @@ PostgreSQL documentation
</para>
</informalexample>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="app-droplang"></member>
<member><xref linkend="sql-createlanguage" endterm="sql-createlanguage-title"></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/createuser.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.25 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createuser.sgml,v 1.26 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -21,12 +21,46 @@ PostgreSQL documentation
<arg rep="repeat"><replaceable>options</replaceable></arg>
<arg><replaceable>username</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect2 id="R2-APP-CREATEUSER-1">
<title>
Inputs
</title>
<para>
<refsect1>
<title>Description</title>
<para>
<application>createuser</application> creates a
new <productname>PostgreSQL</productname> user.
Only superusers (users with <literal>usesuper</literal> set in
the <literal>pg_shadow</literal> table) can create
new <productname>PostgreSQL</productname> users,
so <application>createuser</application> must be
invoked by someone who is a <productname>PostgreSQL</productname>
superuser.
</para>
<para>
Being a superuser also implies the ability to bypass access permission
checks within the database, so superuser-dom should not be granted lightly.
</para>
<para>
<application>createuser</application> is a shell script wrapper around the
<acronym>SQL</acronym> command
<xref linkend="SQL-CREATEUSER" endterm="SQL-CREATEUSER-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<xref linkend="APP-PSQL">. Thus, there is nothing
special about creating users via this or other methods. This means
that the <application>psql</application> application must be found by the
script and that
a database server must be running at the targeted host. Also, any default
settings and environment variables used by <application>psql</application>
and the <application>libpq</application> front-end library will apply.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
......@@ -162,6 +196,7 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
<para>
You will be prompted for a name and other missing information if it is not
specified on the command line.
</para>
......@@ -172,13 +207,31 @@ PostgreSQL documentation
<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>
</refsect2>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Diagnostics</title>
<refsect2 id="R2-APP-CREATEUSER-2">
<title>
Outputs
</title>
<para>
<variablelist>
<varlistentry>
<term><computeroutput>CREATE USER</computeroutput></term>
......@@ -200,52 +253,16 @@ PostgreSQL documentation
</variablelist>
<para>
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"> for possibilities.
</para>
</refsect2>
</refsynopsisdiv>
<refsect1 id="R1-APP-CREATEUSER-1">
<title>
Description
</title>
<para>
<application>createuser</application> creates a
new <productname>PostgreSQL</productname> user.
Only superusers (users with <literal>usesuper</literal> set in
the <literal>pg_shadow</literal> table) can create
new <productname>PostgreSQL</productname> users,
so <application>createuser</application> must be
invoked by someone who is a <productname>PostgreSQL</productname>
superuser.
</para>
<para>
Being a superuser also implies the ability to bypass access permission
checks within the database, so superuser-dom should not be granted lightly.
</para>
<para>
<application>createuser</application> is a shell script wrapper around the
<acronym>SQL</acronym> command
<xref linkend="SQL-CREATEUSER" endterm="SQL-CREATEUSER-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<xref linkend="APP-PSQL">. Thus, there is nothing
special about creating users via this or other methods. This means
that the <application>psql</application> application must be found by the
script and that
a database server must be running at the targeted host. Also, any default
settings and environment variables used by <application>psql</application>
and the <application>libpq</application> front-end library will apply.
</para>
</refsect1>
<refsect1 id="R1-APP-CREATEUSER-2">
<title>Usage</title>
<refsect1>
<title>Examples</title>
<informalexample>
<para>
......@@ -274,6 +291,16 @@ PostgreSQL documentation
</informalexample>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="app-dropuser"></member>
<member><xref linkend="sql-createuser" endterm="sql-createuser-title"></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/dropdb.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.15 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.16 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -21,12 +21,36 @@ PostgreSQL documentation
<arg rep="repeat"><replaceable>options</replaceable></arg>
<arg choice="plain"><replaceable>dbname</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect2 id="R2-APP-DROPDB-1">
<title>
Inputs
</title>
<para>
<refsect1>
<title>Description</title>
<para>
<application>dropdb</application> destroys an existing
<productname>PostgreSQL</productname> database.
The user who executes this command must be a database
superuser or the owner of the database.
</para>
<para>
<application>dropdb</application> is a shell script wrapper around the
<acronym>SQL</acronym> command
<xref linkend="SQL-DROPDATABASE" endterm="SQL-DROPDATABASE-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<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
settings and environment variables available to <application>psql</application>
and the <application>libpq</application> front-end library do apply.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
......@@ -110,18 +134,16 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
<para>
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">.
</para>
</refsect2>
</refsect1>
<refsect2 id="R2-APP-DROPDB-2">
<title>
Outputs
</title>
<para>
<refsect1>
<title>Diagnostics</title>
<variablelist>
<varlistentry>
......@@ -139,41 +161,35 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
<para>
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"> for possibilities.
</para>
</refsect2>
</refsynopsisdiv>
</refsect1>
<refsect1 id="R1-APP-DROPDB-1">
<title>
Description
</title>
<para>
<application>dropdb</application> destroys an existing
<productname>PostgreSQL</productname> database.
The user who executes this command must be a database
superuser or the owner of the database.
</para>
<refsect1>
<title>Environment</title>
<para>
<application>dropdb</application> is a shell script wrapper around the
<acronym>SQL</acronym> command
<xref linkend="SQL-DROPDATABASE" endterm="SQL-DROPDATABASE-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<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
settings and environment variables available to <application>psql</application>
and the <application>libpq</application> front-end library do apply.
</para>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="R1-APP-DROPDB-2">
<title>Usage</title>
<title>Examples</title>
<informalexample>
<para>
......@@ -201,6 +217,17 @@ DROP DATABASE</computeroutput>
</para>
</informalexample>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="app-createdb"></member>
<member><xref linkend="sql-dropdatabase" endterm="sql-dropdatabase-title"></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/droplang.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.18 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/droplang.sgml,v 1.19 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -11,7 +11,7 @@ PostgreSQL documentation
</refmeta>
<refnamediv>
<refname id="droplang">droplang</refname>
<refname>droplang</refname>
<refpurpose>remove a <productname>PostgreSQL</productname> procedural language</refpurpose>
</refnamediv>
......@@ -27,11 +27,34 @@ PostgreSQL documentation
<group choice="plain"><arg>--list</arg><arg>-l</arg></group>
<arg choice="plain"><replaceable>dbname</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="R1-APP-DROPLANG-1">
<title>
Description
</title>
<para>
<application>droplang</application> is a utility for removing an
existing programming language from a
<productname>PostgreSQL</productname> database.
<application>droplang</application> can drop any procedural language,
even those not supplied by the <productname>PostgreSQL</> distribution.
</para>
<para>
Although backend programming languages can be removed directly using
several <acronym>SQL</acronym> commands, it is recommended to use
<application>droplang</application> because it performs a number
of checks and is much easier to use. See
<xref linkend="sql-droplanguage" endterm="sql-droplanguage-title">
for more.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<refsect2 id="R2-APP-DROPLANG-1">
<title>
Inputs
</title>
<para>
<application>droplang</application> accepts the following command line arguments:
......@@ -126,12 +149,31 @@ PostgreSQL documentation
</variablelist>
</para>
</refsect2>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Diagnostics</title>
<refsect2 id="R2-APP-DROPLANG-2">
<title>
Outputs
</title>
<para>
Most error messages are self-explanatory. If not, run
<application>droplang</application> with the <option>--echo</option>
......@@ -139,43 +181,20 @@ PostgreSQL documentation
for details. Check also under <xref linkend="APP-PSQL">
for more possibilities.
</para>
</refsect2>
</refsynopsisdiv>
<refsect1 id="R1-APP-DROPLANG-1">
<title>
Description
</title>
<para>
<application>droplang</application> is a utility for removing an
existing programming language from a
<productname>PostgreSQL</productname> database.
<application>droplang</application> can drop any procedural language,
even those not supplied by the <productname>PostgreSQL</> distribution.
</para>
<para>
Although backend programming languages can be removed directly using
several <acronym>SQL</acronym> commands, it is recommended to use
<application>droplang</application> because it performs a number
of checks and is much easier to use. See
<xref linkend="sql-droplanguage" endterm="sql-droplanguage-title">
for more.
</para>
</refsect1>
<refsect1 id="R1-APP-DROPLANG-2">
<title>
Notes
</title>
<refsect1>
<title>Notes</title>
<para>
Use <xref linkend="app-createlang"> to add a language.
</para>
</refsect1>
<refsect1 id="R1-APP-DROPLANG-3">
<title>Usage</title>
<refsect1>
<title>Examples</title>
<informalexample>
<para>
......@@ -186,6 +205,16 @@ PostgreSQL documentation
</para>
</informalexample>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="app-createlang"></member>
<member><xref linkend="sql-droplanguage" endterm="sql-droplanguage-title"></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/dropuser.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.18 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.19 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -21,12 +21,38 @@ PostgreSQL documentation
<arg rep="repeat"><replaceable>options</replaceable></arg>
<arg><replaceable>username</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect2 id="R2-APP-DROPUSER-1">
<title>
Inputs
</title>
<para>
<refsect1>
<title>Description</title>
<para>
<application>dropuser</application> removes an existing
<productname>PostgreSQL</productname> user
<emphasis>and</emphasis> the databases which that user owned.
Only users with <literal>usesuper</literal> set in
the <literal>pg_shadow</literal> table can destroy
<productname>PostgreSQL</productname> users.
</para>
<para>
<application>dropuser</application> is a shell script wrapper around the
<acronym>SQL</acronym> command
<xref linkend="SQL-DROPUSER" endterm="SQL-DROPUSER-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<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
settings and environment variables available to <application>psql</application>
and the <application>libpq</application> front-end library do apply.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
......@@ -91,7 +117,6 @@ PostgreSQL documentation
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The options <literal>-h</literal>, <literal>-p</literal>, and <literal>-e</literal>,
......@@ -99,14 +124,31 @@ PostgreSQL documentation
<application>psql</application> options <literal>-U</literal> and <literal>-W</literal>
are available as well, but they can be confusing in this context.
</para>
</refsect2>
</refsect1>
<refsect2 id="R2-APP-DROPUSER-2">
<title>
Outputs
</title>
<para>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Diagnostics</title>
<variablelist>
<varlistentry>
<term><computeroutput>DROP USER</computeroutput></term>
......@@ -128,43 +170,16 @@ PostgreSQL documentation
</variablelist>
<para>
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"> for possibilities.
</para>
</refsect2>
</refsynopsisdiv>
<refsect1 id="R1-APP-DROPUSER-1">
<title>
Description
</title>
<para>
<application>dropuser</application> removes an existing
<productname>PostgreSQL</productname> user
<emphasis>and</emphasis> the databases which that user owned.
Only users with <literal>usesuper</literal> set in
the <literal>pg_shadow</literal> table can destroy
<productname>PostgreSQL</productname> users.
</para>
<para>
<application>dropuser</application> is a shell script wrapper around the
<acronym>SQL</acronym> command
<xref linkend="SQL-DROPUSER" endterm="SQL-DROPUSER-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<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
settings and environment variables available to <application>psql</application>
and the <application>libpq</application> front-end library do apply.
</para>
</refsect1>
<refsect1 id="R1-APP-DROPUSER-2">
<title>Usage</title>
<refsect1>
<title>Examples</title>
<informalexample>
<para>
......@@ -193,6 +208,16 @@ DROP USER</computeroutput>
</informalexample>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="app-createuser"></member>
<member><xref linkend="sql-dropuser" endterm="sql-dropuser-title"></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/ecpg-ref.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.19 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.20 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -9,6 +9,7 @@ PostgreSQL documentation
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
<refname>
<application>ecpg</application>
......@@ -17,6 +18,7 @@ PostgreSQL documentation
embedded SQL C preprocessor
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<refsynopsisdivinfo>
<date>1999-07-20</date>
......@@ -29,14 +31,33 @@ PostgreSQL documentation
<arg choice="opt">-o <replaceable>outfile</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="APP-ECPG-description">
<title>Description</title>
<para>
<application>ecpg</application>
is an embedded SQL preprocessor for the C language and the
<productname>PostgreSQL</productname>. It
enables development of C programs with embedded SQL code.
</para>
<para>
Linus Tolke (<email>linus@epact.se</email>) was the
original author of <application>ecpg</application> (up to version 0.2).
Michael Meskes (<email>meskes@debian.org</email>)
is the current author and maintainer of <application>ecpg</application>.
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>
<refsect1>
<title>Options</title>
<refsect2 id="R2-APP-ECPG-1">
<refsect2info>
<date>1999-07-20</date>
</refsect2info>
<title>
Inputs
</title>
<para>
<application>ecpg</application> accepts the following command
line arguments:
......@@ -104,58 +125,23 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
</para>
</refsect2>
<refsect2 id="R2-APP-ECPG-2">
<refsect2info>
<date>1998-11-05</date>
</refsect2info>
<title>
Outputs
</title>
<para>
<application>ecpg</application> will create a file or
write to <filename>stdout</filename>.
</refsect1>
<variablelist>
<varlistentry>
<term>Return value</term>
<listitem>
<para>
<application>ecpg</application> returns 0 to the shell on successful completion, non-zero
for errors.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsynopsisdiv>
<refsect1 id="R1-APP-ECPG-description">
<title>Description</title>
<para>
<application>ecpg</application>
is an embedded SQL preprocessor for the C language and the
<productname>PostgreSQL</productname>. It
enables development of C programs with embedded SQL code.
</para>
<refsect1>
<title>Exit Status</title>
<para>
Linus Tolke (<email>linus@epact.se</email>) was the
original author of <application>ecpg</application> (up to version 0.2).
Michael Meskes (<email>meskes@debian.org</email>)
is the current author and maintainer of <application>ecpg</application>.
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.
<application>ecpg</application> returns 0 to the shell on
successful completion, non-zero for errors.
</para>
</refsect1>
<refsect1 id="R1-APP-ECPG-2">
<refsect1>
<title>Usage</title>
<refsect2 id="R2-APP-ECPG-preprocessing">
<refsect2 id="APP-ECPG-preprocessing">
<title>Preprocessing for Compilation</title>
<para>
......@@ -175,7 +161,7 @@ ecpg [ -d ] [ -o <replaceable>file</replaceable> ] <replaceable>file</replaceabl
</para>
</refsect2>
<refsect2 id="R2-APP-ECPG-compiling">
<refsect2 id="APP-ECPG-compiling">
<title>Compiling and Linking</title>
<para>
......@@ -190,10 +176,10 @@ gcc -g -I /usr/local/pgsql/include [ -o <replaceable>file</replaceable> ] <repla
</refsect2>
</refsect1>
<refsect1 id="R1-APP-ECPG-grammar">
<refsect1 id="APP-ECPG-grammar">
<title>Grammar</title>
<refsect2 id="R2-APP-ECPG-library">
<refsect2 id="APP-ECPG-library">
<title>Libraries</title>
<para>
......@@ -206,7 +192,7 @@ gcc -g -I /usr/local/pgsql/include [ -o <replaceable>file</replaceable> ] <repla
</para>
</refsect2>
<refsect2 id="R2-APP-declaration">
<refsect2 id="APP-ecpg-declaration">
<title>Variable Declaration</title>
<para>
......@@ -237,7 +223,7 @@ char foo[16], bar[16];
</para>
</refsect2>
<refsect2 id="R2-APP-ECPG-errors">
<refsect2 id="APP-ECPG-errors">
<title>Error Handling</title>
<para>
......@@ -292,7 +278,7 @@ EXEC SQL WHENEVER not found sqlprint;
</note>
</refsect2>
<refsect2 id="R2-APP-ECPG-connecting">
<refsect2 id="APP-ECPG-connecting">
<title>Connecting to the Database Server</title>
<para>
......@@ -322,7 +308,7 @@ EXEC SQL CONNECT TO <replaceable>dbname</replaceable>;
</para>
</refsect2>
<refsect2 id="R2-APP-ECPG-queries">
<refsect2 id="APP-ECPG-queries">
<title>Queries</title>
<para>
......@@ -393,7 +379,7 @@ EXEC SQL COMMIT;
</refsect2>
</refsect1>
<refsect1 id="R1-APP-ECPG-notes">
<refsect1 id="APP-ECPG-notes">
<title>Notes</title>
<para>
The complete structure definition MUST be listed
......@@ -406,6 +392,17 @@ EXEC SQL COMMIT;
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citetitle>PostgreSQL Programmer's Guide</citetitle> for a more
detailed description of the embedded SQL interface.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/initlocation.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.15 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/Attic/initlocation.sgml,v 1.16 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -39,7 +39,7 @@ PostgreSQL documentation
</refsect1>
<refsect1 id="R1-APP-INITLOCATION-2">
<title>Usage</title>
<title>Examples</title>
<informalexample>
<para>
......@@ -68,6 +68,15 @@ PostgreSQL documentation
</para>
</informalexample>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><citetitle>PostgreSQL Administrator's Guide</citetitle></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
doc/src/sgml/ref/pg_ctl-ref.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.14 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_ctl-ref.sgml,v 1.15 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -225,9 +225,32 @@ PostgreSQL documentation
</variablelist>
</para>
</refsect2>
</refsect1>
<refsect1>
<title>Environment</title>
<refsect2>
<title>Files</title>
<variablelist>
<varlistentry>
<term><envar>PGDATA</envar></term>
<listitem>
<para>
Default data direction location
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
For others, see <xref linkend="app-postmaster">.
</para>
</refsect1>
<refsect1>
<title>Files</title>
<para>
If the file <filename>postmaster.opts.default</filename> exists in
......@@ -235,8 +258,17 @@ PostgreSQL documentation
options to the <application>postmaster</application>, unless
overridden by the <option>-o</option> option.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>Notes</title>
<para>
Waiting for complete start is not a well-defined operation and may
fail if access control is set up so that a local client cannot
connect without manual interaction. It should be avoided.
</para>
</refsect1>
......@@ -330,15 +362,6 @@ Command line was:
</refsect2>
</refsect1>
<refsect1>
<title>Bugs</title>
<para>
Waiting for complete start is not a well-defined operation and may
fail if access control is set up so that a local client cannot
connect without manual interaction. It should be avoided.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
......
doc/src/sgml/ref/pg_dump.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.45 2002/05/10 22:36:26 tgl Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.46 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -582,6 +582,34 @@ PostgreSQL documentation
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGDATABASE</envar></term>
<listitem>
<para>
Database to dump, unless overridden on the command line.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="app-pgdump-diagnostics">
<title>Diagnostics</title>
......
doc/src/sgml/ref/pg_dumpall.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.28 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.29 2002/07/28 15:22:20 petere Exp $
PostgreSQL documentation
-->
......@@ -152,6 +152,26 @@ PostgreSQL documentation
</refsect2>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="app-pg-dumpall-ex">
<title>Examples</title>
<para>
......
doc/src/sgml/ref/pg_restore.sgml
View file @ 06ad580f
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.28 2002/07/13 00:55:53 momjian Exp $ -->
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.29 2002/07/28 15:22:20 petere Exp $ -->
<refentry id="APP-PGRESTORE">
<docinfo>
......@@ -496,6 +496,25 @@
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="app-pgrestore-diagnostics">
<title>Diagnostics</title>
......
doc/src/sgml/ref/postgres-ref.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.26 2002/04/21 19:02:39 thomas Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.27 2002/07/28 15:22:21 petere Exp $
PostgreSQL documentation
-->
......@@ -349,6 +349,28 @@ PostgreSQL documentation
</refsect2>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGDATA</envar></term>
<listitem>
<para>
Default data direction location
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
For others, which have little influence during single-user mode,
see <xref linkend="app-postmaster">.
</para>
</refsect1>
<refsect1>
<title>Usage</title>
......
doc/src/sgml/ref/postmaster.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.30 2002/06/15 19:52:56 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/postmaster.sgml,v 1.31 2002/07/28 15:22:21 petere Exp $
PostgreSQL documentation
-->
......@@ -338,10 +338,82 @@ PostgreSQL documentation
</para>
</refsect2>
<refsect2 id="R2-APP-POSTMASTER-2">
<title>
Outputs
</title>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGCLIENTENCODING</envar></term>
<listitem>
<para>
Default character encoding used by clients. (The clients may
override this invidiually.) This value can also be set in the
configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><envar>PGDATA</envar></term>
<listitem>
<para>
Default data direction location
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><envar>PGDATASTYLE</envar></term>
<listitem>
<para>
Default value of the <literal>datestyle</literal> run-time
parameter. (The use of this environment variable is deprecated.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><envar>PGPORT</envar></term>
<listitem>
<para>
Default port (preferrably set in the configuration file)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><envar>TZ</envar></term>
<listitem>
<para>
Server time zone
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>others</term>
<listitem>
<para>
Other environment variables may be used to designate alternative
data storage locations. See the <citetitle>Administrator's
Guide</citetitle> for more information.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Diagnostics</title>
<para>
<variablelist>
......@@ -417,7 +489,6 @@ StreamServerPort: cannot bind to port
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsect1>
<refsect1>
......@@ -457,8 +528,8 @@ StreamServerPort: cannot bind to port
</refsect1>
<refsect1 id="app-postmaster-usage">
<title>Usage</title>
<refsect1 id="app-postmaster-examples">
<title>Examples</title>
<para>
To start <application>postmaster</application> in the background
using default values, type:
......
doc/src/sgml/ref/psql-ref.sgml
View file @ 06ad580f
This diff is collapsed.
doc/src/sgml/ref/vacuumdb.sgml
View file @ 06ad580f
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.21 2002/02/18 05:48:43 momjian Exp $
$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.22 2002/07/28 15:22:21 petere Exp $
PostgreSQL documentation
-->
<refentry id="APP-VACUUMDB">
<docinfo>
<date>2000-11-11</date>
</docinfo>
<refmeta>
<refentrytitle id="APP-VACUUMDB-TITLE"><application>vacuumdb</application></refentrytitle>
<manvolnum>1</manvolnum>
......@@ -38,11 +34,37 @@ PostgreSQL documentation
<group><arg>--verbose</arg><arg>-v</arg></group>
<group><arg>--analyze</arg><arg>-z</arg></group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<application>vacuumdb</application> is a utility for cleaning a
<productname>PostgreSQL</productname> database.
<application>vacuumdb</application> will also generate internal statistics
used by the <productname>PostgreSQL</productname> query optimizer.
</para>
<para>
<application>vacuumdb</application> is a shell script wrapper around the
backend command
<xref linkend="SQL-VACUUM" endterm="SQL-VACUUM-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<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
settings and environment variables available to <application>psql</application>
and the <application>libpq</application> front-end library do apply.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<refsect2 id="R2-APP-VACUUMDB-1">
<title>
Inputs
</title>
<para>
<application>vacuumdb</application> accepts the following command line arguments:
......@@ -190,12 +212,12 @@ PostgreSQL documentation
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsect1>
<refsect1>
<title>Diagnostics</title>
<refsect2 id="R2-APP-VACUUMDB-2">
<title>
Outputs
</title>
<para>
<variablelist>
<varlistentry>
......@@ -221,42 +243,30 @@ PostgreSQL documentation
</variablelist>
</para>
</refsect1>
<para>
</para>
</refsect2>
</refsynopsisdiv>
<refsect1 id="R1-APP-VACUUMDB-1">
<title>
Description
</title>
<refsect1>
<title>Environment</title>
<para>
<application>vacuumdb</application> is a utility for cleaning a
<productname>PostgreSQL</productname> database.
<application>vacuumdb</application> will also generate internal statistics
used by the <productname>PostgreSQL</productname> query optimizer.
</para>
<para>
<application>vacuumdb</application> is a shell script wrapper around the
backend command
<xref linkend="SQL-VACUUM" endterm="SQL-VACUUM-title"> via
the <productname>PostgreSQL</productname> interactive terminal
<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
settings and environment variables available to <application>psql</application>
and the <application>libpq</application> front-end library do apply.
</para>
<variablelist>
<varlistentry>
<term><envar>PGHOST</envar></term>
<term><envar>PGPORT</envar></term>
<term><envar>PGUSER</envar></term>
<listitem>
<para>
Default connection parameters.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="R1-APP-VACUUMDB-3">
<title>Usage</title>
<refsect1>
<title>Examples</title>
<informalexample>
<para>
......@@ -290,6 +300,15 @@ PostgreSQL documentation
</informalexample>
</refsect1>
<refsect1>
<title>See Also</title>
<simplelist type="inline">
<member><xref linkend="sql-vacuum" endterm="sql-vacuum-title"></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
......
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