Document iscsi in the man page.
[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 08.06.2010 2.0~a6 "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
31 .SS "Kernel Parameter"
32 \fBlive\-boot\fP ist nur dann aktiv, wenn 'boot=live' als Kernel Parameter
33 benutzt wird.
34 .PP
35 In addition, there are some more boot parameters to influence the behaviour,
36 see below.
37
38 .SS Konfigurationsdateien
39 \fBlive\-boot\fP can be configured (but not activated) through configuration
40 files. Those files can be placed either in the root filesystem itself
41 (/etc/live/boot.conf, /etc/live/boot.conf.d/), or on the live media
42 (live/boot.conf, live/boot.conf.d/).
43
44 .SH OPTIONEN
45 .\" FIXME
46 \fBlive\-boot\fP currently features the following parameters.
47 .IP \fBaccess\fP=\fIACCESS\fP 4
48 Set the accessibility level for physically or visually impared users. ACCESS
49 must be one of v1, v2, v3, m1, or m2. v1=lesser visual impairment,
50 v2=moderate visual impairment, v3=blindness, m1=minor motor difficulties,
51 m2=moderate motor difficulties.
52 .IP \fBconsole\fP=\fITTY,SPEED\fP 4
53 Set the default console to be used with the "live\-getty" option. Example:
54 "console=ttyS0,115200"
55 .IP \fBdebug\fP 4
56 Makes initramfs boot process more verbose.
57 .br
58 Use: debug=1
59 .br
60 Without setting debug to a value the messages may not be shown.
61 .IP \fBfetch\fP=\fIURL\fP 4
62 .IP \fBhttpfs\fP=\fIURL\fP 4
63 Another form of netboot by downloading a squashfs image from a given url.
64 The fetch method copies the image to ram and the httpfs method uses fuse and
65 httpfs2 to mount the image in place. Copying to ram requires more memory and
66 might take a long time for large images. However, it is more likely to work
67 correctly because it does not require networking afterwards and the system
68 operates faster once booted because it does not require to contact the
69 server anymore.
70 .br
71 Due to current limitations in busyboxs wget and DNS resolution, an URL can
72 not contain a hostname but an IP only.
73 .br
74 Not working: http://example.com/path/to/your_filesystem.squashfs
75 .br
76 Working: http://1.2.3.4/path/to/your_filesystem.squashfs
77 .br
78 Also note that therefore it's currently not possible to fetch an image from
79 a namebased virtualhost of an httpd if it is sharing the ip with the main
80 httpd instance.
81 .br
82 You may also use the live iso image in place of the squashfs image.
83 .IP \fBiscsi\fP=\fIserver\-ip[,server\-port];target\-name\fP 4
84 Boot from an iSCSI target that has an iso or disk live image as one of its
85 LUNs. The specified target is searched for a LUN which looks like a live
86 media. If you use the \fBiscsitarget\fP software iSCSI target solution which is
87 packaged in Debian your ietd.conf might look like this:
88 .br
89 # The target\-name you specify in the iscsi= parameter
90 .br
91 Target <target\-name>
92   Lun 0 Path=<path\-to\-your\-live\-image.iso>,Type=fileio,IOMode=ro
93   # If you want to boot multiple machines you might want to look at tuning some parameters like
94   # Wthreads or MaxConnections
95 .IP \fBignore_uuid\fP 4
96 Do not check that any UUID embedded in the initramfs matches the discovered
97 medium. live\-boot may be told to generate a UUID by setting
98 LIVE_GENERATE_UUID=1 when building the initramfs.
99 .IP \fBintegrity\-check\fP 4
100 If specified, an MD5 sum is calculated on the live media during boot and
101 compared to the value found in md5sum.txt found in the root directory of the
102 live media.
103 .IP "\fBip\fP=[\fICLIENT_IP\fP]:[\fISERVER_IP\fP]:[\fIGATEWAY_IP\fP]:[\fINETMASK\fP]:[\fIHOSTNAME\fP]:[\fIDEVICE\fP]:[\fIAUTOCONF\fP] [,[\fICLIENT_IP\fP]:[\fISERVER_IP\fP]:[\fIGATEWAY_IP\fP]:[\fINETMASK\fP]:[\fIHOSTNAME\fP]:[\fIDEVICE\fP]:[\fIAUTOCONF\fP]]" 4
104 Let you specify the name(s) and the options of the interface(s) that should
105 be configured at boot time. Do not specify this if you want to use dhcp
106 (default). It will be changed in a future release to mimick official kernel
107 boot param specification
108 (e.g. ip=10.0.0.1::10.0.0.254:255.255.255.0::eth0,:::::eth1:dhcp).
109 .IP \fBip\fP=[\fIfrommedia\fP] 4
110 If this variable is set, dhcp and static configuration are just skipped and
111 the system will use the (must be) media\-preconfigured
112 /etc/network/interfaces instead.
113 .IP {\fBlive\-media\fP|\fBbootfrom\fP}=\fIDEVICE\fP 4
114 If you specify one of this two equivalent forms, live\-boot will first try to
115 find this device for the "/live" directory where the read\-only root
116 filesystem should reside. If it did not find something usable, the normal
117 scan for block devices is performed.
118 .br
119 Instead of specifing an actual device name, the keyword 'removable' can be
120 used to limit the search of acceptable live media to removable type
121 only. Note that if you want to further restrict the media to usb mass
122 storage only, you can use the 'removable\-usb' keyword.
123 .IP {\fBlive\-media\-encryption\fP|\fBencryption\fP}=\fITYPE\fP 4
124 live\-boot will mount the encrypted rootfs TYPE, asking the passphrase,
125 useful to build paranoid live systems :\-). TYPE supported so far are "aes"
126 for loop\-aes encryption type.
127 .IP \fBlive\-media\-offset\fP=\fIBYTES\fP 4
128 This way you could tell live\-boot that your image starts at offset BYTES in
129 the above specified or autodiscovered device, this could be useful to hide
130 the Debian Live iso or image inside another iso or image, to create "clean"
131 images.
132 .IP \fBlive\-media\-path\fP=\fIPATH\fP 4
133 Sets the path to the live filesystem on the medium. By default, it is set to
134 \&'/live' and you should not change that unless you have customized your media
135 accordingly.
136 .IP \fBlive\-media\-timeout\fP=\fISECONDS\fP 4
137 Set the timeout in seconds for the device specified by "live\-media=" to
138 become ready before giving up.
139 .IP \fBmodule\fP=\fINAME\fP 4
140 Instead of using the default optional file "filesystem.module" (see below)
141 another file could be specified without the extension ".module"; it should
142 be placed on "/live" directory of the live medium.
143 .IP \fBnetboot\fP[=nfs|cifs] 4
144 This tells live\-boot to perform a network mount. The parameter "nfsroot="
145 (with optional "nfsopts="), should specify where is the location of the root
146 filesystem.  With no args, will try cifs first, and if it fails nfs.
147 .IP \fBnfsopts\fP= 4
148 This lets you specify custom nfs options.
149 .IP \fBnofastboot\fP 4
150 This parameter disables the default disabling of filesystem checks in
151 /etc/fstab. If you have static filesystems on your harddisk and you want
152 them to be checked at boot time, use this parameter, otherwise they are
153 skipped.
154 .IP \fBnopersistent\fP 4
155 disables the "persistent" feature, useful if the bootloader (like syslinux)
156 has been installed with persistent enabled.
157 .IP \fBnoprompt\fP 4
158 Do not prompt to eject the CD or remove the USB flash drive on reboot.
159 .IP \fBswapon\fP 4
160 This parameter enables usage of local swap partitions.
161 .IP \fBnoxautoconfig\fP 4
162 This parameter disables Xorg auto\-reconfiguration at boot time. This is
163 valuable if you either do the detection on your own, or, if you want to ship
164 a custom, premade xorg.conf in your live system.
165 .IP \fBpersistent\fP[=nofiles] 4
166 live\-boot will look for persistent and snapshot partitions or files labeled
167 "live\-rw", "home\-rw", and files called "live\-sn*", "home\-sn*" and will try
168 to, in order: mount as /cow the first, mount the second in /home, and just
169 copy the contents of the latter in appropriate locations
170 (snapshots). Snapshots will be tried to be updated on reboot/shutdown. Look
171 at live\-snapshot(1) for more informations. If "nofiles" is specified, only
172 filesystems with matching labels will be searched; no filesystems will be
173 traversed looking for archives or image files. This results in shorter boot
174 times.
175 .IP \fBpersistent\-path\fP=\fIPATH\fP 4
176 live\-boot will look for persistency files in the root directory of a
177 partition, with this parameter, the path can be configured so that you can
178 have multiple directories on the same partition to store persistency files.
179 .IP {\fBpreseed/file\fP|\fBfile\fP}=\fIFILE\fP 4
180 A path to a file present on the rootfs could be used to preseed debconf
181 database.
182 .IP \fBpackage/question\fP=\fIVALUE\fP 4
183 All debian installed packages could be preseeded from command\-line that way,
184 beware of blanks spaces, they will interfere with parsing, use a preseed
185 file in this case.
186 .IP \fBquickreboot\fP 4
187 This option causes live\-boot to reboot without attempting to eject the media
188 and without asking the user to remove the boot media.
189 .IP \fBshowmounts\fP 4
190 This parameter will make live\-boot to show on "/" the ro filesystems (mostly
191 compressed) on "/live". This is not enabled by default because could lead to
192 problems by applications like "mono" which store binary paths on
193 installation.
194 .IP \fBsilent\fP 4
195 If you boot with the normal quiet parameter, live\-boot hides most messages
196 of its own. When adding silent, it hides all.
197 .IP \fBtextonly\fP 4
198 Start up to text\-mode shell prompts, disabling the graphical user interface.
199 .IP \fBtodisk\fP=\fIDEVICE\fP 4
200 Adding this parameter, live\-boot will try to copy the entire read\-only media
201 to the specified device before mounting the root filesystem. It probably
202 needs a lot of free space. Subsequent boots should then skip this step and
203 just specify the "live\-media=DEVICE" boot parameter with the same DEVICE
204 used this time.
205 .IP \fBtoram\fP 4
206 Adding this parameter, live\-boot will try to copy the whole read\-only media
207 to the computer's RAM before mounting the root filesystem. This could need a
208 lot of ram, according to the space used by the read\-only media.
209 .IP \fBunion\fP=aufs|unionfs 4
210 By default, live\-boot uses aufs. With this parameter, you can switch to
211 unionfs.
212 .IP \fBxdebconf\fP 4
213 Uses xdebconfigurator, if present on the rootfs, to configure X instead of
214 the standard procedure (experimental).
215 .IP \fBxvideomode\fP=\fIRESOLUTION\fP 4
216 .\" FIXME
217 Doesn't do xorg autodetection, but enforces a given resolution.
218
219 .\" FIXME
220 .SH "FILES (old)"
221 .IP \fB/etc/live.conf\fP 4
222 Some variables can be configured via this config file (inside the live
223 system).
224 .IP \fBlive/filesystem.module\fP 4
225 This optional file (inside the live media) contains a list of white\-space or
226 carriage\-return\-separated file names corresponding to disk images in the
227 "/live" directory. If this file exists, only images listed here will be
228 merged into the root aufs, and they will be loaded in the order listed
229 here. The first entry in this file will be the "lowest" point in the aufs,
230 and the last file in this list will be on the "top" of the aufs, directly
231 below /cow.  Without this file, any images in the "/live" directory are
232 loaded in alphanumeric order.
233 .IP \fB/etc/live\-persistence.binds\fP 4
234 This optional file (which resides in the rootfs system, not in the live
235 media) is used as a list of directories which not need be persistent:
236 ie. their content does not need to survive reboots when using the
237 persistence features.
238 .br
239 .\" FIXME
240 This saves expensive writes and speeds up operations on volatile data such
241 as web caches and temporary files (like e.g. /tmp and .mozilla) which are
242 regenerated each time. This is achieved by bind mounting each listed
243 directory with a tmpfs on the original path.
244
245 .SH DATEIEN
246 .IP \fB/etc/live/boot.conf\fP 4
247 .IP \fB/etc/live/boot.conf.d/\fP 4
248 .IP \fBlive/boot.conf\fP 4
249 .IP \fBlive/boot.conf.d/\fP 4
250
251 .SH "SIEHE AUCH"
252 \fIlive\-snapshot\fP(1)
253 .PP
254 \fIlive\-config\fP(7)
255 .PP
256 \fIlive\-helper\fP(7)
257
258 .SH HOMEPAGE
259 Weitere Informationen ueber live\-boot und das Debian Live Projekt koennen
260 auf der Homepage unter <\fIhttp://live.debian.net/\fP> und im Handbuch
261 unter <\fIhttp://live.debian.net/manual/\fP> gefunden werden.
262
263 .SH FEHLER
264 Fehler koennen durch Einreichen eines Fehlerberichtes fuer das live\-boot
265 Paket im Debian Bug Tracking System unter
266 <\fIhttp://bugs.debian.org/\fP> oder durch Senden einer E\-Mail an die
267 Debian Live Mailing Liste unter <\fIdebian\-live@lists.debian.org\fP>
268 (englischsprachig) mitgeteilt werden.
269
270 .SH AUTOR
271 live\-boot wurde von Daniel Baumann <\fIdaniel@debian.org\fP> fuer das
272 Debian Projekt geschrieben.