psql documentation fixes

petere · petere · commit 5191e357cf22 · 2017-07-04T21:10:08.000-04:00
Update the documentation for \pset to mention
columns|linestyle|pager_min_lines.  Add various mentions of \pset
command equivalences that were previously inconsistent.

Author: Дилян Палаузов &lt;dpa-postgres@aegee.org&gt;
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
@@ -68,7 +68,8 @@ PostgreSQL documentation
       <listitem>
       <para>
       Switches to unaligned output mode. (The default output mode is
-      otherwise aligned.)
+      otherwise aligned.)  This is equivalent to <command>\pset format
+      unaligned</command>.
       </para>
       </listitem>
     </varlistentry>
@@ -371,8 +372,8 @@ EOF
       <listitem>
       <para>
       Use <replaceable class="parameter">separator</replaceable> as the
-      record separator for unaligned output. This is equivalent to the
-      <command>\pset recordsep</command> command.
+      record separator for unaligned output. This is equivalent to
+      <command>\pset recordsep</command>.
       </para>
       </listitem>
     </varlistentry>
@@ -415,7 +416,8 @@ EOF
       <listitem>
       <para>
       Turn off printing of column names and result row count footers,
-      etc. This is equivalent to the <command>\t</command> command.
+      etc. This is equivalent to <command>\t</command> or
+      <command>\pset tuples_only</command>.
       </para>
       </listitem>
     </varlistentry>
@@ -427,7 +429,7 @@ EOF
       <para>
       Specifies options to be placed within the
       <acronym>HTML</acronym> <sgmltag>table</sgmltag> tag. See
-      <command>\pset</command> for details.
+      <command>\pset tableattr</command> for details.
       </para>
       </listitem>
     </varlistentry>
@@ -522,8 +524,8 @@ EOF
       <term><option>--expanded</></term>
       <listitem>
       <para>
-      Turn on the expanded table formatting mode. This is equivalent to the
-      <command>\x</command> command.
+      Turn on the expanded table formatting mode. This is equivalent to
+      <command>\x</command> or <command>\pset expanded</command>.
       </para>
       </listitem>
     </varlistentry>
@@ -545,7 +547,8 @@ EOF
       <term><option>--field-separator-zero</option></term>
       <listitem>
       <para>
-      Set the field separator for unaligned output to a zero byte.
+      Set the field separator for unaligned output to a zero byte.  This is
+      equvalent to <command>\pset fieldsep_zero</command>.
       </para>
       </listitem>
     </varlistentry>
@@ -557,6 +560,7 @@ EOF
       <para>
       Set the record separator for unaligned output to a zero byte.  This is
       useful for interfacing, for example, with <literal>xargs -0</literal>.
+      This is equivalent to <command>\pset recordsep_zero</command>.
       </para>
       </listitem>
     </varlistentry>
@@ -1907,9 +1911,8 @@ Tue Oct 26 21:40:57 CEST 1999
         <listitem>
         <para>
         Sets the field separator for unaligned query output. The default
-        is the vertical bar (<literal>|</literal>). See also
-        <command>\pset</command> for a generic way of setting output
-        options.
+        is the vertical bar (<literal>|</literal>). It is equivalent to
+        <command>\pset fieldsep</command>.
         </para>
         </listitem>
       </varlistentry>
@@ -2810,8 +2813,9 @@ lo_import 152801
         <tip>
         <para>
         There are various shortcut commands for <command>\pset</command>. See
-        <command>\a</command>, <command>\C</command>, <command>\H</command>,
-        <command>\t</command>, <command>\T</command>, and <command>\x</command>.
+        <command>\a</command>, <command>\C</command>, <command>\f</command>,
+        <command>\H</command>, <command>\t</command>, <command>\T</command>,
+        and <command>\x</command>.
         </para>
         </tip>
 
diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c
@@ -271,9 +271,11 @@ slashUsage(unsigned short int pager)
 	fprintf(output, _("  \\H                     toggle HTML output mode (currently %s)\n"),
 			ON(pset.popt.topt.format == PRINT_HTML));
 	fprintf(output, _("  \\pset [NAME [VALUE]]   set table output option\n"
-					  "                         (NAME := {format|border|expanded|fieldsep|fieldsep_zero|footer|null|\n"
-					  "                         numericlocale|recordsep|recordsep_zero|tuples_only|title|tableattr|pager|\n"
-					  "                         unicode_border_linestyle|unicode_column_linestyle|unicode_header_linestyle})\n"));
+					  "                         (NAME := {border|columns|expanded|fieldsep|fieldsep_zero|\n"
+					  "                         footer|format|linestyle|null|numericlocale|pager|\n"
+					  "                         pager_min_lines|recordsep|recordsep_zero|tableattr|title|\n"
+					  "                         tuples_only|unicode_border_linestyle|\n"
+					  "                         unicode_column_linestyle|unicode_header_linestyle})\n"));
 	fprintf(output, _("  \\t [on|off]            show only rows (currently %s)\n"),
 			ON(pset.popt.topt.tuples_only));
 	fprintf(output, _("  \\T [STRING]            set HTML <table> tag attributes, or unset if none\n"));
