.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
-.TH LIVE\-BOOT persist 2012\-04\-05 3.0~a26\-1 "Debian Live Project"
+.TH LIVE\-BOOT conf 2012\-04\-09 3.0~a27\-1 "Debian Live Project"
.SH NAME
-\fBlive.persist\fP \- Configuration file for persistent media in live\-boot
+\fBlive\-persistence.conf\fP \- Configuration file for persistence media in
+live\-boot
.SH DESCRIPTION
-If live\-boot probes a persistent 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\fP file stored on
-the root of its file system. Any such labeled volume must have such a file,
-or it will be ignored.
+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\-persistence.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 \fBlive.persist\fP allow empty lines and lines starting with a
-"#" (used for comments), both which will be ignored. A so called "custom
-mount" has the format:
+The format of \fBlive\-persistence.conf\fP allow 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 persistent in the way described by
+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
(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\fP on the live file system are stored persistently
-into a path equivalent to \fIDIR\fP on the persistent media, called the source
+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.
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 \fBlive.persist\fP are ordered, or if several
-\fBlive.persist\fP files on different persistent 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 persistent media for a certain
+true no matter how the lines in \fBlive\-persistence.conf\fP are ordered, or if
+several \fBlive\-persistence.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 persistent media. The bootstrapping will not happen when the
-\fBlinkfiles\fP or \fBunion\fP options are used (see below).
+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 \fBlive.persist\fP accept the following options in a
-coma\-separated list:
+Custom mounts defined in \fBlive\-persistence.conf\fP accept the following
+options in a coma\-separated list:
.IP \fBsource\fP=\fIPATH\fP 4
-When given, store the persistent changes into \fIPATH\fP on the persistent
-media. \fIPATH\fP must be a relative path (w.r.t. the persistent media root)
+When given, store the persistence changes into \fIPATH\fP on the persistence
+media. \fIPATH\fP 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
+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
be in effect):
.IP \fBbind\fP 4
Bind\-mount the source directory to \fIDIR\fP. This is the default.
-.IP \fBlinkfiles\fP 4
-Create the directory structure of the source directory on the persistent
+.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
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 \fBlinkfiles\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.
+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 persistent media, so only the changes
+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
supported with \fBunion=unionmount\fP.
.SH DIRECTORIES
-.IP \fB/live/persistent\fP 4
-All persistent volumes will be mounted here (in a directory corresponding to
-the device name). The \fBlive.persist\fP file can easily be edited through this
-mount, as well as any source directories (which is especially practical for
-custom mounts using the \fBlinkfiles\fP option).
+.IP \fB/live/persistence\fP 4
+All persistence volumes will be mounted here (in a directory corresponding
+to the device name). The \fBlive\-persistence.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 persistent volume \fIVOL\fP with the a \fBlive.persist\fP file
-containing the following four lines (numbered for ease of reference):
+Let's say we have a persistence volume \fIVOL\fP with the a
+\fBlive\-persistence.conf\fP file containing the following four lines (numbered
+for ease of reference):
.TP 7
1.
-/home/user1 linkfiles,source=config\-files/user1
+/home/user1 link,source=config\-files/user1
.TP
2.
-/home/user2 linkfiles,source=config\-files/user2
+/home/user2 link,source=config\-files/user2
.TP
3.
/home
\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 illegal.
+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
/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 \fBlive.persist\fP
-file above are unnecessary since line 3 already would make all of /home
-persistent. The \fBlinkfiles\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.
+One could argue, though, that lines 1 and 2 in the example
+\fBlive\-persistence.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,
projects / live-boot-grml.git / blobdiff