summaryrefslogtreecommitdiff
path: root/manpages/live-snapshot.en.1.txt
blob: da5d27d869ee79baca25740bf455d7129d034882 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
live-snapshot(1)
================
:man source: 1.157.3
:man manual: Debian Live

Name
----
live-snapshot - a simple script to ease persistence usage

Synopsis
--------
live-snapshot [-c|--cow **DIRECTORY**s] [-d|--device **DEVICE**] [-e|--exclude-list **FILE**] [-o|--output **FILE**] [-t|--type **TYPE**]

live-snapshot [-r|--resync-string **STRING**]

live-snapshot [-h|--help]

live-snapshot [-u|--usage]

live-snapshot [-v|--version]

Description
-----------

live-snapshot is a script which can be used to build the right types of
persistent image files supported by live-initramfs(7). It is also used on
exit by the live-initramfs init script to resync the boot-found snapshots
devices.

Options
-------

  -c, --cow **DIRECTORY**::

specifies the input directory to be cloned in the image file. Its default value
"/live/cow" should be right for most uses. However it could be handy to specify
"/home" and type ext2 for the type to prepare an image file suited to be
directly mounted by live-initramfs as home.

  -d, --device **DEVICE**::

sets the device where the media which 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 ext2 fs will be automatically created and labelled according to the values
specified after the "--output" value or with a sane default.

  -e, --exclude-list **FILE**::

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.

  -o, --output **FILE**::

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.

  -r, --resync-string **STRING**::

internally used on resyncs.

  -f, --refresh::

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.

  -t, --type **TYPE**::

Type could be one of "cpio", "squashfs", "ext2", "ext3", "ext4", or "jffs2".

  -h, --help::

display help and exit

  -u, --usage::

show usage and exit

  -v, --version::

output version information and exit

Files
-----

  /etc/live-snapshot.list

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.

  /etc/live-snapshot.exclude_list

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.
It works for cpio, whole partition and squashfs snapshot types only; it is pretty useful for filtering temporary files and disk caches.


See also
--------

live-initramfs(8)

This program is a part of live-initramfs.

Bugs
----

Report bugs against live-initramfs
link:http://packages.qa.debian.org/live-initramfs[http://packages.qa.debian.org/live-initramfs].

Homepage
--------

More information about the Debian Live project can be found at
link:http://debian-live.alioth.debian.org/[http://debian-live.alioth.debian.org/] and
link:http://wiki.debian.org/DebianLive/[http://wiki.debian.org/DebianLive/].

Authors
-------

live-initramfs is maintained by Daniel Baumann <daniel@debian.org> for the
Debian project. live-initramfs is a fork of
link:http://packages.ubuntu.com/casper/[casper]. casper was originally written
by Tollef Fog Heen <tfheen@canonical.com> and Matt Zimmerman <mdz@canonical.com>.