From: Tom Lane Date: Tue, 11 Dec 2007 19:57:32 +0000 (+0000) Subject: Make documentation of -W options more accurate and uniform. X-Git-Url: http://waps.l3s.uni-hannover.de/gitweb/?a=commitdiff_plain;h=b60053dd5a764f376f07be2cf2afe00ebc478f3d;p=users%2Fbernd%2Fpostgres.git Make documentation of -W options more accurate and uniform. --- diff --git a/contrib/vacuumlo/vacuumlo.c b/contrib/vacuumlo/vacuumlo.c index a6711ce5bd..b32d9e5bfe 100644 --- a/contrib/vacuumlo/vacuumlo.c +++ b/contrib/vacuumlo/vacuumlo.c @@ -308,7 +308,7 @@ usage(void) fprintf(stdout, " -v\t\tWrite a lot of progress messages\n"); fprintf(stdout, " -n\t\tDon't remove large objects, just show what would be done\n"); fprintf(stdout, " -U username\tUsername to connect as\n"); - fprintf(stdout, " -W\t\tPrompt for password\n"); + fprintf(stdout, " -W\t\tForce password prompt\n"); fprintf(stdout, " -h hostname\tDatabase server host\n"); fprintf(stdout, " -p port\tDatabase server port\n\n"); } diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml index fa62349cdb..56266dc1af 100644 --- a/doc/src/sgml/ref/clusterdb.sgml +++ b/doc/src/sgml/ref/clusterdb.sgml @@ -164,7 +164,18 @@ PostgreSQL documentation - Force password prompt. + Force clusterdb to prompt for a + password before connecting to a database. + + + + This option is never essential, since + clusterdb will automatically prompt + for a password if the server demands password authentication. + However, clusterdb will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index 7ccdaf9754..97c38ed4b8 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -183,7 +183,7 @@ PostgreSQL documentation - User name to connect as + User name to connect as. @@ -193,7 +193,18 @@ PostgreSQL documentation - Force password prompt. + Force createdb to prompt for a + password before connecting to a database. + + + + This option is never essential, since + createdb will automatically prompt + for a password if the server demands password authentication. + However, createdb will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml index 2ca9481e89..06c4c5806c 100644 --- a/doc/src/sgml/ref/createlang.sgml +++ b/doc/src/sgml/ref/createlang.sgml @@ -144,7 +144,18 @@ PostgreSQL documentation - Force password prompt. + Force createlang to prompt for a + password before connecting to a database. + + + + This option is never essential, since + createlang will automatically prompt + for a password if the server demands password authentication. + However, createlang will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index 5633065c54..0600424003 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -295,9 +295,20 @@ PostgreSQL documentation - Force password prompt (to connect to the server, not for the + Force createuser to prompt for a + password (for connecting to the server, not for the password of the new user). + + + This option is never essential, since + createuser will automatically prompt + for a password if the server demands password authentication. + However, createuser will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml index b5ba038056..d2fce6d55a 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -123,7 +123,7 @@ PostgreSQL documentation - User name to connect as + User name to connect as. @@ -133,7 +133,18 @@ PostgreSQL documentation - Force password prompt. + Force dropdb to prompt for a + password before connecting to a database. + + + + This option is never essential, since + dropdb will automatically prompt + for a password if the server demands password authentication. + However, dropdb will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml index 4b60ee14ea..d22dbc509e 100644 --- a/doc/src/sgml/ref/droplang.sgml +++ b/doc/src/sgml/ref/droplang.sgml @@ -142,7 +142,7 @@ PostgreSQL documentation - User name to connect as + User name to connect as. @@ -152,7 +152,18 @@ PostgreSQL documentation - Force password prompt. + Force droplang to prompt for a + password before connecting to a database. + + + + This option is never essential, since + droplang will automatically prompt + for a password if the server demands password authentication. + However, droplang will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml index 24cd5f337f..d97cc99f5d 100644 --- a/doc/src/sgml/ref/dropuser.sgml +++ b/doc/src/sgml/ref/dropuser.sgml @@ -125,7 +125,7 @@ PostgreSQL documentation - User name to connect as (not the user name to drop) + User name to connect as (not the user name to drop). @@ -135,8 +135,18 @@ PostgreSQL documentation - Force password prompt (to connect to the server, not for the - password of the user to be dropped). + Force dropuser to prompt for a + password before connecting to a database. + + + + This option is never essential, since + dropuser will automatically prompt + for a password if the server demands password authentication. + However, dropuser will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 89dc9a1079..f89cfc053d 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -647,7 +647,7 @@ PostgreSQL documentation - Connect as the given user. + User name to connect as. @@ -657,8 +657,18 @@ PostgreSQL documentation - Force a password prompt. This should happen automatically if - the server requires password authentication. + Force pg_dump to prompt for a + password before connecting to a database. + + + + This option is never essential, since + pg_dump will automatically prompt + for a password if the server demands password authentication. + However, pg_dump will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index 576d3fdd92..6f924f2bfb 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -59,7 +59,7 @@ PostgreSQL documentation pg_dumpall needs to connect several times to the PostgreSQL server (once per - database). If you use password authentication it is likely to ask for + database). If you use password authentication it will ask for a password each time. It is convenient to have a ~/.pgpass file in such cases. See for more information. @@ -367,7 +367,7 @@ PostgreSQL documentation --username=username - Connect as the given user. + User name to connect as. @@ -377,8 +377,24 @@ PostgreSQL documentation --password - Force a password prompt. This should happen automatically if - the server requires password authentication. + Force pg_dumpall to prompt for a + password before connecting to a database. + + + + This option is never essential, since + pg_dumpall will automatically prompt + for a password if the server demands password authentication. + However, pg_dumpall will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing + + + Note that the password prompt will occur again for each database + to be dumped. Usually, it's better to set up a + ~/.pgpass file than to rely on manual password entry. diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 4fa352d682..fb7bd0aea3 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -458,7 +458,7 @@ - Connect as the given user. + User name to connect as. @@ -468,8 +468,18 @@ - Force a password prompt. This should happen automatically if - the server requires password authentication. + Force pg_restore to prompt for a + password before connecting to a database. + + + + This option is never essential, since + pg_restore will automatically prompt + for a password if the server demands password authentication. + However, pg_restore will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index c1ab88410a..bf1162fcec 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -406,25 +406,24 @@ PostgreSQL documentation - Forces psql to prompt for a - password before connecting to a database. + Force psql to prompt for a + password before connecting to a database. - psql should automatically prompt for a - password whenever the server requests password authentication. - However, currently password request detection is not totally - reliable, hence this option to force a prompt. If no password - prompt is issued and the server requires password authentication, - the connection attempt will fail. + This option is never essential, since psql + will automatically prompt for a password if the server demands + password authentication. However, psql + will waste a connection attempt finding out that the server wants a + password. In some cases it is worth typing - This option will remain set for the entire session, even if you - change the database connection with the meta-command - \connect. + Note that this option will remain set for the entire session, + and so it affects uses of the meta-command + \connect as well as the initial connection attempt. - diff --git a/doc/src/sgml/ref/reindexdb.sgml b/doc/src/sgml/ref/reindexdb.sgml index e4469bb12e..259b170860 100644 --- a/doc/src/sgml/ref/reindexdb.sgml +++ b/doc/src/sgml/ref/reindexdb.sgml @@ -186,7 +186,18 @@ PostgreSQL documentation - Force password prompt. + Force reindexdb to prompt for a + password before connecting to a database. + + + + This option is never essential, since + reindexdb will automatically prompt + for a password if the server demands password authentication. + However, reindexdb will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index 6b6493ef96..6a00946827 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -199,7 +199,7 @@ PostgreSQL documentation - User name to connect as + User name to connect as. @@ -209,7 +209,18 @@ PostgreSQL documentation - Force password prompt. + Force vacuumdb to prompt for a + password before connecting to a database. + + + + This option is never essential, since + vacuumdb will automatically prompt + for a password if the server demands password authentication. + However, vacuumdb will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing diff --git a/doc/src/sgml/vacuumlo.sgml b/doc/src/sgml/vacuumlo.sgml index 349113ca7d..e05f2ef69e 100644 --- a/doc/src/sgml/vacuumlo.sgml +++ b/doc/src/sgml/vacuumlo.sgml @@ -38,42 +38,55 @@ vacuumlo [options] database [database2 ... databaseN] - Write a lot of progress messages + Write a lot of progress messages. - Don't remove anything, just show what would be done + Don't remove anything, just show what would be done. username - Username to connect as + Username to connect as. - Force prompt for password (generally useless) + + Force vacuumlo to prompt for a + password before connecting to a database. + + + + This option is never essential, since + vacuumlo will automatically prompt + for a password if the server demands password authentication. + However, vacuumlo will waste a + connection attempt finding out that the server wants a password. + In some cases it is worth typing hostname - Database server's host + Database server's host. port - Database server's port + Database server's port. diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c index 02be4d4150..224b94fd96 100644 --- a/src/bin/psql/help.c +++ b/src/bin/psql/help.c @@ -132,7 +132,7 @@ usage(void) if (!env) env = user; printf(_(" -U NAME database user name (default: \"%s\")\n"), env); - puts(_(" -W prompt for password (should happen automatically)")); + puts(_(" -W force password prompt (should happen automatically)")); puts(_( "\nFor more information, type \"\\?\" (for internal commands) or \"\\help\"\n" diff --git a/src/bin/scripts/clusterdb.c b/src/bin/scripts/clusterdb.c index 2422693ef0..fc484e0508 100644 --- a/src/bin/scripts/clusterdb.c +++ b/src/bin/scripts/clusterdb.c @@ -236,7 +236,7 @@ help(const char *progname) printf(_(" -h, --host=HOSTNAME database server host or socket directory\n")); printf(_(" -p, --port=PORT database server port\n")); printf(_(" -U, --username=USERNAME user name to connect as\n")); - printf(_(" -W, --password prompt for password\n")); + printf(_(" -W, --password force password prompt\n")); printf(_("\nRead the description of the SQL command CLUSTER for details.\n")); printf(_("\nReport bugs to .\n")); } diff --git a/src/bin/scripts/createdb.c b/src/bin/scripts/createdb.c index a12a8b3ce0..e2f320d5ad 100644 --- a/src/bin/scripts/createdb.c +++ b/src/bin/scripts/createdb.c @@ -218,7 +218,7 @@ help(const char *progname) printf(_(" -h, --host=HOSTNAME database server host or socket directory\n")); printf(_(" -p, --port=PORT database server port\n")); printf(_(" -U, --username=USERNAME user name to connect as\n")); - printf(_(" -W, --password prompt for password\n")); + printf(_(" -W, --password force password prompt\n")); printf(_("\nBy default, a database with the same name as the current user is created.\n")); printf(_("\nReport bugs to .\n")); } diff --git a/src/bin/scripts/createlang.c b/src/bin/scripts/createlang.c index a0f2f47958..565b7856de 100644 --- a/src/bin/scripts/createlang.c +++ b/src/bin/scripts/createlang.c @@ -212,7 +212,7 @@ help(const char *progname) printf(_(" -h, --host=HOSTNAME database server host or socket directory\n")); printf(_(" -p, --port=PORT database server port\n")); printf(_(" -U, --username=USERNAME user name to connect as\n")); - printf(_(" -W, --password prompt for password\n")); + printf(_(" -W, --password force password prompt\n")); printf(_(" --help show this help, then exit\n")); printf(_(" --version output version information, then exit\n")); printf(_("\nReport bugs to .\n")); diff --git a/src/bin/scripts/createuser.c b/src/bin/scripts/createuser.c index db89ff725a..8eab51391e 100644 --- a/src/bin/scripts/createuser.c +++ b/src/bin/scripts/createuser.c @@ -329,7 +329,7 @@ help(const char *progname) printf(_(" -h, --host=HOSTNAME database server host or socket directory\n")); printf(_(" -p, --port=PORT database server port\n")); printf(_(" -U, --username=USERNAME user name to connect as (not the one to create)\n")); - printf(_(" -W, --password prompt for password to connect\n")); + printf(_(" -W, --password force password prompt\n")); printf(_("\nIf one of -s, -S, -d, -D, -r, -R and ROLENAME is not specified, you will\n" "be prompted interactively.\n")); printf(_("\nReport bugs to .\n")); diff --git a/src/bin/scripts/dropdb.c b/src/bin/scripts/dropdb.c index 88d508c67a..06c88172d5 100644 --- a/src/bin/scripts/dropdb.c +++ b/src/bin/scripts/dropdb.c @@ -145,7 +145,7 @@ help(const char *progname) printf(_(" -h, --host=HOSTNAME database server host or socket directory\n")); printf(_(" -p, --port=PORT database server port\n")); printf(_(" -U, --username=USERNAME user name to connect as\n")); - printf(_(" -W, --password prompt for password\n")); + printf(_(" -W, --password force password prompt\n")); printf(_(" --help show this help, then exit\n")); printf(_(" --version output version information, then exit\n")); printf(_("\nReport bugs to .\n")); diff --git a/src/bin/scripts/droplang.c b/src/bin/scripts/droplang.c index d687909b51..350d5698c6 100644 --- a/src/bin/scripts/droplang.c +++ b/src/bin/scripts/droplang.c @@ -329,7 +329,7 @@ help(const char *progname) printf(_(" -h, --host=HOSTNAME database server host or socket directory\n")); printf(_(" -p, --port=PORT database server port\n")); printf(_(" -U, --username=USERNAME user name to connect as\n")); - printf(_(" -W, --password prompt for password\n")); + printf(_(" -W, --password force password prompt\n")); printf(_(" --help show this help, then exit\n")); printf(_(" --version output version information, then exit\n")); printf(_("\nReport bugs to .\n")); diff --git a/src/bin/scripts/dropuser.c b/src/bin/scripts/dropuser.c index cf6d022366..a0967a9f89 100644 --- a/src/bin/scripts/dropuser.c +++ b/src/bin/scripts/dropuser.c @@ -144,7 +144,7 @@ help(const char *progname) printf(_(" -h, --host=HOSTNAME database server host or socket directory\n")); printf(_(" -p, --port=PORT database server port\n")); printf(_(" -U, --username=USERNAME user name to connect as (not the one to drop)\n")); - printf(_(" -W, --password prompt for password to connect\n")); + printf(_(" -W, --password force password prompt\n")); printf(_(" --help show this help, then exit\n")); printf(_(" --version output version information, then exit\n")); printf(_("\nReport bugs to .\n")); diff --git a/src/bin/scripts/reindexdb.c b/src/bin/scripts/reindexdb.c index c88c24d07d..c3816f27a5 100644 --- a/src/bin/scripts/reindexdb.c +++ b/src/bin/scripts/reindexdb.c @@ -322,7 +322,7 @@ help(const char *progname) printf(_(" -h, --host=HOSTNAME database server host or socket directory\n")); printf(_(" -p, --port=PORT database server port\n")); printf(_(" -U, --username=USERNAME user name to connect as\n")); - printf(_(" -W, --password prompt for password\n")); + printf(_(" -W, --password force password prompt\n")); printf(_("\nRead the description of the SQL command REINDEX for details.\n")); printf(_("\nReport bugs to .\n")); } diff --git a/src/bin/scripts/vacuumdb.c b/src/bin/scripts/vacuumdb.c index 501179a6ea..f646b82891 100644 --- a/src/bin/scripts/vacuumdb.c +++ b/src/bin/scripts/vacuumdb.c @@ -265,7 +265,7 @@ help(const char *progname) printf(_(" -h, --host=HOSTNAME database server host or socket directory\n")); printf(_(" -p, --port=PORT database server port\n")); printf(_(" -U, --username=USERNAME user name to connect as\n")); - printf(_(" -W, --password prompt for password\n")); + printf(_(" -W, --password force password prompt\n")); printf(_("\nRead the description of the SQL command VACUUM for details.\n")); printf(_("\nReport bugs to .\n")); }