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

Commit c086590

Browse files
peterepetere
committed
Assorted reference page updates
1 parent 3379f7b commit c086590

16 files changed

+570
-563
lines changed

‎doc/src/sgml/ref/clusterdb.sgml

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.4 2002/09/21 18:32:54 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.5 2002/10/11 23:03:48 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -33,8 +33,8 @@ PostgreSQL documentation
3333
<title>Description</title>
3434

3535
<para>
36-
<application>clusterdb</application> is a utility for re-clustering tables
37-
in a <productname>PostgreSQL</productname> database. It finds table(s)
36+
<application>clusterdb</application> is a utility for reclustering tables
37+
in a <productname>PostgreSQL</productname> database. It finds tables
3838
that have previously been clustered, and clusters them again on the same
3939
index that was last used. Tables that have never been clustered are not
4040
touched.
@@ -67,12 +67,22 @@ PostgreSQL documentation
6767
<title>Options</title>
6868

6969
<para>
70-
<application>clusterdb</application> accepts the following command line arguments:
70+
<application>clusterdb</application> accepts the following command-line arguments:
7171

7272
<variablelist>
7373
<varlistentry>
74-
<term><option>-d <replaceable class="parameter">dbname</replaceable></></term>
75-
<term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term>
74+
<term><option>-a</></term>
75+
<term><option>--all</></term>
76+
<listitem>
77+
<para>
78+
Cluster all databases.
79+
</para>
80+
</listitem>
81+
</varlistentry>
82+
83+
<varlistentry>
84+
<term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></></term>
85+
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
7686
<listitem>
7787
<para>
7888
Specifies the name of the database to be clustered.
@@ -86,11 +96,22 @@ PostgreSQL documentation
8696
</varlistentry>
8797

8898
<varlistentry>
89-
<term><option>-a</></term>
90-
<term><option>--all</></term>
99+
<term><option>-e</></term>
100+
<term><option>--echo</></term>
91101
<listitem>
92102
<para>
93-
Cluster all databases.
103+
Echo the commands that <application>clusterdb</application> generates
104+
and sends to the server.
105+
</para>
106+
</listitem>
107+
</varlistentry>
108+
109+
<varlistentry>
110+
<term><option>-q</></term>
111+
<term><option>--quiet</></term>
112+
<listitem>
113+
<para>
114+
Do not display a response.
94115
</para>
95116
</listitem>
96117
</varlistentry>
@@ -110,8 +131,8 @@ PostgreSQL documentation
110131

111132
<para>
112133
<application>clusterdb</application> also accepts
113-
the following command line arguments for connection parameters:
114-
134+
the following command-line arguments for connection parameters:
135+
115136
<variablelist>
116137
<varlistentry>
117138
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
@@ -157,27 +178,6 @@ PostgreSQL documentation
157178
</para>
158179
</listitem>
159180
</varlistentry>
160-
161-
<varlistentry>
162-
<term><option>-e</></term>
163-
<term><option>--echo</></term>
164-
<listitem>
165-
<para>
166-
Echo the commands that <application>clusterdb</application> generates
167-
and sends to the server.
168-
</para>
169-
</listitem>
170-
</varlistentry>
171-
172-
<varlistentry>
173-
<term><option>-q</></term>
174-
<term><option>--quiet</></term>
175-
<listitem>
176-
<para>
177-
Do not display a response.
178-
</para>
179-
</listitem>
180-
</varlistentry>
181181
</variablelist>
182182
</para>
183183
</refsect1>
@@ -250,7 +250,7 @@ PostgreSQL documentation
250250
<literal>foo</literal> in a database named
251251
<literal>xyzzy</literal>:
252252
<screen>
253-
<prompt>$ </prompt><userinput>clusterdb --verbose --table foo xyzzy</userinput>
253+
<prompt>$ </prompt><userinput>clusterdb --table foo xyzzy</userinput>
254254
</screen>
255255
</para>
256256

‎doc/src/sgml/ref/createdb.sgml

