manpages/en/live-snapshot.1

   1 .TH LIVE\-BOOT 1 2012\-06\-05 3.0~a29-1 "Debian Live Project"
   2
   3 .SH NAME
   4 \fBlive\-snapshot\fR \- simple script to ease persistence usage
   5
   6 .SH SYNOPSIS
   7 \fBlive\-snapshot\fR [\-c|\-\-cow \fIDIRECTORY\fI] [\-d|\-\-device \fIDEVICE\fR] [\-e|\-\-exclude\-list \fIFILE\fR] [\-o|\-\-output \fIFILE\fR] [\-t|\-\-type \fITYPE\fR]
   8 .br
   9 \fBlive\-snapshot\fR [\-r|\-\-resync\-string \fRSTRING\fR]
  10 .br
  11 \fBlive\-snapshot\fR [\-h|\-\-help]
  12 .br
  13 \fBlive\-snapshot\fR [\-u|\-\-usage]
  14 .br
  15 \fBlive\-snapshot\fR [\-v|\-\-version]
  16
  17 .SH DESCRIPTION
  18 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.
  19
  20 .SH OPTIONS
  21 .IP "\-c, \-\-cow \fIDIRECTORY\fR" 4
  22 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.
  23 .IP "\-d, \-\-device \fIDEVICE\fR" 4
  24 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.
  25 .IP "\-e, \-\-exclude\-list \fIFILE\fR" 4
  26 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.
  27 .IP "\-o, \-\-output \fIFILE\fR" 4
  28 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.
  29 .IP "\-r, \-\-resync\-string \fISTRING\fR" 4
  30 internally used on resyncs.
  31 .IP "\-f, \-\-refresh" 4
  32 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.
  33 .IP "\-t, \-\-type \fITYPE\fR" 4
  34 Type could be one of "cpio", "squashfs", "ext2", "ext3", "ext4", or "jffs2".
  35 .IP "\-h, \-\-help" 4
  36 display help and exit.
  37 .IP "\-u, \-\-usage" 4
  38 show usage and exit.
  39 .IP "\-v, \-\-version" 4
  40 output version information and exit.
  41
  42 .SH FILES
  43 .IP "\fB/etc/live.conf\fR" 4
  44 Some variables can be configured via this config file (inside the live system).
  45 .IP "\fBlive/filesystem.module\fR" 4
  46 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.
  47 .IP "\fB/etc/live\-persistence.binds\fR" 4
  48 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.
  49 .br
  50 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.
  51 .IP "\fB/etc/live\-snapshot.list\fR" 4
  52 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.
  53
  54 .SH SEE ALSO
  55 \fIlive\-boot\fR(1)
  56 .PP
  57 \fIlive\-build\fR(7)
  58 .PP
  59 \fIlive\-config\fR(7)
  60 .PP
  61 \fIlive\-tools\fR(7)
  62
  63 .SH HOMEPAGE
  64 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>.
  65
  66 .SH BUGS
  67 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>.
  68
  69 .SH AUTHOR
  70 live\-boot was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project.