summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2014-05-22 23:22:15 +0200
committerLudovic Courtès <ludo@gnu.org>2014-05-22 23:24:13 +0200
commitfb729425dcd80b8ef34c075867d2f204bc4d55cb (patch)
tree41059b378b89e796d61360c0efa01a673abe74ec /doc
parent1e77fedb46af3c131b46da7ced55f7078d0d0e5f (diff)
downloadguix-fb729425dcd80b8ef34c075867d2f204bc4d55cb.tar.gz
guix system: Add 'disk-image' action.
* guix/scripts/system.scm (show-help): Add 'disk-image'.
  (guix-system)[parse-options]: Support 'disk-image' action.
  [option-arguments]: Likewise.
  Handle the 'disk-image' action.
* doc/guix.texi (Invoking guix system): Document 'disk-image'.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi20
1 files changed, 17 insertions, 3 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index edb1dceeab..ddb0763495 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -3236,9 +3236,23 @@ Build a virtual machine that contain the operating system declared in
 The VM shares its store with the host system.
 
 @item vm-image
-Return a virtual machine image of the operating system declared in
-@var{file} that stands alone.  Use the @option{--image-size} option to
-specify the size of the image.
+@itemx disk-image
+Return a virtual machine or disk image of the operating system declared
+in @var{file} that stands alone.  Use the @option{--image-size} option
+to specify the size of the image.
+
+When using @code{vm-image}, the returned image is in qcow2 format, which
+the QEMU emulator can efficiently use.
+
+When using @code{disk-image}, a raw disk image is produced; it can be
+copied as is to a USB stick, for instance.  Assuming @code{/dev/sdc} is
+the device corresponding to a USB stick, one can copy the image on it
+using the following command:
+
+@example
+# dd if=$(guix system disk-image my-os.scm) of=/dev/sdc
+@end example
+
 @end table
 
 @var{options} can contain any of the common build options provided by