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