.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
-.TH LIVE\-BOOT 7 27.05.2010 2.0~a2 "Debian Live Projekt"
+.TH LIVE\-BOOT 7 2013\-05\-27 4.0~a13\-1 "Live Systems Project"
.SH NAME
-\fBlive\-boot\fP \- System Boot Skripte
+\fBlive\-boot\fP \- System Boot Scripts
-.SH BESCHREIBUNG
-\fBlive\-config\fP enthaelt die Skripte welche ein Debian Live System waehrend
-des Startvorganes (early userspace) konfigurieren.
+.SH DESCRIPTION
+\fBlive\-boot\fP contains the scripts that configure a live system during the
+boot process (early userspace).
.PP
.\" FIXME
live\-boot is a hook for the initramfs\-tools, used to generate a initramfs
capable to boot live systems, such as those created by
-\fIlive\-helper\fP(7). This includes the Debian Live isos, netboot tarballs, and
-usb stick images.
+\fIlive\-helper\fP(7). This includes the Live systems ISOs, netboot tarballs,
+and usb stick images.
.PP
.\" FIXME
At boot time it will look for a (read\-only) media containing a "/live"
directory where a root filesystems (often a compressed filesystem image like
squashfs) is stored. If found, it will create a writable environment, using
-aufs, for Debian like systems to boot from.
+aufs, to boot the system from.
-.SH KONFIGURATION
-\fBlive\-boot\fP kann durch Boot Parameter oder durch Konfigurationsdateien
-konfiguriert werden.
+.SH CONFIGURATION
+\fBlive\-boot\fP can be configured through a boot parameter or a configuration
+file.
+.PP
+To configure the live\-boot parameters used by default in a live image, see
+the \-\-bootappend\-live option in the \fIlb_config\fP(1) manual page.
-.SS "Kernel Parameter"
-\fBlive\-boot\fP ist nur dann aktiv, wenn 'boot=live' als Kernel Parameter
-benutzt wird.
+.SS "Kernel Parameters"
+\fBlive\-boot\fP is only activated if 'boot=live' was used as a kernel
+parameter.
.PP
In addition, there are some more boot parameters to influence the behaviour,
see below.
-.SS Konfigurationsdateien
+.SS "Configuration Files"
\fBlive\-boot\fP can be configured (but not activated) through configuration
files. Those files can be placed either in the root filesystem itself
-(/etc/live/boot.conf, /etc/live/boot.conf.d/), or on the live media
-(live/boot.conf, live/boot.conf.d/).
+(/etc/live/boot.conf, /etc/live/boot/*), or on the live media
+(live/boot.conf, live/boot/*).
-.SH OPTIONEN
+.SH OPTIONS
.\" FIXME
\fBlive\-boot\fP currently features the following parameters.
.IP \fBaccess\fP=\fIACCESS\fP 4
-Set the accessibility level for physically or visually impared users. ACCESS
-must be one of v1, v2, v3, m1, or m2. v1=lesser visual impairment,
-v2=moderate visual impairment, v3=blindness, m1=minor motor difficulties,
-m2=moderate motor difficulties.
+Set the accessibility level for physically or visually impaired
+users. ACCESS must be one of v1, v2, v3, m1, or m2. v1=lesser visual
+impairment, v2=moderate visual impairment, v3=blindness, m1=minor motor
+difficulties, m2=moderate motor difficulties.
.IP \fBconsole\fP=\fITTY,SPEED\fP 4
Set the default console to be used with the "live\-getty" option. Example:
"console=ttyS0,115200"
.IP \fBdebug\fP 4
Makes initramfs boot process more verbose.
+.br
+Use: debug=1
+.br
+Without setting debug to a value the messages may not be shown.
.IP \fBfetch\fP=\fIURL\fP 4
-Another form of netboot by downloading a squashfs image from a given url,
-copying to ram and booting it. Due to current limitations in busyboxs wget
-and DNS resolution, an URL can not contain a hostname but an IP only.
+.IP \fBhttpfs\fP=\fIURL\fP 4
+Another form of netboot by downloading a squashfs image from a given url.
+The fetch method copies the image to ram and the httpfs method uses fuse and
+httpfs2 to mount the image in place. Copying to ram requires more memory and
+might take a long time for large images. However, it is more likely to work
+correctly because it does not require networking afterwards and the system
+operates faster once booted because it does not require to contact the
+server anymore.
+.br
+Due to current limitations in busybox's wget and DNS resolution, an URL can
+not contain a hostname but an IP only.
.br
Not working: http://example.com/path/to/your_filesystem.squashfs
.br
Also note that therefore it's currently not possible to fetch an image from
a namebased virtualhost of an httpd if it is sharing the ip with the main
httpd instance.
-.IP "\fBhostname\fP=\fIHOSTNAME\fP, \fBusername\fP=\fIUSER\fP, \fBuserfullname\fP=\fIUSERFULLNAME\fP" 4
-Those parameters lets you override values read from the config file.
+.br
+You may also use the live iso image in place of the squashfs image.
+.IP \fBiscsi\fP=\fIserver\-ip[,server\-port];target\-name\fP 4
+Boot from an iSCSI target that has an iso or disk live image as one of its
+LUNs. The specified target is searched for a LUN which looks like a live
+media. If you use the \fBiscsitarget\fP software iSCSI target solution your
+ietd.conf might look like this:
+.br
+# The target\-name you specify in the iscsi= parameter
+.br
+Target <target\-name>
+ Lun 0 Path=<path\-to\-your\-live\-image.iso>,Type=fileio,IOMode=ro
+ # If you want to boot multiple machines you might want to look at tuning some parameters like
+ # Wthreads or MaxConnections
+.IP \fBfindiso\fP=\fI/PATH/TO/IMAGE\fP 4
+Look for the specified ISO file on all disks where it usually looks for the
+\&.squashfs file (so you don't have to know the device name as in
+fromiso=....).
+.IP \fBfromiso\fP=\fI/PATH/TO/IMAGE\fP 4
+Allows to use a filesystem from within an iso image that's available on
+live\-media.
.IP \fBignore_uuid\fP 4
Do not check that any UUID embedded in the initramfs matches the discovered
medium. live\-boot may be told to generate a UUID by setting
LIVE_GENERATE_UUID=1 when building the initramfs.
-.IP \fBintegrity\-check\fP 4
+.IP \fBverify\-checksums\fP 4
If specified, an MD5 sum is calculated on the live media during boot and
compared to the value found in md5sum.txt found in the root directory of the
live media.
-.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
+.IP "\fBip\fP=[\fIDEVICE\fP]:[\fICLIENT_IP\fP]:[\fINETMASK\fP]:[\fIGATEWAY_IP\fP]:[\fINAMESERVER\fP] [,[\fIDEVICE\fP]:[\fICLIENT_IP\fP]:[\fINETMASK\fP]:[\fIGATEWAY_IP\fP]:[\fINAMESERVER\fP]]" 4
Let you specify the name(s) and the options of the interface(s) that should
be configured at boot time. Do not specify this if you want to use dhcp
(default). It will be changed in a future release to mimick official kernel
If this variable is set, dhcp and static configuration are just skipped and
the system will use the (must be) media\-preconfigured
/etc/network/interfaces instead.
-.IP "{\fBkeyb\fP|\fBkbd\-chooser/method\fP}=\fIKEYBOARD\fP, {\fBklayout\fP|\fBconsole\-setup/layoutcode\fP}=\fILAYOUT\fP, {\fBkvariant\fP|\fBconsole\-setup/variantcode\fP}=\fIVARIANT\fP, {\fBkmodel\fP\fI|\fP\fBconsole\-setup/modelcode\fP}=\fICODE\fP, \fBkoptions\fP=\fIOPTIONS\fP" 4
-Configure the running keyboard as specified, if this one misses live\-boot
-behaves as if "keyb=us" was specified. It will be interfered from "locale="
-if locale is only 2 lowecase letters as a special case. You could also
-specify console layout, variant, code, and options (no defaults).
-.IP \fBlive\-getty\fP 4
-This changes the auto\-login on virtual terminals to use the (experimental)
-live\-getty code. With this option set the standard kernel argument
-"console=" is parsed and if a serial console is specified then live\-getty is
-used to autologin on the serial console.
.IP {\fBlive\-media\fP|\fBbootfrom\fP}=\fIDEVICE\fP 4
If you specify one of this two equivalent forms, live\-boot will first try to
find this device for the "/live" directory where the read\-only root
.IP \fBlive\-media\-offset\fP=\fIBYTES\fP 4
This way you could tell live\-boot that your image starts at offset BYTES in
the above specified or autodiscovered device, this could be useful to hide
-the Debian Live iso or image inside another iso or image, to create "clean"
+the live system ISO or image inside another iso or image, to create "clean"
images.
.IP \fBlive\-media\-path\fP=\fIPATH\fP 4
Sets the path to the live filesystem on the medium. By default, it is set to
.IP \fBlive\-media\-timeout\fP=\fISECONDS\fP 4
Set the timeout in seconds for the device specified by "live\-media=" to
become ready before giving up.
-.IP {\fBlocale\fP|\fBdebian\-installer/locale\fP}=\fILOCALE\fP 4
-Configure the running locale as specified, if not present the live\-media
-rootfs configured locale will be used and if also this one misses live\-boot
-behave as "locale=en_US.UTF\-8" was specified. If only 2 lowercase letter are
-specified (like "it"), the "maybe wanted" locale is generated (like
-en:EN.UTF\-8), in this case if also "keyb=" is unspecified is set with those
-2 lowercase letters (keyb=us). Beside that facility, only UTF8 locales are
-supported by live\-boot.
.IP \fBmodule\fP=\fINAME\fP 4
Instead of using the default optional file "filesystem.module" (see below)
another file could be specified without the extension ".module"; it should
filesystem. With no args, will try cifs first, and if it fails nfs.
.IP \fBnfsopts\fP= 4
This lets you specify custom nfs options.
-.IP \fBnoautologin\fP 4
-This parameter disables the automatic terminal login only, not touching
-gdk/kdm.
-.IP \fBnoxautologin\fP 4
-This parameter disables the automatic login of gdm/kdm only, not touching
-terminals.
.IP \fBnofastboot\fP 4
This parameter disables the default disabling of filesystem checks in
/etc/fstab. If you have static filesystems on your harddisk and you want
them to be checked at boot time, use this parameter, otherwise they are
skipped.
-.IP \fBnopersistent\fP 4
-disables the "persistent" feature, useful if the bootloader (like syslinux)
-has been installed with persistent enabled.
-.IP \fBnoprompt\fP 4
-Do not prompt to eject the CD or remove the USB flash drive on reboot.
-.IP \fBnosudo\fP 4
-This parameter disables the automatic configuration of sudo.
+.IP \fBnopersistence\fP 4
+disables the "persistence" feature, useful if the bootloader (like syslinux)
+has been installed with persistence enabled.
+.IP \fBnoeject\fP 4
+Do not prompt to eject the live medium.
+.IP \fBramdisk\-size\fP 4
+This parameters allows to set a custom ramdisk size (it's the '\-o size'
+option of tmpfs mount). By default, there is no ramdisk size set, so the
+default of mount applies (currently 50% of available RAM). Note that this
+option has no currently no effect when booting with toram.
.IP \fBswapon\fP 4
This parameter enables usage of local swap partitions.
-.IP \fBnouser\fP 4
-This parameter disables the creation of the default user completely.
-.IP \fBnoxautoconfig\fP 4
-This parameter disables Xorg auto\-reconfiguration at boot time. This is
-valuable if you either do the detection on your own, or, if you want to ship
-a custom, premade xorg.conf in your live system.
-.IP \fBpersistent\fP[=nofiles] 4
-live\-boot will look for persistent and snapshot partitions or files labeled
-"live\-rw", "home\-rw", and files called "live\-sn*", "home\-sn*" and will try
-to, in order: mount as /cow the first, mount the second in /home, and just
-copy the contents of the latter in appropriate locations
-(snapshots). Snapshots will be tried to be updated on reboot/shutdown. Look
-at live\-snapshot(1) for more informations. If "nofiles" is specified, only
-filesystems with matching labels will be searched; no filesystems will be
-traversed looking for archives or image files. This results in shorter boot
-times.
-.IP \fBpersistent\-path\fP=\fIPATH\fP 4
+.IP \fBpersistence\fP 4
+live\-boot will probe devices for persistence media. These can be partitions
+(with the correct GPT name), filesystems (with the correct label) or image
+files (with the correct file name). Overlays are labeled/named "persistence"
+(see \fIpersistence.conf\fP(5)). Overlay image files have extensions which
+determines their filesystem, e.g. "persistence.ext4".
+.IP "\fBpersistence\-encryption\fP=\fITYPE1\fP,\fITYPE2\fP ... \fITYPEn\fP" 4
+This option determines which types of encryption that we allow to be used
+when probing devices for persistence media. If "none" is in the list, we
+allow unencrypted media; if "luks" is in the list, we allow LUKS\-encrypted
+media. Whenever a device containing encrypted media is probed the user will
+be prompted for the passphrase. The default value is "none".
+.IP \fBpersistence\-media\fP={\fIremovable\fP|\fIremovable\-usb\fP} 4
+If you specify the keyword 'removable', live\-boot will try to find
+persistence partitions on removable media only. Note that if you want to
+further restrict the media to usb mass storage only, you can use the
+\&'removable\-usb' keyword.
+.IP "\fBpersistence\-method\fP=\fITYPE1\fP,\fITYPE2\fP ... \fITYPEn\fP" 4
+This option determines which types of persistence media we allow. If
+"overlay" is in the list, we consider overlays (i.e. "live\-rw" and
+"home\-rw"). The default is "overlay".
+.IP \fBpersistence\-path\fP=\fIPATH\fP 4
live\-boot will look for persistency files in the root directory of a
partition, with this parameter, the path can be configured so that you can
have multiple directories on the same partition to store persistency files.
-.IP {\fBpreseed/file\fP|\fBfile\fP}=\fIFILE\fP 4
-A path to a file present on the rootfs could be used to preseed debconf
-database.
-.IP \fBpackage/question\fP=\fIVALUE\fP 4
-All debian installed packages could be preseeded from command\-line that way,
-beware of blanks spaces, they will interfere with parsing, use a preseed
-file in this case.
-.IP \fBquickreboot\fP 4
+.IP \fBpersistence\-read\-only\fP 4
+Filesystem changes are not saved back to persistence media. In particular,
+overlays and netboot NFS mounts are mounted read\-only.
+.IP "\fBpersistence\-storage\fP=\fITYPE1\fP,\fITYPE2\fP ... \fITYPEn\fP" 4
+This option determines which types of persistence storage to consider when
+probing for persistence media. If "filesystem" is in the list, filesystems
+with matching labels will be used; if "file" is in the list, all filesystems
+will be probed for archives and image files with matching filenames. The
+default is "file,filesystem".
+.IP \fBpersistence\-label\fP=\fILABEL\fP 4
+live\-boot will use the name "LABEL" instead of "persistence" when searching
+for persistent storage. LABEL can be any valid filename, partition label, or
+GPT name.
+.IP \fBnoeject\fP 4
This option causes live\-boot to reboot without attempting to eject the media
and without asking the user to remove the boot media.
.IP \fBshowmounts\fP 4
This parameter will make live\-boot to show on "/" the ro filesystems (mostly
-compressed) on "/live". This is not enabled by default because could lead to
-problems by applications like "mono" which store binary paths on
+compressed) on "/lib/live". This is not enabled by default because could
+lead to problems by applications like "mono" which store binary paths on
installation.
.IP \fBsilent\fP 4
If you boot with the normal quiet parameter, live\-boot hides most messages
of its own. When adding silent, it hides all.
-.IP \fBtextonly\fP 4
-Start up to text\-mode shell prompts, disabling the graphical user interface.
-.IP \fBtimezone\fP=\fITIMEZONE\fP 4
-By default, timezone is set to UTC. Using the timezone parameter, you can
-set it to your local zone, e.g. Europe/Zurich.
.IP \fBtodisk\fP=\fIDEVICE\fP 4
Adding this parameter, live\-boot will try to copy the entire read\-only media
to the specified device before mounting the root filesystem. It probably
to the computer's RAM before mounting the root filesystem. This could need a
lot of ram, according to the space used by the read\-only media.
.IP \fBunion\fP=aufs|unionfs 4
+.\" FIXME
By default, live\-boot uses aufs. With this parameter, you can switch to
unionfs.
-.IP \fButc\fP=yes|no 4
-By default, Debian systems do assume that the hardware clock is set to
-UTC. You can change or explicitly set it with this parameter.
-.IP \fBxdebconf\fP 4
-Uses xdebconfigurator, if present on the rootfs, to configure X instead of
-the standard procedure (experimental).
-.IP \fBxvideomode\fP=\fIRESOLUTION\fP 4
-.\" FIXME
-Doesn't do xorg autodetection, but enforces a given resolution.
.\" FIXME
.SH "FILES (old)"
Some variables can be configured via this config file (inside the live
system).
.IP \fBlive/filesystem.module\fP 4
+.\" FIXME
This optional file (inside the live media) contains a list of white\-space or
carriage\-return\-separated file names corresponding to disk images in the
"/live" directory. If this file exists, only images listed here will be
merged into the root aufs, and they will be loaded in the order listed
here. The first entry in this file will be the "lowest" point in the aufs,
and the last file in this list will be on the "top" of the aufs, directly
-below /cow. Without this file, any images in the "/live" directory are
+below /overlay. Without this file, any images in the "/live" directory are
loaded in alphanumeric order.
-.IP \fB/etc/live\-persistence.binds\fP 4
-This optional file (which resides in the rootfs system, not in the live
-media) is used as a list of directories which not need be persistent:
-ie. their content does not need to survive reboots when using the
-persistence features.
-.br
-.\" FIXME
-This saves expensive writes and speeds up operations on volatile data such
-as web caches and temporary files (like e.g. /tmp and .mozilla) which are
-regenerated each time. This is achieved by bind mounting each listed
-directory with a tmpfs on the original path.
-.SH DATEIEN
+.SH FILES
.IP \fB/etc/live/boot.conf\fP 4
-.IP \fB/etc/live/boot.conf.d/\fP 4
+.IP \fB/etc/live/boot/*\fP 4
.IP \fBlive/boot.conf\fP 4
-.IP \fBlive/boot.conf.d/\fP 4
+.IP \fBlive/boot/*\fP 4
+.IP \fBpersistence.conf\fP 4
-.SH "SIEHE AUCH"
-\fIlive\-snapshot\fP(1)
+.SH "SEE ALSO"
+\fIpersistence.conf\fP(5)
+.PP
+\fIlive\-build\fP(7)
.PP
\fIlive\-config\fP(7)
.PP
-\fIlive\-helper\fP(7)
+\fIlive\-tools\fP(7)
.SH HOMEPAGE
-Weitere Informationen ueber live\-boot und das Debian Live Projekt koennen
-auf der Homepage unter <\fIhttp://live.debian.net/\fP> und im Handbuch
-unter <\fIhttp://live.debian.net/manual/\fP> gefunden werden.
+More information about live\-boot and the Live Systems project can be found
+on the homepage at <\fIhttp://live\-systems.org/\fP> and in the manual
+at <\fIhttp://live\-systems.org/manual/\fP>.
-.SH FEHLER
-Fehler koennen durch Einreichen eines Fehlerberichtes fuer das live\-boot
-Paket im Debian Bug Tracking System unter
-<\fIhttp://bugs.debian.org/\fP> oder durch Senden einer E\-Mail an die
-Debian Live Mailing Liste unter <\fIdebian\-live@lists.debian.org\fP>
-(englischsprachig) mitgeteilt werden.
+.SH BUGS
+Bugs can be reported by submitting a bugreport for the live\-boot package in
+the Bug Tracking System at <\fIhttp://bugs.debian.org/\fP> or by
+writing a mail to the Live Systems mailing list at
+<\fIdebian\-live@lists.debian.org\fP>.
-.SH AUTOR
-live\-boot wurde von Daniel Baumann <\fIdaniel@debian.org\fP> fuer das
-Debian Projekt geschrieben.
+.SH AUTHOR
+live\-boot was written by Daniel Baumann <\fImail@daniel\-baumann.ch\fP>.
projects / live-boot-grml.git / blobdiff