summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2015-03-09 21:34:32 +0100
committerLennart Poettering <lennart@poettering.net>2015-03-09 22:46:26 +0100
commitaf40e5d3acbdcff09c8809cd1b86ecf8871f65f0 (patch)
treeb0ea880cf4b7e17c77637a33dbf8186539021b8d
parent124f2f9b6f66db00942b5882d68aa8fa8857865e (diff)
man: document machinectl import-tar and import-raw
-rw-r--r--man/machinectl.xml47
1 files changed, 41 insertions, 6 deletions
diff --git a/man/machinectl.xml b/man/machinectl.xml
index 55bb694e6c..7aeff686a0 100644
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -670,18 +670,51 @@
</varlistentry>
<varlistentry>
+ <term><command>import-tar</command> <replaceable>FILE</replaceable> [<replaceable>NAME</replaceable>]</term>
+ <term><command>import-raw</command> <replaceable>FILE</replaceable> [<replaceable>NAME</replaceable>]</term>
+ <listitem><para>Imports a TAR or RAW container or VM image,
+ and places it under the specified name in
+ <filename>/var/lib/machines/</filename>. When
+ <command>import-tar</command> is used the file specified as
+ first argument should be a tar archive, possibly compressed
+ with xz, gzip or bzip2. It will then be unpacked into its own
+ subvolume in <filename>/var/lib/machines</filename>. When
+ <command>import-raw</command> is used the file should be a
+ qcow2 or raw disk image, possibly compressed with xz, gzip or
+ bzip2. If the second argument (the resulting image name) is
+ not specified it is automatically derived from the file
+ name. If the file name is passed as <literal>-</literal> the
+ image is read from standard input, in which case the second
+ argument is mandatory.</para>
+
+ <para>Similar as with <command>pull-tar</command>,
+ <command>pull-raw</command> the file system
+ <filename>/var/lib/machines.raw</filename> is increased in
+ size of necessary and appropriate. Optionally the
+ <option>--read-only</option> switch may be used to create a
+ read-only container or VM image. No cryptographic validation
+ is done when importing the images.</para>
+
+ <para>Much like image downloads, ongoing imports may be listed
+ with <command>list-transfers</command> and aborted with
+ <command>cancel-transfer</command>.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><command>list-transfers</command></term>
<listitem><para>Shows a list of container or VM image
- downloads that are currently in progress.</para></listitem>
+ downloads and imports that are currently in
+ progress.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>cancel-transfers</command> <replaceable>ID</replaceable>...</term>
- <listitem><para>Aborts download of the container or VM image
- with the specified ID. To list ongoing transfers and their
- IDs, use <command>list-transfers</command>. </para></listitem>
+ <listitem><para>Aborts a download or import of the container
+ or VM image with the specified ID. To list ongoing transfers
+ and their IDs, use
+ <command>list-transfers</command>. </para></listitem>
</varlistentry>
</variablelist></refsect2>
@@ -705,13 +738,15 @@
<para>Note that many image operations are only supported,
efficient or atomic on btrfs file systems. Due to this, if the
<command>pull-tar</command>, <command>pull-raw</command>,
- <command>pull-dkr</command> and <command>set-limit</command>
+ <command>pull-dkr</command>, <command>import-tar</command>,
+ <command>import-raw</command> and <command>set-limit</command>
commands notice that <filename>/var/lib/machines</filename> is
empty and not located on btrfs, they will implicitly set up a
loopback file <filename>/var/lib/machines.raw</filename>
containing a btrfs file system that is mounted to
<filename>/var/lib/machines</filename>. The size of this loopback
- file may be controlled dynamically with <command>set-limit</command>.</para>
+ file may be controlled dynamically with
+ <command>set-limit</command>.</para>
<para>Disk images are understood by
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>