diff options
author | Daniel Baumann <daniel@debian.org> | 2012-04-08 18:29:45 +0200 |
---|---|---|
committer | Daniel Baumann <daniel@debian.org> | 2012-04-08 18:29:52 +0200 |
commit | 4e54d60d7f69ae3441e519e5611bd7ea48a8be19 (patch) | |
tree | dbdde3382732505a1f4b383109c8a12196447917 /manpages/en | |
parent | b5678340476350707c088253fe5ceee2dccda096 (diff) | |
download | live-boot-4e54d60d7f69ae3441e519e5611bd7ea48a8be19.tar.gz live-boot-4e54d60d7f69ae3441e519e5611bd7ea48a8be19.zip |
Using 'persistence' (noun) rather than 'persistent' (adjective/adverb) everywhere.
Diffstat (limited to 'manpages/en')
-rw-r--r-- | manpages/en/live-boot.7 | 34 | ||||
-rw-r--r-- | manpages/en/live-snapshot.1 | 2 | ||||
-rw-r--r-- | manpages/en/live.persist.5 | 32 |
3 files changed, 34 insertions, 34 deletions
diff --git a/manpages/en/live-boot.7 b/manpages/en/live-boot.7 index 32f1108..8ac8394 100644 --- a/manpages/en/live-boot.7 +++ b/manpages/en/live-boot.7 @@ -96,8 +96,8 @@ This tells live\-boot to perform a network mount. The parameter "nfsroot=" (with This lets you specify custom nfs options. .IP "\fBnofastboot\fR" 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\fR" 4 -disables the "persistent" feature, useful if the bootloader (like syslinux) has been installed with persistent enabled. +.IP "\fBnopersistence\fR" 4 +disables the "persistence" feature, useful if the bootloader (like syslinux) has been installed with persistence enabled. .IP "\fBnoprompt\fR" 4 Do not prompt to eject the CD or remove the USB flash drive on reboot. .IP "\fBnoprompt\fR=\fITYPE\fR" 4 @@ -106,22 +106,22 @@ This tells live-boot not to prompt to eject the CD (when noprompt=cd) or remove 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\fR" 4 This parameter enables usage of local swap partitions. -.IP "\fBpersistent\fR" 4 -live\-boot will probe devices for persistent media. These can be partitions (with the correct GPT name), filesystems (with the correct label) or image/archive files (with the correct file name). Overlays are labeled/named either "full\-ov", which will be mounted on /, or "custom\-ov", which can be completely customized (see \fIlive.persist\fR(5)); snapshots are labeled/named either "live\-sn" or "home\-sn" and will be extracted into / or /home, respectively (see \fIlive\-snapshot\fR(1) for more information). The order these are handled are: full\-ov, custom\-ov, live-sn, home-sn. Overlay image files and snapshot archive files have extensions which determines their filesystem or archive type, e.g. "custom\-ov.ext4" and "\home\-sn.squashfs". -.IP "\fBpersistent\-encryption\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 4 -This option determines which types of encryption that we allow to be used when probing devices for persistent 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 "\fBpersistent\-media\fR={\fIremovable\fR|\fIremovable\-usb\fR}" 4 -If you specify the keyword 'removable', live\-boot will try to find persistent and snapshot 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 "\fBpersistent\-method\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 4 -This option determines which types of persistent media we allow. If "overlay" is in the list, we consider overlays (i.e. "live\-rw" and "home\-rw"); if "snapshot" is in the list, we consider snapshots (i.e. "live\-sn" and "home\-sn"). The default is "overlay,snapshot". -.IP "\fBpersistent\-path\fR=\fIPATH\fR" 4 +.IP "\fBpersistence\fR" 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/archive files (with the correct file name). Overlays are labeled/named either "full\-ov", which will be mounted on /, or "custom\-ov", which can be completely customized (see \fIlive.persist\fR(5)); snapshots are labeled/named either "live\-sn" or "home\-sn" and will be extracted into / or /home, respectively (see \fIlive\-snapshot\fR(1) for more information). The order these are handled are: full\-ov, custom\-ov, live-sn, home-sn. Overlay image files and snapshot archive files have extensions which determines their filesystem or archive type, e.g. "custom\-ov.ext4" and "\home\-sn.squashfs". +.IP "\fBpersistence\-encryption\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 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\fR={\fIremovable\fR|\fIremovable\-usb\fR}" 4 +If you specify the keyword 'removable', live\-boot will try to find persistence and snapshot 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\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 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"); if "snapshot" is in the list, we consider snapshots (i.e. "live\-sn" and "home\-sn"). The default is "overlay,snapshot". +.IP "\fBpersistence\-path\fR=\fIPATH\fR" 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 "\fBpersistent\-read\-only\fR" 4 -Filesystem changes are not saved back to persistent media. In particular, overlays and netboot NFS mounts are mounted read-only, and snapshots are not resynced on shutdown. -.IP "\fBpersistent\-storage\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 4 -This option determines which types of persistent storage to consider when probing for persistent 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 "\fBpersistent\-subtext\fR=\fISUFFIX\fR" 4 -Add a suffix when searching for the image filenames or partition labels to use for the above mentioned persistent 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 persistent storage choices. +.IP "\fBpersistence\-read\-only\fR" 4 +Filesystem changes are not saved back to persistence media. In particular, overlays and netboot NFS mounts are mounted read-only, and snapshots are not resynced on shutdown. +.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\-subtext\fR=\fISUFFIX\fR" 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\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 diff --git a/manpages/en/live-snapshot.1 b/manpages/en/live-snapshot.1 index cefa015..2587c56 100644 --- a/manpages/en/live-snapshot.1 +++ b/manpages/en/live-snapshot.1 @@ -15,7 +15,7 @@ \fBlive\-snapshot\fR [\-v|\-\-version] .SH DESCRIPTION -live\-snapshot is a script which can be used to build the right types of persistent image files supported by \fIlive\-boot\fR(7). It is also used on exit by the live\-boot init script to resync the boot\-found snapshots devices. +live\-snapshot is a script which can be used to build the right types of persistence image files supported by \fIlive\-boot\fR(7). It is also used on exit by the live\-boot init script to resync the boot\-found snapshots devices. .SH OPTIONS .IP "\-c, \-\-cow \fIDIRECTORY\fR" 4 diff --git a/manpages/en/live.persist.5 b/manpages/en/live.persist.5 index e7a87c5..94d6e6b 100644 --- a/manpages/en/live.persist.5 +++ b/manpages/en/live.persist.5 @@ -1,11 +1,11 @@ .TH LIVE\-BOOT persist 2012\-04\-08 3.0~a26-1 "Debian Live Project" .SH NAME -\fBlive.persist\fR \- Configuration file for persistent media in +\fBlive.persist\fR \- Configuration file for persistence media in live\-boot .SH DESCRIPTION -If live-boot probes a persistent volume with the label (or GPT name, +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") "custom\-ov", that volume's persistence is fully customizable through the \fBlive.persist\fR file stored on the root of its file system. Any such @@ -19,7 +19,7 @@ called "custom mount" has the format: \fIDIR\fR [\fIOPTION\fR]... .RE .PP -which roughly translates to "make \fIDIR\fR persistent in the way +which roughly translates to "make \fIDIR\fR persistence in the way described by the list of \fIOPTION\fRs". .PP For each custom mount \fIDIR\fR must be an absolute path that cannot @@ -28,7 +28,7 @@ cannot be /live (or any of its sub-directories), or / (for the latter, use "full-ov" persistence instead). Once activated all changes (file deletion, creation and modification) to \fIDIR\fR on the live file system are stored persistently into a path equivalent to \fIDIR\fR on -the persistent media, called the source directory. The default way to +the persistence media, called the source directory. The default way to achieve persistence is to simply bind-mount the corresponding source directory to \fIDIR\fR, but this can be changed through the use of \fIOPTION\fRs. @@ -38,7 +38,7 @@ mounts can "hide" each other. For instance, if we have the two \fIDIR\fR: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 \fBlive.persist\fR are ordered, or if several \fBlive.persist\fR files -on different persistent media are used at the same time. However, it +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 @@ -46,11 +46,11 @@ directories that are auto-created by live-boot does not support must use the \fBsource\fR option (see below) to make sure that they are stored in different source directories. .PP -When a source directory doesn't exist on the persistent media for a +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\fR. It will also be bootstrapped by copying the contents of the -\fIDIR\fR into its source directory on the persistent media. The +\fIDIR\fR into its source directory on the persistence media. The bootstrapping will not happen when the \fBlinkfiles\fR or \fBunion\fR options are used (see below). @@ -58,11 +58,11 @@ options are used (see below). Custom mounts defined in \fBlive.persist\fR accept the following options in a coma-separated list: .IP "\fBsource\fR=\fIPATH\fR" 4 -When given, store the persistent changes into \fIPATH\fR on the -persistent media. \fIPATH\fR must be a relative path (w.r.t. the -persistent media root) that cannot contain white spaces or the +When given, store the persistence changes into \fIPATH\fR on the +persistence media. \fIPATH\fR must be a relative path (w.r.t. 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 persistent media root. This option is mostly +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\fR type of persistence). @@ -73,7 +73,7 @@ will be in effect): Bind-mount the source directory to \fIDIR\fR. This is the default. .IP "\fBlinkfiles\fR" 4 Create the directory structure of the source directory on the -persistent media in \fIDIR\fR and create symbolic links from the +persistence media in \fIDIR\fR and create symbolic links from the corresponding place in \fIDIR\fR 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\fR will only @@ -89,7 +89,7 @@ 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\fR" 4 -Save the rw branch of a union on the persistent media, so only the +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\fR from @@ -100,8 +100,8 @@ live-boot's \fBunion\fR boot parameter, but is not supported with \fBunion=unionmount\fR. .SH DIRECTORIES -.IP "\fB/live/persistent\fR" 4 -All persistent volumes will be mounted here (in a directory +.IP "\fB/live/persistence\fR" 4 +All persistence volumes will be mounted here (in a directory corresponding to the device name). The \fBlive.persist\fR file can easily be edited through this mount, as well as any source directories (which is especially practical for custom mounts using the @@ -109,7 +109,7 @@ easily be edited through this mount, as well as any source directories .SH EXAMPLES -Let's say we have a persistent volume \fIVOL\fR with the a +Let's say we have a persistence volume \fIVOL\fR with the a \fBlive.persist\fR file containing the following four lines (numbered for ease of reference): .TP 7 |