Always execute finalize(), based on patch by Tong Sun <suntong@cpan.org>
[grml-debootstrap.git] / grml-debootstrap.8.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 *--bootappend* <_appendline for the kernel_>::
35     Specify appendline for the kernel.
36     E.g. "_pci=nomsi_"
37
38 *-c*, *--config* <_file_>::
39     Use specified configuration file, defaults to /etc/debootstrap/config.
40
41 *-d*, *--confdir* <_path_>::
42     Place of configuration files for debootstrap, defaults to /etc/debootstrap.
43
44 *--debconf* <_file_>::
45     Use specified file for preseeding Debian packages instead of using
46     the default <confdir>/debconf-selections.
47
48 *--debopt* <_params_>::
49     Extra parameters passed to the debootstrap.
50
51 *--groot* <_device_>::
52     Specify root device for usage in grub (corresponds with $TARGET).
53     Again, use grub syntax for specifying.
54     Corresponding with configuration variable GROOT.
55
56 *--grub* <_device_>::
57     Where do you want to install grub to? Use grub syntax for specifying.
58     Do not forget to set groot as well. Leave empty to avoid installation of grub.
59
60 *--help*, *-h*::
61     Show summary of options and exit.
62
63 *--hostname* <_hostname_>::
64     Use specified hostname instead of the default (being 'grml').
65
66 *-i*, *--iso* <_/mntpoint_>::
67     Specify mountpoint where you have a Debian ISO mounted loopback.
68     Using this option instead of the mirror option gives you the possibility
69     to install the base-system without network access. Make sure you
70     mounted the according Debian-ISO to the given <_/mntpoint_>. See section
71     'Usage examples' for a demonstration.
72
73 *--keep_src_list*::
74      Do not overwrite user provided /etc/apt/sources.list.
75
76 *-m*, *--mirror* <_URL_>::
77     Specify mirror which should be used for apt-get/aptitude. Notice that
78     specifying the mirror also sets the chrootmirror to the given value.
79     Corresponding with configuration variables MIRROR and CHROOTMIRROR.
80
81 *--nodebootstrap*::
82     Skip debootstrap, only do configuration to the target.
83
84 *-p*, *--mntpoint* <_/mntpoint_>::
85     Specify mountpoint that should be used for mounting the target system.
86     Corresponding with configuration variable MNTPOINT.
87
88 *--packages* [<_file_>]::
89     Use specified file as list for packages that should be installed instead of
90     the default package list file <confdir>/packages. If no file parameter is given
91     it activates the default package list file <confdir>/packages.
92
93 *--password* <_password_>::
94     Use specified password as password for user root. Use with caution, as your
95     commandline might be visible in the process list and the shell history.
96     It's meant for automatic installation only.
97
98 *-r*, *--release* <_releasename_>::
99     Specify release of new Debian system. Supported releases: sarge, etch, lenny and sid.
100     Corresponding with configuration variable RELEASE.
101
102 *-t*, *--target* <_target_>::
103     Target partition (/dev/...) or directory (anything else without /dev at the
104     beginning). To install grub using *--grub* and *--groot*, make sure to
105     use a _device_ instead of a directory as _target_ (installation of
106     grub as bootloader when using directories isn't supported yet).
107
108 *-v*, *--verbose*::
109     Increase verbosity.
110
111 *-V*, *--version*::
112     Show version of program and exit.
113
114 WARNING: the commandline parsing of grml-debootstrap does not validate the provided
115 arguments for the commandline options. Please be careful and check docs and
116 /etc/debootstrap/config for further information.
117
118 Usage examples
119 ---------------
120
121   grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0
122
123 Install default Debian release (stable/etch) on /dev/sda1 and install bootmanager
124 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
125
126   grml-debootstrap --target /dev/sda6 --grub hd0 --groot hd0,5 --release sid
127
128 Install Debian unstable/sid on /dev/sda6, install bootmanager
129 Grub in MBR (master boot record) of /dev/sda and use /dev/sda6 as system partition.
130
131   grml-debootstrap --target /data/chroot
132
133 Install default Debian release (stable/etch) in directory /data/chroot (without
134 any bootloader).
135
136   grml-debootstrap --target /dev/sda3 --grub hd0 --groot hd0,2 --mirror ftp://ftp.tugraz.at/mirror/debian
137
138 Install default Debian release (stable/etch) on /dev/sda3 and install bootmanager
139 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
140 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
141
142   mount -o loop /mnt/sda6/debian-40r0-i386-CD-1.iso /mnt/iso
143   grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0 --iso file:/mnt/iso/debian/
144
145 Install Debian stable/etch on /dev/sda1 using the loopback mounted Debian-ISO
146 for the base-system and install bootmanager Grub in MBR (master boot record) of
147 /dev/sda and use /dev/sda1 as system partition. Please notice, that the chroot
148 system requires network access for all packages which are not part of the
149 ISO.
150
151 Files
152 -----
153
154   /etc/debootstrap/config
155
156 Main configuration file. You have to adjust it according to your needs
157 before you are able to run grml-debootstrap.
158
159   /etc/debootstrap/chroot-script
160
161 The script executed within the new Debian system as soon as the main system
162 has been installed via [c]debootstrap.
163
164   /etc/debootstrap/locale.gen
165
166 Defines the default locales used for generating locales via locale-gen.
167
168   /etc/debootstrap/packages
169
170 Defines the software packages which should be installed in the new
171 Debian system by default.
172
173   /etc/debootstrap/extrapackages
174
175 Debian Packages dropped here will be installed into the new Debian system by
176 default (Controlvariable: EXTRAPACKAGES)
177
178   /etc/debootstrap/stages/
179
180 The default directory for storing information about executed stages. Every
181 single function of grml-debootstrap will write 'done' to the stages directory
182 into a file named as the function itself if it has been executed successfully.
183 You can adjust the location of the directory via configuration variable STAGES
184 via /etc/debootstrap/config.  Please notice that you have to remove the stages
185 directory on your own if you want to re-execute grml-debootstrap after running it
186 successfully once. This should avoid recurrent execution by error of
187 grml-debootstrap (which might delete present data).
188
189 Customization
190 -------------
191
192 You can control execution of grml-debootstrap via adjusting
193 /etc/debootstrap/config for some main stuff or via setting some selected
194 variables via commandline.  The packages which should be installed in the new
195 Debian system can be defined via the file /etc/debootstrap/packages.  If you
196 want to put existing files to the new Debian system you can place them into the
197 (by default non-existing) directories boot, etc, share, usr and var in
198 /etc/debootstrap/. Every existing directory will be copied to the new Debian
199 system then. If you want to install additional packages that are not available
200 via the grml or debian mirror drop them into /etc/debootstrap/extrapackages and
201 make sure that EXTRAPACKAGES is set to "yes".
202
203 Automatic installation
204 ----------------------
205
206 If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
207 full automatic mode. While this mode isn't really useful for interactive
208 execution (just configure /etc/debootstrap/configure or specify the relevant
209 variables on the commandline instead) it is meant for use via bootoption
210 debian2hd. The bootoption debian2hd (more precise: the kernelname on bootprompt)
211 supports the following bootoptions (they correspond with the commandline options
212 mentioned above):
213
214   target=...
215
216 The target partition/directory of the new Debian system. Usage example:
217 target=/dev/sda1
218
219   grub=...
220
221 Where do you want to install grub to? Use grub syntax for specifying.
222 Usage example: grub=hd0
223
224   groot=...
225
226 Specify root device for usage in grub (corresponds with $TARGET).
227 Again, use grub syntax for specifying. Usage example: groot=hd0,0
228
229   release=...
230
231 Specify release of new Debian system. Defaults to Debian stable.
232 Supported relases: sarge, etch, lenny and sid. Usage example: release=sid
233
234   mirror=...
235
236 Specify mirror which should be used for apt-get/aptitude instead
237 of the default one (ftp://ftp.debian.de/debian).
238 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
239
240   password=...
241
242 Set password of user root without prompting for it but set it to the given
243 argument. Usage example: password=AiTh5ahn
244
245 Usage example for automatic installation:
246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
247
248   debian2hd target=/dev/sda1 grub=hd0 groot=hd0,0 mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
249
250 You have to enter this commandline at the bootprompt of grml. Please make sure
251 that /dev/sda1 is the partition where you really want to install your new Debian
252 system.
253
254 [NOTE]
255 Automatic installation within booting process is done in grml-autoconfig via
256 setting environment variable AUTOINSTALL and creation of
257 /usr/bin/grml-debootstrap_noninteractive with the available and relevant
258 bootoptions for grml-debootstrap.
259
260 Supported Releases
261 ------------------
262
263 include::releasetable.txt[]
264
265 [NOTE]
266 .Sarge-Release
267 =====================================================================
268 [1] Please notice that Sarge is the current old-stable within Debian.
269 grml-debootstrap can handle the release but you really should not
270 use Sarge anymore unless you really know what you are doing. Choose
271 Etch or Lenny instead.
272 =====================================================================
273
274 Bugs
275 ----
276
277 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
278
279 See also
280 --------
281
282 debootstrap (8), cdebootstrap (1).
283
284 Author
285 ------
286 Michael Prokop <mika@grml.org>