Skip to content

Commit f8f0140

Browse files
bmomjianbmomjian
committed
Document --version and --help options for all client applications (they
all support it). Per report from Josh Kupershmidt
1 parent 4c6c6b5 commit f8f0140

17 files changed

+320
-23
lines changed

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

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.26 2010/02/19 03:50:03 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.27 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -129,6 +129,27 @@ PostgreSQL documentation
129129
</listitem>
130130
</varlistentry>
131131

132+
<varlistentry>
133+
<term><option>-V</></term>
134+
<term><option>--version</></term>
135+
<listitem>
136+
<para>
137+
Print the <application>clusterdb</application> version and exit.
138+
</para>
139+
</listitem>
140+
</varlistentry>
141+
142+
<varlistentry>
143+
<term><option>-?</></term>
144+
<term><option>--help</></term>
145+
<listitem>
146+
<para>
147+
Show help about <application>clusterdb</application> command line
148+
arguments, and exit.
149+
</para>
150+
</listitem>
151+
</varlistentry>
152+
132153
</variablelist>
133154
</para>
134155

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

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.50 2010/02/19 03:50:03 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.51 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -168,6 +168,28 @@ PostgreSQL documentation
168168
</para>
169169
</listitem>
170170
</varlistentry>
171+
172+
<varlistentry>
173+
<term><option>-V</></term>
174+
<term><option>--version</></term>
175+
<listitem>
176+
<para>
177+
Print the <application>createdb</application> version and exit.
178+
</para>
179+
</listitem>
180+
</varlistentry>
181+
182+
<varlistentry>
183+
<term><option>-?</></term>
184+
<term><option>--help</></term>
185+
<listitem>
186+
<para>
187+
Show help about <application>createdb</application> command line
188+
arguments, and exit.
189+
</para>
190+
</listitem>
191+
</varlistentry>
192+
171193
</variablelist>
172194
</para>
173195

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

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.44 2010/02/19 03:50:03 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.45 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -96,6 +96,27 @@ PostgreSQL documentation
9696
</listitem>
9797
</varlistentry>
9898

99+
<varlistentry>
100+
<term><option>-V</></term>
101+
<term><option>--version</></term>
102+
<listitem>
103+
<para>
104+
Print the <application>createlang</application> version and exit.
105+
</para>
106+
</listitem>
107+
</varlistentry>
108+
109+
<varlistentry>
110+
<term><option>-?</></term>
111+
<term><option>--help</></term>
112+
<listitem>
113+
<para>
114+
Show help about <application>createlang</application> command line
115+
arguments, and exit.
116+
</para>
117+
</listitem>
118+
</varlistentry>
119+
99120
</variablelist>
100121
</para>
101122

‎doc/src/sgml/ref/createuser.sgml‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.53 2010/02/19 03:50:03 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.54 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -243,6 +243,28 @@ PostgreSQL documentation
243243
</para>
244244
</listitem>
245245
</varlistentry>
246+
247+
<varlistentry>
248+
<term><option>-V</></term>
249+
<term><option>--version</></term>
250+
<listitem>
251+
<para>
252+
Print the <application>createuser</application> version and exit.
253+
</para>
254+
</listitem>
255+
</varlistentry>
256+
257+
<varlistentry>
258+
<term><option>-?</></term>
259+
<term><option>--help</></term>
260+
<listitem>
261+
<para>
262+
Show help about <application>createuser</application> command line
263+
arguments, and exit.
264+
</para>
265+
</listitem>
266+
</varlistentry>
267+
246268
</variablelist>
247269
</para>
248270

‎doc/src/sgml/ref/dropdb.sgml‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.36 2010/02/19 03:50:03 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.37 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -86,7 +86,30 @@ PostgreSQL documentation
8686
</para>
8787
</listitem>
8888
</varlistentry>
89+
90+
<varlistentry>
91+
<term><option>-V</></term>
92+
<term><option>--version</></term>
93+
<listitem>
94+
<para>
95+
Print the <application>dropdb</application> version and exit.
96+
</para>
97+
</listitem>
98+
</varlistentry>
99+
100+
<varlistentry>
101+
<term><option>-?</></term>
102+
<term><option>--help</></term>
103+
<listitem>
104+
<para>
105+
Show help about <application>dropdb</application> command line
106+
arguments, and exit.
107+
</para>
108+
</listitem>
109+
</varlistentry>
110+
89111
</variablelist>
112+
90113
</para>
91114

92115
<para>

