Clarify usage of default hostname ($HOSTNAME is considered)
[grml-debootstrap.git] / grml-debootstrap.8.txt
index 5d18b90..9633864 100644 (file)
@@ -15,7 +15,7 @@ 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 the configuration file
 /etc/debootstrap/config or specify some command line options and invoke
@@ -38,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.
@@ -67,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*::
@@ -98,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_::
 
@@ -121,6 +132,11 @@ 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 --vmfile.
+
 *--nopackages*::
 
     Skip installation of packages defined in /etc/debootstrap/packages.
@@ -171,32 +187,35 @@ 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.
 
 *--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
 ---------------
@@ -243,9 +262,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
 
@@ -266,17 +285,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
 -------------
 
@@ -319,7 +327,7 @@ relases: lenny, squeeze, wheezy 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=...
@@ -327,8 +335,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
 
@@ -350,13 +358,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.
 
 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.
 
@@ -366,11 +374,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 jessie (Debian/testing) and sid (Debian/unstable) 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