Sync with Debian's upstream/3.0_a27 (new log file name, persistency reworked,...)
[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 2012\-04\-09 3.0~a27\-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 which the snapshot/persistence
37 file/partition will be put. If it is not specified, a tmpfs will be used and
38 linked to the user's desktop to move it where it is needed. If the device
39 has no filesystem, an ext4 fs will be automatically created and labelled
40 according to the values specified after the "\-\-output" value or with a sane
41 default.
42 .IP "\-e, \-\-exclude\-list \fIFILE\fP" 4
43 a file containing a list of filenames/paths that should not be saved. This
44 exclude list will be remebered on the target snapshot media for reuse.
45 .IP "\-o, \-\-output \fIFILE\fP" 4
46 the filename/label used for the output file/partition. If left blank,
47 live\-snapshot will search for a proper file on the device or use the whole
48 partition.
49 .IP "\-r, \-\-resync\-string \fISTRING\fP" 4
50 internally used on resyncs.
51 .IP "\-f, \-\-refresh" 4
52 try to do the same operation that should be done at reboot or halt,
53 resyncing boot\-time auto discovered snapshots. Useful to prevent a crash or
54 surge power\-off.
55 .IP "\-t, \-\-type \fITYPE\fP" 4
56 Type could be one of "cpio", "squashfs", "ext2", "ext3", "ext4", or "jffs2".
57 .IP "\-h, \-\-help" 4
58 display help and exit.
59 .IP "\-u, \-\-usage" 4
60 show usage and exit.
61 .IP "\-v, \-\-version" 4
62 output version information and exit.
63
64 .SH FILES
65 .IP \fB/etc/live.conf\fP 4
66 Some variables can be configured via this config file (inside the live
67 system).
68 .IP \fBlive/filesystem.module\fP 4
69 This optional file (inside the live media) contains a list of white\-space or
70 carriage\-return\-separated file names corresponding to disk images in the
71 "/live" directory. If this file exists, only images listed here will be
72 merged into the root aufs, and they will be loaded in the order listed
73 here. The first entry in this file will be the "lowest" point in the aufs,
74 and the last file in this list will be on the "top" of the aufs, directly
75 below /overlay.  Without this file, any images in the "/live" directory are
76 loaded in alphanumeric order.
77 .IP \fB/etc/live\-persistence.binds\fP 4
78 This optional file (which resides in the rootfs system, not in the live
79 media) is used as a list of directories which not need be persistent:
80 ie. their content does not need to survive reboots when using the
81 persistence features.
82 .br
83 This saves expensive writes and speeds up operations on volatile data such
84 as web caches and temporary files (like e.g. /tmp and .mozilla) which are
85 regenerated each time. This is achieved by bind mounting each listed
86 directory with a tmpfs on the original path.
87 .IP \fB/etc/live\-snapshot.list\fP 4
88 This optional file, if present changes the behaviour of live\-snapshot: only
89 files and directories listed there are included (integrally) in the
90 snapshot. Beware, it is an experimental feature that only works for cpio
91 targets now.
92
93 .SH "SEE ALSO"
94 \fIlive\-boot\fP(1)
95 .PP
96 \fIlive\-build\fP(7)
97 .PP
98 \fIlive\-config\fP(7)
99 .PP
100 \fIlive\-tools\fP(7)
101
102 .SH HOMEPAGE
103 More information about live\-boot and the Debian Live project can be found on
104 the homepage at <\fIhttp://live.debian.net/\fP> and in the manual at
105 <\fIhttp://live.debian.net/manual/\fP>.
106
107 .SH BUGS
108 Bugs can be reported by submitting a bugreport for the live\-boot package in
109 the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fP> or by
110 writing a mail to the Debian Live mailing list at
111 <\fIdebian\-live@lists.debian.org\fP>.
112
113 .SH AUTHOR
114 live\-boot was written by Daniel Baumann <\fIdaniel@debian.org\fP> for
115 the Debian project.