man: add a link to systemd-coredump(8) in Description of coredump.conf(5)

[elogind.git] / man / machinectl.xml

diff --git a/man/machinectl.xml b/man/machinectl.xml
index 2606180d123d70890d217502e5099d6f4777b547..2f2e2571f597fec5ad62f3bc4008b9f25fda77c5 100644 (file)
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 

-<refentry id="machinectl" conditional='ENABLE_MACHINED'>
+<refentry id="machinectl" conditional='ENABLE_MACHINED'
+          xmlns:xi="http://www.w3.org/2001/XInclude">

 
         <refentryinfo>
                 <title>machinectl</title>
 
         <refentryinfo>
                 <title>machinectl</title>


@@ -71,29 +72,14 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
                 <para>The following options are understood:</para>
 
                 <variablelist>

-                        <varlistentry>
-                                <term><option>-h</option></term>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>--version</option></term>
-
-                                <listitem><para>Prints a short version
-                                string and exits.</para></listitem>
-                        </varlistentry>
-

                         <varlistentry>
                                 <term><option>-p</option></term>
                                 <term><option>--property=</option></term>
 
                                 <listitem><para>When showing
                         <varlistentry>
                                 <term><option>-p</option></term>
                                 <term><option>--property=</option></term>
 
                                 <listitem><para>When showing

-                                session/user properties, limit
-                                display to certain properties as
-                                specified as argument. If not
+                                machine properties, limit the
+                                output to certain properties as
+                                specified by the argument. If not

                                 specified, all set properties are
                                 shown. The argument should be a
                                 property name, such as
                                 specified, all set properties are
                                 shown. The argument should be a
                                 property name, such as


@@ -108,8 +94,8 @@
                                 <term><option>--all</option></term>
 
                                 <listitem><para>When showing
                                 <term><option>--all</option></term>
 
                                 <listitem><para>When showing

-                                unit/job/manager properties, show all
-                                properties regardless whether they are
+                                machine properties, show all
+                                properties regardless of whether they are

                                 set or not.</para></listitem>
                         </varlistentry>
 
                                 set or not.</para></listitem>
                         </varlistentry>
 


@@ -117,37 +103,22 @@
                                 <term><option>-l</option></term>
                                 <term><option>--full</option></term>
 
                                 <term><option>-l</option></term>
                                 <term><option>--full</option></term>
 

-                                <listitem><para>Do not ellipsize cgroup
-                                members.</para>
+                                <listitem><para>Do not ellipsize
+                                process tree entries.</para>

                                 </listitem>
                         </varlistentry>
 
                                 </listitem>
                         </varlistentry>
 

-                        <varlistentry>
-                                <term><option>--no-pager</option></term>
-
-                                <listitem><para>Do not pipe output into a
-                                pager.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>--no-ask-password</option></term>
-
-                                <listitem><para>Do not query the user
-                                for authentication for privileged
-                                operations.</para></listitem>
-                        </varlistentry>
-

                         <varlistentry>
                                 <term><option>--kill-who=</option></term>
 
                                 <listitem><para>When used with
                         <varlistentry>
                                 <term><option>--kill-who=</option></term>
 
                                 <listitem><para>When used with

-                                <command>kill-session</command>,
+                                <command>kill</command>,

                                 choose which processes to kill. Must
                                 be one of <option>leader</option>, or
                                 <option>all</option> to select whether
                                 to kill only the leader process of the
                                 choose which processes to kill. Must
                                 be one of <option>leader</option>, or
                                 <option>all</option> to select whether
                                 to kill only the leader process of the

-                                session or all processes of the
-                                session. If omitted, defaults to
+                                machine or all processes of the
+                                machine. If omitted, defaults to

                                 <option>all</option>.</para></listitem>
                         </varlistentry>
 
                                 <option>all</option>.</para></listitem>
                         </varlistentry>
 


@@ -156,11 +127,10 @@
                                 <term><option>--signal=</option></term>
 
                                 <listitem><para>When used with
                                 <term><option>--signal=</option></term>
 
                                 <listitem><para>When used with

-                                <command>kill-session</command> or
-                                <command>kill-user</command>, choose
+                                <command>kill</command>, choose

                                 which signal to send to selected
                                 which signal to send to selected

-                                processes. Must be one of the well
-                                known signal specifiers, such as
+                                processes. Must be one of the
+                                well-known signal specifiers, such as

                                 <constant>SIGTERM</constant>,
                                 <constant>SIGINT</constant> or
                                 <constant>SIGSTOP</constant>. If
                                 <constant>SIGTERM</constant>,
                                 <constant>SIGINT</constant> or
                                 <constant>SIGSTOP</constant>. If


