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