Skip to content

Commit 3955c8c

Browse files
tglsfdctglsfdc
committed
Reformat psql's --help=variables output.
The previous format with variable names and descriptions in separate columns was extremely constraining about the length of the descriptions. We'd dealt with that in several inconsistent ways over the years, including letting the lines run over 80 characters, breaking descriptions into multiple lines, or shoving the description onto a separate line. But it's been a long time since the output could realistically fit onto a single screen vertically, so let's just rely even more heavily on the pager to deal with the vertical distance, and split each entry into two (or more) lines, in the format variable-name variable description goes here Each variable name + description remains a single translatable string, in hopes of reducing translator confusion; we're just changing the embedded whitespace. I failed to resist the temptation to copy-edit one or two of the descriptions while at it. Discussion: https://postgr.es/m/2947.1504542679@sss.pgh.pa.us
1 parent 0b707d6 commit 3955c8c

File tree

1 file changed

+117
-64
lines changed

1 file changed

+117
-64
lines changed

‎src/bin/psql/help.c‎

Lines changed: 117 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -336,70 +336,110 @@ helpVariables(unsigned short int pager)
336336
* Windows builds currently print one more line than non-Windows builds.
337337
* Using the larger number is fine.
338338
*/
339-
output = PageOutput(88, pager ? &(pset.popt.topt) : NULL);
339+
output = PageOutput(140, pager ? &(pset.popt.topt) : NULL);
340340

341341
fprintf(output, _("List of specially treated variables\n\n"));
342342

343343
fprintf(output, _("psql variables:\n"));
344344
fprintf(output, _("Usage:\n"));
345345
fprintf(output, _(" psql --set=NAME=VALUE\n or \\set NAME VALUE inside psql\n\n"));
346346

347-
fprintf(output, _(" AUTOCOMMIT if set, successful SQL commands are automatically committed\n"));
348-
fprintf(output, _(" COMP_KEYWORD_CASE determines the case used to complete SQL key words\n"
349-
" [lower, upper, preserve-lower, preserve-upper]\n"));
350-
fprintf(output, _(" DBNAME the currently connected database name\n"));
351-
fprintf(output, _(" ECHO controls what input is written to standard output\n"
352-
" [all, errors, none, queries]\n"));
353-
fprintf(output, _(" ECHO_HIDDEN if set, display internal queries executed by backslash commands;\n"
354-
" if set to \"noexec\", just show without execution\n"));
355-
fprintf(output, _(" ENCODING current client character set encoding\n"));
356-
fprintf(output, _(" FETCH_COUNT the number of result rows to fetch and display at a time\n"
357-
" (default: 0=unlimited)\n"));
358-
fprintf(output, _(" HISTCONTROL controls command history [ignorespace, ignoredups, ignoreboth]\n"));
359-
fprintf(output, _(" HISTFILE file name used to store the command history\n"));
360-
fprintf(output, _(" HISTSIZE max number of commands to store in the command history\n"));
361-
fprintf(output, _(" HOST the currently connected database server host\n"));
362-
fprintf(output, _(" IGNOREEOF number of EOFs needed to terminate an interactive session\n"));
363-
fprintf(output, _(" LASTOID value of the last affected OID\n"));
364-
fprintf(output, _(" ON_ERROR_ROLLBACK if set, an error doesn't stop a transaction (uses implicit savepoints)\n"));
365-
fprintf(output, _(" ON_ERROR_STOP stop batch execution after error\n"));
366-
fprintf(output, _(" PORT server port of the current connection\n"));
367-
fprintf(output, _(" PROMPT1 specifies the standard psql prompt\n"));
368-
fprintf(output, _(" PROMPT2 specifies the prompt used when a statement continues from a previous line\n"));
369-
fprintf(output, _(" PROMPT3 specifies the prompt used during COPY ... FROM STDIN\n"));
370-
fprintf(output, _(" QUIET run quietly (same as -q option)\n"));
371-
fprintf(output, _(" SHOW_CONTEXT controls display of message context fields [never, errors, always]\n"));
372-
fprintf(output, _(" SINGLELINE end of line terminates SQL command mode (same as -S option)\n"));
373-
fprintf(output, _(" SINGLESTEP single-step mode (same as -s option)\n"));
374-
fprintf(output, _(" USER the currently connected database user\n"));
375-
fprintf(output, _(" VERBOSITY controls verbosity of error reports [default, verbose, terse]\n"));
347+
fprintf(output, _(" AUTOCOMMIT\n"
348+
" if set, successful SQL commands are automatically committed\n"));
349+
fprintf(output, _(" COMP_KEYWORD_CASE\n"
350+
" determines the case used to complete SQL key words\n"
351+
" [lower, upper, preserve-lower, preserve-upper]\n"));
352+
fprintf(output, _(" DBNAME\n"
353+
" the currently connected database name\n"));
354+
fprintf(output, _(" ECHO\n"
355+
" controls what input is written to standard output\n"
356+
" [all, errors, none, queries]\n"));
357+
fprintf(output, _(" ECHO_HIDDEN\n"
358+
" if set, display internal queries executed by backslash commands;\n"
359+
" if set to \"noexec\", just show them without execution\n"));
360+
fprintf(output, _(" ENCODING\n"
361+
" current client character set encoding\n"));
362+
fprintf(output, _(" FETCH_COUNT\n"
363+
" the number of result rows to fetch and display at a time (0 = unlimited)\n"));
364+
fprintf(output, _(" HISTCONTROL\n"
365+
" controls command history [ignorespace, ignoredups, ignoreboth]\n"));
366+
fprintf(output, _(" HISTFILE\n"
367+
" file name used to store the command history\n"));
368+
fprintf(output, _(" HISTSIZE\n"
369+
" max number of commands to store in the command history\n"));
370+
fprintf(output, _(" HOST\n"
371+
" the currently connected database server host\n"));
372+
fprintf(output, _(" IGNOREEOF\n"
373+
" number of EOFs needed to terminate an interactive session\n"));
374+
fprintf(output, _(" LASTOID\n"
375+
" value of the last affected OID\n"));
376+
fprintf(output, _(" ON_ERROR_ROLLBACK\n"
377+
" if set, an error doesn't stop a transaction (uses implicit savepoints)\n"));
378+
fprintf(output, _(" ON_ERROR_STOP\n"
379+
" stop batch execution after error\n"));
380+
fprintf(output, _(" PORT\n"
381+
" server port of the current connection\n"));
382+
fprintf(output, _(" PROMPT1\n"
383+
" specifies the standard psql prompt\n"));
384+
fprintf(output, _(" PROMPT2\n"
385+
" specifies the prompt used when a statement continues from a previous line\n"));
386+
fprintf(output, _(" PROMPT3\n"
387+
" specifies the prompt used during COPY ... FROM STDIN\n"));
388+
fprintf(output, _(" QUIET\n"
389+
" run quietly (same as -q option)\n"));
390+
fprintf(output, _(" SHOW_CONTEXT\n"
391+
" controls display of message context fields [never, errors, always]\n"));
392+
fprintf(output, _(" SINGLELINE\n"
393+
" if set, end of line terminates SQL commands (same as -S option)\n"));
394+
fprintf(output, _(" SINGLESTEP\n"
395+
" single-step mode (same as -s option)\n"));
396+
fprintf(output, _(" USER\n"
397+
" the currently connected database user\n"));
398+
fprintf(output, _(" VERBOSITY\n"
399+
" controls verbosity of error reports [default, verbose, terse]\n"));
376400

