machinectl: add new commands for copying files from/to containers

[elogind.git] / man / machinectl.xml

diff --git a/man/machinectl.xml b/man/machinectl.xml
index 2f2e2571f597fec5ad62f3bc4008b9f25fda77c5..eef1740f95eb37243cbd22371d25b0b06d7f84b8 100644 (file)
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -146,6 +146,25 @@
                                         footer.</para></listitem>
                         </varlistentry>
 
                                         footer.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--mkdir</option></term>
+
+                                <listitem><para>When used with
+                                <command>bind</command> creates the
+                                destination directory before applying
+                                the bind mount.</para></listitem>
+                        </varlistentry>
+
+
+                        <varlistentry>
+                                <term><option>--read-only</option></term>
+
+                                <listitem><para>When used with
+                                <command>bind</command> applies a
+                                read-only bind
+                                mount.</para></listitem>
+                        </varlistentry>
+

                         <xi:include href="user-system-options.xml" xpointer="host" />
                         <xi:include href="user-system-options.xml" xpointer="machine" />
 
                         <xi:include href="user-system-options.xml" xpointer="host" />
                         <xi:include href="user-system-options.xml" xpointer="machine" />
 


@@ -166,7 +185,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><command>status</command> <replaceable>ID</replaceable>...</term>
+                                <term><command>status</command> <replaceable>NAME</replaceable>...</term>

 
                                 <listitem><para>Show terse runtime
                                 status information about one or more
 
                                 <listitem><para>Show terse runtime
                                 status information about one or more


@@ -179,14 +198,14 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><command>show</command> <replaceable>ID</replaceable>...</term>
+                                <term><command>show</command> <replaceable>NAME</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
                                 of the manager will be shown. If an
 
                                 <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 an

-                                ID is specified, properties of this
+                                NAME is specified, properties of this

                                 virtual machine or container are
                                 shown. By default, empty properties
                                 are suppressed. Use
                                 virtual machine or container are
                                 shown. By default, empty properties
                                 are suppressed. Use


@@ -203,7 +222,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><command>login</command> <replaceable>ID</replaceable></term>
+                                <term><command>login</command> <replaceable>NAME</replaceable></term>

 
                                 <listitem><para>Open a terminal login
                                 session to a container. This will
 
                                 <listitem><para>Open a terminal login
                                 session to a container. This will


@@ -216,7 +235,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><command>reboot</command> <replaceable>ID</replaceable>...</term>
+                                <term><command>reboot</command> <replaceable>NAME</replaceable>...</term>

 
                                 <listitem><para>Reboot one or more
                                 containers. This will trigger a reboot
 
                                 <listitem><para>Reboot one or more
                                 containers. This will trigger a reboot


@@ -229,7 +248,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><command>poweroff</command> <replaceable>ID</replaceable>...</term>
+                                <term><command>poweroff</command> <replaceable>NAME</replaceable>...</term>

 
                                 <listitem><para>Power off one or more
                                 containers. This will trigger a reboot
 
                                 <listitem><para>Power off one or more
                                 containers. This will trigger a reboot


@@ -245,7 +264,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><command>kill</command> <replaceable>ID</replaceable>...</term>
+                                <term><command>kill</command> <replaceable>NAME</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


@@ -260,7 +279,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><command>terminate</command> <replaceable>ID</replaceable>...</term>
+                                <term><command>terminate</command> <replaceable>NAME</replaceable>...</term>

 
                                 <listitem><para>Terminates a virtual
                                 machine or container. This kills all
 
                                 <listitem><para>Terminates a virtual
                                 machine or container. This kills all


@@ -270,6 +289,58 @@
                                 instance.</para></listitem>
                         </varlistentry>
 
                                 instance.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><command>bind</command> <replaceable>NAME</replaceable> <replaceable>PATH</replaceable> [<replaceable>PATH</replaceable>]</term>
+
+                                <listitem><para>Bind mounts a
+                                directory from the host into the
+                                specified container. The first
+                                directory argument is the source
+                                directory on the host, the second
+                                directory argument the source
+                                directory on the host. When the latter
+                                is omitted the destination path in the
+                                container is the same as the source
+                                path on the host. When combined with
+                                the <option>--read-only</option>
+                                switch a ready-only bind mount is
+                                created. When combined with the
+                                <option>--mkdir</option> switch the
+                                destination path is first created
+                                before the mount is applied. Note that
+                                this option is currently only
+                                supported for
+                                <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                                containers.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>copy-to</command> <replaceable>NAME</replaceable> <replaceable>PATH</replaceable> [<replaceable>PATH</replaceable>]</term>
+
+                                <listitem><para>Copies files or
+                                directories from the host system into
+                                a running container. Takes a container
+                                name, followed by the source path on
+                                the host and the destination path in
+                                the container. If the destination path
+                                is omitted the same as the source path
+                                is used.</para></listitem>
+                        </varlistentry>
+
+
+                        <varlistentry>
+                                <term><command>copy-from</command> <replaceable>NAME</replaceable> <replaceable>PATH</replaceable> [<replaceable>PATH</replaceable>]</term>
+
+                                <listitem><para>Copies files or
+                                directories from a container into the
+                                host system. Takes a container name,
+                                followed by the source path in the
+                                container the destination path on the
+                                host. If the destination path is
+                                omitted the same as the source path is
+                                used.</para></listitem>
+                        </varlistentry>
+

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