psql: Review of new help output strings
authorPeter Eisentraut <peter_e@gmx.net>
Sun, 20 Dec 2015 16:50:04 +0000 (11:50 -0500)
committerPeter Eisentraut <peter_e@gmx.net>
Sun, 20 Dec 2015 16:50:04 +0000 (11:50 -0500)
src/bin/psql/describe.c
src/bin/psql/help.c

index a8acdc25ef686149116455f28a9799ff2c93ae79..bb59bc2364ff341933bff3c0659e4819d903167d 100644 (file)
@@ -2063,16 +2063,16 @@ describeOneTableDetails(const char *schemaname,
                printTableAddFooter(&cont, _("Policies:"));
 
            if (tableinfo.rowsecurity && tableinfo.forcerowsecurity && tuples > 0)
-               printTableAddFooter(&cont, _("Policies (Forced Row Security Enabled):"));
+               printTableAddFooter(&cont, _("Policies (forced row security enabled):"));
 
            if (tableinfo.rowsecurity && !tableinfo.forcerowsecurity && tuples == 0)
-               printTableAddFooter(&cont, _("Policies (Row Security Enabled): (None)"));
+               printTableAddFooter(&cont, _("Policies (row security enabled): (none)"));
 
            if (tableinfo.rowsecurity && tableinfo.forcerowsecurity && tuples == 0)
-               printTableAddFooter(&cont, _("Policies (Forced Row Security Enabled): (None)"));
+               printTableAddFooter(&cont, _("Policies (forced row security enabled): (none)"));
 
            if (!tableinfo.rowsecurity && tuples > 0)
-               printTableAddFooter(&cont, _("Policies (Row Security Disabled):"));
+               printTableAddFooter(&cont, _("Policies (row security disabled):"));
 
            /* Might be an empty set - that's ok */
            for (i = 0; i < tuples; i++)
index 5b63e76ac95c17b6b4d6c53f0dcfebc8b9ba3a15..5f240be1b283b534bc99d27d045ff73cd1f8626f 100644 (file)
@@ -180,9 +180,9 @@ slashUsage(unsigned short int pager)
 
    fprintf(output, _("Help\n"));
 
-   fprintf(output, _("  \\? [commands]          description of all psql backslash commands\n"));
-   fprintf(output, _("  \\? options             description of all psql commandline options\n"));
-   fprintf(output, _("  \\? variables           description of all psql configuration variables\n"));
+   fprintf(output, _("  \\? [commands]          show help on backslash commands\n"));
+   fprintf(output, _("  \\? options             show help on psql command-line options\n"));
+   fprintf(output, _("  \\? variables           show help on special variables\n"));
    fprintf(output, _("  \\h [NAME]              help on syntax of SQL commands, * for all commands\n"));
    fprintf(output, "\n");
 
@@ -323,51 +323,51 @@ helpVariables(unsigned short int pager)
     */
    output = PageOutput(87, pager ? &(pset.popt.topt) : NULL);
 
-   fprintf(output, _("List of specially treated variables.\n"));
+   fprintf(output, _("List of specially treated variables\n\n"));
 
    fprintf(output, _("psql variables:\n"));
    fprintf(output, _("Usage:\n"));
-   fprintf(output, _("  psql --set=NAME=VALUE\n  or \\set NAME VALUE in interactive mode\n\n"));
+   fprintf(output, _("  psql --set=NAME=VALUE\n  or \\set NAME VALUE inside psql\n\n"));
 
    fprintf(output, _("  AUTOCOMMIT         if set, successful SQL commands are automatically committed\n"));
-   fprintf(output, _("  COMP_KEYWORD_CASE  determine the case used to complete SQL keywords\n"
+   fprintf(output, _("  COMP_KEYWORD_CASE  determines the case used to complete SQL key words\n"
    "                     [lower, upper, preserve-lower, preserve-upper]\n"));
    fprintf(output, _("  DBNAME             the currently connected database name\n"));
-   fprintf(output, _("  ECHO               control what input is written to standard output\n"
+   fprintf(output, _("  ECHO               controls what input is written to standard output\n"
                      "                     [all, errors, none, queries]\n"));
-   fprintf(output, _("  ECHO_HIDDEN        display internal queries executed by backslash commands when it is set\n"
-    "                     or with [noexec] just show without execution\n"));
+   fprintf(output, _("  ECHO_HIDDEN        if set, display internal queries executed by backslash commands;\n"
+                     "                     if set to \"noexec\", just show without execution\n"));
    fprintf(output, _("  ENCODING           current client character set encoding\n"));
    fprintf(output, _("  FETCH_COUNT        the number of result rows to fetch and display at a time\n"
                      "                     (default: 0=unlimited)\n"));
-   fprintf(output, _("  HISTCONTROL        control history list [ignorespace, ignoredups, ignoreboth]\n"));
-   fprintf(output, _("  HISTFILE           file name used to store the history list\n"));
+   fprintf(output, _("  HISTCONTROL        controls command history [ignorespace, ignoredups, ignoreboth]\n"));
+   fprintf(output, _("  HISTFILE           file name used to store the command history\n"));
    fprintf(output, _("  HISTSIZE           the number of commands to store in the command history\n"));
-   fprintf(output, _("  HOST               the currently connected database server\n"));
+   fprintf(output, _("  HOST               the currently connected database server host\n"));
    fprintf(output, _("  IGNOREEOF          if unset, sending an EOF to interactive session terminates application\n"));
-   fprintf(output, _("  LASTOID            the value of last affected OID\n"));
-   fprintf(output, _("  ON_ERROR_ROLLBACK  if set, an error doesn't stop a transaction (uses implicit SAVEPOINTs)\n"));
+   fprintf(output, _("  LASTOID            value of the last affected OID\n"));
+   fprintf(output, _("  ON_ERROR_ROLLBACK  if set, an error doesn't stop a transaction (uses implicit savepoints)\n"));
    fprintf(output, _("  ON_ERROR_STOP      stop batch execution after error\n"));
    fprintf(output, _("  PORT               server port of the current connection\n"));
-   fprintf(output, _("  PROMPT1            specify the standard psql prompt\n"));
-   fprintf(output, _("  PROMPT2            specify the prompt used when a statement continues from a previous line\n"));
-   fprintf(output, _("  PROMPT3            specify the prompt used during COPY ... FROM STDIN\n"));
+   fprintf(output, _("  PROMPT1            specifies the standard psql prompt\n"));
+   fprintf(output, _("  PROMPT2            specifies the prompt used when a statement continues from a previous line\n"));
+   fprintf(output, _("  PROMPT3            specifies the prompt used during COPY ... FROM STDIN\n"));
    fprintf(output, _("  QUIET              run quietly (same as -q option)\n"));
-   fprintf(output, _("  SHOW_CONTEXT       control display of message context fields [never, errors, always]\n"));
+   fprintf(output, _("  SHOW_CONTEXT       controls display of message context fields [never, errors, always]\n"));
    fprintf(output, _("  SINGLELINE         end of line terminates SQL command mode (same as -S option)\n"));
    fprintf(output, _("  SINGLESTEP         single-step mode (same as -s option)\n"));
    fprintf(output, _("  USER               the currently connected database user\n"));
-   fprintf(output, _("  VERBOSITY          control verbosity of error reports [default, verbose, terse]\n"));
+   fprintf(output, _("  VERBOSITY          controls verbosity of error reports [default, verbose, terse]\n"));
 
-   fprintf(output, _("\nDisplay influencing variables:\n"));
+   fprintf(output, _("\nDisplay settings:\n"));
    fprintf(output, _("Usage:\n"));
-   fprintf(output, _("  psql --pset=NAME[=VALUE]\n  or \\pset NAME [VALUE] in interactive mode\n\n"));
+   fprintf(output, _("  psql --pset=NAME[=VALUE]\n  or \\pset NAME [VALUE] inside psql\n\n"));
 
    fprintf(output, _("  border             border style (number)\n"));
-   fprintf(output, _("  columns            set the target width for the wrapped format\n"));
-   fprintf(output, _("  expanded (or x)    toggle expanded output\n"));
-   fprintf(output, _("  fieldsep           field separator for unaligned output (default '|')\n"));
-   fprintf(output, _("  fieldsep_zero      set field separator in unaligned mode to zero\n"));
+   fprintf(output, _("  columns            target width for the wrapped format\n"));
+   fprintf(output, _("  expanded (or x)    expanded output [on, off, auto]\n"));
+   fprintf(output, _("  fieldsep           field separator for unaligned output (default \"%s\")\n"), DEFAULT_FIELD_SEP);
+   fprintf(output, _("  fieldsep_zero      set field separator for unaligned output to zero byte\n"));
    fprintf(output, _("  format             set output format [unaligned, aligned, wrapped, html, asciidoc, ...]\n"));
    fprintf(output, _("  footer             enable or disable display of the table footer [on, off]\n"));
    fprintf(output, _("  linestyle          set the border line drawing style [ascii, old-ascii, unicode]\n"));
@@ -375,24 +375,24 @@ helpVariables(unsigned short int pager)
    fprintf(output, _("  numericlocale      enable or disable display of a locale-specific character to separate\n"
                      "                     groups of digits [on, off]\n"));
    fprintf(output, _("  pager              control when an external pager is used [yes, no, always]\n"));
-   fprintf(output, _("  recordsep          specify the record (line) separator to use in unaligned output format\n"));
-   fprintf(output, _("  recordsep_zero     set the record separator to use in unaligned output format to a zero byte.\n"));
+   fprintf(output, _("  recordsep          record (line) separator for unaligned output\n"));
+   fprintf(output, _("  recordsep_zero     set record separator for unaligned output to zero byte\n"));
    fprintf(output, _("  tableattr (or T)   specify attributes for table tag in html format or proportional\n"
-                     "                     column width of left aligned data type in latex format\n"));
+                     "                     column widths for left-aligned data types in latex-longtable format\n"));
    fprintf(output, _("  title              set the table title for any subsequently printed tables\n"));
    fprintf(output, _("  tuples_only        if set, only actual table data is shown\n"));
-   fprintf(output, _("  unicode_border_linestyle\n"));
-   fprintf(output, _("  unicode_column_linestyle\n"));
-   fprintf(output, _("  unicode_header_linestyle\n"
-                     "                     set the style of unicode line drawing [single, double]\n"));
+   fprintf(output, _("  unicode_border_linestyle\n"
+                     "  unicode_column_linestyle\n"
+                     "  unicode_header_linestyle\n"
+                     "                     set the style of Unicode line drawing [single, double]\n"));
 
    fprintf(output, _("\nEnvironment variables:\n"));
    fprintf(output, _("Usage:\n"));
 
 #ifndef WIN32
-   fprintf(output, _("  NAME=VALUE [NAME=VALUE] psql ...\n  or \\setenv NAME [VALUE] in interactive mode\n\n"));
+   fprintf(output, _("  NAME=VALUE [NAME=VALUE] psql ...\n  or \\setenv NAME [VALUE] inside psql\n\n"));
 #else
-   fprintf(output, _("  set NAME=VALUE\n  psql ...\n  or \\setenv NAME VALUE in interactive mode\n\n"));
+   fprintf(output, _("  set NAME=VALUE\n  psql ...\n  or \\setenv NAME [VALUE] inside psql\n\n"));
 #endif
 
    fprintf(output, _("  COLUMNS            number of columns for wrapped format\n"));