Adding live-initramfs 1.87.4-1.
[live-initramfs-grml.git] / manpages / live-snapshot.en.1
1 .TH LIVE\-SNAPSHOT 1 "2007\-05\-21" "1.87.4" "live\-initramfs"
2
3 .SH NAME
4 live\-snapshot \- a simple script to ease persistence usage
5
6 .SH SYNOPSIS
7 .B live\-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 live\-snapshot
20 .RB [\| \-r \||\| \-\-resync\-string
21 .IR STRING \|]
22 .PP
23 .B live\-snapshot
24 .RB [\| \-h \||\| \-\-help \|]
25 .br
26 .B live\-snapshot
27 .RB [\| \-u \||\| \-\-usage \|]
28 .br
29 .B live-snapshot
30 .RB [\| \-v \||\| \-\-version \|]
31
32 .SH DESCRIPTION
33 live\-snapshot is a script which can be used to build the right types of persistent image files supported by \fIlive\-initramfs\fR(7). It is also used on exit by the live\-initramfs init script to resync the boot-found snapshots devices.
34
35 .SH OPTIONS
36 .IP "\fB\-c, \-\-cow\fR \fIDIRECTORY\fR" 4
37 specifies the input directory to be cloned in the image file.
38 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 live-initramfs as home.
39 .IP "\fB\-d, \-\-device\fR \fIDEVICE\fR" 4
40 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.
41 .IP "\fB\-e, \-\-exclude\-list\fR \fIFILE\fR" 4
42 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.
43 .IP "\fB\-o, \-\-output\fR \fIFILE\fR" 4
44 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.
45 .IP "\fB\-r, \-\-resync\-string\fR \fISTRING\fR" 4
46 internally used on resyncs.
47 .IP "\fB\-t, \-\-type\fR \fITYPE\fR" 4
48 Type could be one of "cpio", "squashfs" or "ext2".
49 .PP
50 .IP "\fB\-h, \-\-help\fR" 4
51 display help and exit
52 .IP "\fB\-u, \-\-usage\fR" 4
53 show usage and exit
54 .IP "\fB\-v, \-\-version\fR" 4
55 output version information and exit
56
57 .SH SEE ALSO
58 \fIlive\-initramfs\fR(8)
59 .PP
60 This program is a part of live\-initramfs.
61
62 .SH BUGS
63 Report bugs against live\-initramfs <\fIhttp://packages.qa.debian.org/live\-initramfs/\fR>.
64
65 .SH HOMEPAGE
66 More information about the Debian Live project can be found at <\fIhttp://debian\-live.alioth.debian.org/\fR> and <\fIhttp://wiki.debian.org/DebianLive/\fR>.
67
68 .SH AUTHORS
69 live\-initramfs is maintained by Daniel Baumann <\fIdaniel@debian.org\fR> and Marco Amadori <\fImarco.amadori@gmail.com\fR> for the Debian project.
70 .PP
71 live\-initramfs is a fork of casper <\fIhttp://packages.ubuntu.com/casper/\fR>. casper was originally written by Tollef Fog Heen <\fItfheen@canonical.com\fR> and Matt Zimmerman <\fImdz@canonical.com\fR>.