Update documentation for upcoming stable release Debian/jessie
[grml-debootstrap.git] / grml-debootstrap.8.txt
index 329a7d3..fa68864 100644 (file)
@@ -15,14 +15,16 @@ Introduction
 ------------
 
 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!
 
@@ -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_"
 
+*--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.
@@ -65,10 +73,15 @@ Options and environment variables
 
     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.
-    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*::
@@ -96,7 +109,7 @@ Options and environment variables
 
 *--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_::
 
@@ -119,6 +132,18 @@ Options and environment variables
 
     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.
+
 *--nopackages*::
 
     Skip installation of packages defined in /etc/debootstrap/packages.
@@ -150,8 +175,8 @@ Options and environment variables
 *-r*, *--release* _releasename_::
 
     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.
+    squeeze, wheezy, jessie (note: requires a recent version of debootstrap)
+    and sid. Corresponding with configuration variable RELEASE.
 
 *--pre-scripts* _directory_::
 
@@ -169,39 +194,50 @@ Options and environment variables
     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* 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*::
+
     Increase verbosity.
 
+*--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.
+    Usage example: --vm --target /dev/mapper/your-vm-disk
+
 *--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.
     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*::
+
     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
 
-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
@@ -212,18 +248,18 @@ Install Debian unstable/sid on /dev/sda6, install bootmanager Grub in MBR
   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
 
-Install default debian release (wheezy) in a Virtual Machine file with
+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 /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
+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.
 
@@ -241,9 +277,9 @@ Files
 
   /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
 
@@ -264,17 +300,6 @@ Debian system by default.
 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
 -------------
 
@@ -311,13 +336,13 @@ Where do you want to install grub to? Usage example: grub=/dev/sda
 
   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
+relases: lenny, squeeze, wheezy, jessie and sid. Usage example: release=sid
 
   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://http.debian.net/debian).
 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 
   password=...
@@ -325,8 +350,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
 
-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
 
@@ -348,13 +373,13 @@ include::releasetable.txt[]
 [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
-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 7.0 (wheezy) or
+something newer instead.
 
 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://http.debian.net/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.
 
@@ -364,11 +389,11 @@ 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