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

Commit bb0fc46

Browse files
author
Thomas G. Lockhart
committed
Add new reference pages for postmaster and postgres.
Normalize markup for vacuumdb; content is the same.
1 parent ff8bf5a commit bb0fc46

File tree

3 files changed

+77
-66
lines changed

3 files changed

+77
-66
lines changed

doc/src/sgml/ref/allfiles.sgml

+2
Original file line numberDiff line numberDiff line change
@@ -122,5 +122,7 @@
122122
<!entity pgDump system "pg_dump.sgml">
123123
<!entity pgDumpall system "pg_dumpall.sgml">
124124
<!entity pgUpgrade system "pg_upgrade.sgml">
125+
<!entity postgres system "postgres-ref.sgml">
126+
<!entity postmaster system "postmaster.sgml">
125127
<!entity psqlRef system "psql-ref.sgml">
126128
<!entity vacuumdb system "vacuumdb.sgml">

doc/src/sgml/ref/commands.sgml

+6-3
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,13 @@ functions supported by <productname>Postgres</productname>.
8787
-->
8888

8989
<chapter Id="utilities">
90-
<title>Utility Applications</title>
90+
<title>Applications</title>
9191

9292
<abstract>
9393
<para>
94-
This is reference information for the
95-
<productname>Postgres</productname> support utilities.
94+
This is reference information for
95+
<productname>Postgres</productname> applications
96+
and support utilities.
9697
</para>
9798
</abstract>
9899

@@ -106,6 +107,8 @@ functions supported by <productname>Postgres</productname>.
106107
&pgAdmin;
107108
&pgDump;
108109
&pgDumpall;
110+
&postgres;
111+
&postmaster;
109112
&psqlRef;
110113
&vacuumdb;
111114

doc/src/sgml/ref/vacuumdb.sgml

+69-63
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,40 @@
1-
<REFENTRY ID="APP-VACUUMDB">
2-
<REFMETA>
3-
<REFENTRYTITLE>
4-
<application>vacuumdb</application>
5-
</REFENTRYTITLE>
6-
<REFMISCINFO>Application</REFMISCINFO>
7-
</REFMETA>
8-
<REFNAMEDIV>
9-
<REFNAME id="vacuumdb">
10-
<application>vacuumdb</application>
11-
</REFNAME>
12-
<REFPURPOSE>
13-
Clean and analyze a <productname>Postgres</productname> database
14-
</REFPURPOSE>
1+
<refentry id="APP-VACUUMDB">
2+
<refmeta>
3+
<refentrytitle>
4+
<application>vacuumdb</application>
5+
</refentrytitle>
6+
<refmiscinfo>Application</refmiscinfo>
7+
</refmeta>
8+
<refnamediv>
9+
<refname id="vacuumdb">
10+
<application>vacuumdb</application>
11+
</refname>
12+
<refpurpose>
13+
Clean and analyze a <productname>Postgres</productname> database
14+
</refpurpose>
1515
</refnamediv>
16-
<REFSYNOPSISDIV>
17-
<REFSYNOPSISDIVINFO>
18-
<DATE>1998-10-04</DATE>
19-
</REFSYNOPSISDIVINFO>
20-
<SYNOPSIS>
21-
vacuumdb [ --analyze | -z ] [ --verbose | -v ] [ <replaceable class="parameter">dbname</replaceable> ]
22-
vacuumdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ]
23-
[ --table '<replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column</replaceable> [,...] ) ]' ]
16+
<refsynopsisdiv>
17+
<refsynopsisdivinfo>
18+
<date>1998-10-04</date>
19+
</refsynopsisdivinfo>
20+
<synopsis>
21+
vacuumdb [ --analyze | -z ] [ --verbose | -v ] [ <replaceable
22+
class="parameter">dbname</replaceable> ]
23+
vacuumdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p
24+
<replaceable class="parameter">port</replaceable> ]
25+
[ --table '<replaceable class="parameter">table</replaceable> [ (
26+
<replaceable class="parameter">column</replaceable> [,...] ) ]' ]
2427
[ <replaceable class="parameter">dbname</replaceable> ]
25-
</SYNOPSIS>
28+
</synopsis>
2629

27-
<REFSECT2 ID="R2-APP-VACUUMDB-1">
28-
<REFSECT2INFO>
29-
<DATE>1998-10-04</DATE>
30-
</REFSECT2INFO>
31-
<TITLE>
30+
<refsect2 id="R2-APP-VACUUMDB-1">
31+
<refsect2info>
32+
<date>1998-10-04</date>
33+
</refsect2info>
34+
<title>
3235
Inputs
33-
</TITLE>
34-
<PARA>
36+
</title>
37+
<para>
3538
<application>vacuumdb</application> accepts the following command line arguments:
3639

