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

Commit 1ebff9b

Browse files
tglsfdctglsfdc
committed
Make documentation of -W options more accurate and uniform.
1 parent 1161f1a commit 1ebff9b

25 files changed

+224
-78
lines changed

‎contrib/vacuumlo/vacuumlo.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*
99
*
1010
* IDENTIFICATION
11-
* $PostgreSQL: pgsql/contrib/vacuumlo/vacuumlo.c,v 1.34 2007/12/11 02:08:59 tgl Exp $
11+
* $PostgreSQL: pgsql/contrib/vacuumlo/vacuumlo.c,v 1.35 2007/12/11 19:57:32 tgl Exp $
1212
*
1313
*-------------------------------------------------------------------------
1414
*/
@@ -308,7 +308,7 @@ usage(void)
308308
fprintf(stdout, " -v\t\tWrite a lot of progress messages\n");
309309
fprintf(stdout, " -n\t\tDon't remove large objects, just show what would be done\n");
310310
fprintf(stdout, " -U username\tUsername to connect as\n");
311-
fprintf(stdout, " -W\t\tPrompt for password\n");
311+
fprintf(stdout, " -W\t\tForce password prompt\n");
312312
fprintf(stdout, " -h hostname\tDatabase server host\n");
313313
fprintf(stdout, " -p port\tDatabase server port\n\n");
314314
}

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.22 2007/06/04 10:02:40 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.23 2007/12/11 19:57:32 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -164,7 +164,18 @@ PostgreSQL documentation
164164
<term><option>--password</></term>
165165
<listitem>
166166
<para>
167-
Force password prompt.
167+
Force <application>clusterdb</application> to prompt for a
168+
password before connecting to a database.
169+
</para>
170+
171+
<para>
172+
This option is never essential, since
173+
<application>clusterdb</application> will automatically prompt
174+
for a password if the server demands password authentication.
175+
However, <application>clusterdb</application> will waste a
176+
connection attempt finding out that the server wants a password.
177+
In some cases it is worth typing <option>-W</> to avoid the extra
178+
connection attempt.
168179
</para>
169180
</listitem>
170181
</varlistentry>

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.46 2007/06/21 10:43:09 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.47 2007/12/11 19:57:32 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -183,7 +183,7 @@ PostgreSQL documentation
183183
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
184184
<listitem>
185185
<para>
186-
User name to connect as
186+
User name to connect as.
187187
</para>
188188
</listitem>
189189
</varlistentry>
@@ -193,7 +193,18 @@ PostgreSQL documentation
193193
<term><option>--password</></term>
194194
<listitem>
195195
<para>
196-
Force password prompt.
196+
Force <application>createdb</application> to prompt for a
197+
password before connecting to a database.
198+
</para>
199+
200+
<para>
201+
This option is never essential, since
202+
<application>createdb</application> will automatically prompt
203+
for a password if the server demands password authentication.
204+
However, <application>createdb</application> will waste a
205+
connection attempt finding out that the server wants a password.
206+
In some cases it is worth typing <option>-W</> to avoid the extra
207+
connection attempt.
197208
</para>
198209
</listitem>
199210
</varlistentry>

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.41 2007/05/15 19:43:51 neilc Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.42 2007/12/11 19:57:32 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -144,7 +144,18 @@ PostgreSQL documentation
144144
<term><option>--password</></term>
145145
<listitem>
146146
<para>
147-
Force password prompt.
147+
Force <application>createlang</application> to prompt for a
148+
password before connecting to a database.
149+
</para>
150+
151+
<para>
152+
This option is never essential, since
153+
<application>createlang</application> will automatically prompt
154+
for a password if the server demands password authentication.
155+
However, <application>createlang</application> will waste a
156+
connection attempt finding out that the server wants a password.
157+
In some cases it is worth typing <option>-W</> to avoid the extra
158+
connection attempt.
148159
</para>
149160
</listitem>
150161
</varlistentry>

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.50 2007/06/21 12:20:10 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.51 2007/12/11 19:57:32 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -295,9 +295,20 @@ PostgreSQL documentation
295295
<term><option>--password</></term>
296296
<listitem>
297297
<para>
298-
Force password prompt (to connect to the server, not for the
298+
Force <application>createuser</application> to prompt for a
299+
password (for connecting to the server, not for the
299300
password of the new user).
300301
</para>
302+
303+
<para>
304+
This option is never essential, since
305+
<application>createuser</application> will automatically prompt
306+
for a password if the server demands password authentication.
307+
However, <application>createuser</application> will waste a
308+
connection attempt finding out that the server wants a password.
309+
In some cases it is worth typing <option>-W</> to avoid the extra
310+
connection attempt.
311+
</para>
301312
</listitem>
302313
</varlistentry>
303314
</variablelist>

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.33 2007/06/21 10:43:09 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.34 2007/12/11 19:57:32 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -123,7 +123,7 @@ PostgreSQL documentation
123123
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
124124
<listitem>
125125
<para>
126-
User name to connect as
126+
User name to connect as.
127127
</para>
128128
</listitem>
129129
</varlistentry>
@@ -133,7 +133,18 @@ PostgreSQL documentation
133133
<term><option>--password</></term>
134134
<listitem>
135135
<para>
136-
Force password prompt.
136+
Force <application>dropdb</application> to prompt for a
137+
password before connecting to a database.
138+
</para>
139+
140+
<para>
141+
This option is never essential, since
142+
<application>dropdb</application> will automatically prompt
143+
for a password if the server demands password authentication.
144+
However, <application>dropdb</application> will waste a
145+
connection attempt finding out that the server wants a password.
146+
In some cases it is worth typing <option>-W</> to avoid the extra
147+
connection attempt.
137148
</para>
138149
</listitem>
139150
</varlistentry>

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.30 2007/03/26 17:23:36 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.31 2007/12/11 19:57:32 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -142,7 +142,7 @@ PostgreSQL documentation
142142
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
143143
<listitem>
144144
<para>
145-
User name to connect as
145+
User name to connect as.
146146
</para>
147147
</listitem>
148148
</varlistentry>
@@ -152,7 +152,18 @@ PostgreSQL documentation
152152
<term><option>--password</></term>
153153
<listitem>
154154
<para>
155-
Force password prompt.
155+
Force <application>droplang</application> to prompt for a
156+
password before connecting to a database.
157+
</para>
158+
159+
<para>
160+
This option is never essential, since
161+
<application>droplang</application> will automatically prompt
162+
for a password if the server demands password authentication.
163+
However, <application>droplang</application> will waste a
164+
connection attempt finding out that the server wants a password.
165+
In some cases it is worth typing <option>-W</> to avoid the extra
166+
connection attempt.
156167
</para>
157168
</listitem>
158169
</varlistentry>

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

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.38 2007/06/21 10:43:09 petere Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.39 2007/12/11 19:57:32 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -125,7 +125,7 @@ PostgreSQL documentation
125125
<term><option>--username <replaceable class="parameter">username</replaceable></></term>
126126
<listitem>
127127
<para>
128-
User name to connect as (not the user name to drop)
128+
User name to connect as (not the user name to drop).
129129
</para>
130130
</listitem>
131131
</varlistentry>
@@ -135,8 +135,18 @@ PostgreSQL documentation
135135
<term><option>--password</></term>
136136
<listitem>
137137
<para>
138-
Force password prompt (to connect to the server, not for the
139-
password of the user to be dropped).
138+
Force <application>dropuser</application> to prompt for a
139+
password before connecting to a database.
140+
</para>
141+
142+
<para>
143+
This option is never essential, since
144+
<application>dropuser</application> will automatically prompt
145+
for a password if the server demands password authentication.
146+
However, <application>dropuser</application> will waste a
147+
connection attempt finding out that the server wants a password.
148+
In some cases it is worth typing <option>-W</> to avoid the extra
149+
connection attempt.
140150
</para>
141151
</listitem>
142152
</varlistentry>

‎doc/src/sgml/ref/pg_dump.sgml

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.97 2007/03/26 17:23:36 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.98 2007/12/11 19:57:32 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -647,7 +647,7 @@ PostgreSQL documentation
647647
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
648648
<listitem>
649649
<para>
650-
Connect as the given user.
650+
User name to connect as.
651651
</para>
652652
</listitem>
653653
</varlistentry>
@@ -657,8 +657,18 @@ PostgreSQL documentation
657657
<term><option>--password</option></term>
658658
<listitem>
659659
<para>
660-
Force a password prompt. This should happen automatically if
661-
the server requires password authentication.
660+
Force <application>pg_dump</application> to prompt for a
661+
password before connecting to a database.
662+
</para>
663+
664+
<para>
665+
This option is never essential, since
666+
<application>pg_dump</application> will automatically prompt
667+
for a password if the server demands password authentication.
668+
However, <application>pg_dump</application> will waste a
669+
connection attempt finding out that the server wants a password.
670+
In some cases it is worth typing <option>-W</> to avoid the extra
671+
connection attempt.
662672
</para>
663673
</listitem>
664674
</varlistentry>

‎doc/src/sgml/ref/pg_dumpall.sgml

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.68 2007/03/26 17:23:37 tgl Exp $
2+
$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.69 2007/12/11 19:57:32 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -59,7 +59,7 @@ PostgreSQL documentation
5959
<para>
6060
<application>pg_dumpall</application> needs to connect several
6161
times to the <productname>PostgreSQL</productname> server (once per
62-
database). If you use password authentication it is likely to ask for
62+
database). If you use password authentication it will ask for
6363
a password each time. It is convenient to have a
6464
<filename>~/.pgpass</> file in such cases. See <xref
6565
linkend="libpq-pgpass"> for more information.
@@ -367,7 +367,7 @@ PostgreSQL documentation
367367
<term>--username=<replaceable>username</replaceable></term>
368368
<listitem>
369369
<para>
370-
Connect as the given user.
370+
User name to connect as.
371371
</para>
372372
</listitem>
373373
</varlistentry>
@@ -377,8 +377,24 @@ PostgreSQL documentation
377377
<term>--password</term>
378378
<listitem>
379379
<para>
380-
Force a password prompt. This should happen automatically if
381-
the server requires password authentication.
380+
Force <application>pg_dumpall</application> to prompt for a
381+
password before connecting to a database.
382+
</para>
383+
384+
<para>
385+
This option is never essential, since
386+
<application>pg_dumpall</application> will automatically prompt
387+
for a password if the server demands password authentication.
388+
However, <application>pg_dumpall</application> will waste a
389+
connection attempt finding out that the server wants a password.
390+
In some cases it is worth typing <option>-W</> to avoid the extra
391+
connection attempt.
392+
</para>
393+
394+
<para>
395+
Note that the password prompt will occur again for each database
396+
to be dumped. Usually, it's better to set up a
397+
<filename>~/.pgpass</> file than to rely on manual password entry.
382398
</para>
383399
</listitem>
384400
</varlistentry>

‎doc/src/sgml/ref/pg_restore.sgml

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.71 2007/05/15 19:13:55 neilc Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.72 2007/12/11 19:57:32 tgl Exp $ -->
22

33
<refentry id="APP-PGRESTORE">
44
<refmeta>
@@ -458,7 +458,7 @@
458458
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
459459
<listitem>
460460
<para>
461-
Connect as the given user.
461+
User name to connect as.
462462
</para>
463463
</listitem>
464464
</varlistentry>
@@ -468,8 +468,18 @@
468468
<term><option>--password</option></term>
469469
<listitem>
470470
<para>
471-
Force a password prompt. This should happen automatically if
472-
the server requires password authentication.
471+
Force <application>pg_restore</application> to prompt for a
472+
password before connecting to a database.
473+
</para>
474+
475+
<para>
476+
This option is never essential, since
477+
<application>pg_restore</application> will automatically prompt
478+
for a password if the server demands password authentication.
479+
However, <application>pg_restore</application> will waste a
480+
connection attempt finding out that the server wants a password.
481+
In some cases it is worth typing <option>-W</> to avoid the extra
482+
connection attempt.
473483
</para>
474484
</listitem>
475485
</varlistentry>

0 commit comments

Comments
 (0)