Updated unit test for latest changes
[grml-debootstrap.git] / grml-debootstrap.8.txt
index 7bf600e..a12054a 100644 (file)
@@ -56,25 +56,25 @@ Options and environment variables
 
     Place of configuration files for debootstrap, defaults to /etc/debootstrap.
 
-*--debconf* <_file_>::
+*--debconf*[=<_file_>]::
 
-    Use specified file for preseeding Debian packages instead of using
-    the default <confdir>/debconf-selections.
+    When using *--debconf* without the optional '=<_file_>' parameter, it
+    enables preseeding Debian packages using the default
+    '<confdir>/debconf-selections' file. If the optional parameter is given,
+    use the specified file for preseeding Debian packages instead.
 
 *--debopt* <_params_>::
 
     Extra parameters passed to the debootstrap command.
 
-*--groot* <_device_>::
-
-    Specify root device for usage in grub (corresponds with $TARGET).
-    Again, use grub syntax for specifying.
-    Corresponding with configuration variable GROOT.
-
 *--grub* <_device_>::
 
-    Where do you want to install grub to? Use grub syntax for specifying.
-    Do not forget to set groot as well. Leave empty to avoid installation of grub.
+    Device where grub should be installed to. Note that only the MBR (master
+    boot record) can be used (/dev/sda, /dev/sdb,...). Partitions (like
+    /dev/sda1, /dev/sdb2,...) are NOT supported because grub2 doesn't support
+    installation into the PBR (partition boot record) anymore.  Usage example:
+    '--grub /dev/sda'.  Note: just do not set this option to avoid installation
+    of grub.
 
 *--help*, *-h*::
 
@@ -105,6 +105,10 @@ Options and environment variables
 
     Skip debootstrap, only do configuration to the target.
 
+*--insecure*::
+
+    Do not download and check signatures for retrieved Release files.
+
 *-p*, *--mntpoint* <_/mntpoint_>::
 
     Specify mountpoint that should be used for mounting the target system.
@@ -112,10 +116,13 @@ Options and environment variables
     Note: this option has no effect if option -t is given and represents a
     directory.
 
-*--packages* <_file_>::
+*--packages*[=<_file_>]::
 
-    Use specified file as list for packages that should be installed instead of
-    the default package list file <confdir>/packages.
+    When using *--packages* without the optional '=<_file_>' parameter, it
+    enables installing the packages defined in the default package list
+    '<confdir>/packages' file. If the optional parameter is given, the
+    specified list file is used as list for packages that should be
+    installed instead.
 
 *--password* <_password_>::
 
@@ -125,22 +132,35 @@ Options and environment variables
 
 *-r*, *--release* <_releasename_>::
 
-    Specify release of new Debian system. Supported releases names: etch, lenny,
+    Specify release of new Debian system. Supported releases names: lenny,
     squeeze (note: requires current version of debootstrap) and sid.
     Corresponding with configuration variable RELEASE.
 
-*--scripts* <_directory_>::
+*--pre-scripts*[=<_directory_>]::
+
+    When using *--pre-scripts* without the optional '=<_directory_>'
+    parameter, it enables executing scripts from the default
+    '<confdir>/pre-scripts/' directory before executing the chroot script.
+    If the optional parameter is given, execute scripts from the specified
+    directory instead. This allows customization of the system before the
+    chroot has been set up.  The environment variable $MNTPOINT is available
+    inside the scripts for direct access of the chroot.
+
+*--scripts*[=<_directory_>]::
 
-    Execute scripts from specified directory. This allows customisation of
-    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/
+    When using *--scripts* without the optional '=<_directory_>' parameter,
+    it enables executing scripts from the default '<confdir>/scripts/'
+    directory after the chroot has been set up.  If the optional parameter is
+    given, execute scripts from the specified directory instead. This allows
+    customisation of the system after the chroot has been set up. The
+    environment variable $MNTPOINT is available inside the scripts for
+    direct access of the chroot.
 
 *-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 is NOT supported).
+    beginning). To install grub using *--grub* make sure to use a _device_
+    instead of a directory as _target_ (installation of grub as bootloader when
+    using directories is NOT supported).
 
 *-v*, *--verbose*::
     Increase verbosity.
@@ -148,22 +168,34 @@ Options and environment variables
 *-V*, *--version*::
     Show version of program and exit.
 
-WARNING: the commandline parsing of grml-debootstrap does not validate the provided
+TIP: The long options may be abbreviated, as long as the abbreviation is not
+ambiguous. Eg. '--k' will be the same as '--keep_src_list', and '--pac' be
+'--packages'.
+
+[WARNING]
+=====================================================================
+
+- To specify the optional parameter for switches that accept them, the
+optional argument must be written directly after the long option name,
+separated by `=' (without space).
+
+- the commandline parsing of grml-debootstrap does not validate the provided
 arguments for the commandline options. Please be careful and check docs and
 /etc/debootstrap/config for further information.
+=====================================================================
 
 Usage examples
 ---------------
 
-  grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0
+  grml-debootstrap --target /dev/sda1 --grub /dev/sda
 
 Install default Debian release (stable/lenny) on /dev/sda1 and install bootmanager
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
 
-  grml-debootstrap --target /dev/sda6 --grub hd0 --groot hd0,5 --release sid
+  grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid
 
-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
@@ -171,14 +203,14 @@ Grub in MBR (master boot record) of /dev/sda and use /dev/sda6 as system partiti
 Install default Debian release (stable/lenny) in directory /data/chroot (without
 any bootloader).
 
-  grml-debootstrap --target /dev/sda3 --grub hd0 --groot hd0,2 --mirror ftp://ftp.tugraz.at/mirror/debian
+  grml-debootstrap --target /dev/sda3 --grub /dev/sda  --mirror ftp://ftp.tugraz.at/mirror/debian
 
 Install default Debian release (stable/lenny) on /dev/sda3 and install bootmanager
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
 
   mount -o loop /mnt/sda6/debian-40r0-i386-CD-1.iso /mnt/iso
-  grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0 --iso file:/mnt/iso/debian/
+  grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso file:/mnt/iso/debian/
 
 Install Debian stable/lenny on /dev/sda1 using the loopback mounted Debian-ISO
 for the base-system and install bootmanager Grub in MBR (master boot record) of
@@ -256,18 +288,12 @@ target=/dev/sda1
 
   grub=...
 
-Where do you want to install grub to? Use grub syntax for specifying.
-Usage example: grub=hd0
-
-  groot=...
-
-Specify root device for usage in grub (corresponds with $TARGET).
-Again, use grub syntax for specifying. Usage example: groot=hd0,0
+Where do you want to install grub to? Usage example: grub=/dev/sda
 
   release=...
 
 Specify release of new Debian system. Defaults to Debian stable.  Supported
-relases: etch, lenny, squeeze and sid. Usage example: release=sid
+relases: lenny, squeeze and sid. Usage example: release=sid
 
   mirror=...
 
@@ -283,7 +309,7 @@ argument. Usage example: password=AiTh5ahn
 Usage example for automatic installation:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-  debian2hd target=/dev/sda1 grub=hd0 groot=hd0,0 mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
+  debian2hd target=/dev/sda1 grub=/dev/sda mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
 
 You have to enter this commandline at the bootprompt of grml. Please make sure
 that /dev/sda1 is the partition where you really want to install your new Debian