377401
fprintf(output, _("\nDisplay settings:\n"));
378402
fprintf(output, _("Usage:\n"));
379403
fprintf(output, _(" psql --pset=NAME[=VALUE]\n or \\pset NAME [VALUE] inside psql\n\n"));
380404

381-
fprintf(output, _(" border border style (number)\n"));
382-
fprintf(output, _(" columns target width for the wrapped format\n"));
383-
fprintf(output, _(" expanded (or x) expanded output [on, off, auto]\n"));
384-
fprintf(output, _(" fieldsep field separator for unaligned output (default \"%s\")\n"), DEFAULT_FIELD_SEP);
385-
fprintf(output, _(" fieldsep_zero set field separator for unaligned output to zero byte\n"));
386-
fprintf(output, _(" footer enable or disable display of the table footer [on, off]\n"));
387-
fprintf(output, _(" format set output format [unaligned, aligned, wrapped, html, asciidoc, ...]\n"));
388-
fprintf(output, _(" linestyle set the border line drawing style [ascii, old-ascii, unicode]\n"));
389-
fprintf(output, _(" null set the string to be printed in place of a null value\n"));
390-
fprintf(output, _(" numericlocale enable or disable display of a locale-specific character to separate\n"
391-
" groups of digits [on, off]\n"));
392-
fprintf(output, _(" pager control when an external pager is used [yes, no, always]\n"));
393-
fprintf(output, _(" recordsep record (line) separator for unaligned output\n"));
394-
fprintf(output, _(" recordsep_zero set record separator for unaligned output to zero byte\n"));
395-
fprintf(output, _(" tableattr (or T) specify attributes for table tag in html format or proportional\n"
396-
" column widths for left-aligned data types in latex-longtable format\n"));
397-
fprintf(output, _(" title set the table title for any subsequently printed tables\n"));
398-
fprintf(output, _(" tuples_only if set, only actual table data is shown\n"));
405+
fprintf(output, _(" border\n"
406+
" border style (number)\n"));
407+
fprintf(output, _(" columns\n"
408+
" target width for the wrapped format\n"));
409+
fprintf(output, _(" expanded (or x)\n"
410+
" expanded output [on, off, auto]\n"));
411+
fprintf(output, _(" fieldsep\n"
412+
" field separator for unaligned output (default \"%s\")\n"),
413+
DEFAULT_FIELD_SEP);
414+
fprintf(output, _(" fieldsep_zero\n"
415+
" set field separator for unaligned output to a zero byte\n"));
416+
fprintf(output, _(" footer\n"
417+
" enable or disable display of the table footer [on, off]\n"));
418+
fprintf(output, _(" format\n"
419+
" set output format [unaligned, aligned, wrapped, html, asciidoc, ...]\n"));
420+
fprintf(output, _(" linestyle\n"
421+
" set the border line drawing style [ascii, old-ascii, unicode]\n"));
422+
fprintf(output, _(" null\n"
423+
" set the string to be printed in place of a null value\n"));
424+
fprintf(output, _(" numericlocale\n"
425+
" enable display of a locale-specific character to separate groups of digits\n"));
426+
fprintf(output, _(" pager\n"
427+
" control when an external pager is used [yes, no, always]\n"));
428+
fprintf(output, _(" recordsep\n"
429+
" record (line) separator for unaligned output\n"));
430+
fprintf(output, _(" recordsep_zero\n"
431+
" set record separator for unaligned output to a zero byte\n"));
432+
fprintf(output, _(" tableattr (or T)\n"
433+
" specify attributes for table tag in html format, or proportional\n"
434+
" column widths for left-aligned data types in latex-longtable format\n"));
435+
fprintf(output, _(" title\n"
436+
" set the table title for subsequently printed tables\n"));
437+
fprintf(output, _(" tuples_only\n"
438+
" if set, only actual table data is shown\n"));
399439
fprintf(output, _(" unicode_border_linestyle\n"
400440
" unicode_column_linestyle\n"
401441
" unicode_header_linestyle\n"
402-
" set the style of Unicode line drawing [single, double]\n"));
442+
" set the style of Unicode line drawing [single, double]\n"));
403443

