Add support for debootstrapopts

[forks/vmdebootstrap.git] / vmdebootstrap.8.in

diff --git a/vmdebootstrap.8.in b/vmdebootstrap.8.in
index 29e0f6861532a218e74fe611f879c30b15d3ae08..f7a4439fb7120a2bc5092a93d663e2c0cda6cf65 100644 (file)
--- a/vmdebootstrap.8.in
+++ b/vmdebootstrap.8.in
@@ -30,6 +30,7 @@ vmdebootstrap \- install basic Debian system into virtual disk image
 [\-\-bootsize=BOOTSIZE] [\-\-boottype=FSTYPE] [\-\-roottype=FSTYPE] [\-\-foreign=PATH]
 [\-\-variant=VARIANT] [\-\-no-extlinux] [\-\-squash] [\-\-configure-apt]
 [\-\-grub] [\-\-apt-mirror] [\-\-pkglist] [\-\-use\-efi] [\-\-efi\-size]
+[\-\-debootstrapopts]
 .SH DESCRIPTION
 .B vmdebootstrap
 installs a basic Debian system into a virtual disk image,
@@ -280,6 +281,10 @@ available.
 Disable extlinux installation and configure grub2 instead. grub2 will be added to
 the list of packages to install. update-grub will be called once the debootstrap is
 complete and grub-install will be called in the image.
+.IP \-\-debootstrapopts
+Pass additional options to debootstrap as a quoted list of options
+and values, separated by commas. See debootstrap \-\-help and
+debootstrap (1) for valid options.
 .IP \-\-no\-acpid
 Disable installation of acpid if not required, otherwise acpid will be
 installed if \-\-foreign is not used.
@@ -314,14 +319,13 @@ none, simple, meliae, or heapy (default: simple)
 make memory profiling dumps at least SECONDS apart
 .SH EXAMPLE
 To create an image for the stable release of Debian:
-.nf
 .IP
 sudo vmdebootstrap \-\-image test.img \-\-size 1g \\
     \-\-log test.log \-\-log-level debug \-\-verbose \\
     \-\-mirror http://mirror.lan/debian/
 .PP
-To run the test image, make sure it is writeable. Use the \-\-owner
-option to set mode 0644 for the specified user or use chmod manually:
+To run the test image, make sure it is writeable. Use the \-\-owner option to set
+mode 0644 for the specified user or use chmod manually:
 .IP
 sudo chmod a+w ./test.img
 .PP
@@ -329,7 +333,20 @@ Execute using qemu, e.g. on amd64 using qemu-system-x86_64:
 .IP
 qemu-system-x86_64 -drive format=raw,file=./test.img
 .PP
-(This loads the image in a new window.)
+(This loads the image in a new window.) Note the use of -drive
+file=<img>,format=raw which is needed for newer versions of QEMU.
+.PP
+There is EFI firmware available to use with QEMU when testing images built
+using the UEFI support, but this software is in Debian non-free due to patent
+concerns. If you choose to install
+.B
+ovmf
+to test UEFI builds, a secondary change is also needed to symlink the provided
+OVMF.fd to the file required by QEMU: bios-256k.bin and then tell QEMU about
+the location of this file with the -L option:
+.IP
+$ qemu-system-x86_64 \-L /usr/share/ovmf/ -machine accel=kvm \\
+  \-m 4096 \-smp 2 \-drive format=raw,file=test.img
 .PP
 For further examples, including u-boot support for beaglebone-black,
 see /usr/share/vmdebootstrap/examples