chiark / gitweb /
bus: introduce concept of "const" properties
[elogind.git] / man / machinectl.xml
index f2fa6ce53e9aff3f2b974683ec671dec717e4798..6e991ee957f10425db1aec5120aa9c4fde055d21 100644 (file)
                                 <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
                                 <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>
                         </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
                         </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
                         </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
                         </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
                                 <option>--signal=</option> to select
                                 the signal to send.</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>