Update manpage, depends
[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 (or directory) then. Customization of this process is
22 possible as well.
23 .SH OPTIONS
24 grml-debootstrap supports the following options:
25 .TP
26 .B \-h, \-\-help
27 Show summary of options.
28 .TP
29 .B \-v, \-\-version
30 Show version of program.
31 .SH FILES
32 .TP
33 .B /etc/debootstrap/config
34 Main configuration file. You have to adjust it according to your needs
35 before you are able to run grml-debootstrap.
36 .TP
37 .B /etc/debootstrap/chroot-script
38 The script executed within the new Debian system as soon as the main system
39 has been installed via [c]debootstrap.
40 .TP
41 .B /etc/debootstrap/locale.gen
42 Defines the default locales used for generating locales via locale-gen.
43 .TP
44 .B /etc/debootstrap/packages
45 Defines the software packages which should be installed in the new
46 Debian system by default.
47 .TP
48 .B /etc/debootstrap/stages/
49 The default directory for storing information about executed stages. Every
50 single function of grml-debootstrap will write 'done' to the stages directory
51 into a file named as the function itself if it has been executed sucessfully.
52 You can adjust the location of the directory via configuration variable STAGES
53 via /etc/debootstrap/config.  Please notice that you have to remove the stages
54 directory on your own if you want to re-execute grml-deboostrap after running it
55 successfully once. This should avoid recurrent execution by error of
56 grml-debootstrap (which might delete present data).
57 .SH CUSTOMIZATION
58
59 You can control execution of grml-debootstrap via adjusting
60 /etc/debootstrap/config for some main stuff.  The packages which should be
61 installed in the new Debian system can be defined via the file
62 /etc/debootstrap/packages.  If you want to put existing files to the new
63 Debian system you can place them into the (by default non-existing)
64 directories boot, etc, share, usr and var in /etc/debootstrap/. Every
65 existing directory will be copied to the new Debian system then.
66
67 .SH SUPPORTED RELEASES
68 .TP
69 Current status:
70
71   +----------------+-------------+-----------------+
72   | Release / Tool | debootstrap | cdebootstrap    |
73   +----------------+-------------+-----------------+
74   | Sarge          |  works [1]  |  works [1]      |
75   +----------------+-------------+-----------------+
76   | Etch           |  works      |  works          |
77   +----------------+-------------+-----------------+
78   | Lenny          |  works      |  works          |
79   +----------------+-------------+-----------------+
80   | Sid            |  works      |  works          |
81   +----------------+-------------+-----------------+
82
83 [1] Please notice that Sarge is the current old-stable within Debian.
84 grml-debootstrap can handle the release but you really should not
85 use Sarge anymore unless you really know what you are doing. Choose
86 Etch instead.
87
88 .SH BUGS
89 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
90 .SH SEE ALSO
91 .BR debootstrap (8),
92 .BR cdebootstrap (1).
93 .SH AUTHOR
94 grml-debootstrap was written by Michael Prokop <mika@grml.org>.
95 .PP
96 This manual page was written by Michael Prokop <mika@grml.org>
97 for the grml project (but may be used by others).