X-Git-Url: http://git.grml.org/?a=blobdiff_plain;f=manpages%2Fen%2Flive-boot.7;h=788e351b08aed4dc7b85686cf6ae419bda2a7344;hb=51f4b9d56200b;hp=72184cc552a96723d6829b5d7c5ac152b0cf6bbf;hpb=94c54362dbd29805ae85e9cf0ae4c00a167c2bf3;p=live-boot-grml.git diff --git a/manpages/en/live-boot.7 b/manpages/en/live-boot.7 index 72184cc..788e351 100644 --- a/manpages/en/live-boot.7 +++ b/manpages/en/live-boot.7 @@ -1,4 +1,4 @@ -.TH LIVE\-BOOT 7 2015\-09\-22 5.0~a5-1 "Live Systems Project" +.TH LIVE\-BOOT 7 2015\-09\-22 5.0~a5-1 "Debian Live Project" .SH NAME \fBlive\-boot\fR \- System Boot Components @@ -24,6 +24,39 @@ In addition, there are some more boot parameters to influence the behaviour, see .SS Configuration Files \fBlive\-boot\fR 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/*). +These environment variables can only be set in the configuration files: + +.TP +\fBDISABLE_CDROM\fR=[\fItrue\fR|\fIfalse\fR] +Disable support for booting from CD-ROMs. If set to '\fItrue\fR' mkinitramfs will build an initramfs without the kernel modules for reading CD-ROMs. + +.TP +\fBDISABLE_FAT\fR=[\fItrue\fR|\fIfalse\fR] +Disable support for booting from FAT file systems. If set to '\fItrue\fR' mkinitramfs will build an initramfs without the kernel module vfat and some nls_* modules. + +.TP +\fBDISABLE_FUSE\fR=[\fItrue\fR|\fIfalse\fR] +Disable support for booting from FUSE-based file systems. If set to '\fItrue\fR' mkinitramfs will build an initramfs without the kernel module fuse and file systems that depend on it (like curlftpfs and httpfs2). + +.TP +\fBDISABLE_NTFS\fR=[\fItrue\fR|\fIfalse\fR] +Disable support for booting from NTFS file systems. If set to '\fItrue\fR' mkinitramfs will build an initramfs without the kernel module ntfs. + +.TP +\fBDISABLE_USB\fR=[\fItrue\fR|\fIfalse\fR] +Disable support for booting from USB devices. If set to '\fItrue\fR' mkinitramfs will build an initramfs without the kernel module sd_mod. + +.TP +\fBMINIMAL\fR=[\fItrue\fR|\fIfalse\fR] +Build a minimal initramfs. If set to '\fItrue\fR' mkinitramfs will build an initramfs without some udev scripts and without rsync. + +.TP +\fBPERSISTENCE_FSCK\fR=[\fItrue\fR|\fIfalse\fR] +Run fsck on persistence filesystem on boot. Will attempt to repair errors. The execution log will be saved in /var/log/live/fsck.log. + +.TP +\fBFSCKFIX\fR=[\fItrue\fR|\fIfalse\fR] +If PERSISTENCE_FSCK or forcefsck are set, will pass -y to fsck to stop it from asking questions interactively and assume yes to all queries. .SH OPTIONS \fBlive\-boot\fR currently features the following parameters. @@ -68,8 +101,12 @@ Target # Wthreads or MaxConnections .IP "\fBfindiso\fR=\fI/PATH/TO/IMAGE\fI" 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 "\fBforcefsck\fR" 4 +Run fsck on persistence filesystem on boot. Will attempt to repair errors. The execution log will be saved in /var/log/live/fsck.log. .IP "\fBfromiso\fR=\fI/PATH/TO/IMAGE\fI" 4 -Use a filesystem from within an ISO image that's available on live-media. +Use a filesystem from within an ISO image that's available on live-media. The first part of the argument should be the block device where the image is stored, followed by the path and filename (e.g. fromiso=/dev/sda1/live/image.iso). +.br +Alternatively, it can be used to boot from an ISO embedded into an initrd (e.g. fromiso=/live/image.iso). .IP "\fBignore_uuid\fR" 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\fR" 4 @@ -104,6 +141,8 @@ disables the "persistence" feature, useful if the bootloader (like syslinux) has Do not prompt to eject the live medium. .IP "\fBramdisk\-size\fR" 4 This parameter defines 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 currently no effect when booting with toram. +.IP "\fBoverlay\-size\fR=\fISIZE\fR" 4 +The size of the tmpfs mount (used for the upperdir union root mount) in bytes, and rounded up to entire pages. This option accepts a suffix % to limit the instance to that percentage of your physical RAM or a suffix k, m or g for Ki, Mi, Gi (binary kilo (kibi), binary mega (mebi) and binary giga (gibi)). By default, 50% of available RAM will be used. .IP "\fBswap=true\fR" 4 This parameter enables usage of local swap partitions. .IP "\fBpersistence\fR" 4 @@ -120,8 +159,8 @@ live\-boot will look for persistency files in the root directory of a partition, Filesystem changes are not saved back to persistence media. In particular, overlays and netboot NFS mounts are mounted read-only. .IP "\fBpersistence\-storage\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 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\fR=\fILABEL\fR" 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 "\fBpersistence\-label\fR=\fILABEL1\fR,\fILABEL2\fR ... \fILABELn\fR" 4 +live-boot will use the names in this list (instead of "persistence") when searching for persistent storage. Each LABEL can be a valid filename, partition label, or GPT name. The default is "persistence". .IP "\fBnoeject\fR" 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\fR" 4 @@ -161,10 +200,10 @@ This optional file (inside the live media) contains a list of white\-space or ca \fIlive\-tools\fR(7) .SH HOMEPAGE -More information about live\-boot and the Live Systems project can be found on the homepage at <\fIhttp://live-systems.org/\fR> and in the manual at <\fIhttp://live-systems.org/manual/\fR>. +More information about live\-boot and the Debian Live project can be found on the homepage at <\fIhttps://wiki.debian.org/DebianLive\fR> and in the manual at <\fIhttps://live-team.pages.debian.net/live-manual/\fR>. .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/\fR> or by writing a mail to the Live Systems mailing list at <\fIdebian-live@lists.debian.org\fR>. +Bugs can be reported by submitting a bugreport for the live\-boot package in the Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or by writing a mail to the Debian Live mailing list at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\-boot was written by Daniel Baumann <\fImail@daniel-baumann.ch\fR>. +live\-boot was originally written by Daniel Baumann <\fImail@daniel-baumann.ch\fR>. Since 2016 development has been continued by the Debian Live team.