chiark / gitweb /
man: document machinectl import-tar and import-raw
authorLennart Poettering <lennart@poettering.net>
Mon, 9 Mar 2015 20:34:32 +0000 (21:34 +0100)
committerLennart Poettering <lennart@poettering.net>
Mon, 9 Mar 2015 21:46:26 +0000 (22:46 +0100)
man/machinectl.xml

index 55bb694..7aeff68 100644 (file)
       </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>
     <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>