Skip to content

Commit

Permalink
Renaming live.persist to live-persistence.conf.
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-baumann committed Apr 8, 2012
1 parent eece680 commit 315900e
Show file tree
Hide file tree
Showing 12 changed files with 574 additions and 530 deletions.
21 changes: 13 additions & 8 deletions manpages/de/live-boot.de.7
Expand Up @@ -95,6 +95,10 @@ Target <target\-name>
Lun 0 Path=<path\-to\-your\-live\-image.iso>,Type=fileio,IOMode=ro
# If you want to boot multiple machines you might want to look at tuning some parameters like
# Wthreads or MaxConnections
.IP \fBfindiso\fP=\fI/PATH/TO/IMAGE\fP 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 \fBfromiso\fP=\fI/PATH/TO/IMAGE\fP 4
Allows to use a filesystem from within an iso image that's available on
live\-media.
Expand Down Expand Up @@ -177,12 +181,13 @@ 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\fP(5)); snapshots are labeled/named
either "live\-sn" or "home\-sn" and will be extracted into / or /home,
respectively (see \fIlive\-snapshot\fP(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".
completely customized (see \fIlive\-persistence.conf\fP(5)); snapshots are
labeled/named either "live\-sn" or "home\-sn" and will be extracted into / or
/home, respectively (see \fIlive\-snapshot\fP(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\fP=\fITYPE1\fP,\fITYPE2\fP ... \fITYPEn\fP" 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
Expand Down Expand Up @@ -276,12 +281,12 @@ directory with a tmpfs on the original path.
.IP \fB/etc/live/boot.d/*.conf\fP 4
.IP \fBlive/boot.conf\fP 4
.IP \fBlive/boot.d/*.conf\fP 4
.IP \fBlive.persist\fP 4
.IP \fBlive\-persistence.conf\fP 4

.SH "SEE ALSO"
\fIlive\-snapshot\fP(1)
.PP
\fIlive.persist\fP(5)
\fIlive\-persistence.conf\fP(5)
.PP
\fIlive\-build\fP(7)
.PP
Expand Down
Expand Up @@ -3,21 +3,22 @@
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.TH LIVE\-BOOT persist 2012\-04\-08 3.0~a26\-1 "Debian Live Project"
.TH LIVE\-BOOT conf 2012\-04\-08 3.0~a26\-1 "Debian Live Project"

.SH NAME
\fBlive.persist\fP \- Configuration file for persistence media in live\-boot
\fBlive\-persistence.conf\fP \- Configuration file for persistence media in
live\-boot

.SH DESCRIPTION
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\fP file
stored on the root of its file system. Any such labeled volume must have
such a file, or it will be ignored.
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]...
Expand All @@ -39,14 +40,14 @@ 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 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.
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
Expand All @@ -56,8 +57,8 @@ on the persistence media. The bootstrapping will not happen when the
\fBlinkfiles\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 persistence changes into \fIPATH\fP on the persistence
media. \fIPATH\fP must be a relative path (w.r.t. the persistence media root)
Expand Down Expand Up @@ -101,14 +102,15 @@ supported with \fBunion=unionmount\fP.
.SH DIRECTORIES
.IP \fB/live/persistence\fP 4
All persistence 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).
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).

.SH EXAMPLES

Let's say we have a persistence 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
Expand Down Expand Up @@ -170,11 +172,11 @@ Link:
/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 \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.
.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,
Expand Down
6 changes: 3 additions & 3 deletions manpages/en/live-boot.7
Expand Up @@ -107,7 +107,7 @@ This parameters allows to set a custom ramdisk size (it's the '\-o size' option
.IP "\fBswapon\fR" 4
This parameter enables usage of local swap partitions.
.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".
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-persistence.conf\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
Expand Down Expand Up @@ -153,12 +153,12 @@ This saves expensive writes and speeds up operations on volatile data such as we
.IP "\fB/etc/live/boot.d/*.conf\fR" 4
.IP "\fBlive/boot.conf\fR" 4
.IP "\fBlive/boot.d/*.conf\fR" 4
.IP "\fBlive.persist\fR" 4
.IP "\fBlive-persistence.conf\fR" 4

.SH SEE ALSO
\fIlive\-snapshot\fR(1)
.PP
\fIlive.persist\fR(5)
\fIlive-persistence.conf\fR(5)
.PP
\fIlive\-build\fR(7)
.PP
Expand Down
@@ -1,17 +1,17 @@
.TH LIVE\-BOOT persist 2012\-04\-08 3.0~a26-1 "Debian Live Project"
.TH LIVE\-BOOT conf 2012\-04\-08 3.0~a26-1 "Debian Live Project"

.SH NAME
\fBlive.persist\fR \- Configuration file for persistence media in
\fBlive-persistence.conf\fR \- Configuration file for persistence media in
live\-boot

.SH DESCRIPTION
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
\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.persist\fR allow empty lines and lines starting
The format of \fBlive-persistence.conf\fR 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
Expand All @@ -37,7 +37,7 @@ 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\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
\fBlive-persistence.conf\fR are ordered, or if several \fBlive-persistence.conf\fR 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
Expand All @@ -55,7 +55,7 @@ bootstrapping will not happen when the \fBlinkfiles\fR or \fBunion\fR
options are used (see below).

.SH OPTIONS
Custom mounts defined in \fBlive.persist\fR accept the following
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
Expand Down Expand Up @@ -102,15 +102,15 @@ live-boot's \fBunion\fR boot parameter, but is not supported with
.SH DIRECTORIES
.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
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).

.SH EXAMPLES

Let's say we have a persistence volume \fIVOL\fR with the a
\fBlive.persist\fR file containing the following four lines (numbered
\fBlive-persistence.conf\fR file containing the following four lines (numbered
for ease of reference):
.TP 7
1.
Expand Down Expand Up @@ -174,7 +174,7 @@ Link:
(from c)
.PP
One could argue, though, that lines 1 and 2 in the example
\fBlive.persist\fR file above are unnecessary since line 3 already
\fBlive-persistence.conf\fR file above are unnecessary since line 3 already
would make all of /home persistent. The \fBlinkfiles\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.
Expand Down

0 comments on commit 315900e

Please sign in to comment.