aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/vacuumdb.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/ref/vacuumdb.sgml')
-rw-r--r--doc/src/sgml/ref/vacuumdb.sgml107
1 files changed, 63 insertions, 44 deletions
diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml
index b1c3cab01a8..37debc1b845 100644
--- a/doc/src/sgml/ref/vacuumdb.sgml
+++ b/doc/src/sgml/ref/vacuumdb.sgml
@@ -1,13 +1,9 @@
<!--
-$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