3c13106d565f1e96fe7942ba49e26fceaf6b2076
[live-boot-grml.git] / manpages / de / live-snapshot.de.1
1 .\"*******************************************************************
2 .\"
3 .\" This file was generated with po4a. Translate the source file.
4 .\"
5 .\"*******************************************************************
6 .TH LIVE\-BOOT 1 05.06.2012 3.0~a31\-1 "Debian Live Project"
7
8 .SH NAME
9 \fBlive\-snapshot\fP \- simple script to ease persistence usage
10
11 .SH SYNOPSIS
12 \fBlive\-snapshot\fP [\-c|\-\-cow \fIDIRECTORY] [\-d|\-\-device DEVICE\fP]
13 [\-e|\-\-exclude\-list \fIFILE\fP] [\-o|\-\-output \fIFILE\fP] [\-t|\-\-type \fITYPE\fP]
14 .br
15 \fBlive\-snapshot\fP [\-r|\-\-resync\-string STRING]
16 .br
17 \fBlive\-snapshot\fP [\-h|\-\-help]
18 .br
19 \fBlive\-snapshot\fP [\-u|\-\-usage]
20 .br
21 \fBlive\-snapshot\fP [\-v|\-\-version]
22
23 .SH DESCRIPTION
24 live\-snapshot is a script which can be used to build the right types of
25 persistence image files supported by \fIlive\-boot\fP(7). It is also used on
26 exit by the live\-boot init script to resync the boot\-found snapshots
27 devices.
28
29 .SH OPTIONS
30 .IP "\-c, \-\-cow \fIDIRECTORY\fP" 4
31 specifies the input directory to be cloned in the image file. Its default
32 value "/live/overlay" should be right for most uses. However it could be
33 handy to specify "/home" and type ext4 for the type to prepare an image file
34 suited to be directly mounted by live\-boot as home.
35 .IP "\-d, \-\-device \fIDEVICE\fP" 4
36 sets the device where the media with the snapshot/persistence file/partition
37 will be put. If it is not specified, a tmpfs will be used and linked to the
38 user's desktop to move it where it is needed. If the device has no
39 filesystem, an ext4 fs will be automatically created and labelled according
40 to the values specified after the "\-\-output" value or with a sane default.
41 .IP "\-e, \-\-exclude\-list \fIFILE\fP" 4
42 a file containing a list of filenames/paths that should not be saved. This
43 exclude list will be remebered on the target snapshot media for reuse.
44 .IP "\-o, \-\-output \fIFILE\fP" 4
45 the filename/label used for the output file/partition. If left blank,
46 live\-snapshot will search for a proper file on the device or use the whole
47 partition.
48 .IP "\-r, \-\-resync\-string \fISTRING\fP" 4
49 internally used on resyncs.
50 .IP "\-f, \-\-refresh" 4
51 try to do the same operation that should be done at reboot or halt,
52 resyncing boot\-time auto discovered snapshots. Useful to prevent a crash or
53 surge power\-off.
54 .IP "\-t, \-\-type \fITYPE\fP" 4
55 Type could be one of "cpio", "squashfs", "ext2", "ext3", "ext4", or "jffs2".
56 .IP "\-h, \-\-help" 4
57 display help and exit.
58 .IP "\-u, \-\-usage" 4
59 show usage and exit.
60 .IP "\-v, \-\-version" 4
61 output version information and exit.
62
63 .SH FILES
64 .IP \fB/etc/live.conf\fP 4
65 Some variables can be configured via this config file (inside the live
66 system).
67 .IP \fBlive/filesystem.module\fP 4
68 This optional file (inside the live media) contains a list of white\-space or
69 carriage\-return\-separated file names corresponding to disk images in the
70 "/live" directory. If this file exists, only images listed here will be
71 merged into the root aufs, and they will be loaded in the order listed
72 here. The first entry in this file will be the "lowest" point in the aufs,
73 and the last file in this list will be on the "top" of the aufs, directly
74 below /overlay.  Without this file, any images in the "/live" directory are
75 loaded in alphanumeric order.
76 .IP \fB/etc/live\-persistence.binds\fP 4
77 This optional file (which resides in the rootfs system, not in the live
78 media) is used as a list of directories which not need be persistent:
79 i.e. their content does not need to survive reboots when using the
80 persistence features.
81 .br
82 This saves expensive writes and speeds up operations on volatile data such
83 as web caches and temporary files (like e.g. /tmp and .mozilla) which are
84 regenerated each time. This is achieved by bind mounting each listed
85 directory with a tmpfs on the original path.
86 .IP \fB/etc/live\-snapshot.list\fP 4
87 This optional file, if present changes the behaviour of live\-snapshot: only
88 files and directories listed there are included (integrally) in the
89 snapshot. Beware, it is an experimental feature that only works for cpio
90 targets now.
91
92 .SH "SEE ALSO"
93 \fIlive\-boot\fP(1)
94 .PP
95 \fIlive\-build\fP(7)
96 .PP
97 \fIlive\-config\fP(7)
98 .PP
99 \fIlive\-tools\fP(7)
100
101 .SH HOMEPAGE
102 More information about live\-boot and the Debian Live project can be found on
103 the homepage at <\fIhttp://live.debian.net/\fP> and in the manual at
104 <\fIhttp://live.debian.net/manual/\fP>.
105
106 .SH BUGS
107 Bugs can be reported by submitting a bugreport for the live\-boot package in
108 the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fP> or by
109 writing a mail to the Debian Live mailing list at
110 <\fIdebian\-live@lists.debian.org\fP>.
111
112 .SH AUTHOR
113 live\-boot was written by Daniel Baumann <\fIdaniel@debian.org\fP> for
114 the Debian project.