@@ -169,25 +139,19 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>-H</option></term>
-                                <term><option>--host</option></term>
-
-                                <listitem><para>Execute operation
-                                remotely. Specify a hostname, or
-                                username and hostname separated by <literal>@</literal>,
-                                to connect to. This will use SSH to
-                                talk to the remote machine manager
-                                instance.</para></listitem>
+                                <term><option>--no-legend</option></term>
+
+                                <listitem><para>Do not print the legend,
+                                        i.e. the column headers and the
+                                        footer.</para></listitem>

                         </varlistentry>
 
                         </varlistentry>
 

-                        <varlistentry>
-                                <term><option>-P</option></term>
-                                <term><option>--privileged</option></term>
+                        <xi:include href="user-system-options.xml" xpointer="host" />
+                        <xi:include href="user-system-options.xml" xpointer="machine" />

 
 

-                                <listitem><para>Acquire privileges via
-                                PolicyKit before executing the
-                                operation.</para></listitem>
-                        </varlistentry>
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
+                        <xi:include href="standard-options.xml" xpointer="no-pager" />

                 </variablelist>
 
                 <para>The following commands are understood:</para>
                 </variablelist>
 
                 <para>The following commands are understood:</para>


@@ -202,7 +166,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </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
 
                                 <listitem><para>Show terse runtime
                                 status information about one or more


@@ -215,13 +179,13 @@
                         </varlistentry>
 
                         <varlistentry>
                         </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
                                 containers or the manager itself. If
                                 no argument is specified, properties
 
                                 <listitem><para>Show properties of one
                                 or more registered virtual machines or
                                 containers or the manager itself. If
                                 no argument is specified, properties

-                                of the manager will be shown. If a an
+                                of the manager will be shown. If an

                                 ID is specified, properties of this
                                 virtual machine or container are
                                 shown. By default, empty properties
                                 ID is specified, properties of this
                                 virtual machine or container are
                                 shown. By default, empty properties


@@ -239,18 +203,49 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><command>terminate [ID...]</command></term>
+                                <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>

 
 

-                                <listitem><para>Terminates a virtual
-                                machine or container. This kills all
-                                processes of the virtual machine or
-                                container and deallocates all
-                                resources attached to that
-                                instance.</para></listitem>
+                        <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, and is
+                                compatible with containers running any
+                                init system.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>poweroff</command> <replaceable>ID</replaceable>...</term>
+
+                                <listitem><para>Power off one or more
+                                containers. This will trigger a reboot
+                                by sending SIGRTMIN+4 to the
+                                container's init process, which causes
+                                systemd-compatible init systems to
+                                shut down cleanly. This operation does
+                                not work on containers that do not run
+                                a
+                                <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>-compatible
+                                init system, such as
+                                sysvinit.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </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
 
                                 <listitem><para>Send a signal to one
                                 or more processes of the virtual


@@ -263,6 +258,18 @@
                                 <option>--signal=</option> to select
                                 the signal to send.</para></listitem>
                         </varlistentry>
                                 <option>--signal=</option> to select
                                 the signal to send.</para></listitem>
                         </varlistentry>

+
+                        <varlistentry>
+                                <term><command>terminate</command> <replaceable>ID</replaceable>...</term>
+
+                                <listitem><para>Terminates a virtual
+                                machine or container. This kills all
+                                processes of the virtual machine or
+                                container and deallocates all
+                                resources attached to that
+                                instance.</para></listitem>
+                        </varlistentry>
+

                 </variablelist>
 
         </refsect1>
                 </variablelist>
 
         </refsect1>


@@ -274,27 +281,14 @@
                 code otherwise.</para>
         </refsect1>
 
                 code otherwise.</para>
         </refsect1>
 

-        <refsect1>
-                <title>Environment</title>
-
-                <variablelist class='environment-variables'>
-                        <varlistentry>
-                                <term><varname>$SYSTEMD_PAGER</varname></term>
-                                <listitem><para>Pager to use when
-                                <option>--no-pager</option> is not given;
-                                overrides <varname>$PAGER</varname>.  Setting
-                                this to an empty string or the value
-                                <literal>cat</literal> is equivalent to passing
-                                <option>--no-pager</option>.</para></listitem>
-                        </varlistentry>
-                </variablelist>
-        </refsect1>
+        <xi:include href="less-variables.xml" />

 
         <refsect1>
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 
         <refsect1>
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,

-                        <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>

                 </para>
         </refsect1>
 
                 </para>
         </refsect1>