Skip to content

Commit ea00ff5

Browse files
peterepetere
committed
Review program help output for wording and formatting
1 parent 68b5201 commit ea00ff5

File tree

10 files changed

+19
-16
lines changed

10 files changed

+19
-16
lines changed

‎src/bin/pg_basebackup/pg_receivexlog.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ usage(void)
6767
printf(_(" %s [OPTION]...\n"), progname);
6868
printf(_("\nOptions:\n"));
6969
printf(_(" -D, --directory=DIR receive transaction log files into this directory\n"));
70-
printf(_(" --if-not-exists do not treat naming conflicts as an error when creating a slot\n"));
70+
printf(_(" --if-not-exists do not error if slot already exists when creating a slot\n"));
7171
printf(_(" -n, --no-loop do not loop on connection lost\n"));
7272
printf(_(" -s, --status-interval=SECS\n"
7373
" time between status packets sent to server (default: %d)\n"), (standby_message_timeout / 1000));

‎src/bin/pg_basebackup/pg_recvlogical.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ usage(void)
7676
printf(_(" -f, --file=FILE receive log into this file, - for stdout\n"));
7777
printf(_(" -F --fsync-interval=SECS\n"
7878
" time between fsyncs to the output file (default: %d)\n"), (fsync_interval / 1000));
79-
printf(_(" --if-not-exists do not treat naming conflicts as an error when creating a slot\n"));
79+
printf(_(" --if-not-exists do not error if slot already exists when creating a slot\n"));
8080
printf(_(" -I, --startpos=LSN where in an existing slot should the streaming start\n"));
8181
printf(_(" -n, --no-loop do not loop on connection lost\n"));
8282
printf(_(" -o, --option=NAME[=VALUE]\n"

‎src/bin/pg_controldata/pg_controldata.c

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@ usage(const char *progname)
3434
{
3535
printf(_("%s displays control information of a PostgreSQL database cluster.\n\n"), progname);
3636
printf(_("Usage:\n"));
37-
printf(_(" %s [OPTION] [[-D] DATADIR]\n"), progname);
37+
printf(_(" %s [OPTION] [DATADIR]\n"), progname);
3838
printf(_("\nOptions:\n"));
39+
printf(_(" [-D] DATADIR data directory\n"));
3940
printf(_(" -V, --version output version information, then exit\n"));
4041
printf(_(" -?, --help show this help, then exit\n"));
4142
printf(_("\nIf no data directory (DATADIR) is specified, "

‎src/bin/pg_dump/pg_dump.c

+2-1
Original file line numberDiff line numberDiff line change
@@ -893,7 +893,8 @@ help(const char *progname)
893893
printf(_(" --column-inserts dump data as INSERT commands with column names\n"));
894894
printf(_(" --disable-dollar-quoting disable dollar quoting, use SQL standard quoting\n"));
895895
printf(_(" --disable-triggers disable triggers during data-only restore\n"));
896-
printf(_(" --enable-row-security enable row level security\n"));
896+
printf(_(" --enable-row-security enable row security (dump only content user has\n"
897+
" access to)\n"));
897898
printf(_(" --exclude-table-data=TABLE do NOT dump data for the named table(s)\n"));
898899
printf(_(" --if-exists use IF EXISTS when dropping objects\n"));
899900
printf(_(" --inserts dump data as INSERT commands, rather than COPY\n"));

‎src/bin/pg_dump/pg_restore.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ usage(const char *progname)
460460
printf(_(" -x, --no-privileges skip restoration of access privileges (grant/revoke)\n"));
461461
printf(_(" -1, --single-transaction restore as a single transaction\n"));
462462
printf(_(" --disable-triggers disable triggers during data-only restore\n"));
463-
printf(_(" --enable-row-security enable row level security\n"));
463+
printf(_(" --enable-row-security enable row security\n"));
464464
printf(_(" --if-exists use IF EXISTS when dropping objects\n"));
465465
printf(_(" --no-data-for-failed-tables do not restore data of tables that could not be\n"
466466
" created\n"));

‎src/bin/pg_resetxlog/pg_resetxlog.c

+2-1
Original file line numberDiff line numberDiff line change
@@ -1165,10 +1165,11 @@ static void
11651165
usage(void)
11661166
{
11671167
printf(_("%s resets the PostgreSQL transaction log.\n\n"), progname);
1168-
printf(_("Usage:\n %s [OPTION]... {[-D] DATADIR}\n\n"), progname);
1168+
printf(_("Usage:\n %s [OPTION]... DATADIR\n\n"), progname);
11691169
printf(_("Options:\n"));
11701170
printf(_(" -c XID,XID set oldest and newest transactions bearing commit timestamp\n"));
11711171
printf(_(" (zero in either value means no change)\n"));
1172+
printf(_(" [-D] DATADIR data directory\n"));
11721173
printf(_(" -e XIDEPOCH set next transaction ID epoch\n"));
11731174
printf(_(" -f force update to be done\n"));
11741175
printf(_(" -l XLOGFILE force minimum WAL starting location for new transaction log\n"));

‎src/bin/pg_rewind/pg_rewind.c

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ usage(const char *progname)
6060
printf(_("Usage:\n %s [OPTION]...\n\n"), progname);
6161
printf(_("Options:\n"));
6262
printf(_(" -D, --target-pgdata=DIRECTORY existing data directory to modify\n"));
63-
printf(_(" --source-pgdata=DIRECTORY source data directory to sync with\n"));
64-
printf(_(" --source-server=CONNSTR source server to sync with\n"));
63+
printf(_(" --source-pgdata=DIRECTORY source data directory to synchronize with\n"));
64+
printf(_(" --source-server=CONNSTR source server to synchronize with\n"));
6565
printf(_(" -n, --dry-run stop before modifying anything\n"));
6666
printf(_(" -P, --progress write progress messages\n"));
6767
printf(_(" --debug write a lot of debug messages\n"));

‎src/bin/pgbench/pgbench.c

+1-2
Original file line numberDiff line numberDiff line change
@@ -390,8 +390,7 @@ usage(void)
390390
" -f, --file=FILENAME read transaction script from FILENAME\n"
391391
" -j, --jobs=NUM number of threads (default: 1)\n"
392392
" -l, --log write transaction times to log file\n"
393-
" -L, --latency-limit=NUM count transactions lasting more than NUM ms\n"
394-
" as late.\n"
393+
" -L, --latency-limit=NUM count transactions lasting more than NUM ms as late\n"
395394
" -M, --protocol=simple|extended|prepared\n"
396395
" protocol for submitting queries (default: simple)\n"
397396
" -n, --no-vacuum do not run VACUUM before tests\n"

‎src/bin/psql/help.c

+4-3
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,15 @@ usage(unsigned short int pager)
8181
fprintf(output, _(" -f, --file=FILENAME execute commands from file, then exit\n"));
8282
fprintf(output, _(" -l, --list list available databases, then exit\n"));
8383
fprintf(output, _(" -v, --set=, --variable=NAME=VALUE\n"
84-
" set psql variable NAME to VALUE e.g.: -v ON_ERROR_STOP=1\n"));
84+
" set psql variable NAME to VALUE\n"
85+
" (e.g., -v ON_ERROR_STOP=1)\n"));
8586
fprintf(output, _(" -V, --version output version information, then exit\n"));
8687
fprintf(output, _(" -X, --no-psqlrc do not read startup file (~/.psqlrc)\n"));
8788
fprintf(output, _(" -1 (\"one\"), --single-transaction\n"
8889
" execute as a single transaction (if non-interactive)\n"));
8990
fprintf(output, _(" -?, --help[=options] show this help, then exit\n"));
90-
fprintf(output, _(" --help=variables show a list of all specially treated variables, then exit\n"));
91-
fprintf(output, _(" --help=commands show a list of backslash commands, then exit\n"));
91+
fprintf(output, _(" --help=commands list backslash commands, then exit\n"));
92+
fprintf(output, _(" --help=variables list special variables, then exit\n"));
9293

9394
fprintf(output, _("\nInput and output options:\n"));
9495
fprintf(output, _(" -a, --echo-all echo all input from script\n"));

‎src/bin/scripts/vacuumdb.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -936,15 +936,15 @@ help(const char *progname)
936936
printf(_(" -e, --echo show the commands being sent to the server\n"));
937937
printf(_(" -f, --full do full vacuuming\n"));
938938
printf(_(" -F, --freeze freeze row transaction information\n"));
939+
printf(_(" -j, --jobs=NUM use this many concurrent connections to vacuum\n"));
939940
printf(_(" -q, --quiet don't write any messages\n"));
940941
printf(_(" -t, --table='TABLE[(COLUMNS)]' vacuum specific table(s) only\n"));
941942
printf(_(" -v, --verbose write a lot of output\n"));
942943
printf(_(" -V, --version output version information, then exit\n"));
943944
printf(_(" -z, --analyze update optimizer statistics\n"));
944-
printf(_(" -Z, --analyze-only only update optimizer statistics; no vacuum\n"));
945-
printf(_(" -j, --jobs=NUM use this many concurrent connections to vacuum\n"));
945+
printf(_(" -Z, --analyze-only only update optimizer statistics; no vacuum\n"));
946946
printf(_(" --analyze-in-stages only update optimizer statistics, in multiple\n"
947-
" stages for faster results; no vacuum\n"));
947+
" stages for faster results; no vacuum\n"));
948948
printf(_(" -?, --help show this help, then exit\n"));
949949
printf(_("\nConnection options:\n"));
950950
printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));

0 commit comments

Comments
 (0)