Move displaying installation notes into umount_chroot()
[grml-debootstrap.git] / grml-debootstrap.8.txt
index 87c4519..7bf600e 100644 (file)
@@ -29,6 +29,13 @@ CAUTION: The grml team does not take responsibility for loss of any data!
 Options and environment variables
 ---------------------------------
 
 Options and environment variables
 ---------------------------------
 
+*--arch* <_architecture_>::
+
+    Architecture you want to bootstrap. Currently only i386 is supported.
+    Defaults to the architecture that is currently running on your system. If
+    you're running an amd64 system and want to deploy a i386 system use this option.
+    Note: deploying amd64 from a i386 system won't work.
+
 *--bootappend* <_appendline for the kernel_>::
 
     Specify appendline for the kernel.
 *--bootappend* <_appendline for the kernel_>::
 
     Specify appendline for the kernel.
@@ -56,7 +63,7 @@ Options and environment variables
 
 *--debopt* <_params_>::
 
 
 *--debopt* <_params_>::
 
-    Extra parameters passed to the debootstrap.
+    Extra parameters passed to the debootstrap command.
 
 *--groot* <_device_>::
 
 
 *--groot* <_device_>::
 
@@ -91,9 +98,8 @@ Options and environment variables
 
 *-m*, *--mirror* <_URL_>::
 
 
 *-m*, *--mirror* <_URL_>::
 
-    Specify mirror which should be used for apt-get/aptitude. Notice that
-    specifying the mirror also sets the chrootmirror to the given value.
-    Corresponding with configuration variables MIRROR and CHROOTMIRROR.
+    Specify mirror which should be used for apt-get/aptitude.
+    Corresponding with configuration variable MIRROR.
 
 *--nodebootstrap*::
 
 
 *--nodebootstrap*::
 
@@ -103,6 +109,8 @@ Options and environment variables
 
     Specify mountpoint that should be used for mounting the target system.
     Corresponding with configuration variable MNTPOINT.
 
     Specify mountpoint that should be used for mounting the target system.
     Corresponding with configuration variable MNTPOINT.
+    Note: this option has no effect if option -t is given and represents a
+    directory.
 
 *--packages* <_file_>::
 
 
 *--packages* <_file_>::
 
@@ -117,21 +125,22 @@ Options and environment variables
 
 *-r*, *--release* <_releasename_>::
 
 
 *-r*, *--release* <_releasename_>::
 
-    Specify release of new Debian system. Supported releases: sarge (not
-    recommended though), etch, lenny, squeeze (note: requires current version of
-    debootstrap) and sid.  Corresponding with configuration variable RELEASE.
+    Specify release of new Debian system. Supported releases names: etch, lenny,
+    squeeze (note: requires current version of debootstrap) and sid.
+    Corresponding with configuration variable RELEASE.
 
 *--scripts* <_directory_>::
 
     Execute scripts from specified directory. This allows customisation of
 
 *--scripts* <_directory_>::
 
     Execute scripts from specified directory. This allows customisation of
-    the system after the chroot has been set up.
+    the system after the chroot has been set up. The environment variable
+    $MNTPOINT is available inside the scripts for direct access of the chroot.
     Default directory: /etc/debootstrap/scripts/
 
 *-t*, *--target* <_target_>::
     Target partition (/dev/...) or directory (anything else without /dev at the
     beginning). To install grub using *--grub* and *--groot*, make sure to
     use a _device_ instead of a directory as _target_ (installation of
     Default directory: /etc/debootstrap/scripts/
 
 *-t*, *--target* <_target_>::
     Target partition (/dev/...) or directory (anything else without /dev at the
     beginning). To install grub using *--grub* and *--groot*, make sure to
     use a _device_ instead of a directory as _target_ (installation of
-    grub as bootloader when using directories isn't supported yet).
+    grub as bootloader when using directories is NOT supported).
 
 *-v*, *--verbose*::
     Increase verbosity.
 
 *-v*, *--verbose*::
     Increase verbosity.
@@ -156,6 +165,7 @@ Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partiti
 Install Debian unstable/sid on /dev/sda6, install bootmanager
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda6 as system partition.
 
 Install Debian unstable/sid on /dev/sda6, install bootmanager
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda6 as system partition.
 
+  mount /dev/sda1 /data/chroot
   grml-debootstrap --target /data/chroot
 
 Install default Debian release (stable/lenny) in directory /data/chroot (without
   grml-debootstrap --target /data/chroot
 
 Install default Debian release (stable/lenny) in directory /data/chroot (without
@@ -257,8 +267,7 @@ Again, use grub syntax for specifying. Usage example: groot=hd0,0
   release=...
 
 Specify release of new Debian system. Defaults to Debian stable.  Supported
   release=...
 
 Specify release of new Debian system. Defaults to Debian stable.  Supported
-relases: sarge (not recommended though), etch, lenny, squeeze and sid. Usage
-example: release=sid
+relases: etch, lenny, squeeze and sid. Usage example: release=sid
 
   mirror=...
 
 
   mirror=...
 
@@ -292,12 +301,11 @@ Supported Releases
 include::releasetable.txt[]
 
 [NOTE]
 include::releasetable.txt[]
 
 [NOTE]
-.Sarge-Release
+.Etch-Release
 ================================================================================
 [1] Please notice that Etch is the current old-stable within Debian.
 ================================================================================
 [1] Please notice that Etch is the current old-stable within Debian.
-grml-debootstrap can handle the release (as well as sarge) but you really should
-not use Etch anymore unless you really know what you are doing. Choose Lenny
-instead.
+grml-debootstrap can handle the release but you really should not use Etch
+anymore unless you really know what you are doing. Choose Lenny instead.
 ================================================================================
 
 Bugs
 ================================================================================
 
 Bugs