Adding casper 1.77+debian-2.
[live-boot-grml.git] / debian / manpage / casper-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 useful 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 This parameters often does not need to be specified as the default of "/cow" for it 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 the device on where the media which the snapshot/persistence file/partition will be put. If not specified a tmpfs will be used and linked on user's desktop to move it where he/her wants. If the device has not a filesystem on it, an ext2 fs will be created in it and labeled like --output options or with a sane default.
43 .TP
44 .BI "\-e, \-\-exclude\-list" FILE
45 you could pass a list of filenames/path that should not be saved. This exclude list will be remebered on the target snapshotting media for reuse.
46 .TP
47 .BI "\-o, \-\-output" FILE
48 the filename/label to be used for the output file/partition, if left blank it could 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
55 .SH BUGS
56 .B casper-snapshot
57 Time (and BTS) will tell.
58
59 .SH HOMEPAGE
60 Debian Live project <http://live.debian.net/>
61
62 .SH SEE ALSO
63 .BR casper(7)
64
65 .SH AUTHOR
66 casper-snapshot was written Marco Amadori <marco.amadori@gmail.com>.
67 .TP
68 This manual page was written by Marco Amadori <marco.amadori@gmail.com>,
69 for the Debian project (but may be used by others).