diff options
| author | Daniel Baumann <mail@daniel-baumann.ch> | 2013-05-06 13:46:18 +0200 |
|---|---|---|
| committer | Daniel Baumann <mail@daniel-baumann.ch> | 2013-05-06 13:54:10 +0200 |
| commit | 2648cbc4fbb19cc4b20bca4b4f3d38d515f130a1 (patch) | |
| tree | a638a56c0c90de0afb70f1c1b2d19e570d39e20c /manpages/de | |
| parent | 18d2f858d485f89f667d012efc76386f82ffda59 (diff) | |
| download | live-boot-2648cbc4fbb19cc4b20bca4b4f3d38d515f130a1.tar.gz live-boot-2648cbc4fbb19cc4b20bca4b4f3d38d515f130a1.zip | |
Adding debian version 4.0~a1-1.
Diffstat (limited to 'manpages/de')
| -rw-r--r-- | manpages/de/live-boot.de.7 | 290 | ||||
| -rw-r--r-- | manpages/de/persistence.conf.de.5 | 207 |
2 files changed, 497 insertions, 0 deletions
diff --git a/manpages/de/live-boot.de.7 b/manpages/de/live-boot.de.7 new file mode 100644 index 0000000..ae21ae1 --- /dev/null +++ b/manpages/de/live-boot.de.7 @@ -0,0 +1,290 @@ +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH LIVE\-BOOT 7 30.11.2012 4.0~a1\-1 "Debian Live Project" + +.SH NAME +\fBlive\-boot\fP \- System Boot Scripts + +.SH DESCRIPTION +\fBlive\-boot\fP contains the scripts that configure a Debian 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. +.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. + +.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 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 "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/*), or on the live media +(live/boot.conf, live/boot/*). + +.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 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 +.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 +Working: http://1.2.3.4/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. +.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 which is +packaged in Debian 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 \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=[\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 +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 +boot param specification +(e.g. ip=10.0.0.1::10.0.0.254:255.255.255.0::eth0,:::::eth1:dhcp). +.IP \fBip\fP=[\fIfrommedia\fP] 4 +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 {\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 +filesystem should reside. If it did not find something usable, the normal +scan for block devices is performed. +.br +Instead of specifing an actual device name, the keyword 'removable' can be +used to limit the search of acceptable live media to removable type +only. Note that if you want to further restrict the media to usb mass +storage only, you can use the 'removable\-usb' keyword. +.IP {\fBlive\-media\-encryption\fP|\fBencryption\fP}=\fITYPE\fP 4 +live\-boot will mount the encrypted rootfs TYPE, asking the passphrase, +useful to build paranoid live systems :\-). TYPE supported so far are "aes" +for loop\-aes encryption type. +.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" +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 +\&'/live' and you should not change that unless you have customized your media +accordingly. +.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 \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 +be placed on "/live" directory of the live medium. +.IP \fBnetboot\fP[=nfs|cifs] 4 +This tells live\-boot to perform a network mount. The parameter "nfsroot=" +(with optional "nfsopts="), should specify where is the location of the root +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 \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 \fBnopersistence\fP 4 +disables the "persistence" feature, useful if the bootloader (like syslinux) +has been installed with persistence enabled. +.IP \fBnoprompt\fP 4 +Do not prompt to eject the CD or remove the USB flash drive on reboot. +.IP \fBnoprompt\fP=\fITYPE\fP 4 +This tells live\-boot not to prompt to eject the CD (when noprompt=cd) or +remove the USB flash drive (when noprompt=usb) on reboot. +.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 \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 \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\-subtext\fP=\fISUFFIX\fP 4 +Add a suffix when searching for the image filenames or partition labels to +use for the above mentioned persistence feature, the SUFFIX will be added +after a dash (e.g.: "live\-sn" would transform to "live\-sn\-SUFFIX"). This is +handy to test multiple live\-boot based live\-systems with different +persistence storage choices. +.IP \fBquickreboot\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 "/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 \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 +needs a lot of free space. Subsequent boots should then skip this step and +just specify the "live\-media=DEVICE" boot parameter with the same DEVICE +used this time. +.IP \fBtoram\fP 4 +Adding this parameter, live\-boot will try to copy the whole read\-only media +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. + +.\" FIXME +.SH "FILES (old)" +.IP \fB/etc/live.conf\fP 4 +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 /overlay. Without this file, any images in the "/live" directory are +loaded in alphanumeric order. + +.SH FILES +.IP \fB/etc/live/boot.conf\fP 4 +.IP \fB/etc/live/boot/*\fP 4 +.IP \fBlive/boot.conf\fP 4 +.IP \fBlive/boot/*\fP 4 +.IP \fBpersistence.conf\fP 4 + +.SH "SEE ALSO" +\fIpersistence.conf\fP(5) +.PP +\fIlive\-build\fP(7) +.PP +\fIlive\-config\fP(7) +.PP +\fIlive\-tools\fP(7) + +.SH HOMEPAGE +More information about live\-boot and the Debian Live project can be found on +the homepage at <\fIhttp://live.debian.net/\fP> and in the manual at +<\fIhttp://live.debian.net/manual/\fP>. + +.SH BUGS +Bugs can be reported by submitting a bugreport for the live\-boot package in +the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fP> or by +writing a mail to the Debian Live mailing list at +<\fIdebian\-live@lists.debian.org\fP>. + +.SH AUTHOR +live\-boot was written by Daniel Baumann <\fIdaniel@debian.org\fP> for +the Debian project. diff --git a/manpages/de/persistence.conf.de.5 b/manpages/de/persistence.conf.de.5 new file mode 100644 index 0000000..c8d2d5d --- /dev/null +++ b/manpages/de/persistence.conf.de.5 @@ -0,0 +1,207 @@ +.\"******************************************************************* +.\" +.\" This file was generated with po4a. Translate the source file. +.\" +.\"******************************************************************* +.TH LIVE\-BOOT conf 30.11.2012 4.0~a1\-1 "Debian Live Project" + +.SH NAME +\fBpersistence.conf\fP \- Configuration file for persistence media in live\-boot + +.SH DESCRIPTION +If live\-boot probes a persistence volume with the label (or GPT name, or +file name, but from now on we will just say "label") "persistence", that +volume's persistence is fully customizable through the \fBpersistence.conf\fP +file stored on the root of its file system. Any such labeled volume must +have such a file, or it will be ignored. +.PP +The format of \fBpersistence.conf\fP allows empty lines and lines starting with +a "#" (used for comments), both which will be ignored. A so called "custom +mount" has the format: +.PP +.RS +\fIDIR\fP [\fIOPTION\fP]... +.RE +.PP +which roughly translates to "make \fIDIR\fP persistence in the way described by +the list of \fIOPTION\fPs". +.PP +For each custom mount \fIDIR\fP must be an absolute path that cannot contain +white spaces or the special . and .. path components, and cannot be /live +(or any of its sub\-directories). Once activated all changes (file deletion, +creation and modification) to \fIDIR\fP on the live file system are stored +persistently into a path equivalent to \fIDIR\fP on the persistence media, +called the source directory. The default way to achieve persistence is to +simply bind\-mount the corresponding source directory to \fIDIR\fP, but this can +be changed through the use of \fIOPTION\fPs. +.PP +All custom mounts will be done in an order so that no two custom mounts can +"hide" each other. For instance, if we have the two \fIDIR\fP:s /a and /a/b it +would always be the case that /a is mounted first, then /a/b. This remains +true no matter how the lines in \fBpersistence.conf\fP are ordered, or if +several \fBpersistence.conf\fP files on different persistence media are used at +the same time. However, it is forbidden for custom mounts to have their +source directory inside the source directory of another custom mount, so the +source directories that are auto\-created by live\-boot does not support +"nested" mounts like /a and /a/b on the same media. In this case you must +use the \fBsource\fP option (see below) to make sure that they are stored in +different source directories. +.PP +When a source directory doesn't exist on the persistence media for a certain +custom mount, it will be created automatically, and permissions and +ownership will be optimistically set according to \fIDIR\fP. It will also be +bootstrapped by copying the contents of the \fIDIR\fP into its source directory +on the persistence media. The bootstrapping will not happen when the \fBlink\fP +or \fBunion\fP options are used (see below). + +.SH OPTIONS +Custom mounts defined in \fBpersistence.conf\fP accept the following options in +a coma\-separated list: +.IP \fBsource\fP=\fIPATH\fP 4 +When given, store the persistence changes into \fIPATH\fP on the persistence +media. \fIPATH\fP must be a relative path (with respect to the persistence +media root) that cannot contain white spaces or the special . or .. path +components, with the exception that it can be just . which means the +persistence media root. This option is mostly relevant if you want to nest +custom mounts, which otherwise would cause errors, or if you want to make +the whole media root available (similar to the now deprecated \fBhome\-rw\fP +type of persistence). +.PP +The following options are mutually exclusive (only the last given one will +be in effect): +.IP \fBbind\fP 4 +Bind\-mount the source directory to \fIDIR\fP. This is the default. +.IP \fBlink\fP 4 +Create the directory structure of the source directory on the persistence +media in \fIDIR\fP and create symbolic links from the corresponding place in +\fIDIR\fP to each file in the source directory. Existing files or directories +with the same name as any link will be overwritten. Note that deleting the +links in \fIDIR\fP will only remove the link, not the corresponding file in the +source; removed links will reappear after a reboot. To permanently add or +delete a file one must do so directly in the source directory. +.IP +Effectively \fBlink\fP will make only files already in the source directory +persistent, not any other files in \fIDIR\fP. These files must be manually +added to the source directory to make use of this option, and they will +appear in \fIDIR\fP in addition to files already there. This option is useful +when only certain files need to be persistent, not the whole directory +they're in, e.g. some configuration files in a user's home directory. +.IP \fBunion\fP 4 +Save the rw branch of a union on the persistence media, so only the changes +are stored persistently. This can potentially reduce disk usage compared to +bind\-mounts, and will not hide files added to the read\-only media. One +caveat is that the union will use \fIDIR\fP from the image's read\-only file +system, not the real file system root, so files created after boot (e.g. by +live\-config) will not appear in the union. This option will use the union +file system specified by live\-boot's \fBunion\fP boot parameter, but is not +supported with \fBunion=unionmount\fP. + +.SH DIRECTORIES +.IP \fB/live/persistence\fP 4 +All persistence volumes will be mounted here (in a directory corresponding +to the device name). The \fBpersistence.conf\fP file can easily be edited +through this mount, as well as any source directories (which is especially +practical for custom mounts using the \fBlink\fP option). + +.SH EXAMPLES + +Let's say we have a persistence volume \fIVOL\fP with the a \fBpersistence.conf\fP +file containing the following four lines (numbered for ease of reference): +.TP 7 +1. +/home/user1 link,source=config\-files/user1 +.TP +2. +/home/user2 link,source=config\-files/user2 +.TP +3. +/home +.TP +4. +/usr union +.PP +The corresponding source directories are: +.TP 7 +1. +\fIVOL\fP/config\-files/user1 (but it would be \fIVOL\fP/home/user1 without the +\fBsource\fP option) +.TP +2. +\fIVOL\fP/config\-files/user2 (but it would be \fIVOL\fP/home/user2 without the +\fBsource\fP option) +.TP +3. +\fIVOL\fP/home +.TP +4. +\fIVOL\fP/usr +.PP +It was necessary to set the \fBsource\fP options for 1 and 2, since they +otherwise would become nested with 3's source, which is invalid. +.PP +Line 3 will be taken care of before line 1 and 2 in order to prevent custom +mounts 1 and 2 from being hidden by 3. When line 3 is handled, \fIVOL\fP/home +is simply bind\-mounted on /home. To illustrate what happens for lines 1 and +2, let's say that the following files exist: +.TP 7 +a. +\fIVOL\fP/config\-files/user1/.emacs +.TP +b. +\fIVOL\fP/config\-files/user2/.bashrc +.TP +c. +\fIVOL\fP/config\-files/user2/.ssh/config +.PP +Then the following links and directories will be created: +.TP 7 +Link: +/home/user1/.emacs \-> \fIVOL\fP/config\-files/user1/.emacs (from a) +.TP +Link: +/home/user2/.bashrc \-> \fIVOL\fP/config\-files/user2/.bashrc (from b) +.TP +Dir: +/homea/user2/.ssh (from c) +.TP +Link: +/home/user2/.ssh/config \-> \fIVOL\fP/config\-files/user2/.ssh/config (from +c) +.PP +One could argue, though, that lines 1 and 2 in the example +\fBpersistence.conf\fP file above are unnecessary since line 3 already would +make all of /home persistent. The \fBlink\fP option is intended for situations +where you don't want a complete directory to be persistent, only certain +files in it or its sub\-directories. +.PP +Line 4 can be mounted at any time since its \fIDIR\fP (and source directory) is +completely disjoint from all the other custom mounts. When mounted, +\fIVOL\fP/usr will be the rw branch due to the \fBunion\fP option, and will only +contain the difference compared to the underlying read\-only file +system. Hence packages could be installed into /usr with great space\-wise +efficiency compared to bind\-mounts, since in the latter case all of /usr +would have to be copied into \fIVOL\fP/usr during the initial bootstrap. + +.SH "SEE ALSO" +\fIlive\-boot\fP(7) +.PP +\fIlive\-build\fP(7) +.PP +\fIlive\-config\fP(7) +.PP +\fIlive\-tools\fP(7) + +.SH HOMEPAGE +More information about live\-boot and the Debian Live project can be found on +the homepage at <\fIhttp://live.debian.net/\fP> and in the manual at +<\fIhttp://live.debian.net/manual/\fP>. + +.SH BUGS +Bugs can be reported by submitting a bugreport for the live\-boot package in +the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fP> or by +writing a mail to the Debian Live mailing list at +<\fIdebian\-live@lists.debian.org\fP>. + +.SH AUTHOR +persistence.conf was written by anonym <\fIanonym@lavabit.com\fP> for +the Debian project. |