3740
<variablelist>
@@ -80,10 +83,12 @@ vacuumdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replacea
8083

8184
<varlistentry>
8285
<term>
83-
--table <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]
86+
--table <replaceable class="parameter">table</replaceable> [
87+
(<replaceable class="parameter">column</replaceable> [,...]) ]
8488
</term>
8589
<term>
86-
-t <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]
90+
-t <replaceable class="parameter">table</replaceable> [
91+
(<replaceable class="parameter">column</replaceable> [,...]) ]
8792
</term>
8893
<listitem>
8994
<para>
@@ -148,22 +153,23 @@ vacuumdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replacea
148153
</para>
149154
</refsect2>
150155

151-
<REFSECT2 ID="R2-APP-VACUUMDB-2">
152-
<REFSECT2INFO>
153-
<DATE>1998-10-04</DATE>
154-
</REFSECT2INFO>
155-
<TITLE>
156+
<refsect2 id="R2-APP-VACUUMDB-2">
157+
<refsect2info>
158+
<date>1998-10-04</date>
159+
</refsect2info>
160+
<title>
156161
Outputs
157-
</TITLE>
158-
<PARA>
162+
</title>
163+
<para>
159164
<application>vacuumdb</application> executes a <command>VACUUM</command> command
160165
on the specified database, so has not explicit external output.
161166

162167
<variablelist>
163168
<varlistentry>
164169
<term>
165170
ERROR: Can't vacuum columns, only tables. You can 'vacuum analyze' columns.
166-
vacuumdb: database vacuum failed on <replaceable class="parameter">dbname</replaceable>.
171+
vacuumdb: database vacuum failed on <replaceable
172+
class="parameter">dbname</replaceable>.
167173
</term>
168174
<listitem>
169175
<para>
@@ -221,43 +227,43 @@ vacuumdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replacea
221227
</refsect2>
222228
</refsynopsisdiv>
223229

224-
<REFSECT1 ID="R1-APP-VACUUMDB-1">
225-
<REFSECT1INFO>
226-
<DATE>1998-10-04</DATE>
227-
</REFSECT1INFO>
228-
<TITLE>
230+
<refsect1 id="R1-APP-VACUUMDB-1">
231+
<refsect1info>
232+
<date>1998-10-04</date>
233+
</refsect1info>
234+
<title>
229235
Description
230-
</TITLE>
236+
</title>
231237

232-
<PARA>
238+
<para>
233239
<application>vacuumdb</application> is a utility for cleaning a
234240
<productname>Postgres</productname> database.
235241
<application>vacuumdb</application> will also generate internal statistics
236242
used by the <productname>Postgres</productname> query optimizer.
237243
</para>
238244
</refsect1>
239245

240-
<REFSECT1 ID="R1-APP-VACUUMDB-2">
241-
<REFSECT1INFO>
242-
<DATE>1998-10-04</DATE>
243-
</REFSECT1INFO>
244-
<TITLE>
246+
<refsect1 id="R1-APP-VACUUMDB-2">
247+
<refsect1info>
248+
<date>1998-10-04</date>
249+
</refsect1info>
250+
<title>
245251
Notes
246-
</TITLE>
252+
</title>
247253

248254
<para>
249-
See <xref linkend="vacuum" endterm="vacuum"> for more details.
255+
See <xref endterm="vacuum" linkend="vacuum"> for more details.
250256
</para>
251257
</refsect1>
252258

253-
<REFSECT1 ID="R1-APP-VACUUMDB-3">
254-
<REFSECT1INFO>
255-
<DATE>1998-10-04</DATE>
256-
</REFSECT1INFO>
257-
<TITLE>
259+
<refsect1 id="R1-APP-VACUUMDB-3">
260+
<refsect1info>
261+
<date>1998-10-04</date>
262+
</refsect1info>
263+
<title>
258264
Usage
259-
</TITLE>
260-
<PARA>
265+
</title>
266+
<para>
261267
To clean a database of the same name as the user:
262268

263269
<programlisting>
@@ -280,12 +286,12 @@ vacuumdb [ -h <replaceable class="parameter">host</replaceable> ] [ -p <replacea
280286
</programlisting>
281287
</para>
282288
</refsect1>
283-
</REFENTRY>
289+
</refentry>
284290

285291
<!-- Keep this comment at the end of the file
286292
Local variables:
287293
mode: sgml
288-
sgml-omittag:t
294+
sgml-omittag:nil
289295
sgml-shorttag:t
290296
sgml-minimize-attributes:nil
291297
sgml-always-quote-attributes:t

0 commit comments

Comments
 (0)