improve the kernel package option description.

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

diff --git a/vmdebootstrap.8.in b/vmdebootstrap.8.in
index 80df9bc0340973345118fa65e958cb20df961f2e..6632aad9999cfe742a0e083318d9c3078ccb070f 100644 (file)
--- a/vmdebootstrap.8.in
+++ b/vmdebootstrap.8.in
@@ -23,7 +23,7 @@ vmdebootstrap \- install basic Debian system into virtual disk image
 .B vmdebootstrap
 [\-\-output=FILE] [\-\-verbose |\-\-no-verbose] \-\-image=FILE \-\-size=SIZE
 [\-\-tarball=FILE] [\-\-mirror=URL] [\-\-arch=ARCH] [\-\-distribution=NAME]
-[\-\-package=PACKAGE] [\-\-custom-package=DEB] [\-\-no-kernel]
+[\-\-package=PACKAGE] [\-\-custom-package=DEB] [\-\-no-kernel] [\-\-kernel-package]
 [\-\-enable-dhcp | \-\-no-enable-dhcp] [\-\-root-password=PASSWORD]
 [\-\-customize=SCRIPT] [\-\-hostname=HOSTNAME] [\-\-user=USER/PASSWORD]
 [\-\-serial-console | \-\-no-serial-console] [\-\-sudo |\-\-no-sudo] [\-\-owner=OWNER]
@@ -65,6 +65,24 @@ and log into it via its console to configure it.
 The image has an empty root password and will not have networking
 configured by default. Set the root password before you configure
 networking.
+.SH NETWORKING
+The \-\-enable\-networking option uses the /etc/network/interfaces.d/
+source directory, with the default settings for
+.B lo
+and
+.B eth0
+being added to /etc/network/interfaces.d/setup. Other networking
+configuration can be specified using a customisation script.
+Localhost settings would be:
+ auto lo
+ iface lo inet loopback
+
+If \-\-enable\-dhcp is specified, these settings are also included
+into /etc/network/interfaces.d/setup:
+
+ auto eth0
+ iface eth0 inet dhcp
+
 .SH BOOTLOADERS
 Unless the \-\-no\-extlinux or \-\-grub options are specified, the
 image will use
@@ -155,13 +173,23 @@ architecture to use (amd64) - if using an architecture which the
 host system cannot execute, ensure the \-\-foreign option is also
 used.
 .IP \-\-distribution=NAME
-release to use (stable)
+release to use (defaults to stable). The release needs to be a valid
+Debian or Ubuntu release name or codename.
 .IP \-\-package=PACKAGE
 install PACKAGE onto system
 .IP \-\-custom-package=DEB
 install package in DEB file onto system (not from mirror)
 .IP \-\-no-kernel
 do not install a linux package
+.IP \-\-kernel-package
+If \-\-no-kernel is not used and the auto-selection of the
+.B linux-image-586
+or
+.B linux-image-armmp
+or
+.B linux-image-$ARCH
+package is not suitable, the kernel package can be specified
+explicitly.
 .IP \-\-enable-dhcp
 enable DHCP on eth0
 .IP \-\-root-password=PASSWORD
@@ -227,6 +255,9 @@ 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 \-\-no\-acpid
+Disable installation of acpid if not required, otherwise acpid will be
+installed if \-\-foreign is not used.
 .IP \-\-pkglist
 Output a list of package names installed inside the image. Useful if you
 need to track the relevant source packages used inside the image for
@@ -271,7 +302,7 @@ sudo chmod a+w ./test.img
 .PP
 Execute using qemu, e.g. on amd64 using qemu-system-x86_64:
 .IP
-qemu-system-x86_64 ./test.img
+qemu-system-x86_64 -drive format=raw,file=./test.img
 .PP
 (This loads the image in a new window.)
 .PP