Skip to content

Commit

Permalink
Switching to final name for the persistence configuration file 'persi…
Browse files Browse the repository at this point in the history
…stence.conf' in line with boot parameter.
  • Loading branch information
daniel-baumann committed Sep 27, 2012
1 parent b1ea78d commit 89adeb3
Show file tree
Hide file tree
Showing 15 changed files with 477 additions and 485 deletions.
8 changes: 4 additions & 4 deletions manpages/de/live-boot.de.7
Expand Up @@ -3,7 +3,7 @@
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.TH LIVE\-BOOT 7 26.09.2012 3.0~b3\-1 "Debian Live Project"
.TH LIVE\-BOOT 7 27.09.2012 3.0~b3\-1 "Debian Live Project"

.SH NAME
\fBlive\-boot\fP \- System Boot Scripts
Expand Down Expand Up @@ -180,7 +180,7 @@ This parameter enables usage of local swap partitions.
live\-boot will probe devices for persistence media. These can be partitions
(with the correct GPT name), filesystems (with the correct label) or image
files (with the correct file name). Overlays are labeled/named "persistence"
(see \fIlive\-persistence.conf\fP(5)). Overlay image files have extensions which
(see \fIpersistence.conf\fP(5)). Overlay image files have extensions which
determines their filesystem, e.g. "persistence.ext4".
.IP "\fBpersistence\-encryption\fP=\fITYPE1\fP,\fITYPE2\fP ... \fITYPEn\fP" 4
This option determines which types of encryption that we allow to be used
Expand Down Expand Up @@ -263,10 +263,10 @@ loaded in alphanumeric order.
.IP \fB/etc/live/boot/*\fP 4
.IP \fBlive/boot.conf\fP 4
.IP \fBlive/boot/*\fP 4
.IP \fBlive\-persistence.conf\fP 4
.IP \fBpersistence.conf\fP 4

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

.SH NAME
\fBlive\-persistence.conf\fP \- Configuration file for persistence media in
live\-boot
\fBpersistence.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") "persistence", 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.
volume's persistence is fully customizable through the \fBpersistence.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 allows 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 \fBpersistence.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
.RS
\fIDIR\fP [\fIOPTION\fP]...
Expand All @@ -39,14 +38,14 @@ 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\-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.
true no matter how the lines in \fBpersistence.conf\fP are ordered, or if
several \fBpersistence.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 +55,8 @@ 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:
Custom mounts defined in \fBpersistence.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 (with respect to the persistence
Expand Down Expand Up @@ -100,15 +99,14 @@ 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\-persistence.conf\fP file can easily be edited
to the device name). The \fBpersistence.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 persistence volume \fIVOL\fP with the a
\fBlive\-persistence.conf\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 \fBpersistence.conf\fP
file containing the following four lines (numbered for ease of reference):
.TP 7
1.
/home/user1 link,source=config\-files/user1
Expand Down Expand Up @@ -171,10 +169,10 @@ Link:
c)
.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 \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.
\fBpersistence.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,
Expand Down Expand Up @@ -205,5 +203,5 @@ writing a mail to the Debian Live mailing list at
<\fIdebian\-live@lists.debian.org\fP>.

.SH AUTHOR
live\-persistence.conf was written by anonym <\fIanonym@lavabit.com\fP>
for the Debian project.
persistence.conf was written by anonym <\fIanonym@lavabit.com\fP> for
the Debian project.
8 changes: 4 additions & 4 deletions manpages/en/live-boot.7
@@ -1,4 +1,4 @@
.TH LIVE\-BOOT 7 2012\-09\-26 3.0~b3-1 "Debian Live Project"
.TH LIVE\-BOOT 7 2012\-09\-27 3.0~b3-1 "Debian Live Project"

.SH NAME
\fBlive\-boot\fR \- System Boot Scripts
Expand Down Expand Up @@ -109,7 +109,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 files (with the correct file name). Overlays are labeled/named "persistence" (see \fIlive-persistence.conf\fR(5)). Overlay image files have extensions which determines their filesystem, e.g. "persistence.ext4".
live\-boot will probe devices for persistence media. These can be partitions (with the correct GPT name), filesystems (with the correct label) or image files (with the correct file name). Overlays are labeled/named "persistence" (see \fIpersistence.conf\fR(5)). Overlay image files have extensions which determines their filesystem, e.g. "persistence.ext4".
.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 @@ -151,10 +151,10 @@ This optional file (inside the live media) contains a list of white\-space or ca
.IP "\fB/etc/live/boot/*\fR" 4
.IP "\fBlive/boot.conf\fR" 4
.IP "\fBlive/boot/*\fR" 4
.IP "\fBlive-persistence.conf\fR" 4
.IP "\fBpersistence.conf\fR" 4

.SH SEE ALSO
\fIlive-persistence.conf\fR(5)
\fIpersistence.conf\fR(5)
.PP
\fIlive\-build\fR(7)
.PP
Expand Down
@@ -1,17 +1,17 @@
.TH LIVE\-BOOT conf 2012\-09\-26 3.0~b3-1 "Debian Live Project"
.TH LIVE\-BOOT conf 2012\-09\-27 3.0~b3-1 "Debian Live Project"

.SH NAME
\fBlive-persistence.conf\fR \- Configuration file for persistence media in
\fBpersistence.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") "persistence",
that volume's persistence is fully customizable through the
\fBlive-persistence.conf\fR file stored on the root of its file system. Any such
\fBpersistence.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 allows empty lines and lines starting
The format of \fBpersistence.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
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-persistence.conf\fR are ordered, or if several \fBlive-persistence.conf\fR files
\fBpersistence.conf\fR are ordered, or if several \fBpersistence.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 \fBlink\fR or \fBunion\fR
options are used (see below).

.SH OPTIONS
Custom mounts defined in \fBlive-persistence.conf\fR accept the following
Custom mounts defined in \fBpersistence.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-persistence.conf\fR file can
corresponding to the device name). The \fBpersistence.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
\fBlink\fR option).

.SH EXAMPLES

Let's say we have a persistence volume \fIVOL\fR with the a
\fBlive-persistence.conf\fR file containing the following four lines (numbered
\fBpersistence.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-persistence.conf\fR file above are unnecessary since line 3 already
\fBpersistence.conf\fR file above are unnecessary since line 3 already
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.
Expand Down Expand Up @@ -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\-persistence.conf was written by anonym <\fIanonym@lavabit.com\fR> for the
persistence.conf was written by anonym <\fIanonym@lavabit.com\fR> for the
Debian project.
10 changes: 5 additions & 5 deletions manpages/es/live-boot.es.7
Expand Up @@ -3,7 +3,7 @@
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.TH LIVE\-BOOT 7 26.09.2012 3.0~b3\-1 "Proyecto Debian Live"
.TH LIVE\-BOOT 7 27.09.2012 3.0~b3\-1 "Proyecto Debian Live"

.SH NOMBRE
\fBlive\-boot\fP \- Scripts de Arranque del Sistema
Expand Down Expand Up @@ -191,8 +191,8 @@ live\-boot buscará dispositivos con "persistence". Estos pueden ser
particiones (con el nombre GPT correcto), sistemas de ficheros (con la
etiqueta correcta) o ficheros imagen (con el nombre de fichero
correcto). Los overlays tienen la etiqueta/nombre "persistence" (ver
\fIlive\-persistence.conf\fP(5)). Los ficheros imagen overlay tienen extensiones
que determinan su sistema de ficheros, por ejemplo, "persistence.ext4".
\fIpersistence.conf\fP(5)). Los ficheros imagen overlay tienen extensiones que
determinan su sistema de ficheros, por ejemplo, "persistence.ext4".
.IP "\fBpersistence\-encryption\fP=\fITYPE1\fP,\fITYPE2\fP ... \fITYPEn\fP" 4
Esta opción determina qué tipo de cifrado se usa cuando se prueban los
dispositivos de los medios con persistencia. Si se especifica "none" en la
Expand Down Expand Up @@ -282,10 +282,10 @@ alfanumérico.
.IP \fB/etc/live/boot/*\fP 4
.IP \fBlive/boot.conf\fP 4
.IP \fBlive/boot.d/*\fP 4
.IP \fBlive\-persistence.conf\fP 4
.IP \fBpersistence.conf\fP 4

.SH "VER ADEMÁS"
\fIlive\-persistence.conf\fP(5)
\fIpersistence.conf\fP(5)
.PP
\fIlive\-build\fP(7)
.PP
Expand Down
Expand Up @@ -3,23 +3,23 @@
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.TH LIVE\-BOOT conf 26.09.2012 3.0~b3\-1 "Proyecto Debian Live"
.TH LIVE\-BOOT conf 27.09.2012 3.0~b3\-1 "Proyecto Debian Live"

.SH NOMBRE
\fBlive\-persistence.conf\fP \- Fichero para configurar medios de almacenamiento
con persistencia en live\-boot
\fBpersistence.conf\fP \- Fichero para configurar medios de almacenamiento con
persistencia en live\-boot

.SH DESCRIPCIÓN
Si live\-boot prueba un volumen persistente con la etiqueta (o nombre GPT, o
nombre de fichero, aunque a partir de este momento nos referiremos a él como
simplemente "etiqueta") "persistence", la persistencia de ese volumen es
completamente personalizable a través del fichero \fBlive\-persistence.conf\fP
completamente personalizable a través del fichero \fBpersistence.conf\fP
almacenado en la raíz de su sistema de ficheros. Cualquier volumen esa
etiqueta debe tener uno de esos ficheros, o si no será ignorado.
.PP
El formato de \fBlive\-persistence.conf\fP permite añadir líneas vacias o líneas
que comiencen por "#" (usado para los comentarios), ambos serán
ignorados. Un "montaje personalizado" tiene el formato:
El formato de \fBpersistence.conf\fP permite añadir líneas vacias o líneas que
comiencen por "#" (usado para los comentarios), ambos serán ignorados. Un
"montaje personalizado" tiene el formato:
.PP
.RS
\fIDIR\fP [\fIOPTION\fP]...
Expand All @@ -43,10 +43,10 @@ Todos los montajes personalizados serán montados en orden de tal manera que
dos montajes personalizados no se "escondan" uno al otro. Por ejemplo, si
tenemos los dos \fIDIR\fP:s /a y /a/b siempre /a será montado en primer lugar,
después /a/b. Esto siempre es así sin importar el orden en que aparezcan las
líneas en \fBlive\-persistence.conf\fP o incluso si se usan varios ficheros
\fBlive\-persistence.conf\fP en medios persistentes distintos al mismo
tiempo. Sin embargo, no está permitido que un montaje personalizado tenga su
directorio de origen en el interior del directorio de origen de otro montaje
líneas en \fBpersistence.conf\fP o incluso si se usan varios ficheros
\fBpersistence.conf\fP en medios persistentes distintos al mismo tiempo. Sin
embargo, no está permitido que un montaje personalizado tenga su directorio
de origen en el interior del directorio de origen de otro montaje
personalizado, ya que los directorios de origen que live\-boot crea
automáticamente no tienen soporte para montajes "anidados" como /a y /a/b en
el mismo medio. En este caso se debe usar la opción \fBsource\fP (ver debajo)
Expand All @@ -61,8 +61,8 @@ persistencia. La preinstalación no se realiza cuando se utilizan las
opciones \fBlink\fP o \fBunion\fP (ver debajo).

.SH OPCIONES
Los montajes personalizados definidos en \fBlive\-persistence.conf\fP aceptan
las siguientes opciones en una lista separada por comas:
Los montajes personalizados definidos en \fBpersistence.conf\fP aceptan las
siguientes opciones en una lista separada por comas:
.IP \fBsource\fP=\fIPATH\fP 4
Cuando se especifica, se guardan los cambios persistentes en \fIPATH\fP en los
medios con persistencia. \fIPATH\fP debe ser una ruta relativa (respecto a la
Expand Down Expand Up @@ -112,16 +112,16 @@ tiene soporte si se utiliza \fBunion=unionmount\fP.
.SH DIRECTORIOS
.IP \fB/live/persistence\fP 4
Aquí se montarán todos los volumenes persistentes (en un directorio que
corresponda con el nombre del dispositivo). El fichero
\fBlive\-persistence.conf\fP se puede editar fácilmente a través de este
montaje, así como cualquier directorio de origen (esto resulta especialmente
práctico para los montajes personalizados usando la opción \fBlink\fP).
corresponda con el nombre del dispositivo). El fichero \fBpersistence.conf\fP
se puede editar fácilmente a través de este montaje, así como cualquier
directorio de origen (esto resulta especialmente práctico para los montajes
personalizados usando la opción \fBlink\fP).

.SH EJEMPLOS

Si tenemos un volumen con persistencia \fIVOL\fP con un fichero
\fBlive\-persistence.conf\fP que contiene las cuatro lineas siguientes
(numeradas para una mejor referencia):
\fBpersistence.conf\fPque contiene las cuatro lineas siguientes (numeradas para
una mejor referencia):
.TP 7
1.
/home/user1 link,source=config\-files/user1
Expand Down Expand Up @@ -184,8 +184,8 @@ Enlace:
/home/user2/.ssh/config \-> \fIVOL\fP/config\-files/user2/.ssh/config (de c)
.PP
Se podría decir, sin embargo, que las líneas 1 y 2 en el fichero de ejemplo
\fBlive\-persistence.conf\fP anterior son innecesarias ya que la línea 3 ya
crearía el directorio /home persistente. La opción \fBlink\fP se utiliza en
\fBpersistence.conf\fP anterior son innecesarias ya que la línea 3 ya crearía
el directorio /home persistente. La opción \fBlink\fP se utiliza en
situaciones en las que no se desea guardar de forma persistente un
directorio completo, sino únicamente algunos ficheros o subdirectorios
incluidos en él.
Expand Down Expand Up @@ -221,5 +221,5 @@ correo de Debian Live a la dirección
<\fIdebian\-live@lists.debian.org\fP>.

.SH AUTOR
live\-persistence.conf fue escrito por anonym <\fIanonym@lavabit.com\fP>
para el proyecto Debian.
persistence.conf fue escrito por anonym <\fIanonym@lavabit.com\fP> para
el proyecto Debian.

0 comments on commit 89adeb3

Please sign in to comment.