docs: Improve documentation of \pset without arguments.
authorFujii Masao <fujii@postgresql.org>
Thu, 4 Sep 2014 04:48:09 +0000 (13:48 +0900)
committerFujii Masao <fujii@postgresql.org>
Thu, 4 Sep 2014 04:48:09 +0000 (13:48 +0900)
The syntax summary previously failed to clarify that the first
argument is also optional.  The textual description did mention it,
but all the way at the bottom.  It fits better with the command
overview, so move it there, and fix the summary also.

Back-patch to 9.4 where \pset without arguments was supported.

Dilip Kumar, reviewed by Fabien Coelho

doc/src/sgml/ref/psql-ref.sgml

index 255e8cac144434f6600034b573f5efed23232b8c..fd8661d7d0cc1458fbc3c4904a0c60b51e61cbf5 100644 (file)
@@ -1943,7 +1943,7 @@ lo_import 152801
       </varlistentry>
 
       <varlistentry>
-        <term><literal>\pset <replaceable class="parameter">option</replaceable> [ <replaceable class="parameter">value</replaceable> ]</literal></term>
+        <term><literal>\pset [ <replaceable class="parameter">option</replaceable> [ <replaceable class="parameter">value</replaceable> ] ]</literal></term>
 
         <listitem>
         <para>
@@ -1959,6 +1959,11 @@ lo_import 152801
         the current setting being displayed.
         </para>
 
+        <para>
+        <command>\pset</command> without any arguments displays the current status
+        of all printing options.
+        </para>
+
         <para>
         Adjustable printing options are:
         <variablelist>
@@ -2298,11 +2303,6 @@ lo_import 152801
         </para>
         </tip>
 
-        <para>
-        <command>\pset</command> without any arguments displays the current status
-        of all printing options.
-        </para>
-
         </listitem>
       </varlistentry>