Improve --vm and --vmfile usage instructions
authorMichael Prokop <mika@grml.org>
Thu, 4 Jun 2015 08:58:04 +0000 (10:58 +0200)
committerMichael Prokop <mika@grml.org>
Thu, 4 Jun 2015 09:00:13 +0000 (11:00 +0200)
Fixes #45 @ github

grml-debootstrap
grml-debootstrap.8.txt

index 02498cc..d15849d 100755 (executable)
@@ -116,10 +116,12 @@ Bootstrap options:
 
 Options for Virtual Machine deployment:
 
 
 Options for Virtual Machine deployment:
 
-      --vm               Set up a Virtual Machine, instead of plainly installing
-                         to a partition or directory, to be combined with --target,
-                         like: --vm --target /dev/mapper/your-vm-disk
-      --vmfile           Like --vm, but install into a file (raw format).
+      --vm               Set up a Virtual Machine on an existing block device
+                         instead of plainly installing to a partition or
+                         directory. Needs to be combined with --target.
+                         Example: --vm --target /dev/mapper/your-vm-disk
+      --vmfile           Like --vm, but install into a regular file (created by
+                         'qemu-img create -f raw ...') instead.
                          Example: --vmfile --target /mnt/sda1/qemu.img
       --vmsize <size>    Use specified size for size of VM file (default: 2G).
                          Syntax as supported by qemu-img, like: --vmsize 3G
                          Example: --vmfile --target /mnt/sda1/qemu.img
       --vmsize <size>    Use specified size for size of VM file (default: 2G).
                          Syntax as supported by qemu-img, like: --vmsize 3G
index 245978e..e585719 100644 (file)
@@ -222,9 +222,10 @@ Options and environment variables
 
 *--vmfile*::
 
 
 *--vmfile*::
 
-    Set up a Virtual Machine instead of installing to a partition or directory.
-    This allows deployment of a Virtual Machine. The options needs to be
-    combined with the --target option.
+    Set up a Virtual Machine using a regular file instead of installing to a
+    partition/block device or directory. This allows deployment of a Virtual
+    Machine. The options needs to be combined with the --target option
+    ('qemu-img create -f raw ...' is executed on the specified target).
     Usage example: --vmfile --target /mnt/sda1/qemu.img
 
 *--vmsize* _size_::
     Usage example: --vmfile --target /mnt/sda1/qemu.img
 
 *--vmsize* _size_::