use '.. to the debootstrap command' in description of --debopt
[grml-debootstrap.git] / grml-debootstrap.8.txt
index a29bb41..ccbd323 100644 (file)
@@ -14,71 +14,130 @@ image:images/screenshot.png[Screenshot]
 Introduction
 ------------
 
-grml-debootstrap is a wrapper suite around debootstrap
-(and cdebootstrap if you want) for installing a plain Debian
-system via grml very fast and easy.
+grml-debootstrap is a wrapper suite around debootstrap (and cdebootstrap if you
+want) for installing a plain Debian system via grml very fast and easy.
 
 All you have to do is adjust a few variables in configuration file
 /etc/debootstrap/config (or specify some variables via commandline) and invoke
 grml-debootstrap without any further options then.
 
-A plain and base Debian system will be installed on the given
-device (or directory) then. Customization of this process is
-possible as well.
+A plain and base Debian system will be installed on the given device (or
+directory) then. Customization of this process is possible as well.
 
 CAUTION: The grml team does not take responsibility for loss of any data!
 
 Options and environment variables
 ---------------------------------
 
-*-h*, *--help*::
-    Show summary of options and exit.
+*--bootappend* <_appendline for the kernel_>::
 
-*-v*, *--version*::
-    Show version of program and exit.
+    Specify appendline for the kernel.
+    E.g. "_pci=nomsi_"
 
-*--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.
+*-c*, *--config* <_file_>::
+
+    Use specified configuration file, defaults to /etc/debootstrap/config.
+
+*--chroot-scripts* <_directory_>::
+
+    Execute chroot scripts from specified directory. This allows customisation
+    of the chroot setup, the executable script(s) present in the given directory
+    are executed at the end of the chroot procedure.
+    Default directory: /etc/debootstrap/chroot-scripts/
+
+*-d*, *--confdir* <_path_>::
+
+    Place of configuration files for debootstrap, defaults to /etc/debootstrap.
+
+*--debconf* <_file_>::
+
+    Use specified file for preseeding Debian packages instead of using
+    the default <confdir>/debconf-selections.
+
+*--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.
 
-*--boot_append* <_appendline for the kernel_>::
-    Specify appendline for the kernel. 
-    E.g. "_pci=nomsi_"
+*--grub* <_device_>::
 
-*-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.
+    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.
+
+*--help*, *-h*::
+
+    Show summary of options and exit.
+
+*--hostname* <_hostname_>::
+
+    Use specified hostname instead of the default (being 'grml').
 
 *-i*, *--iso* <_/mntpoint_>::
+
     Specify mountpoint where you have a Debian ISO mounted loopback.
     Using this option instead of the mirror option gives you the possibility
     to install the base-system without network access. Make sure you
     mounted the according Debian-ISO to the given <_/mntpoint_>. See section
     'Usage examples' for a demonstration.
 
+*--keep_src_list*::
+
+     Do not overwrite user provided /etc/apt/sources.list.
+
+*-m*, *--mirror* <_URL_>::
+
+    Specify mirror which should be used for apt-get/aptitude.
+    Corresponding with configuration variable MIRROR.
+
+*--nodebootstrap*::
+
+    Skip debootstrap, only do configuration to the target.
+
 *-p*, *--mntpoint* <_/mntpoint_>::
+
     Specify mountpoint that should be used for mounting the target system.
     Corresponding with configuration variable MNTPOINT.
 
+*--packages* <_file_>::
+
+    Use specified file as list for packages that should be installed instead of
+    the default package list file <confdir>/packages.
+
 *--password* <_password_>::
+
     Use specified password as password for user root. Use with caution, as your
     commandline might be visible in the process list and the shell history.
     It's meant for automatic installation only.
 
 *-r*, *--release* <_releasename_>::
