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