handle missing customise scripts cleanly with fallback to upstream examples.

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

diff --git a/vmdebootstrap.8.in b/vmdebootstrap.8.in
index 74f3e30c452e83089adb1a65e00f4f8a6b571680..2c411b7091bcfab43bca8af729486953126385d9 100644 (file)
--- a/vmdebootstrap.8.in
+++ b/vmdebootstrap.8.in
@@ -28,7 +28,7 @@ vmdebootstrap \- install basic Debian system into virtual disk image
 [--customize=SCRIPT] [--hostname=HOSTNAME] [--user=USER/PASSWORD]
 [--serial-console | --no-serial-console] [--sudo | --no-sudo] [--owner=OWNER]
 [--bootsize=BOOTSIZE] [--boottype=FSTYPE] [--foreign=PATH] [--variant=VARIANT]
-[--no-extlinux]
+[--no-extlinux] [--squash] [--configure-apt] [--grub]
 .SH DESCRIPTION
 .B vmdebootstrap
 installs a basic Debian system into a virtual disk image,
@@ -63,8 +63,9 @@ and log into it via its console to configure it.
 Unless the \-\-no\-extlinux option is specified, the image will use
 .BR extlinux (1)
 as a boot loader.
-The imagehas an empty root password and will not have networking configured.
-Set the root password before you configure networking.
+The image has an empty root password and will not have networking
+configured by default. Set the root password before you configure
+networking.
 .SH OPTIONS
 .IP \-\-output=FILE
 write output to FILE, instead of standard output
@@ -122,9 +123,18 @@ squashfs-tools to be installed. The final file will have the .squashfs suffix.
 By default, mksquashfs is allowed to use all processors which may result
 in high load. Run mksquashfs separately if you need to control the number
 of processors used per run.
-.IP\-\-configure\-apt
+.IP \-\-configure\-apt
 Use the specified mirror and distribution to create a suitable apt source inside
-the VM.
+the VM. Can be useful if debootstrap fails to create it automatically.
+.IP \-\-grub
+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. Versions of grub2 in wheezy
+can fail to install in the VM, at which point vmdebootstrap will fall back to
+extlinux. It may still be possible to complete the installation of grub2 after
+booting the VM as the problem may be related to the need to use loopback
+devices during the grub-install operation. Details of the error will appear in the
+vmdebootstrap log file, if enabled with the \-\-log option.
 .SH Configuration files and settings:
 .IP \-\-dump-config
 write out the entire current configuration
@@ -167,6 +177,8 @@ Execute using qemu, e.g. on amd64 using qemu-system-x86_64:
 qemu-system-x86_64 ./test.img
 .PP
 (This loads the image in a new window.)
+.PP
+For further examples, including u-boot support for beaglebone-black, see /usr/share/vmdebootstrap/examples
 .SH NOTES
 If you get problems with the bootstrap process, run a similar bootstrap call directly and chroot into the directory to investigate the failure. The actual debootstrap call is part of the vmdebootstrap logfile. The debootstrap logfile, if any, will be copied into your current working directory on error.
 .PP
@@ -181,7 +193,9 @@ particularly if you need to do repeated builds.
 .SH "SEE ALSO"
 .BR debootstrap (8)
 ,
-.BR qemu (1)
+.BR qemu-system-x86_64 (1)
+,
+.BR grub-install (8)
 .
 .SH BUGS
 Please provide the config section of the logfile when reporting bugs, as well as the complete command line.