.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
-.TH LIVE\-BOOT conf 2012\-04\-08 3.0~a26\-1 "Debian Live Project"
+.TH LIVE\-BOOT conf 2012\-05\-24 3.0~a27\-1 "Debian Live Project"
.SH NAME
\fBlive\-persistence.conf\fP \- Configuration file for persistence media in
\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\-persistence.conf\fP allow empty lines and lines starting
+The format of \fBlive\-persistence.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
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
-\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\-persistence.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 (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 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).
+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 \fBlinkfiles\fP 4
+.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
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 persistence media, so only the changes
are stored persistently. This can potentially reduce disk usage compared to
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 \fBlinkfiles\fP option).
+practical for custom mounts using the \fBlink\fP option).
.SH EXAMPLES
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
.PP
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 \fBlinkfiles\fP option is intended for
+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
<\fIdebian\-live@lists.debian.org\fP>.
.SH AUTHOR
-live.persist was written by anonym <\fIanonym@lavabit.com\fP> for the
-Debian project.
+live\-persistence.conf was written by anonym <\fIanonym@lavabit.com\fP>
+for the Debian project.
projects / live-boot-grml.git / blobdiff