updated TODO
[grml-debootstrap.git] / debian / grml-debootstrap.8
1 .TH GRML-DEBOOTSTRAP 8
2 .SH NAME
3 grml-debootstrap \- wrapper around debootstrap for installing plain Debian via grml
4 .SH SYNOPSIS
5 .B grml-debootstrap
6 .RI [ options ]
7 .SH DESCRIPTION
8 This manual page documents briefly the
9 .B grml-debootstrap
10 command.
11 .PP
12 \fBgrml-debootstrap\fP is a wrapper suite around debootstrap
13 (and cdebootstrap if you want) for installing a plain Debian
14 system via grml very fast and easy.
15
16 All you have to do is adjust a few variables in configuration
17 file /etc/debootstrap/config and invoke grml-debootstrap without
18 any further options then.
19
20 A plain and base Debian system will be installed on the given
21 device then. Customization of this process is possible as well.
22 .SH OPTIONS
23 grml-debootstrap supports the following options:
24 .TP
25 .B \-h, \-\-help
26 Show summary of options.
27 .TP
28 .B \-v, \-\-version
29 Show version of program.
30 .SH FILES
31 .TP
32 .B /etc/debootstrap/config
33 Main configuration file. You have to adjust it according to your needs
34 before you are able to run grml-debootstrap.
35 .SH CUSTOMIZATION
36
37 You can control execution of grml-debootstrap via adjusting
38 /etc/debootstrap/config for some main stuff.  The packages which should be
39 installed in the new Debian system can be defined via the file
40 /etc/debootstrap/packages.  If you want to put existing files to the new
41 Debian system you can place them into the (by default non-existing)
42 directories boot, etc, share, usr and var in /etc/debootstrap/. Every
43 existing directory will be copied to the new Debian system then.
44
45 .SH SUPPORTED RELEASES
46 .TP
47 Current status:
48
49   +----------------+-------------+-----------------+
50   | Release / Tool | debootstrap | cdebootstrap    |
51   +----------------+-------------+-----------------+
52   | Sarge          |  works      | broken: #390510 |
53   +----------------+-------------+-----------------+
54   | Etch           |  works      |  works          |
55   +----------------+-------------+-----------------+
56   | Sid            |  works      |  works          |
57   +----------------+-------------+-----------------+
58 .SH BUGS
59 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
60 .SH SEE ALSO
61 .BR debootstrap (8),
62 .BR cdebootstrap (1).
63 .SH AUTHOR
64 grml-debootstrap was written by Michael Prokop <mika@grml.org>.
65 .PP
66 This manual page was written by Michael Prokop <mika@grml.org>
67 for the grml project (but may be used by others).