Lines changed: 60 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.29 2002/09/21 18:32:54 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createdb.sgml,v 1.30 2002/10/11 23:03:48 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -59,46 +59,39 @@ PostgreSQL documentation
5959
<refsect1>
6060
<title>Options</title>
6161

62-
<variablelist>
63-
<varlistentry>
64-
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
65-
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
66-
<listitem>
67-
<para>
68-
Specifies the host name of the machine on which the
69-
server is running. If host begins with a slash, it is used
70-
as the directory for the Unix domain socket.
71-
</para>
72-
</listitem>
73-
</varlistentry>
62+
<para>
63+
<application>createdb</application> accepts the following command-line arguments:
7464

65+
<variablelist>
7566
<varlistentry>
76-
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
77-
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
67+
<term><replaceable class="parameter">dbname</replaceable></term>
7868
<listitem>
7969
<para>
80-
Specifies the Internet TCP/IP port or the local Unix domain socket file
81-
extension on which the server is listening for connections.
70+
Specifies the name of the database to be created. The name must be
71+
unique among all <productname>PostgreSQL</productname> databases in this installation.
72+
The default is to create a database with the same name as the
73+
current system user.
8274
</para>
8375
</listitem>
8476
</varlistentry>
8577

8678
<varlistentry>
87-
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
88-
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
79+
<term><replaceable class="parameter">description</replaceable></term>
8980
<listitem>
9081
<para>
91-
User name to connect as
82+
This optionally specifies a comment to be associated with the newly created
83+
database.
9284
</para>
9385
</listitem>
9486
</varlistentry>
9587

9688
<varlistentry>
97-
<term><option>-W</></term>
98-
<term><option>--password</></term>
89+
<term><option>-D <replaceable class="parameter">location</replaceable></></term>
90+
<term><option>--location <replaceable class="parameter">location</replaceable></></term>
9991
<listitem>
10092
<para>
101-
Force password prompt.
93+
Specifies the alternative location for the database. See also <xref
94+
linkend="app-initlocation">.
10295
</para>
10396
</listitem>
10497
</varlistentry>
@@ -115,11 +108,11 @@ PostgreSQL documentation
115108
</varlistentry>
116109

117110
<varlistentry>
118-
<term><option>-q</></term>
119-
<term><option>--quiet</></term>
111+
<term><option>-E <replaceable class="parameter">encoding</replaceable></></term>
112+
<term><option>--encoding <replaceable class="parameter">encoding</replaceable></></term>
120113
<listitem>
121114
<para>
122-
Do not display a response.
115+
Specifies the character encoding scheme to be used in this database.
123116
</para>
124117
</listitem>
125118
</varlistentry>
@@ -135,12 +128,11 @@ PostgreSQL documentation
135128
</varlistentry>
136129

137130
<varlistentry>
138-
<term><option>-D <replaceable class="parameter">datadir</replaceable></></term>
139-
<term><option>--location <replaceable class="parameter">datadir</replaceable></></term>
131+
<term><option>-q</></term>
132+
<term><option>--quiet</></term>
140133
<listitem>
141134
<para>
142-
Specifies the alternative location for the database. See also <xref
143-
linkend="app-initlocation">.
135+
Do not display a response.
144136
</para>
145137
</listitem>
146138
</varlistentry>
@@ -154,53 +146,68 @@ PostgreSQL documentation
154146
</para>
155147
</listitem>
156148
</varlistentry>
149+
</variablelist>
150+
</para>
157151

152+
<para>
153+
The options <option>-D</option>, <option>-E</option>,
154+
<option>-O</option>, and
155+
<option>-T</option> correspond to options of the underlying
156+
SQL command <xref linkend="SQL-CREATEDATABASE"
157+
endterm="SQL-CREATEDATABASE-title">; see there for more information
158+
about them.
159+
</para>
160+
161+
<para>
162+
<application>createdb</application> also accepts the following
163+
command-line arguments for connection parameters:
164+
165+
<variablelist>
158166
<varlistentry>
159-
<term><option>-E <replaceable class="parameter">encoding</replaceable></></term>
160-
<term><option>--encoding <replaceable class="parameter">encoding</replaceable></></term>
167+
<term><option>-h <replaceable class="parameter">host</replaceable></></term>
168+
<term><option>--host <replaceable class="parameter">host</replaceable></></term>
161169
<listitem>
162170
<para>
163-
Specifies the character encoding scheme to be used in this database.
171+
Specifies the host name of the machine on which the
172+
server is running. If host begins with a slash, it is used
173+
as the directory for the Unix domain socket.
164174
</para>
165175
</listitem>
166176
</varlistentry>
167177

