Use parted to create partition table (issue #90)
[grml-debootstrap.git] / grml-debootstrap.8.txt
index 329a7d3..8b78669 100644 (file)
@@ -15,14 +15,16 @@ Introduction
 ------------
 
 grml-debootstrap is a wrapper suite around debootstrap (and cdebootstrap if you
 ------------
 
 grml-debootstrap is a wrapper suite around debootstrap (and cdebootstrap if you
-want) for installing a plain Debian system (e.g. via Grml) very fast and easy.
+want) for installing a plain Debian system 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 command line) and invoke
-grml-debootstrap without any further options then.
+All you have to do is adjust a few variables in the configuration file
+/etc/debootstrap/config or specify some command line options and invoke
+grml-debootstrap. If invoked without any configuration modifications or command
+line options a dialog based frontend will be available to control some basic
+configuration options.
 
 
-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, directory
+or virtual image file then. Customization of this process is possible as well.
 
 CAUTION: The Grml team does not take responsibility for loss of any data!
 
 
 CAUTION: The Grml team does not take responsibility for loss of any data!
 
@@ -36,6 +38,12 @@ Options and environment variables
     deploy an i386 system use this option. Note: deploying amd64 from an i386
     kernel does *not* work. Example: "_--arch i386_"
 
     deploy an i386 system use this option. Note: deploying amd64 from an i386
     kernel does *not* work. Example: "_--arch i386_"
 
+*--backportrepos*::
+
+    Enable Debian's Backports repository (http://backports.debian.org/) via the
+    /etc/apt/sources.list.d/backports.list configuration file. This provides the
+    option to install Debian packages from Debian's backports repository.
+
 *--bootappend* _appendline-for-the-kernel_::
 
     Specify appendline for the kernel.
 *--bootappend* _appendline-for-the-kernel_::
 
     Specify appendline for the kernel.
@@ -52,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.
@@ -65,10 +78,15 @@ Options and environment variables
 
     Extra parameters passed to the debootstrap command.
 
 
     Extra parameters passed to the debootstrap command.
 
+*--debug*::
+
+   Execute in very verbose way. Useful for debugging possible problems
+   with grml-debootstrap or identify what's actually executed.
+
 *--filesystem* _filesystem_::
 
     Filesystem that should be created when installing to a partition.
 *--filesystem* _filesystem_::
 
     Filesystem that should be created when installing to a partition.
-    If unset defaults to ext3. Valid values are all filesystems that
+    If unset defaults to ext4. Valid values are all filesystems that
     can be created through mkfs._filesystem_.
 
 *--force*::
     can be created through mkfs._filesystem_.
 
 *--force*::
@@ -96,7 +114,7 @@ Options and environment variables
 
 *--hostname* _hostname_::
 
 
 *--hostname* _hostname_::
 
-    Use specified hostname instead of the default (being 'grml').
+    Use specified hostname instead of the default (being $HOSTNAME or if unset 'grml').
 
 *-i*, *--iso* _/mntpoint_::
 
 
 *-i*, *--iso* _/mntpoint_::
 
@@ -119,6 +137,23 @@ Options and environment variables
 
     Skip debootstrap, only do configuration to the target.
 
 
     Skip debootstrap, only do configuration to the target.
 