-    Specify release of new Debian system. Supported releases: sarge, etch, lenny and sid.
+
+    Specify release of new Debian system. Supported releases: 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
+    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 
-    specify _device_ instead of directory as _target_.
+    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).
+
+*-v*, *--verbose*::
+    Increase verbosity.
+
+*-V*, *--version*::
+    Show version of program and exit.
 
 WARNING: the commandline parsing of grml-debootstrap does not validate the provided
 arguments for the commandline options. Please be careful and check docs and
@@ -87,33 +146,33 @@ arguments for the commandline options. Please be careful and check docs and
 Usage examples
 ---------------
 
-  grml-debootstrap --target /dev/hda1 --grub hd0 --groot hd0,0
+  grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0
 
-Install default Debian release (stable/etch) on /dev/hda1 and install bootmanager
-Grub in MBR (master boot record) of /dev/hda and use /dev/hda1 as system partition.
+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/hda6 --grub hd0 --groot hd0,5 --release sid
+  grml-debootstrap --target /dev/sda6 --grub hd0 --groot hd0,5 --release sid
 
-Install Debian unstable/sid on /dev/hda6, install bootmanager
-Grub in MBR (master boot record) of /dev/hda and use /dev/hda6 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.
 
   grml-debootstrap --target /data/chroot
 
-Install default Debian release (stable/etch) in directory /data/chroot (without
+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
 
-Install default Debian release (stable/etch) on /dev/sda3 and install bootmanager
+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/hda6/debian-40r0-i386-CD-1.iso /mnt/iso
-  grml-debootstrap --target /dev/hda1 --grub hd0 --groot hd0,0 --iso file:/mnt/iso/debian/
+  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/
 
-Install Debian stable/etch on /dev/hda1 using the loopback mounted Debian-ISO
+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
-/dev/hda and use /dev/hda1 as system partition. Please notice, that the chroot
+/dev/sda and use /dev/sda1 as system partition. Please notice, that the chroot
 system requires network access for all packages which are not part of the
 ISO.
 
@@ -167,7 +226,7 @@ want to put existing files to the new Debian system you can place them into the
 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 system then. If you want to install additional packages that are not available
 via the grml or debian mirror drop them into /etc/debootstrap/extrapackages and
-take sure that EXTRAPACKAGES is set to "yes". 
+make sure that EXTRAPACKAGES is set to "yes".
 
 Automatic installation
 ----------------------
@@ -183,7 +242,7 @@ mentioned above):
   target=...
 
 The target partition/directory of the new Debian system. Usage example:
-target=/dev/hda1
+target=/dev/sda1
 
   grub=...
 
@@ -197,8 +256,8 @@ Again, use grub syntax for specifying. Usage example: groot=hd0,0
 
   release=...
 
-Specify release of new Debian system. Defaults to Debian stable.
-Supported relases: sarge, etch, lenny and sid. Usage example: release=sid
+Specify release of new Debian system. Defaults to Debian stable.  Supported
+relases: etch, lenny, squeeze and sid. Usage example: release=sid
 
   mirror=...
 
@@ -214,10 +273,10 @@ argument. Usage example: password=AiTh5ahn
 Usage example for automatic installation:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-  debian2hd target=/dev/hda1 grub=hd0 groot=hd0,0 mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
+  debian2hd target=/dev/sda1 grub=hd0 groot=hd0,0 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/hda1 is the partition where you really want to install your new Debian
+that /dev/sda1 is the partition where you really want to install your new Debian
 system.
 
 [NOTE]
@@ -232,13 +291,12 @@ Supported Releases
 include::releasetable.txt[]
 
 [NOTE]
-.Sarge-Release
-=====================================================================
-[1] Please notice that Sarge is the current old-stable within Debian.
-grml-debootstrap can handle the release but you really should not
-use Sarge anymore unless you really know what you are doing. Choose
-Etch instead.
-=====================================================================
+.Etch-Release
+================================================================================
+[1] Please notice that Etch is the current old-stable within Debian.
+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
 ----