updated manpage and fix for apt-get command in chroot-script

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

diff --git a/debian/grml-debootstrap.8 b/debian/grml-debootstrap.8
index 2b54452..1811c9a 100644 (file)
--- a/debian/grml-debootstrap.8
+++ b/debian/grml-debootstrap.8
@@ -1,31 +1,67 @@
 .TH GRML-DEBOOTSTRAP 8
 .SH NAME
-grml-debootstrap \- program to do something
+grml-debootstrap \- wrapper around debootstrap for installing plain Debian via grml
 .SH SYNOPSIS
 .B grml-debootstrap
-.RI [ options ] " files" ...
+.RI [ options ]
 .SH DESCRIPTION
 This manual page documents briefly the
 .B grml-debootstrap
 command.
 .PP
-\fBgrml-debootstrap\fP is a program that...
+\fBgrml-debootstrap\fP is a wrapper suite around debootstrap
+(and cdebootstrap if you want) for installing a plain Debian
+system via grml very fast and easy.
+
+All you have to do is adjust a few variables in configuration
+file /etc/debootstrap/config and invoke grml-debootstrap without
+any further options then.
+
+A plain and base Debian system will be installed on the given
+device then. Customization of this process is possible as well.
 .SH OPTIONS
-These programs follow the usual GNU command line syntax, with long
-options starting with two dashes (`-').
-A summary of options is included below.
-For a complete description, see the Info files.
+grml-debootstrap supports the following options:
 .TP
 .B \-h, \-\-help
 Show summary of options.
 .TP
 .B \-v, \-\-version
 Show version of program.
+.SH FILES
+.TP
+.B /etc/debootstrap/config
+Main configuration file. You have to adjust it according to your needs
+before you are able to run grml-debootstrap.
+.SH CUSTOMIZATION
+
+You can control execution of grml-debootstrap via adjusting
+/etc/debootstrap/config for some main stuff.  The packages which should be
+installed in the new Debian system can be defined via the file
+/etc/debootstrap/packages.  If you want to put existing files to the new
+Debian system you can place them into the (by default non-existing)
+directories boot, etc, share, usr and var in /etc/debootstrap/. Every
+existing directory will be copied to the new Debian system then.
+
+.SH SUPPORTED RELEASES
+.TP
+Current status:
+
+  +----------------+-------------+--------------+
+  | Release / Tool | debootstrap | cdebootstrap |
+  +----------------+-------------+--------------+
+  | Sarge          |  untested   |  untested    |
+  +----------------+-------------+--------------+
+  | Etch           |  works      |  works       |
+  +----------------+-------------+--------------+
+  | Sid            |  untested   |  untested    |
+  +----------------+-------------+--------------+
+.SH BUGS
+Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
 .SH SEE ALSO
 .BR debootstrap (8),
 .BR cdebootstrap (1).
 .SH AUTHOR
 grml-debootstrap was written by Michael Prokop <mika@grml.org>.
 .PP
-This manual page was written by Michael Prokop <mika@grml.org>,
-for the Debian project (but may be used by others).
+This manual page was written by Michael Prokop <mika@grml.org>
+for the grml project (but may be used by others).