summaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/psql-ref.sgml
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2023-05-12 16:11:14 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2023-05-12 16:11:14 -0400
commit51b2c08798867cb9788090704b37c4698b456240 (patch)
tree2a92b72f73b17f7550bcba99677a4a112a4e771d /doc/src/sgml/ref/psql-ref.sgml
parente32701b8d285cd402f75fc9059d083e89ee8166b (diff)
downloadpostgresql-51b2c08798867cb9788090704b37c4698b456240.tar.gz
Tighten usage of PSQL_WATCH_PAGER.
Don't use PSQL_WATCH_PAGER when stdin/stdout are not a terminal. This corresponds to the restrictions on when other commands will use [PSQL_]PAGER. There isn't a lot of sense in trying to use a pager in non-interactive cases, and doing so allows an environment setting to break our tests. Also, ignore PSQL_WATCH_PAGER if it is set but empty or all-blank, for the same reasons we ignore such settings of [PSQL_]PAGER (see commit 18f8f784c). No documentation change is really needed, since there is nothing suggesting that these constraints on [PSQL_]PAGER didn't already apply to PSQL_WATCH_PAGER too. But I rearranged the text a little to make it read more naturally (IMHO anyway). Per report from Pavel Stehule. Back-patch to v15 where PSQL_WATCH_PAGER was introduced. Discussion: https://postgr.es/m/CAFj8pRDTwFzmEWdA-gdAcUh0ZnxUioSfTMre71WyB_wNJy-8gw@mail.gmail.com
Diffstat (limited to 'doc/src/sgml/ref/psql-ref.sgml')
-rw-r--r--doc/src/sgml/ref/psql-ref.sgml31
1 files changed, 16 insertions, 15 deletions
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index dc422373d6..de760f9990 100644
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -3120,8 +3120,21 @@ lo_import 152801
<listitem>
<para>
Controls use of a pager program for query and <application>psql</application>
- help output. If the environment variable <envar>PSQL_PAGER</envar>
- or <envar>PAGER</envar> is set, the output is piped to the
+ help output.
+ When the <literal>pager</literal> option is <literal>off</literal>, the pager
+ program is not used. When the <literal>pager</literal> option is
+ <literal>on</literal>, the pager is used when appropriate, i.e., when the
+ output is to a terminal and will not fit on the screen.
+ The <literal>pager</literal> option can also be set to <literal>always</literal>,
+ which causes the pager to be used for all terminal output regardless
+ of whether it fits on the screen. <literal>\pset pager</literal>
+ without a <replaceable class="parameter">value</replaceable>
+ toggles pager use on and off.
+ </para>
+
+ <para>
+ If the environment variable <envar>PSQL_PAGER</envar>
+ or <envar>PAGER</envar> is set, output to be paged is piped to the
specified program. Otherwise a platform-dependent default program
(such as <filename>more</filename>) is used.
</para>
@@ -3135,18 +3148,6 @@ lo_import 152801
<application>psql</application>'s output format (such as
<filename>pspg --stream</filename>).
</para>
-
- <para>
- When the <literal>pager</literal> option is <literal>off</literal>, the pager
- program is not used. When the <literal>pager</literal> option is
- <literal>on</literal>, the pager is used when appropriate, i.e., when the
- output is to a terminal and will not fit on the screen.
- The <literal>pager</literal> option can also be set to <literal>always</literal>,
- which causes the pager to be used for all terminal output regardless
- of whether it fits on the screen. <literal>\pset pager</literal>
- without a <replaceable class="parameter">value</replaceable>
- toggles pager use on and off.
- </para>
</listitem>
</varlistentry>
@@ -4898,7 +4899,7 @@ PSQL_EDITOR_LINENUMBER_ARG='--line '
pager-related options of the <command>\pset</command> command.
These variables are examined in the order listed;
the first that is set is used.
- If none of them is set, the default is to use <literal>more</literal> on most
+ If neither of them is set, the default is to use <literal>more</literal> on most
platforms, but <literal>less</literal> on Cygwin.
</para>