pager: support SYSTEMD_LESS environment variable

[elogind.git] / man / machinectl.xml

diff --git a/man/machinectl.xml b/man/machinectl.xml
index f2fa6ce53e9aff3f2b974683ec671dec717e4798..2e7fa3bf8d4892e537e401d087d51a0fb1429b3c 100644 (file)
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -105,7 +105,7 @@
                                 <term><option>-H</option></term>
                                 <term><option>--host=</option></term>
 
-                                <listitem><para>Execute operation
+                                <listitem><para>Execute the operation
                                 remotely. Specify a hostname, or
                                 username and hostname separated by <literal>@</literal>,
                                 to connect to. This will use SSH to
@@ -117,7 +117,7 @@
                                 <term><option>-M</option></term>
                                 <term><option>--machine=</option></term>
 
-                                <listitem><para>Execute operation on a
+                                <listitem><para>Execute the operation on a
                                 local container. Specify a container
                                 name to connect to.</para></listitem>
                         </varlistentry>
@@ -202,7 +202,7 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>status [ID...]</command></term>
+                                <term><command>status</command> <replaceable>ID</replaceable>...</term>
 
                                 <listitem><para>Show terse runtime
                                 status information about one or more
@@ -215,7 +215,7 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>show [ID...]</command></term>
+                                <term><command>show</command> <replaceable>ID</replaceable>...</term>
 
                                 <listitem><para>Show properties of one
                                 or more registered virtual machines or
@@ -239,7 +239,7 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>terminate [ID...]</command></term>
+                                <term><command>terminate</command> <replaceable>ID</replaceable>...</term>
 
                                 <listitem><para>Terminates a virtual
                                 machine or container. This kills all
@@ -250,7 +250,7 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>kill [ID...]</command></term>
+                                <term><command>kill</command> <replaceable>ID</replaceable>...</term>
 
                                 <listitem><para>Send a signal to one
                                 or more processes of the virtual
@@ -263,6 +263,31 @@
                                 <option>--signal=</option> to select
                                 the signal to send.</para></listitem>
                         </varlistentry>
+
+                        <varlistentry>
+                                <term><command>reboot</command> <replaceable>ID</replaceable>...</term>
+
+                                <listitem><para>Reboot one or more
+                                containers. This will trigger a reboot
+                                by sending SIGINT to the container's
+                                init process, which is roughly
+                                equivalent to pressing Ctrl+Alt+Del on
+                                a non-containerized
+                                system.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>login</command> <replaceable>ID</replaceable></term>
+
+                                <listitem><para>Open a terminal login
+                                session to a container. This will
+                                create a TTY connection to a specific
+                                container and asks for the execution of a
+                                getty on it. Note that this is only
+                                supported for containers running
+                                <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                                as init system.</para></listitem>
+                        </varlistentry>
                 </variablelist>
 
         </refsect1>
@@ -286,6 +311,10 @@
                                 this to an empty string or the value
                                 <literal>cat</literal> is equivalent to passing
                                 <option>--no-pager</option>.</para></listitem>
+                               <term><varname>$SYSTEMD_LESS</varname></term>
+                               <listitem><para><varname>$SYSTEMD_LESS</varname> overrides the
+                               default options passed to <literal>less</literal>
+                               (<literal>FRSXMK</literal>).</para></listitem>
                         </varlistentry>
                 </variablelist>
         </refsect1>