man: change noindex="true" to index="false"

[thirdparty/systemd.git] / man / less-variables.xml

diff --git a/man/less-variables.xml b/man/less-variables.xml
index 396481c937253335fffa586ecf0c93c287476f44..8a701277b6e1546d637f5bbf157f071d8fb300fd 100644 (file)
--- a/man/less-variables.xml
+++ b/man/less-variables.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-                 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
 
 <refsect1>
   <title>Environment</title>
@@ -22,7 +23,38 @@
       <term><varname>$SYSTEMD_LESS</varname></term>
 
       <listitem><para>Override the options passed to <command>less</command> (by default
-      <literal>FRSXMK</literal>).</para></listitem>
+      <literal>FRSXMK</literal>).</para>
+
+      <para>Users might want to change two options in particular:</para>
+
+      <variablelist class='environment-variables'>
+        <varlistentry>
+          <term><option>K</option></term>
+
+          <para>This option instructs the pager to exit immediately when
+          <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> is pressed. To allow
+          <command>less</command> to handle <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo>
+          itself to switch back to the pager command prompt, unset this option.</para>
+
+          <para>If the value of <varname>$SYSTEMD_LESS</varname> does not include <literal>K</literal>,
+          and the pager that is invoked is <command>less</command>,
+          <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> will be ignored by the
+          executable, and needs to be handled by the pager.</para>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>X</option></term>
+
+          <para>This option instructs the pager to not send termcap initialization and deinitialization
+          strings to the terminal. It is set by default to allow command output to remain visible in the
+          terminal even after the pager exits. Nevertheless, this prevents some pager functionality from
+          working, in particular paged output cannot be scrolled with the mouse.</para>
+        </varlistentry>
+      </variablelist>
+
+      <para>See
+      <citerefentry project='man-pages'><refentrytitle>less</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+      for more discussion.</para></listitem>
     </varlistentry>
 
     <varlistentry id='lesscharset'>
@@ -32,5 +64,23 @@
       the invoking terminal is determined to be UTF-8 compatible).</para></listitem>
     </varlistentry>
 
-    </variablelist>
+    <varlistentry id='colors'>
+      <term><varname>$SYSTEMD_COLORS</varname></term>
+
+      <listitem><para>The value must be a boolean. Controls whether colorized output should be
+      generated. This can be specified to override the decision that <command>systemd</command> makes based
+      on <varname>$TERM</varname> and what the console is connected to.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry id='urlify'>
+      <term><varname>$SYSTEMD_URLIFY</varname></term>
+
+      <listitem><para>The value must be a boolean. Controls whether clickable links should be generated in
+      the output for terminal emulators supporting this. This can be specified to override the decision that
+      <command>systemd</command> makes based on <varname>$TERM</varname> and other conditions.</para>
+      </listitem>
+    </varlistentry>
+
+  </variablelist>
 </refsect1>