manpages/live-snapshot.en.1.txt

   1 live-snapshot(1)
   2 ================
   3 :man source: 1.157.3
   4 :man manual: Debian Live
   5
   6 Name
   7 ----
   8 live-snapshot - a simple script to ease persistence usage
   9
  10 Synopsis
  11 --------
  12 live-snapshot [-c|--cow **DIRECTORY**s] [-d|--device **DEVICE**] [-e|--exclude-list **FILE**] [-o|--output **FILE**] [-t|--type **TYPE**]
  13
  14 live-snapshot [-r|--resync-string **STRING**]
  15
  16 live-snapshot [-h|--help]
  17
  18 live-snapshot [-u|--usage]
  19
  20 live-snapshot [-v|--version]
  21
  22 Description
  23 -----------
  24
  25 live-snapshot is a script which can be used to build the right types of
  26 persistent image files supported by live-initramfs(7). It is also used on
  27 exit by the live-initramfs init script to resync the boot-found snapshots
  28 devices.
  29
  30 Options
  31 -------
  32
  33   -c, --cow **DIRECTORY**::
  34
  35 specifies the input directory to be cloned in the image file. Its default value
  36 "/live/cow" should be right for most uses. However it could be handy to specify
  37 "/home" and type ext2 for the type to prepare an image file suited to be
  38 directly mounted by live-initramfs as home.
  39
  40   -d, --device **DEVICE**::
  41
  42 sets the device where the media which the snapshot/persistence file/partition
  43 will be put. If it is not specified, a tmpfs will be used and linked to the
  44 user's desktop to move it where it is needed. If the device has no filesystem,
  45 an ext2 fs will be automatically created and labelled according to the values
  46 specified after the "--output" value or with a sane default.
  47
  48   -e, --exclude-list **FILE**::
  49
  50 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.
  51
  52   -o, --output **FILE**::
  53
  54 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.
  55
  56   -r, --resync-string **STRING**::
  57
  58 internally used on resyncs.
  59
  60   -f, --refresh::
  61
  62 try to do the same operation that should be done at reboot or halt, resyncing
  63 boot-time auto discovered snapshots. Useful to prevent a crash or surge
  64 power-off.
  65
  66   -t, --type **TYPE**::
  67
  68 Type could be one of "cpio", "squashfs", "ext2", "ext3", "ext4", or "jffs2".
  69
  70   -h, --help::
  71
  72 display help and exit
  73
  74   -u, --usage::
  75
  76 show usage and exit
  77
  78   -v, --version::
  79
  80 output version information and exit
  81
  82 Files
  83 -----
  84
  85   /etc/live-snapshot.list
  86
  87 This optional file, if present changes the behaviour of live-snapshot, only files and directories listed there are included (integrally) in the snapshot. It works only for cpio and whole partition targets.
  88
  89   /etc/live-snapshot.exclude_list
  90
  91 This optional file, if present will filter the files that will be saved by live-snapshot removing (as in "grep -F -v") all filenames that will be matched by strings listed in it.
  92 It works for cpio, whole partition and squashfs snapshot types only; it is pretty useful for filtering temporary files and disk caches.
  93
  94
  95 See also
  96 --------
  97
  98 live-initramfs(8)
  99
 100 This program is a part of live-initramfs.
 101
 102 Bugs
 103 ----
 104
 105 Report bugs against live-initramfs
 106 link:http://packages.qa.debian.org/live-initramfs[http://packages.qa.debian.org/live-initramfs].
 107
 108 Homepage
 109 --------
 110
 111 More information about the Debian Live project can be found at
 112 link:http://debian-live.alioth.debian.org/[http://debian-live.alioth.debian.org/] and
 113 link:http://wiki.debian.org/DebianLive/[http://wiki.debian.org/DebianLive/].
 114
 115 Authors
 116 -------
 117
 118 live-initramfs is maintained by Daniel Baumann <daniel@debian.org> for the
 119 Debian project. live-initramfs is a fork of
 120 link:http://packages.ubuntu.com/casper/[casper]. casper was originally written
 121 by Tollef Fog Heen <tfheen@canonical.com> and Matt Zimmerman <mdz@canonical.com>.