‎doc/src/sgml/ref/droplang.sgml‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.32 2009/02/26 16:02:37 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.33 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -104,6 +104,27 @@ PostgreSQL documentation
104104
</listitem>
105105
</varlistentry>
106106

107+
<varlistentry>
108+
<term><option>-V</></term>
109+
<term><option>--version</></term>
110+
<listitem>
111+
<para>
112+
Print the <application>droplang</application> version and exit.
113+
</para>
114+
</listitem>
115+
</varlistentry>
116+
117+
<varlistentry>
118+
<term><option>-?</></term>
119+
<term><option>--help</></term>
120+
<listitem>
121+
<para>
122+
Show help about <application>droplang</application> command line
123+
arguments, and exit.
124+
</para>
125+
</listitem>
126+
</varlistentry>
127+
107128
</variablelist>
108129
</para>
109130

‎doc/src/sgml/ref/dropuser.sgml‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.41 2010/02/19 03:50:03 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.42 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -88,6 +88,28 @@ PostgreSQL documentation
8888
</para>
8989
</listitem>
9090
</varlistentry>
91+
92+
<varlistentry>
93+
<term><option>-V</></term>
94+
<term><option>--version</></term>
95+
<listitem>
96+
<para>
97+
Print the <application>dropuser</application> version and exit.
98+
</para>
99+
</listitem>
100+
</varlistentry>
101+
102+
<varlistentry>
103+
<term><option>-?</></term>
104+
<term><option>--help</></term>
105+
<listitem>
106+
<para>
107+
Show help about <application>dropuser</application> command line
108+
arguments, and exit.
109+
</para>
110+
</listitem>
111+
</varlistentry>
112+
91113
</variablelist>
92114
</para>
93115

‎doc/src/sgml/ref/ecpg-ref.sgml‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.33 2010/02/19 03:50:03 momjian Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.34 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -159,28 +159,30 @@ PostgreSQL documentation
159159
<listitem>
160160
<para>
161161
Print additional information including the version and the
162-
include path.
162+
"include" path.
163163
</para>
164164
</listitem>
165165
</varlistentry>
166166

167167
<varlistentry>
168-
<term><option>--help</option></term>
168+
<term><option>--version</option></term>
169169
<listitem>
170170
<para>
171-
Show a brief summary of the command usage, then exit.
171+
Print the <application>ecpg</application> version and exit.
172172
</para>
173173
</listitem>
174174
</varlistentry>
175175

176176
<varlistentry>
177-
<term><option>--version</option></term>
177+
<term><option>--help</option></term>
178178
<listitem>
179179
<para>
180-
Output version information, then exit.
180+
Show help about <application>ecpg</application> command line
181+
arguments, and exit.
181182
</para>
182183
</listitem>
183184
</varlistentry>
185+
184186
</variablelist>
185187
</para>
186188
</refsect1>

‎doc/src/sgml/ref/initdb.sgml‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.45 2009/12/10 06:32:28 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.46 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -280,6 +280,28 @@ PostgreSQL documentation
280280
</para>
281281
</listitem>
282282
</varlistentry>
283+
284+
<varlistentry>
285+
<term><option>-V</></term>
286+
<term><option>--version</></term>
287+
<listitem>
288+
<para>
289+
Print the <application>initdb</application> version and exit.
290+
</para>
291+
</listitem>
292+
</varlistentry>
293+
294+
<varlistentry>
295+
<term><option>-?</></term>
296+
<term><option>--help</></term>
297+
<listitem>
298+
<para>
299+
Show help about <application>initdb</application> command line
300+
arguments, and exit.
301+
</para>
302+
</listitem>
303+
</varlistentry>
304+
283305
</variablelist>
284306
</para>
285307

‎doc/src/sgml/ref/pg_controldata.sgml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.11 2008/09/23 09:20:35 heikki Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.12 2010/02/19 14:36:45 momjian Exp $
33
PostgreSQL documentation
44
-->
55

@@ -40,7 +40,11 @@ PostgreSQL documentation
4040
This utility can only be run by the user who initialized the cluster because
4141
it requires read access to the data directory.
4242
You can specify the data directory on the command line, or use
43-
the environment variable <envar>PGDATA</>.
43+
the environment variable <envar>PGDATA</>. This utility supports the options
44+
<literal>-V</> and <literal>--version</>, which print the
45+
<application>pg_controldata</application> version and exit. It also
46+
supports options <literal>-?</> and <literal>--help</>, which output the
47+
supported arguments.
4448
</para>
4549
</refsect1>
4650

0 commit comments

Comments
 (0)