168178
<varlistentry>
169-
<term><replaceable class="parameter">dbname</replaceable></term>
179+
<term><option>-p <replaceable class="parameter">port</replaceable></></term>
180+
<term><option>--port <replaceable class="parameter">port</replaceable></></term>
170181
<listitem>
171182
<para>
172-
Specifies the name of the database to be created. The name must be
173-
unique among all <productname>PostgreSQL</productname> databases in this installation.
174-
The default is to create a database with the same name as the
175-
current system user.
183+
Specifies the Internet TCP/IP port or the local Unix domain socket file
184+
extension on which the server is listening for connections.
176185
</para>
177186
</listitem>
178187
</varlistentry>
179188

180189
<varlistentry>
181-
<term><replaceable class="parameter">description</replaceable></term>
190+
<term><option>-U <replaceable class="parameter">username</replaceable></></term>
191+
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
182192
<listitem>
183193
<para>
184-
This optionally specifies a comment to be associated with the newly created
185-
database.
194+
User name to connect as
186195
</para>
187196
</listitem>
188197
</varlistentry>
189198

199+
<varlistentry>
200+
<term><option>-W</></term>
201+
<term><option>--password</></term>
202+
<listitem>
203+
<para>
204+
Force password prompt.
205+
</para>
206+
</listitem>
207+
</varlistentry>
190208
</variablelist>
191-
192-
<para>
193-
The options <option>-h</option>, <option>-p</option>, <option>-U</option>,
194-
<option>-W</option>, and <option>-e</option> are passed on literally to
195-
<xref linkend="app-psql">.
196-
197-
The options <option>-O</option>, <option>-D</option>,
198-
<option>-T</option>, and
199-
<option>-E</option> are converted into options for the underlying
200-
SQL command <xref linkend="SQL-CREATEDATABASE"
201-
endterm="SQL-CREATEDATABASE-title">; see there for more information
202-
about them.
203209
</para>
210+
204211
</refsect1>
205212

206213

‎doc/src/sgml/ref/createlang.sgml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.27 2002/09/21 18:32:54 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/createlang.sgml,v 1.28 2002/10/11 23:03:48 petere Exp $
33
PostgreSQL documentation
44
-->
55

@@ -46,7 +46,7 @@ PostgreSQL documentation
4646
<application>createlang</application> because it performs a number
4747
of checks and is much easier to use. See
4848
<xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
49-
for more.
49+
for additional information.
5050
</para>
5151
</refsect1>
5252

@@ -55,7 +55,7 @@ PostgreSQL documentation
5555
<title>Options</title>
5656

5757
<para>
58-
<application>createlang</application> accepts the following command line arguments:
58+
<application>createlang</application> accepts the following command-line arguments:
5959

6060
<variablelist>
6161
<varlistentry>
@@ -69,8 +69,8 @@ PostgreSQL documentation
6969
</varlistentry>
7070

7171
<varlistentry>
72-
<term><option>-d <replaceable class="parameter">dbname</replaceable></></term>
73-
<term><option>--dbname <replaceable class="parameter">dbname</replaceable></></term>
72+
<term><option><optional>-d</> <replaceable class="parameter">dbname</replaceable></></term>
73+
<term><option><optional>--dbname</> <replaceable class="parameter">dbname</replaceable></></term>
7474
<listitem>
7575
<para>
7676
Specifies to which database the language should be added.
@@ -117,7 +117,7 @@ PostgreSQL documentation
117117

118118
<para>
119119
<application>createlang</application> also accepts
120-
the following command line arguments for connection parameters:
120+
the following command-line arguments for connection parameters:
121121

122122
<variablelist>
123123
<varlistentry>

0 commit comments

Comments
 (0)