Update screenshot
[grml-debootstrap.git] / grml-debootstrap.txt
1 grml-debootstrap(8)
2 ===================
3
4 Name
5 ----
6 grml-debootstrap - wrapper around debootstrap for installing plain Debian via grml
7
8 Synopsis
9 --------
10 grml-debootstrap [ options ]
11
12 image:images/screenshot.png[Screenshot]
13
14 Introduction
15 ------------
16
17 grml-debootstrap is a wrapper suite around debootstrap
18 (and cdebootstrap if you want) for installing a plain Debian
19 system via grml very fast and easy.
20
21 All you have to do is adjust a few variables in configuration file
22 /etc/debootstrap/config (or specify some variables via commandline) and invoke
23 grml-debootstrap without any further options then.
24
25 A plain and base Debian system will be installed on the given
26 device (or directory) then. Customization of this process is
27 possible as well.
28
29 CAUTION: The grml team does not take responsibility for loss of any data!
30
31 Options and environment variables
32 ---------------------------------
33
34   -h, --help
35
36 Show summary of options and exit.
37
38   -v, --version
39
40 Show version of program and exit.
41
42   --grub <device>
43
44 Where do you want to install grub to? Use grub syntax for specifying.
45 Do not forget to set groot as well. Leave empty to avoid installation of grub.
46
47   --groot <device>
48
49 Specify root device for usage in grub (corresponds with $TARGET).
50 Again, use grub syntax for specifying.
51 Corresponding with configuration variable GROOT.
52
53   -m, --mirror <URL>
54
55 Specify mirror which should be used for apt-get/aptitude. Notice that
56 specifying the mirror also sets the chrootmirror to the given value.
57 Corresponding with configuration variables MIRROR and CHROOTMIRROR.
58
59   -p, --mntpoint </mntpoint>
60
61 Specify mountpoint that should be used for mounting the target system.
62 Corresponding with configuration variable MNTPOINT.
63
64   -r, --release <releasename>
65
66 Specify release of new Debian system. Supported relases: sarge, etch, lenny and sid.
67 Corresponding with configuration variable RELEASE.
68
69   -t, --target <target>
70
71 Target partition (/dev/...) or directory (anything else without /dev at the
72 beginning).
73
74 WARNING: the commandline parsing of grml-debootstrap does not validate the provided
75 arguments for the commandline options. Please be careful and check docs and
76 /etc/debootstrap/config for further information.
77
78 Usage examples
79 ---------------
80
81   grml-debootstrap --target /dev/hda1 --grub hd0 --groot hd0,0
82
83 Install default Debian release (stable/etch) on /dev/hda1 and install bootmanager
84 Grub in MBR (master boot record) of /dev/hda and use /dev/hda1 as system partition.
85
86   grml-debootstrap --target /dev/hda6 --grub hd0 --groot hd0,5 --release sid
87
88 Install Debian unstable/sid on /dev/hda6, install bootmanager
89 Grub in MBR (master boot record) of /dev/hda and use /dev/hda6 as system partition.
90
91   grml-debootstrap --target /data/chroot
92
93 Install default Debian release (stable/etch) in directory /data/chroot (without
94 any bootloader).
95
96   grml-debootstrap --target /dev/sda3 --grub hd0 --groot hd0,2 --mirror ftp://ftp.tugraz.at/mirror/debian
97
98 Install default Debian release (stable/etch) on /dev/sda3 and install bootmanager
99 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
100 Use specifed mirror instead of the default (ftp://ftp.debian.de/debian) one.
101
102 Files
103 -----
104
105   /etc/debootstrap/config
106
107 Main configuration file. You have to adjust it according to your needs
108 before you are able to run grml-debootstrap.
109
110   /etc/debootstrap/chroot-script
111
112 The script executed within the new Debian system as soon as the main system
113 has been installed via [c]debootstrap.
114
115   /etc/debootstrap/locale.gen
116
117 Defines the default locales used for generating locales via locale-gen.
118
119   /etc/debootstrap/packages
120
121 Defines the software packages which should be installed in the new
122 Debian system by default.
123
124   /etc/debootstrap/stages/
125
126 The default directory for storing information about executed stages. Every
127 single function of grml-debootstrap will write 'done' to the stages directory
128 into a file named as the function itself if it has been executed sucessfully.
129 You can adjust the location of the directory via configuration variable STAGES
130 via /etc/debootstrap/config.  Please notice that you have to remove the stages
131 directory on your own if you want to re-execute grml-deboostrap after running it
132 successfully once. This should avoid recurrent execution by error of
133 grml-debootstrap (which might delete present data).
134
135 Customization
136 -------------
137
138 You can control execution of grml-debootstrap via adjusting
139 /etc/debootstrap/config for some main stuff or via setting some selected
140 variables via commandline.  The packages which should be installed in the new
141 Debian system can be defined via the file /etc/debootstrap/packages.  If you
142 want to put existing files to the new Debian system you can place them into the
143 (by default non-existing) directories boot, etc, share, usr and var in
144 /etc/debootstrap/. Every existing directory will be copied to the new Debian
145 system then.
146
147 Supported Releases
148 ------------------
149
150 include::releasetable.txt[]
151
152 [NOTE]
153 .A Sarge-Release
154 =====================================================================
155 [1] Please notice that Sarge is the current old-stable within Debian.
156 grml-debootstrap can handle the release but you really should not
157 use Sarge anymore unless you really know what you are doing. Choose
158 Etch instead.
159 =====================================================================
160
161 Bugs
162 ----
163
164 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
165
166 See also
167 --------
168
169 debootstrap (8), cdebootstrap (1).
170
171 Author
172 ------
173 Michael Prokop <mika@grml.org>