Update manpage
[grml-debootstrap.git] / grml-debootstrap.txt
index e8f6557..c136ef1 100644 (file)
@@ -9,6 +9,8 @@ Synopsis
 --------
 grml-debootstrap [ options ]
 
+image:images/screenshot.png[Screenshot]
+
 Introduction
 ------------
 
@@ -24,10 +26,7 @@ A plain and base Debian system will be installed on the given
 device (or directory) then. Customization of this process is
 possible as well.
 
-
-*******************************************************************************
-Important! 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!
 
 Options and environment variables
 ---------------------------------
@@ -62,6 +61,12 @@ Corresponding with configuration variables MIRROR and CHROOTMIRROR.
 Specify mountpoint that should be used for mounting the target system.
 Corresponding with configuration variable MNTPOINT.
 
+  --password <password>
+
+Use specified password as password for user root. Use with caution, as your
+commandline might be visible in the process list and the shell history.
+It's meant for automatic installation only.
+
   -r, --release <releasename>
 
 Specify release of new Debian system. Supported relases: sarge, etch, lenny and sid.
@@ -72,6 +77,10 @@ Corresponding with configuration variable RELEASE.
 Target partition (/dev/...) or directory (anything else without /dev at the
 beginning).
 
+WARNING: the commandline parsing of grml-debootstrap does not validate the provided
+arguments for the commandline options. Please be careful and check docs and
+/etc/debootstrap/config for further information.
+
 Usage examples
 ---------------
 
@@ -122,7 +131,7 @@ Debian system by default.
 
 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 sucessfully.
+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-deboostrap after running it
@@ -141,24 +150,67 @@ want to put existing files to the new Debian system you can place them into the
 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 system then.
 
+Automatic installation
+----------------------
+
+If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
+full automatic mode. While this mode isn't really useful for interactive
+execution (just configure /etc/debootstrap/configure or specify the relevant
+variables on the commandline instead) it is meant for use via bootoption
+debian2hd. The bootoption debian2hd (more precise: the kernelname on bootprompt)
+supports the following bootoptions (they correspond with the commandline options
+mentioned above):
+
+  target=...
+
+The target partition/directory of the new Debian system. Usage example:
+target=/dev/hda1
+
+  grub=...
+
+Where do you want to install grub to? Use grub syntax for specifying.
+Usage example: grub=hd0
+
+  groot=...
+
+Specify root device for usage in grub (corresponds with $TARGET).
+Again, use grub syntax for specifying. Usage example: groot=hd0,0
+
+  release=...
+
+Specify release of new Debian system. Defaults to Debian stable.
+Supported relases: sarge, etch, lenny and sid. Usage example: release=sid
+
+  mirror=...
+
+Specify mirror which should be used for apt-get/aptitude instead
+of the default one (ftp://ftp.debian.de/debian).
+Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
+
+  password=...
+
+Set passwort of user root without prompting for it but set it to the given
+argument. Usage example: password=AiTh5ahn
+
+[NOTE]
+Automatic installation within booting process is done in grml-autoconfig via
+setting environment variable AUTOINSTALL and creation of
+/usr/bin/grml-debootstrap_noninteractive with the available and relevant
+bootoptions for grml-debootstrap.
+
 Supported Releases
 ------------------
 
-.Current status
-[grid="all"]
-'---------.-----------------.---------------
-Release / Tool  debootstrap   cdebootstrap
---------------------------------------------
-Sarge           works[1]      works[1]
-Etch            works         works
-Lenny           works         works
-Sid             works         works
---------------------------------------------
+include::releasetable.txt[]
 
+[NOTE]
+.Sarge-Release
+=====================================================================
 [1] Please notice that Sarge is the current old-stable within Debian.
 grml-debootstrap can handle the release but you really should not
 use Sarge anymore unless you really know what you are doing. Choose
 Etch instead.
+=====================================================================
 
 Bugs
 ----
@@ -170,10 +222,6 @@ See also
 
 debootstrap (8), cdebootstrap (1).
 
-Bugs
-----
-Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to us]!
-
 Author
 ------
 Michael Prokop <mika@grml.org>