manpages/live-snapshot.en.1.txt

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