Skip to content

Commit 946f7b7

Browse files
keszybzbluca
authored andcommitted
man: rework the description of $SYSTEMD_PAGER and $PAGER
$PAGER wasn't documented, but actually we treat it same as $SYSTEMD_PAGER, except for lower priority. And the two variables can be used to disable the pager, even if $SYSTEMD_PAGERSECURE is not set. Behaviour is (obviously) not changed by this patch, it intentionally just updates the docs to match the code. (cherry picked from commit b6b7817) (cherry picked from commit affb45d6b2dfdb3a87da2e0241be8c5c5c9a9d8f) (cherry picked from commit ab19d19d3e89a270e40b9b9cff845581d3d9e3a4)
1 parent 5212152 commit 946f7b7

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

man/common-variables.xml

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -91,17 +91,22 @@
9191

9292
<varlistentry id='pager'>
9393
<term><varname>$SYSTEMD_PAGER</varname></term>
94+
<term><varname>$PAGER</varname></term>
9495

95-
<listitem><para>Pager to use when <option>--no-pager</option> is not given; overrides
96-
<varname>$PAGER</varname>. If neither <varname>$SYSTEMD_PAGER</varname> nor <varname>$PAGER</varname> are set, a
97-
set of well-known pager implementations are tried in turn, including
98-
<citerefentry project='man-pages'><refentrytitle>less</refentrytitle><manvolnum>1</manvolnum></citerefentry> and
99-
<citerefentry project='man-pages'><refentrytitle>more</refentrytitle><manvolnum>1</manvolnum></citerefentry>, until one is found. If
100-
no pager implementation is discovered no pager is invoked. Setting this environment variable to an empty string
101-
or the value <literal>cat</literal> is equivalent to passing <option>--no-pager</option>.</para>
96+
<listitem><para>Pager to use when <option>--no-pager</option> is not given.
97+
<varname>$SYSTEMD_PAGER</varname> is used if set; otherwise <varname>$PAGER</varname> is used.
98+
If neither <varname>$SYSTEMD_PAGER</varname> nor <varname>$PAGER</varname> are set, a set of well-known
99+
pager implementations is tried in turn, including
100+
<citerefentry project='man-pages'><refentrytitle>less</refentrytitle><manvolnum>1</manvolnum></citerefentry>
101+
and
102+
<citerefentry project='man-pages'><refentrytitle>more</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
103+
until one is found. If no pager implementation is discovered, no pager is invoked. Setting those
104+
environment variables to an empty string or the value <literal>cat</literal> is equivalent to passing
105+
<option>--no-pager</option>.</para>
102106

103107
<para>Note: if <varname>$SYSTEMD_PAGERSECURE</varname> is not set, <varname>$SYSTEMD_PAGER</varname>
104-
(as well as <varname>$PAGER</varname>) will be silently ignored.</para></listitem>
108+
and <varname>$PAGER</varname> can only be used to disable the pager (with <literal>cat</literal> or
109+
<literal></literal>), and are otherwise ignored.</para></listitem>
105110
</varlistentry>
106111

107112
<varlistentry id='less'>
@@ -196,8 +201,8 @@
196201
implement "secure mode" will not be used at all.</para>
197202

198203
<para>Note that if the <varname>$SYSTEMD_PAGER</varname> or <varname>$PAGER</varname> variables are to
199-
be honoured, <varname>$SYSTEMD_PAGERSECURE</varname> must be set too.</para>
200-
</listitem>
204+
be honoured, other than to disable the pager, <varname>$SYSTEMD_PAGERSECURE</varname> must be set
205+
too.</para></listitem>
201206
</varlistentry>
202207

203208
<varlistentry id='colors'>

0 commit comments

Comments
 (0)