+*--nointerfaces*::
+
+    Do not copy /etc/network/interfaces from host system to the target.
+    This option is automatically enabled when using --vm or --vmfile.
+
+*--nokernel*::
+
+    Skip installation of default kernel images. This option might be
+    interesting for you if you want a Debian system which doesn't
+    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.
@@ -147,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 (note: requires current 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_::
 
@@ -161,47 +198,63 @@ 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_::
+
     Target partition (/dev/...) or directory (anything else without /dev at the
     Target partition (/dev/...) or directory (anything else without /dev at the
-    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).
+    beginning).
 
 *-v*, *--verbose*::
 
 *-v*, *--verbose*::
+
     Increase verbosity.
 
     Increase verbosity.
 
-*--vmfile*::
-    Set up a Virtual Machine instead of installing to a partition or directory.
+*--vm*::
+
+    Set up a Virtual Machine on an existing block device, which will be
+    partitioned.
     This allows deployment of a Virtual Machine. The options needs to be
     combined with the --target option.
     This allows deployment of a Virtual Machine. The options needs to be
     combined with the --target option.
+    Usage example: --vm --target /dev/mapper/your-vm-disk
+
+*--vmfile*::
+
+    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_::
+
    Use specified size for size of Virtual Machine disk file. If not specified it
    defaults to 2G (being 2GB). Syntax as supported by qemu-img (see manpage
    qemu-img(1) for details.
    Usage example: --vmsize 3G
 
 *-V*, *--version*::
    Use specified size for size of Virtual Machine disk file. If not specified it
    defaults to 2G (being 2GB). Syntax as supported by qemu-img (see manpage
    qemu-img(1) for details.
    Usage example: --vmsize 3G
 
 *-V*, *--version*::
+
     Show version of program and exit.
 
     Show version of program and exit.
 
-WARNING: the command line parsing of grml-debootstrap does not validate the provided
-arguments for the command line options. Please be careful and check docs and
-/etc/debootstrap/config for further information.
+WARNING: the command line parsing of grml-debootstrap usually does not validate
+the provided arguments for the command line options. Please be careful and check
+docs and /etc/debootstrap/config for further information.
 
 Usage examples
 ---------------
 
   grml-debootstrap --target /dev/sda1 --grub /dev/sda
 
 
 Usage examples
 ---------------
 
   grml-debootstrap --target /dev/sda1 --grub /dev/sda
 
-Install default Debian release (wheezy) on /dev/sda1 and install bootmanager
+Install default Debian release (jessie) 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 /dev/sda --release sid
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
 
   grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid
@@ -212,20 +265,20 @@ Install Debian unstable/sid on /dev/sda6, install bootmanager Grub in MBR
   mount /dev/sda1 /data/chroot
   grml-debootstrap --target /data/chroot
 
   mount /dev/sda1 /data/chroot
   grml-debootstrap --target /data/chroot
 
-Install default Debian release (wheezy) in directory /data/chroot (without
+Install default Debian release (jessie) in directory /data/chroot (without
 any bootloader).
 
   grml-debootstrap --target /dev/sda3 --grub /dev/sda  --mirror ftp://ftp.tugraz.at/mirror/debian
 
 any bootloader).
 
   grml-debootstrap --target /dev/sda3 --grub /dev/sda  --mirror ftp://ftp.tugraz.at/mirror/debian
 
-Install default debian release (wheezy) in a Virtual Machine file with
-3GB disk size (including Grub as bootmanager in MBR of the virtual disk file):
+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://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
 
-Install default Debian release (wheezy) 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.
+Install default debian release (jessie) in a Virtual Machine file with
+3GB disk size (including Grub as bootmanager in MBR of the virtual disk file):
 
   mount -o loop /mnt/sda6/debian-CD-1.iso /mnt/iso
   grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso file:/mnt/iso/debian/
 
   mount -o loop /mnt/sda6/debian-CD-1.iso /mnt/iso
   grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso file:/mnt/iso/debian/
@@ -241,9 +294,9 @@ Files
 
   /etc/debootstrap/config
 
 
   /etc/debootstrap/config
 
-Main configuration file. You have to adjust it according to your needs
-if you want to execute grml-debootstrap in the non-interactive mode without
-any special command line arguments.
+Main configuration file. Adjust it according to your needs if you want to
+execute grml-debootstrap in the non-interactive mode without any special command
+line arguments.
 
   /etc/debootstrap/chroot-script
 
 
   /etc/debootstrap/chroot-script
 
@@ -264,17 +317,6 @@ Debian system by default.
 Debian Packages dropped in this directory will be installed into the new Debian
 system by default (Control variable: EXTRAPACKAGES)
 
 Debian Packages dropped in this directory will be installed into the new Debian
 system by default (Control variable: EXTRAPACKAGES)
 
-  /etc/debootstrap/stages/
-
-The default directory for storing information about executed stages. Every
-single function of grml-debootstrap will write 'done' to the stages directory
-into a file named as the function itself if it has been executed successfully.
-You can adjust the location of the directory via configuration variable STAGES
-via /etc/debootstrap/config.  Please notice that you have to remove the stages
-directory on your own if you want to re-execute grml-debootstrap after running it
-successfully once. This should avoid recurrent execution by error of
-grml-debootstrap (which might delete present data).
-
 Customization
 -------------
 
 Customization
 -------------
 
@@ -311,13 +353,13 @@ Where do you want to install grub to? Usage example: grub=/dev/sda
 
   release=...
 
 
   release=...
 
-Specify release of new Debian system. Defaults to Debian wheezy. Supported
-relases: lenny, squeeze, wheezy and sid. Usage example: release=sid
+Specify release of new Debian system. Defaults to Debian jessie. Supported
+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://cdn.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=...
@@ -325,8 +367,8 @@ Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 Set password of user root without prompting for it but set it to the given
 argument. Usage example: password=AiTh5ahn
 
 Set password of user root without prompting for it but set it to the given
 argument. Usage example: password=AiTh5ahn
 
-Usage example for automatic installation:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Usage example for automatic installation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
   debian2hd target=/dev/sda1 grub=/dev/sda 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
 
@@ -348,27 +390,43 @@ include::releasetable.txt[]
 [NOTE]
 .lenny release
 ================================================================================
 [NOTE]
 .lenny release
 ================================================================================
-[1] Please notice that lenny is the current old-stable release within Debian.
+[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
 grml-debootstrap can handle the release but you really should not use lenny
-anymore unless you really know what you are doing. Choose Debian 6.0 (squeeze)
-or Debian 7.0 (wheezy) instead.
+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
 
 Notice that you need to specify a mirror providing the lenny release, the
-default (http://cdn.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:
+
+   [...]
+   /var/lib/dpkg/tmp.ci/preinst: line 265: [: 3.16-1-grml-amd64: integery expression expected
+   /var/lib/dpkg/tmp.ci/preinst: line 231: 3.16-1-grml-amd64: syntax error: invalid arithemtic operator (error token is ".16-1-grml-amd64")
+   dpkg: error processing /var/cache/apt/archives/libc6_2.7-18lenny7_amd64.deb (--install):
+   [....]
+
+To workaround this either debootstrap from a system with an according
+kernel version or use the "fake uname" workaround (just google for it).
+
 When installing lenny to a new mdraid, grml-debootstrap will use md metadata
 format version 0.90. This limits the device to a maximum size of 2TB, but has
 the advantage of grub-legacy actually being able to boot from it.
 ================================================================================
 
 [NOTE]
 When installing lenny to a new mdraid, grml-debootstrap will use md metadata
 format version 0.90. This limits the device to a maximum size of 2TB, but has
 the advantage of grub-legacy actually being able to boot from it.
 ================================================================================
 
 [NOTE]
-.sid release
+.unstable and testing releases
 ================================================================================
 ================================================================================
-[2] Please notice that sid is Debian/unstable and due to its nature might not be
-always installable. What _might_ work instead is deploying a stable or testing
-release and upgrade it after installation finished.
+[2] Please notice that Debian/testing and Debian/unstable (sid) might
+not be always installable due to their nature. What _might_ work instead is
+deploying a stable release and upgrade it after installation finished.
 ================================================================================
 
 Bugs
 ================================================================================
 
 Bugs