Resolve now unused bootgrub.mksh (issue #90)
[grml-debootstrap.git] / grml-debootstrap.8.txt
index 2f4c197..8b78669 100644 (file)
@@ -60,6 +60,11 @@ Options and environment variables
     are executed at the end of the chroot procedure.
     Default directory: /etc/debootstrap/chroot-scripts/
 
     are executed at the end of the chroot procedure.
     Default directory: /etc/debootstrap/chroot-scripts/
 
+*--contrib*::
+
+    Enable the 'contrib' repository in COMPONENTS. By default only
+    the 'main' repository is enabled.
+
 *-d*, *--confdir* _path_::
 
     Place of configuration files for debootstrap, defaults to /etc/debootstrap.
 *-d*, *--confdir* _path_::
 
     Place of configuration files for debootstrap, defaults to /etc/debootstrap.
@@ -144,6 +149,11 @@ Options and environment variables
     need to provide regular boot, e.g. a system which provides
     ISOs for booting via GRUB using grml-rescueboot.
 
     need to provide regular boot, e.g. a system which provides
     ISOs for booting via GRUB using grml-rescueboot.
 
+*--non-free*::
+
+    Enable the 'non-free' repository in COMPONENTS. By default only
+    the 'main' repository is enabled.
+
 *--nopackages*::
 
     Skip installation of packages defined in /etc/debootstrap/packages.
 *--nopackages*::
 
     Skip installation of packages defined in /etc/debootstrap/packages.
@@ -172,11 +182,13 @@ Options and environment variables
     command line might be visible in the process list and the shell history.
     It's meant for automatic installation only.
 
     command line might be visible in the process list and the shell history.
     It's meant for automatic installation only.
 
-*-r*, *--release* _releasename_::
+*--post-scripts* _directory_::
 
 
-    Specify release of new Debian system. Supported releases names: lenny,
-    squeeze, wheezy, jessie (note: requires a recent version of debootstrap)
-    and sid. Corresponding with configuration variable RELEASE.
+    Execute scripts from specified directory after executing the chroot script.
+    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/post-scripts/
 
 *--pre-scripts* _directory_::
 
 
 *--pre-scripts* _directory_::
 
@@ -186,12 +198,16 @@ Options and environment variables
     scripts for direct access of the chroot.
     Default directory: /etc/debootstrap/pre-scripts/
 
     scripts for direct access of the chroot.
     Default directory: /etc/debootstrap/pre-scripts/
 
-*--scripts* _directory_::
+*-r*, *--release* _releasename_::
 
 
-    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/
+    Specify release of new Debian system. Supported releases names: lenny,
+    squeeze, wheezy, jessie, stretch (note: requires a recent version of debootstrap)
+    and sid. Corresponding with configuration variable RELEASE.
+
+*--remove-configs*::
+
+    Delete grml-debootstrap configuration files (/etc/debootstrap/*) from installed
+    system. Useful for reproducible builds or if you don't want to leak information.
 
 *-t*, *--target* _target_::
 
 
 *-t*, *--target* _target_::
 
@@ -212,9 +228,10 @@ Options and environment variables
 
 *--vmfile*::
 
 
 *--vmfile*::
 
-    Set up a Virtual Machine instead of installing to a partition or directory.
-    This allows deployment of a Virtual Machine. The options needs to be
-    combined with the --target option.
+    Set up a Virtual Machine using a regular file instead of installing to a
+    partition/block device or directory. This allows deployment of a Virtual
+    Machine. The options needs to be combined with the --target option
+    ('qemu-img create -f raw ...' is executed on the specified target).
     Usage example: --vmfile --target /mnt/sda1/qemu.img
 
 *--vmsize* _size_::
     Usage example: --vmfile --target /mnt/sda1/qemu.img
 
 *--vmsize* _size_::
@@ -255,7 +272,7 @@ any bootloader).
 
 Install default Debian release (jessie) on /dev/sda3 and install bootmanager
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 
 Install default Debian release (jessie) 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 (http://http.debian.net/debian) one.
+Use specified mirror instead of the default (http://httpredir.debian.org/debian) one.
 
   mount /dev/sda1 /mnt/sda1
   grml-debootstrap --vmfile --vmsize 3G --target /mnt/sda1/qemu.img
 
   mount /dev/sda1 /mnt/sda1
   grml-debootstrap --vmfile --vmsize 3G --target /mnt/sda1/qemu.img
@@ -337,12 +354,12 @@ Where do you want to install grub to? Usage example: grub=/dev/sda
   release=...
 
 Specify release of new Debian system. Defaults to Debian jessie. Supported
   release=...
 
 Specify release of new Debian system. Defaults to Debian jessie. Supported
-releases: lenny, squeeze, wheezy, jessie and sid. Usage example: release=sid
+releases: lenny, squeeze, wheezy, jessie, stretch and sid. Usage example: release=sid
 
   mirror=...
 
 Specify mirror which should be used for apt-get/aptitude instead
 
   mirror=...
 
 Specify mirror which should be used for apt-get/aptitude instead
-of the default one (http://http.debian.net/debian).
+of the default one (http://httpredir.debian.org/debian).
 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 
   password=...
 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 
   password=...
@@ -375,14 +392,18 @@ include::releasetable.txt[]
 ================================================================================
 [1] Please notice that lenny is an unsupported release within Debian nowadays.
 grml-debootstrap can handle the release but you really should not use lenny
 ================================================================================
 [1] Please notice that lenny is an unsupported release within Debian nowadays.
 grml-debootstrap can handle the release but you really should not use lenny
-anymore unless you really know what you are doing. Choose Debian 7.0 (wheezy) or
+anymore unless you really know what you are doing. Choose Debian 8.0 (jessie) or
 something newer instead.
 
 Notice that you need to specify a mirror providing the lenny release, the
 something newer instead.
 
 Notice that you need to specify a mirror providing the lenny release, the
-default (http://http.debian.net/debian) doesn't provide it any longer nowadays.
+default (http://httpredir.debian.org/debian) doesn't provide it any longer nowadays.
 Set the mirror to e.g. http://archive.debian.org/debian/ if you don't have
 your own lenny mirror.
 
 Set the mirror to e.g. http://archive.debian.org/debian/ if you don't have
 your own lenny mirror.
 
+You also need to specify a filesystem that's supported by lenny, e.g.
+'--filesystem ext3' since grml-debootstrap's current default (ext4) isn't
+supported by lenny.
+
 Also when debootstrapping lenny on a live system with a kernel version
 like "3.16-1-grml-amd64" lenny's libc will fail to install with:
 
 Also when debootstrapping lenny on a live system with a kernel version
 like "3.16-1-grml-amd64" lenny's libc will fail to install with: