X-Git-Url: http://git.grml.org/?a=blobdiff_plain;f=manpages%2Fen%2Flive-persistence.conf.5;h=6dccd00f67ffd394011246ec42b4ec8b03487f38;hb=599bb4e4402769547c1a3134402013941cb5fa12;hp=b680f51329bb5fc2e91de7f6ca2c63cdeb3293d8;hpb=315900ea66904606c7a5d92cf46d590fa00b12a6;p=live-boot-grml.git diff --git a/manpages/en/live-persistence.conf.5 b/manpages/en/live-persistence.conf.5 index b680f51..6dccd00 100644 --- a/manpages/en/live-persistence.conf.5 +++ b/manpages/en/live-persistence.conf.5 @@ -1,4 +1,4 @@ -.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\fR \- Configuration file for persistence media in @@ -11,7 +11,7 @@ that volume's persistence is fully customizable through the \fBlive-persistence.conf\fR 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\fR allow empty lines and lines starting +The format of \fBlive-persistence.conf\fR 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 @@ -51,7 +51,7 @@ 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 persistence media. The -bootstrapping will not happen when the \fBlinkfiles\fR or \fBunion\fR +bootstrapping will not happen when the \fBlink\fR or \fBunion\fR options are used (see below). .SH OPTIONS @@ -59,7 +59,7 @@ Custom mounts defined in \fBlive-persistence.conf\fR accept the following options in a coma-separated list: .IP "\fBsource\fR=\fIPATH\fR" 4 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. \fIPATH\fR 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 @@ -71,7 +71,7 @@ The following options are mutually exclusive (only the last given one will be in effect): .IP "\fBbind\fR" 4 Bind-mount the source directory to \fIDIR\fR. This is the default. -.IP "\fBlinkfiles\fR" 4 +.IP "\fBlink\fR" 4 Create the directory structure of the source directory on the persistence media in \fIDIR\fR and create symbolic links from the corresponding place in \fIDIR\fR to each file in the source directory. @@ -81,7 +81,7 @@ 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 \fBlinkfiles\fR will make only files already in the source +Effectively \fBlink\fR will make only files already in the source directory persistent, not any other files in \fIDIR\fR. These files must be manually added to the source directory to make use of this option, and they will appear in \fIDIR\fR in addition to files already @@ -105,7 +105,7 @@ All persistence volumes will be mounted here (in a directory corresponding to the device name). The \fBlive-persistence.conf\fR file can easily be edited through this mount, as well as any source directories (which is especially practical for custom mounts using the -\fBlinkfiles\fR option). +\fBlink\fR option). .SH EXAMPLES @@ -114,10 +114,10 @@ Let's say we have a persistence volume \fIVOL\fR with the a 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 @@ -175,7 +175,7 @@ Link: .PP One could argue, though, that lines 1 and 2 in the example \fBlive-persistence.conf\fR file above are unnecessary since line 3 already -would make all of /home persistent. The \fBlinkfiles\fR option is +would make all of /home persistent. The \fBlink\fR 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 @@ -209,5 +209,5 @@ package in the Debian Bug Tracking System at Live mailing list at <\fIdebian-live@lists.debian.org\fR>. .SH AUTHOR -live\.persist was written by anonym <\fIanonym@lavabit.com\fR> for the +live\-persistence.conf was written by anonym <\fIanonym@lavabit.com\fR> for the Debian project.