Add preliminary support for Debian/bullseye (AKA Debian v11.0)

[grml-debootstrap.git] / grml-debootstrap.8.txt

diff --git a/grml-debootstrap.8.txt b/grml-debootstrap.8.txt
index bfb38cc..4882d2b 100644 (file)
--- a/grml-debootstrap.8.txt
+++ b/grml-debootstrap.8.txt
@@ -20,7 +20,7 @@ want) for installing a plain Debian system very fast and easy.
 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
 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
+line options a dialog based front end will be available to control some basic

 configuration options.
 
 A plain and base Debian system will be installed on the given device, directory
 configuration options.
 
 A plain and base Debian system will be installed on the given device, directory


@@ -40,7 +40,7 @@ Options and environment variables
 
 *--backportrepos*::
 
 
 *--backportrepos*::
 

-    Enable Debian's Backports repository (http://backports.debian.org/) via the
+    Enable Debian's Backports repository via the

     /etc/apt/sources.list.d/backports.list configuration file. This provides the
     option to install Debian packages from Debian's backports repository.
 
     /etc/apt/sources.list.d/backports.list configuration file. This provides the
     option to install Debian packages from Debian's backports repository.
 


@@ -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.


@@ -78,6 +83,21 @@ Options and environment variables
    Execute in very verbose way. Useful for debugging possible problems
    with grml-debootstrap or identify what's actually executed.
 
    Execute in very verbose way. Useful for debugging possible problems
    with grml-debootstrap or identify what's actually executed.
 

+*--defaultinterfaces*::
+
+   Install a default /etc/network/interfaces file (enabling DHCP for eth0)
+   instead of taking over config from host system.
+
+*--efi* _device_::
+
+    Partition where EFI boot manager should be installed to. If the
+    specified device doesn't use a FAT filesystem yet grml-debootstrap
+    automatically creates the filesystem. If a FAT filesystem is already
+    present the filesystem creation is skipped. Please ensure that it's
+    a valid FAT32 filesystem and the partition has the 'boot' and 'esp'
+    flags enabled. This option requires EFI support on the running system
+    and the option is NOT supported for Virtual Machine deployments.
+

 *--filesystem* _filesystem_::
 
     Filesystem that should be created when installing to a partition.
 *--filesystem* _filesystem_::
 
     Filesystem that should be created when installing to a partition.


@@ -144,6 +164,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 +197,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 +213,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, buster, bullseye and sid. Corresponding with configuration
+    variable RELEASE. Default release: buster
+
+*--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 +243,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_::


@@ -237,37 +269,43 @@ Usage examples
 
   grml-debootstrap --target /dev/sda1 --grub /dev/sda
 
 
   grml-debootstrap --target /dev/sda1 --grub /dev/sda
 

-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.
+Install default Debian release (buster) on /dev/sda1 and install bootmanager
+GRUB in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
+
+  grml-debootstrap --release stretch --target /dev/sda1 --grub /dev/sda --hostname foobar --password changeme
+
+Install Debian release stretch on /dev/sda1 and install bootmanager
+GRUB in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
+Set hostname to 'foobar' and password for user root to 'changeme'.

 
   grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid
 
 
   grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid
 

-Install Debian unstable/sid on /dev/sda6, install bootmanager Grub in MBR
+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
 
 (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 (jessie) in directory /data/chroot (without
+Install default Debian release (buster) 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 (jessie) in a Virtual Machine file with
-3GB disk size (including Grub as bootmanager in MBR of the virtual disk file):
+Install default Debian release (buster) 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://deb.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 (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 (ftp://ftp.debian.de/debian) one.
+Install default debian release (buster) 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/
 
 Install Debian on /dev/sda1 using the loopback mounted Debian-ISO
 
   mount -o loop /mnt/sda6/debian-CD-1.iso /mnt/iso
   grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso file:/mnt/iso/debian/
 
 Install Debian on /dev/sda1 using the loopback mounted Debian-ISO

-for the base-system and install bootmanager Grub in MBR (master boot record) of
+for the base-system and install bootmanager GRUB in MBR (master boot record) of

 /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.
 /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.


@@ -336,13 +374,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 jessie. Supported
-relases: lenny, squeeze, wheezy, jessie and sid. Usage example: release=sid
+Specify release of new Debian system. Defaults to Debian buster. Supported
+releases: lenny, squeeze, wheezy, jessie, stretch, buster, bullseye and sid. Usage example: release=stretch

 
   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://deb.debian.org/debian).

 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 
   password=...
 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 
   password=...


@@ -371,17 +409,30 @@ Supported Releases
 include::releasetable.txt[]
 
 [NOTE]
 include::releasetable.txt[]
 
 [NOTE]

-.lenny release
+.lenny/squeeze/wheezy release

 ================================================================================
 ================================================================================

-[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
-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.
+[1] Please notice that releases like lenny, squeeze and wheezy are unsupported releases within Debian nowadays.
+grml-debootstrap can handle the releases but you really should not use them
+anymore unless you really know what you are doing.
+Choose the current Debian stable version instead.
+See https://wiki.debian.org/DebianReleases for the list of supported releases.
+
+Notice that you need to specify a mirror providing the lenny and squeeze releases, the
+default (http://deb.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
 Set the mirror to e.g. http://archive.debian.org/debian/ if you don't have

-your own lenny mirror.
+your own lenny/squeeze mirror.
+
+Older releases might also fail to install when running on top of recent kernel versions,
+throwing segfaults during debootstrap. This can be identified by the following messages inside kernel log (check with 'dmesg'):
+
+   dpkg[...] vsyscall attempted with vsyscall=none ip:[...]
+   dpkg[...]: segfault at [...]
+
+To work around this issue boot your system with the kernel boot option 'vsyscall=emulate'.
+
+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: