9cd2415f7eea422e439e659d32bf4a75bcda26bf
[live-boot-grml.git] / manpages / de / live-boot.de.7
1 .\"*******************************************************************
2 .\"
3 .\" This file was generated with po4a. Translate the source file.
4 .\"
5 .\"*******************************************************************
6 .TH LIVE\-BOOT 7 04.12.2011 3.0~a24\-1 "Debian Live Projekt"
7
8 .SH NAME
9 \fBlive\-boot\fP \- System Boot Skripte
10
11 .SH BESCHREIBUNG
12 \fBlive\-config\fP enthaelt die Skripte welche ein Debian Live System waehrend
13 des Startvorganes (early userspace) konfigurieren.
14 .PP
15 .\" FIXME
16 live\-boot is a hook for the initramfs\-tools, used to generate a initramfs
17 capable to boot live systems, such as those created by
18 \fIlive\-helper\fP(7). This includes the Debian Live isos, netboot tarballs, and
19 usb stick images.
20 .PP
21 .\" FIXME
22 At boot time it will look for a (read\-only) media containing a "/live"
23 directory where a root filesystems (often a compressed filesystem image like
24 squashfs) is stored. If found, it will create a writable environment, using
25 aufs, for Debian like systems to boot from.
26
27 .SH KONFIGURATION
28 \fBlive\-boot\fP kann durch Boot Parameter oder durch Konfigurationsdateien
29 konfiguriert werden.
30 .PP
31 To configure the live\-boot parameters used by default in a live image, see
32 the \-\-bootappend\-live option in the \fIlb_config\fP(1) manual page.
33
34 .SS "Kernel Parameter"
35 \fBlive\-boot\fP ist nur dann aktiv, wenn 'boot=live' als Kernel Parameter
36 benutzt wird.
37 .PP
38 In addition, there are some more boot parameters to influence the behaviour,
39 see below.
40
41 .SS Konfigurationsdateien
42 \fBlive\-boot\fP can be configured (but not activated) through configuration
43 files. Those files can be placed either in the root filesystem itself
44 (/etc/live/boot.conf, /etc/live/boot.d/), or on the live media
45 (live/boot.conf, live/boot.d/).
46
47 .SH OPTIONEN
48 .\" FIXME
49 \fBlive\-boot\fP currently features the following parameters.
50 .IP \fBaccess\fP=\fIACCESS\fP 4
51 Set the accessibility level for physically or visually impared users. ACCESS
52 must be one of v1, v2, v3, m1, or m2. v1=lesser visual impairment,
53 v2=moderate visual impairment, v3=blindness, m1=minor motor difficulties,
54 m2=moderate motor difficulties.
55 .IP \fBconsole\fP=\fITTY,SPEED\fP 4
56 Set the default console to be used with the "live\-getty" option. Example:
57 "console=ttyS0,115200"
58 .IP \fBdebug\fP 4
59 Makes initramfs boot process more verbose.
60 .br
61 Use: debug=1
62 .br
63 Without setting debug to a value the messages may not be shown.
64 .IP \fBfetch\fP=\fIURL\fP 4
65 .IP \fBhttpfs\fP=\fIURL\fP 4
66 Another form of netboot by downloading a squashfs image from a given url.
67 The fetch method copies the image to ram and the httpfs method uses fuse and
68 httpfs2 to mount the image in place. Copying to ram requires more memory and
69 might take a long time for large images. However, it is more likely to work
70 correctly because it does not require networking afterwards and the system
71 operates faster once booted because it does not require to contact the
72 server anymore.
73 .br
74 Due to current limitations in busyboxs wget and DNS resolution, an URL can
75 not contain a hostname but an IP only.
76 .br
77 Not working: http://example.com/path/to/your_filesystem.squashfs
78 .br
79 Working: http://1.2.3.4/path/to/your_filesystem.squashfs
80 .br
81 Also note that therefore it's currently not possible to fetch an image from
82 a namebased virtualhost of an httpd if it is sharing the ip with the main
83 httpd instance.
84 .br
85 You may also use the live iso image in place of the squashfs image.
86 .IP \fBiscsi\fP=\fIserver\-ip[,server\-port];target\-name\fP 4
87 Boot from an iSCSI target that has an iso or disk live image as one of its
88 LUNs. The specified target is searched for a LUN which looks like a live
89 media. If you use the \fBiscsitarget\fP software iSCSI target solution which is
90 packaged in Debian your ietd.conf might look like this:
91 .br
92 # The target\-name you specify in the iscsi= parameter
93 .br
94 Target <target\-name>
95   Lun 0 Path=<path\-to\-your\-live\-image.iso>,Type=fileio,IOMode=ro
96   # If you want to boot multiple machines you might want to look at tuning some parameters like
97   # Wthreads or MaxConnections
98 .IP \fBfromiso\fP=\fI/PATH/TO/IMAGE\fP 4
99 Allows to use a filesystem from within an iso image that's available on
100 live\-media.
101 .IP \fBignore_uuid\fP 4
102 Do not check that any UUID embedded in the initramfs matches the discovered
103 medium. live\-boot may be told to generate a UUID by setting
104 LIVE_GENERATE_UUID=1 when building the initramfs.
105 .IP \fBintegrity\-check\fP 4
106 If specified, an MD5 sum is calculated on the live media during boot and
107 compared to the value found in md5sum.txt found in the root directory of the
108 live media.
109 .IP "\fBip\fP=[\fIDEVICE\fP]:[\fICLIENT_IP\fP]:[\fISERVER_IP\fP]:[\fIGATEWAY_IP\fP]:[\fINETMASK\fP]:[\fIHOSTNAME\fP]:[\fIAUTOCONF\fP] [,[\fIDEVICE\fP]:[\fICLIENT_IP\fP]:[\fISERVER_IP\fP]:[\fIGATEWAY_IP\fP]:[\fINETMASK\fP]:[\fIHOSTNAME\fP]:[\fIAUTOCONF\fP]]" 4
110 Let you specify the name(s) and the options of the interface(s) that should
111 be configured at boot time. Do not specify this if you want to use dhcp
112 (default). It will be changed in a future release to mimick official kernel
113 boot param specification
114 (e.g. ip=10.0.0.1::10.0.0.254:255.255.255.0::eth0,:::::eth1:dhcp).
115 .IP \fBip\fP=[\fIfrommedia\fP] 4
116 If this variable is set, dhcp and static configuration are just skipped and
117 the system will use the (must be) media\-preconfigured
118 /etc/network/interfaces instead.
119 .IP {\fBlive\-media\fP|\fBbootfrom\fP}=\fIDEVICE\fP 4
120 If you specify one of this two equivalent forms, live\-boot will first try to
121 find this device for the "/live" directory where the read\-only root
122 filesystem should reside. If it did not find something usable, the normal
123 scan for block devices is performed.
124 .br
125 Instead of specifing an actual device name, the keyword 'removable' can be
126 used to limit the search of acceptable live media to removable type
127 only. Note that if you want to further restrict the media to usb mass
128 storage only, you can use the 'removable\-usb' keyword.
129 .IP {\fBlive\-media\-encryption\fP|\fBencryption\fP}=\fITYPE\fP 4
130 live\-boot will mount the encrypted rootfs TYPE, asking the passphrase,
131 useful to build paranoid live systems :\-). TYPE supported so far are "aes"
132 for loop\-aes encryption type.
133 .IP \fBlive\-media\-offset\fP=\fIBYTES\fP 4
134 This way you could tell live\-boot that your image starts at offset BYTES in
135 the above specified or autodiscovered device, this could be useful to hide
136 the Debian Live iso or image inside another iso or image, to create "clean"
137 images.
138 .IP \fBlive\-media\-path\fP=\fIPATH\fP 4
139 Sets the path to the live filesystem on the medium. By default, it is set to
140 \&'/live' and you should not change that unless you have customized your media
141 accordingly.
142 .IP \fBlive\-media\-timeout\fP=\fISECONDS\fP 4
143 Set the timeout in seconds for the device specified by "live\-media=" to
144 become ready before giving up.
145 .IP \fBmodule\fP=\fINAME\fP 4
146 Instead of using the default optional file "filesystem.module" (see below)
147 another file could be specified without the extension ".module"; it should
148 be placed on "/live" directory of the live medium.
149 .IP \fBnetboot\fP[=nfs|cifs] 4
150 This tells live\-boot to perform a network mount. The parameter "nfsroot="
151 (with optional "nfsopts="), should specify where is the location of the root
152 filesystem.  With no args, will try cifs first, and if it fails nfs.
153 .IP \fBnfsopts\fP= 4
154 This lets you specify custom nfs options.
155 .IP \fBnofastboot\fP 4
156 This parameter disables the default disabling of filesystem checks in
157 /etc/fstab. If you have static filesystems on your harddisk and you want
158 them to be checked at boot time, use this parameter, otherwise they are
159 skipped.
160 .IP \fBnopersistent\fP 4
161 disables the "persistent" feature, useful if the bootloader (like syslinux)
162 has been installed with persistent enabled.
163 .IP \fBnoprompt\fP 4
164 Do not prompt to eject the CD or remove the USB flash drive on reboot.
165 .IP \fBnoprompt\fP=\fITYPE\fP 4
166 This tells live\-boot not to prompt to eject the CD (when noprompt=cd) or
167 remove the USB flash drive (when noprompt=usb) on reboot.
168 .IP \fBramdisk\-size\fP 4
169 This parameters allows to set a custom ramdisk size (it's the '\-o size'
170 option of tmpfs mount). By default, there is no ramdisk size set, so the
171 default of mount applies (currently 50% of available RAM). Note that this
172 option has no currently no effect when booting with toram.
173 .IP \fBswapon\fP 4
174 This parameter enables usage of local swap partitions.
175 .IP \fBpersistent\fP 4
176 live\-boot will probe filesystems for persistent media. These can either be
177 the filesystems themselves, if labeled correctly, or image/archive files, if
178 named correctly. Overlays are labeled/named either "live\-rw" or "home\-rw"
179 and will be mounted on / or /home, respectively; snapshots are labeled/named
180 either "live\-sn" or "home\-sn" and will be extracted into / or /home,
181 respectively (see live\-snapshot(1) for more information). Overlays are
182 mounted before snapshots are extracted, and for both overlays and snapshots,
183 "live\-*" are handled before "home\-*". Overlay image files and snapshot
184 archive files have extensions which determines their filesystem or archive
185 type, e.g. "live\-rw.ext3" and "\home\-sn.squashfs".
186 .IP "\fBpersistent\-encryption\fP=\fITYPE1\fP,\fITYPE2\fP ... \fITYPEn\fP" 4
187 This option determines which types of encryption that we allow to be used
188 when probing devices for persistent media. If "none" is in the list, we
189 allow unencrypted media; if "luks" is in the list, we allow LUKS\-encrypted
190 media. Whenever a device containing encrypted media is probed the user will
191 be prompted for the passphrase. The default value is "none".
192 .IP \fBpersistent\-media\fP={\fIremovable\fP|\fIremovable\-usb\fP} 4
193 If you specify the keyword 'removable', live\-boot will try to find
194 persistent and snapshot partitions on removable media only. Note that if you
195 want to further restrict the media to usb mass storage only, you can use the
196 \&'removable\-usb' keyword.
197 .IP "\fBpersistent\-method\fP=\fITYPE1\fP,\fITYPE2\fP ... \fITYPEn\fP" 4
198 This option determines which types of persistent media we allow. If
199 "overlay" is in the list, we consider overlays (i.e. "live\-rw" and
200 "home\-rw"); if "snapshot" is in the list, we consider snapshots
201 (i.e. "live\-sn" and "home\-sn"). The default is "overlay,snapshot".
202 .IP \fBpersistent\-path\fP=\fIPATH\fP 4
203 live\-boot will look for persistency files in the root directory of a
204 partition, with this parameter, the path can be configured so that you can
205 have multiple directories on the same partition to store persistency files.
206 .IP \fBpersistent\-read\-only\fP 4
207 Filesystem changes are not saved back to persistent media. In particular,
208 overlays and netboot NFS mounts are mounted read\-only, and snapshots are not
209 resynced on shutdown.
210 .IP "\fBpersistent\-storage\fP=\fITYPE1\fP,\fITYPE2\fP ... \fITYPEn\fP" 4
211 This option determines which types of persistent storage to consider when
212 probing for persistent media. If "filesystem" is in the list, filesystems
213 with matching labels will be used; if "file" is in the list, all filesystems
214 will be probed for archives and image files with matching filenames. The
215 default is "file,filesystem".
216 .IP \fBpersistent\-subtext\fP=\fISUFFIX\fP 4
217 Add a suffix when searching for the image filenames or partition labels to
218 use for the above mentioned persistent feature, the SUFFIX will be added
219 after a dash (e.g.: "live\-sn" would transform to "live\-sn\-SUFFIX"). This is
220 handy to test multiple live\-boot based live\-systems with different
221 persistent storage choices.
222 .IP {\fBpreseed/file\fP|\fBfile\fP}=\fIFILE\fP 4
223 A path to a file present on the rootfs could be used to preseed debconf
224 database.
225 .IP \fBpackage/question\fP=\fIVALUE\fP 4
226 All debian installed packages could be preseeded from command\-line that way,
227 beware of blanks spaces, they will interfere with parsing, use a preseed
228 file in this case.
229 .IP \fBquickreboot\fP 4
230 This option causes live\-boot to reboot without attempting to eject the media
231 and without asking the user to remove the boot media.
232 .IP \fBshowmounts\fP 4
233 This parameter will make live\-boot to show on "/" the ro filesystems (mostly
234 compressed) on "/live". This is not enabled by default because could lead to
235 problems by applications like "mono" which store binary paths on
236 installation.
237 .IP \fBsilent\fP 4
238 If you boot with the normal quiet parameter, live\-boot hides most messages
239 of its own. When adding silent, it hides all.
240 .IP \fBtodisk\fP=\fIDEVICE\fP 4
241 Adding this parameter, live\-boot will try to copy the entire read\-only media
242 to the specified device before mounting the root filesystem. It probably
243 needs a lot of free space. Subsequent boots should then skip this step and
244 just specify the "live\-media=DEVICE" boot parameter with the same DEVICE
245 used this time.
246 .IP \fBtoram\fP 4
247 Adding this parameter, live\-boot will try to copy the whole read\-only media
248 to the computer's RAM before mounting the root filesystem. This could need a
249 lot of ram, according to the space used by the read\-only media.
250 .IP \fBunion\fP=aufs|unionfs 4
251 .\" FIXME
252 By default, live\-boot uses aufs. With this parameter, you can switch to
253 unionfs.
254
255 .\" FIXME
256 .SH "FILES (old)"
257 .IP \fB/etc/live.conf\fP 4
258 Some variables can be configured via this config file (inside the live
259 system).
260 .IP \fBlive/filesystem.module\fP 4
261 This optional file (inside the live media) contains a list of white\-space or
262 carriage\-return\-separated file names corresponding to disk images in the
263 "/live" directory. If this file exists, only images listed here will be
264 merged into the root aufs, and they will be loaded in the order listed
265 here. The first entry in this file will be the "lowest" point in the aufs,
266 and the last file in this list will be on the "top" of the aufs, directly
267 below /cow.  Without this file, any images in the "/live" directory are
268 loaded in alphanumeric order.
269 .IP \fB/etc/live\-persistence.binds\fP 4
270 This optional file (which resides in the rootfs system, not in the live
271 media) is used as a list of directories which not need be persistent:
272 ie. their content does not need to survive reboots when using the
273 persistence features.
274 .br
275 .\" FIXME
276 This saves expensive writes and speeds up operations on volatile data such
277 as web caches and temporary files (like e.g. /tmp and .mozilla) which are
278 regenerated each time. This is achieved by bind mounting each listed
279 directory with a tmpfs on the original path.
280
281 .SH DATEIEN
282 .IP \fB/etc/live/boot.conf\fP 4
283 .IP \fB/etc/live/boot.d/\fP 4
284 .IP \fBlive/boot.conf\fP 4
285 .IP \fBlive/boot.d/\fP 4
286
287 .SH "SIEHE AUCH"
288 \fIlive\-snapshot\fP(1)
289 .PP
290 \fIlive\-build\fP(7)
291 .PP
292 \fIlive\-config\fP(7)
293 .PP
294 \fIlive\-tools\fP(7)
295
296 .SH HOMEPAGE
297 Weitere Informationen ueber live\-boot und das Debian Live Projekt koennen
298 auf der Homepage unter <\fIhttp://live.debian.net/\fP> und im Handbuch
299 unter <\fIhttp://live.debian.net/manual/\fP> gefunden werden.
300
301 .SH FEHLER
302 Fehler koennen durch Einreichen eines Fehlerberichtes fuer das live\-boot
303 Paket im Debian Bug Tracking System unter
304 <\fIhttp://bugs.debian.org/\fP> oder durch Senden einer E\-Mail an die
305 Debian Live Mailing Liste unter <\fIdebian\-live@lists.debian.org\fP>
306 (englischsprachig) mitgeteilt werden.
307
308 .SH AUTOR
309 live\-boot wurde von Daniel Baumann <\fIdaniel@debian.org\fP> fuer das
310 Debian Projekt geschrieben.