8f27412c9b1518cebb82ff2895298542225ada48
[live-boot-grml.git] / manpages / live-snapshot.1
1 .TH "CASPER-SNAPSHOT" 1 "Thu,  28 Sep 2006" "0.0.1" "User commands"
2
3 .SH NAME
4 casper-snapshot \- a simple script to ease persistence usage.
5
6 .SH SYNOPSIS
7 .B casper-snapshot
8 .RB [\| \-c \||\| \-\-cow
9 .IR DIRECTORY \|]
10 .RB [\| \-d \||\| \-\-device
11 .IR DEVICE \|]
12 .RB [\| \-e \||\| \-\-exclude\-list
13 .IR FILE \|]
14 .RB [\| \-o \||\| \-\-output
15 .IR FILE \|]
16 .RB [\| \-t \||\| \-\-type
17 .IR TYPE \|]
18 .PP
19 .B casper-snapshot
20 .RB \-r \||\| \-\-resync\-string
21 .IR STRING
22 .br
23 .B casper-snapshot
24 .RB \-h \||\| \-\-help
25 .br
26 .B casper-snapshot
27 .RB \-u \||\| \-\-usage
28 .br
29 .B casper-snapshot
30 .RB \-v \||\| \-\-version
31
32 .SH DESCRIPTION
33 Casper-snapshot is a script which can be used to build the right types of persistent image files supported by casper. It is also used on exit by the casper init script to resync the boot-found snapshots devices.
34
35 .SH OPTIONS
36 .TP
37 .BI "\-c, \-\-cow" DIRECTORY
38 specifies the input directory to be cloned in the image file.
39 Its default value "/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 casper as home.
40 .TP
41 .BI "\-d, \-\-device" DEVICE
42 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.
43 .TP
44 .BI "\-e, \-\-exclude\-list" FILE
45 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.
46 .TP
47 .BI "\-o, \-\-output" FILE
48 the filename/label used for the output file/partition. If left blank, casper-snapshot will search for a proper file on the device or use the whole partition.
49 .TP
50 .BI "\-r, \-\-resync\-string" STRING
51 internally used on resyncs.
52 .TP
53 .BI "\-t, \-\-type" TYPE
54 Type could be one of "cpio", "squashfs" or "ext2".
55
56 .SH BUGS
57 .B casper-snapshot
58 Time (and BTS) will tell.
59
60 .SH HOMEPAGE
61 Debian Live project <http://live.debian.net/>
62
63 .SH SEE ALSO
64 .BR casper(7)
65
66 .SH AUTHOR
67 casper-snapshot was written Marco Amadori <marco.amadori@gmail.com>.
68 .TP
69 This manual page was written by Marco Amadori <marco.amadori@gmail.com>,
70 for the Debian project (but may be used by others).