404444
fprintf(output, _("\nEnvironment variables:\n"));
405445
fprintf(output, _("Usage:\n"));
@@ -410,23 +450,36 @@ helpVariables(unsigned short int pager)
410450
fprintf(output, _(" set NAME=VALUE\n psql ...\n or \\setenv NAME [VALUE] inside psql\n\n"));
411451
#endif
412452

413-
fprintf(output, _(" COLUMNS number of columns for wrapped format\n"));
414-
fprintf(output, _(" PAGER name of external pager program\n"));
415-
fprintf(output, _(" PGAPPNAME same as the application_name connection parameter\n"));
416-
fprintf(output, _(" PGDATABASE same as the dbname connection parameter\n"));
417-
fprintf(output, _(" PGHOST same as the host connection parameter\n"));
418-
fprintf(output, _(" PGPASSWORD connection password (not recommended)\n"));
419-
fprintf(output, _(" PGPASSFILE password file name\n"));
420-
fprintf(output, _(" PGPORT same as the port connection parameter\n"));
421-
fprintf(output, _(" PGUSER same as the user connection parameter\n"));
453+
fprintf(output, _(" COLUMNS\n"
454+
" number of columns for wrapped format\n"));
455+
fprintf(output, _(" PAGER\n"
456+
" name of external pager program\n"));
457+
fprintf(output, _(" PGAPPNAME\n"
458+
" same as the application_name connection parameter\n"));
459+
fprintf(output, _(" PGDATABASE\n"
460+
" same as the dbname connection parameter\n"));
461+
fprintf(output, _(" PGHOST\n"
462+
" same as the host connection parameter\n"));
463+
fprintf(output, _(" PGPASSWORD\n"
464+
" connection password (not recommended)\n"));
465+
fprintf(output, _(" PGPASSFILE\n"
466+
" password file name\n"));
467+
fprintf(output, _(" PGPORT\n"
468+
" same as the port connection parameter\n"));
469+
fprintf(output, _(" PGUSER\n"
470+
" same as the user connection parameter\n"));
422471
fprintf(output, _(" PSQL_EDITOR, EDITOR, VISUAL\n"
423-
" editor used by the \\e, \\ef, and \\ev commands\n"));
472+
" editor used by the \\e, \\ef, and \\ev commands\n"));
424473
fprintf(output, _(" PSQL_EDITOR_LINENUMBER_ARG\n"
425-
" how to specify a line number when invoking the editor\n"));
426-
fprintf(output, _(" PSQL_HISTORY alternative location for the command history file\n"));
427-
fprintf(output, _(" PSQLRC alternative location for the user's .psqlrc file\n"));
428-
fprintf(output, _(" SHELL shell used by the \\! command\n"));
429-
fprintf(output, _(" TMPDIR directory for temporary files\n"));
474+
" how to specify a line number when invoking the editor\n"));
475+
fprintf(output, _(" PSQL_HISTORY\n"
476+
" alternative location for the command history file\n"));
477+
fprintf(output, _(" PSQLRC\n"
478+
" alternative location for the user's .psqlrc file\n"));
479+
fprintf(output, _(" SHELL\n"
480+
" shell used by the \\! command\n"));
481+
fprintf(output, _(" TMPDIR\n"
482+
" directory for temporary files\n"));
430483

431484
ClosePager(output);
432485
}

0 commit comments

Comments
 (0)