diff options
author | Daniel Baumann <daniel@debian.org> | 2012-06-06 18:29:07 +0200 |
---|---|---|
committer | Daniel Baumann <daniel@debian.org> | 2012-06-06 18:43:56 +0200 |
commit | e243babf191d5b42efe58e90e74a22bd8063be8d (patch) | |
tree | d29c3630f8235f98395450b4b3c499580b1f625e /manpages/en | |
parent | f04ab476c668ad513f1ec68beaa948a26c862e05 (diff) | |
download | live-boot-e243babf191d5b42efe58e90e74a22bd8063be8d.tar.gz live-boot-e243babf191d5b42efe58e90e74a22bd8063be8d.zip |
Dropping snapshot functionality, superseeded by awesome custom mount persistence.
See the following threads for more information:
* http://lists.debian.org/debian-live/2012/04/msg00110.html
* http://lists.debian.org/debian-live/2012/06/msg00039.html
Diffstat (limited to 'manpages/en')
-rw-r--r-- | manpages/en/live-boot.7 | 16 | ||||
-rw-r--r-- | manpages/en/live-persistence.conf.5 | 2 | ||||
-rw-r--r-- | manpages/en/live-snapshot.1 | 70 |
3 files changed, 6 insertions, 82 deletions
diff --git a/manpages/en/live-boot.7 b/manpages/en/live-boot.7 index 2606bbb..516b189 100644 --- a/manpages/en/live-boot.7 +++ b/manpages/en/live-boot.7 @@ -1,4 +1,4 @@ -.TH LIVE\-BOOT 7 2012\-06\-05 3.0~a31-1 "Debian Live Project" +.TH LIVE\-BOOT 7 2012\-06\-06 3.0~a31-1 "Debian Live Project" .SH NAME \fBlive\-boot\fR \- System Boot Scripts @@ -109,17 +109,17 @@ 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-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". +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 either "full\-ov", which will be mounted on /, or "custom\-ov", which can be completely customized (see \fIlive-persistence.conf\fR(5)). The order these are handled are: full\-ov, custom\-ov. Overlay image files have extensions which determines their filesystem, e.g. "custom\-ov.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 -If you specify the keyword 'removable', live\-boot will try to find persistence and snapshot partitions on removable media only. Note that if you want to further restrict the media to usb mass storage only, you can use the 'removable\-usb' keyword. +If you specify the keyword 'removable', live\-boot will try to find persistence partitions on removable media only. Note that if you want to further restrict the media to usb mass storage only, you can use the 'removable\-usb' keyword. .IP "\fBpersistence\-method\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 4 -This option determines which types of persistence media we allow. If "overlay" is in the list, we consider overlays (i.e. "live\-rw" and "home\-rw"); if "snapshot" is in the list, we consider snapshots (i.e. "live\-sn" and "home\-sn"). The default is "overlay,snapshot". +This option determines which types of persistence media we allow. If "overlay" is in the list, we consider overlays (i.e. "live\-rw" and "home\-rw"). The default is "overlay". .IP "\fBpersistence\-path\fR=\fIPATH\fR" 4 live\-boot will look for persistency files in the root directory of a partition, with this parameter, the path can be configured so that you can have multiple directories on the same partition to store persistency files. .IP "\fBpersistence\-read\-only\fR" 4 -Filesystem changes are not saved back to persistence media. In particular, overlays and netboot NFS mounts are mounted read-only, and snapshots are not resynced on shutdown. +Filesystem changes are not saved back to persistence media. In particular, overlays and netboot NFS mounts are mounted read-only. .IP "\fBpersistence\-storage\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 4 This option determines which types of persistence storage to consider when probing for persistence media. If "filesystem" is in the list, filesystems with matching labels will be used; if "file" is in the list, all filesystems will be probed for archives and image files with matching filenames. The default is "file,filesystem". .IP "\fBpersistence\-subtext\fR=\fISUFFIX\fR" 4 @@ -144,10 +144,6 @@ By default, live\-boot uses aufs. With this parameter, you can switch to unionfs Some variables can be configured via this config file (inside the live system). .IP "\fBlive/filesystem.module\fR" 4 This optional file (inside the live media) contains a list of white\-space or carriage\-return\-separated file names corresponding to disk images in the "/live" directory. If this file exists, only images listed here will be merged into the root aufs, and they will be loaded in the order listed here. The first entry in this file will be the "lowest" point in the aufs, and the last file in this list will be on the "top" of the aufs, directly below /overlay. Without this file, any images in the "/live" directory are loaded in alphanumeric order. -.IP "\fB/etc/live\-persistence.binds\fR" 4 -This optional file (which resides in the rootfs system, not in the live media) is used as a list of directories which not need be persistent: ie. their content does not need to survive reboots when using the persistence features. -.br -This saves expensive writes and speeds up operations on volatile data such as web caches and temporary files (like e.g. /tmp and .mozilla) which are regenerated each time. This is achieved by bind mounting each listed directory with a tmpfs on the original path. .\" FIXME .SH FILES @@ -158,8 +154,6 @@ This saves expensive writes and speeds up operations on volatile data such as we .IP "\fBlive-persistence.conf\fR" 4 .SH SEE ALSO -\fIlive\-snapshot\fR(1) -.PP \fIlive-persistence.conf\fR(5) .PP \fIlive\-build\fR(7) diff --git a/manpages/en/live-persistence.conf.5 b/manpages/en/live-persistence.conf.5 index 1ea2a79..194826d 100644 --- a/manpages/en/live-persistence.conf.5 +++ b/manpages/en/live-persistence.conf.5 @@ -1,4 +1,4 @@ -.TH LIVE\-BOOT conf 2012\-06\-05 3.0~a31-1 "Debian Live Project" +.TH LIVE\-BOOT conf 2012\-06\-06 3.0~a31-1 "Debian Live Project" .SH NAME \fBlive-persistence.conf\fR \- Configuration file for persistence media in diff --git a/manpages/en/live-snapshot.1 b/manpages/en/live-snapshot.1 deleted file mode 100644 index 81e4a86..0000000 --- a/manpages/en/live-snapshot.1 +++ /dev/null @@ -1,70 +0,0 @@ -.TH LIVE\-BOOT 1 2012\-06\-05 3.0~a31-1 "Debian Live Project" - -.SH NAME -\fBlive\-snapshot\fR \- simple script to ease persistence usage - -.SH SYNOPSIS -\fBlive\-snapshot\fR [\-c|\-\-cow \fIDIRECTORY\fI] [\-d|\-\-device \fIDEVICE\fR] [\-e|\-\-exclude\-list \fIFILE\fR] [\-o|\-\-output \fIFILE\fR] [\-t|\-\-type \fITYPE\fR] -.br -\fBlive\-snapshot\fR [\-r|\-\-resync\-string \fRSTRING\fR] -.br -\fBlive\-snapshot\fR [\-h|\-\-help] -.br -\fBlive\-snapshot\fR [\-u|\-\-usage] -.br -\fBlive\-snapshot\fR [\-v|\-\-version] - -.SH DESCRIPTION -live\-snapshot is a script which can be used to build the right types of persistence image files supported by \fIlive\-boot\fR(7). It is also used on exit by the live\-boot init script to resync the boot\-found snapshots devices. - -.SH OPTIONS -.IP "\-c, \-\-cow \fIDIRECTORY\fR" 4 -specifies the input directory to be cloned in the image file. Its default value "/live/overlay" should be right for most uses. However it could be handy to specify "/home" and type ext4 for the type to prepare an image file suited to be directly mounted by live\-boot as home. -.IP "\-d, \-\-device \fIDEVICE\fR" 4 -sets the device where the media with the snapshot/persistence file/partition will be put. If it is not specified, a tmpfs will be used and linked to the user's desktop to move it where it is needed. If the device has no filesystem, an ext4 fs will be automatically created and labelled according to the values specified after the "\-\-output" value or with a sane default. -.IP "\-e, \-\-exclude\-list \fIFILE\fR" 4 -a file containing a list of filenames/paths that should not be saved. This exclude list will be remebered on the target snapshot media for reuse. -.IP "\-o, \-\-output \fIFILE\fR" 4 -the filename/label used for the output file/partition. If left blank, live\-snapshot will search for a proper file on the device or use the whole partition. -.IP "\-r, \-\-resync\-string \fISTRING\fR" 4 -internally used on resyncs. -.IP "\-f, \-\-refresh" 4 -try to do the same operation that should be done at reboot or halt, resyncing boot\-time auto discovered snapshots. Useful to prevent a crash or surge power\-off. -.IP "\-t, \-\-type \fITYPE\fR" 4 -Type could be one of "cpio", "squashfs", "ext2", "ext3", "ext4", or "jffs2". -.IP "\-h, \-\-help" 4 -display help and exit. -.IP "\-u, \-\-usage" 4 -show usage and exit. -.IP "\-v, \-\-version" 4 -output version information and exit. - -.SH FILES -.IP "\fB/etc/live.conf\fR" 4 -Some variables can be configured via this config file (inside the live system). -.IP "\fBlive/filesystem.module\fR" 4 -This optional file (inside the live media) contains a list of white\-space or carriage\-return\-separated file names corresponding to disk images in the "/live" directory. If this file exists, only images listed here will be merged into the root aufs, and they will be loaded in the order listed here. The first entry in this file will be the "lowest" point in the aufs, and the last file in this list will be on the "top" of the aufs, directly below /overlay. Without this file, any images in the "/live" directory are loaded in alphanumeric order. -.IP "\fB/etc/live\-persistence.binds\fR" 4 -This optional file (which resides in the rootfs system, not in the live media) is used as a list of directories which not need be persistent: i.e. their content does not need to survive reboots when using the persistence features. -.br -This saves expensive writes and speeds up operations on volatile data such as web caches and temporary files (like e.g. /tmp and .mozilla) which are regenerated each time. This is achieved by bind mounting each listed directory with a tmpfs on the original path. -.IP "\fB/etc/live\-snapshot.list\fR" 4 -This optional file, if present changes the behaviour of live\-snapshot: only files and directories listed there are included (integrally) in the snapshot. Beware, it is an experimental feature that only works for cpio targets now. - -.SH SEE ALSO -\fIlive\-boot\fR(1) -.PP -\fIlive\-build\fR(7) -.PP -\fIlive\-config\fR(7) -.PP -\fIlive\-tools\fR(7) - -.SH HOMEPAGE -More information about live\-boot and the Debian Live project can be found on the homepage at <\fIhttp://live.debian.net/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>. - -.SH BUGS -Bugs can be reported by submitting a bugreport for the live\-boot package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or by writing a mail to the Debian Live mailing list at <\fIdebian-live@lists.debian.org\fR>. - -.SH AUTHOR -live\-boot was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project. |