Fix the math in the description of the unit interval.
[dss.git] / dss.ggo
1 # Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
2 #
3 # Licensed under the GPL v2. For licencing details see COPYING.
4
5 package "dss"
6 version "0.0.5"
7 purpose "the dyadic snapshot scheduler
8
9 dss creates hardlink-based snapshots of a given directory on a remote
10 or local host using rsync's link-dest feature.
11 "
12
13 #########################
14 section "General options"
15 #########################
16
17 option "config-file" c
18 #~~~~~~~~~~~~~~~~~~~~~
19 "(default='~/.dssrc')"
20 string typestr="filename"
21 optional
22 details="
23 Options may be given at the command line or in the
24 configuration file. As usual, if an option is given both at
25 the command line and in the configuration file, the command
26 line option takes precedence.
27
28 However, there is an important exception to this rule:
29 If the --run option was given (see below) then dss honors
30 SIGHUP and re-reads its configuration file whenever it
31 receives this signal. In this case the options in the config
32 file override any options that were previously given at the
33 command line. This allows to change the configuration of a
34 running dss process on the fly by sending SIGHUP.
35 "
36
37 option "daemon" d
38 #~~~~~~~~~~~~~~~~
39 "Run as background daemon"
40 flag off
41 dependon="logfile"
42 details="
43 Note that dss refuses to start in daemon mode if no logfile
44 was specified. This option is mostly useful in conjuction
45 with the -R option described below.
46
47 Note that it is not possible to change whether dss runs as
48 background daemon by sending SIGHUP.
49 "
50
51 option "dry-run" D
52 #~~~~~~~~~~~~~~~~~
53 "Only print what would be done"
54 flag off
55 details="
56 This flag does not make sense for all commands. The run
57 command refuses to start if this option was given. The ls
58 command silently ignores this flag.
59 "
60
61 #################
62 section "Logging"
63 #################
64
65 option "loglevel" l
66 #~~~~~~~~~~~~~~~~~~
67 "Set loglevel (0-6)"
68 int typestr="level"
69 default="3"
70 optional
71 details="
72 Lower values mean more verbose logging.
73 "
74
75 option "logfile" -
76 #~~~~~~~~~~~~~~~~~
77 "Logfile for the dss daemon process"
78 string typestr="filename"
79 optional
80 details="
81 This option is mostly useful for the run command if --daemon
82 is also given.
83 "
84
85 ##################
86 section "Commands"
87 ##################
88
89 defgroup "command"
90 #=================
91 groupdesc="
92 dss supports a couple of commands each of which corresponds
93 to a different command line option. Exactly one of these
94 options must be given.
95
96 "
97 required
98
99 groupoption "create" C
100 #~~~~~~~~~~~~~~~~~~~~~
101 "Create a new snapshot"
102 group="command"
103 details="
104 Execute the rsync command to create a new snapshot. Note that
105 this command does not care about free disk space.
106 "
107
108 groupoption "prune" P
109 #~~~~~~~~~~~~~~~~~~~~
110 "Remove redundant and outdated snapshots"
111 group="command"
112 details="
113 A snapshot is considered outdated if it belongs to an interval
114 greater than the maximum number of intervals. It is said to be
115 redundant if it belongs to an interval that already contains
116 more than the desired number of snapshots. This command gets
117 rid of such snapshots.
118 "
119
120 groupoption "ls" L
121 #~~~~~~~~~~~~~~~~~
122 "Print a list of all snapshots"
123 group="command"
124 details="
125 The list will contain all snapshots no matter of their state,
126 i. e. incomplete snapshots and snapshots being deleted will
127 also be listed.
128 "
129
130 groupoption "run" R
131 #~~~~~~~~~~~~~~~~~~
132 "Start creating and pruning snapshots"
133 group="command"
134 details="
135 This is the main mode of operation. Snapshots will be created
136 as needed and pruned automatically.
137 "
138
139 ###############################
140 section "Rsync-related options"
141 ###############################
142
143 option "remote-host" H
144 #~~~~~~~~~~~~~~~~~~~~~
145 "Remote host"
146 string typestr="hostname"
147 default="localhost"
148 optional
149 details="
150 If this option is given and its value differs from the local
151 host, then rsync uses ssh. Make sure there is no password
152 needed for the ssh connection. To achieve that, use public key
153 authentication for ssh and, if needed, set the remote user name
154 by using the --remote-user option.
155 "
156
157 option "remote-user" U
158 #~~~~~~~~~~~~~~~~~~~~~
159 "Remote user name (default: current user)"
160 string typestr="username"
161 optional
162 details="
163 Set this if the user running dss is different from the
164 user at the remote host when using ssh.
165 "
166
167 option "source-dir" -
168 #~~~~~~~~~~~~~~~~~~~~
169 "The data directory"
170 string typestr="dirname"
171 required
172 details="
173 The directory on the remote host from which snapshots are
174 taken. Of course, the user specified as --remote-user must
175 have read access to this directory.
176 "
177
178 option "dest-dir" -
179 #~~~~~~~~~~~~~~~~~~
180 "Snapshot dir"
181 string typestr="dirname"
182 required
183 details="
184 The destination directory on the local host where snapshots
185 will be written. This must be writable by the user who runs
186 dss.
187 "
188
189 option "rsync-option" O
190 #~~~~~~~~~~~~~~~~~~~~~~
191 "Further rsync options"
192 string typestr="option"
193 optional
194 multiple
195 details="
196 These option may be given multiple times. The arguments passed
197 to that option are passed verbatim to the rsync command.
198 "
199
200 ###################
201 section "Intervals"
202 ###################
203
204 option "unit-interval" u
205 #~~~~~~~~~~~~~~~~~~~~~~~
206 "The duration of a unit interval"
207 int typestr="days"
208 default="4"
209 optional
210 details="
211 dss snapshot aging is implemented in terms of intervals. There
212 are two command line options related to intervals: the
213 duration u of a \"unit\" interval and the number n of those
214 unit intervals.
215
216 dss removes any snapshots older than n times u and tries to
217 keep 2^(n - k - 1) snapshots in interval k, where the interval
218 number k counts from zero, zero being the most recent unit
219 interval.
220
221 In other words, the oldest snapshot will at most be u * n days
222 (= 20 days if default values are used) old. Moreover, there
223 are at most 2^n - 1 snapshots in total (i. e. 31 by default).
224 Observe that you have to create at least 2^(n - 1) snapshots
225 each interval for this to work out because that is the number
226 of snapshots in interval zero.
227 "
228
229 option "num-intervals" n
230 #~~~~~~~~~~~~~~~~~~~~~~~
231 "The number of unit intervals"
232 int typestr="num"
233 default="5"
234 optional
235
236 ###############
237 section "Hooks"
238 ###############
239
240 option "pre-create-hook" r
241 #~~~~~~~~~~~~~~~~~~~~~~~~~~
242 "Executed before snapshot creation"
243 string typestr="command"
244 optional
245 details="
246 Execute this command before trying to create a new snapshot.
247 If this command returns with a non-zero exit status, no
248 snapshot is being created and the operation is retried later.
249
250 For example, one might want to execute a script that checks
251 whether all snapshot-related file systems are properly mounted.
252
253 Another possible application of this is to return non-zero
254 during office hours in order to not slow down the file systems
255 by taking snapshots.
256 "
257
258 option "post-create-hook" o
259 #~~~~~~~~~~~~~~~~~~~~~~~~~~
260 "Executed after snapshot creation"
261 string typestr="command"
262 optional
263 details="
264 Execute this after a snapshot has successfully been
265 created. The full path of the newly created snapshot is
266 passed to the hook as the first argument. The exit code of
267 this hook is ignored.
268
269 For instance this hook can be used to count the number of
270 files per user and/or the disk usage patterns in order to
271 store them in a database for further analysis.
272 "
273
274 ###############################
275 section "Disk space monitoring"
276 ###############################
277
278 option "min-free-mb" m
279 #~~~~~~~~~~~~~~~~~~~~~
280 "Minimal amount of free disk space"
281 int typestr="megabytes"
282 default="100"
283 optional
284 details="
285 If disk space on the file system containing the destination
286 directory gets low, \"dss --run\" will suspend the currently
287 running rsync process and will start to remove snapshots in
288 order to free disk space. This option specifies the minimal
289 amount of free disk space. If less than the given number of
290 megabytes is available, snapshots are being deleted. See also
291 the --min_free_percent and the min-free-percent-inodes options.
292
293 A value of zero deactivates this check.
294 "
295
296 option "min-free-percent" p
297 #~~~~~~~~~~~~~~~~~~~~~~~~~~
298 "Minimal percent of free disk space"
299 int typestr="percent"
300 default="2"
301 optional
302 details="
303 See --min-free-mb. Note that it is not recommended to set both
304 --min-free-mb and --min-free-percent to zero as this will
305 cause your file system to fill up quickly.
306 "
307 option "min-free-percent-inodes" i
308 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
309 "Minimal percent of free inodes"
310 int typestr="percent"
311 default="0"
312 optional
313 details="
314 Specify the minimum amount of free inodes on the file system
315 containing the destination dir. If less than that many inodes
316 are free, snapshot removal kicks in just as in case of low
317 disk space.
318
319 Note that not every file system supports the concept of inodes.
320 Moreover it is not possible to reliably detect whether this is
321 the case. Therefore this feature is disabled by default. It's
322 safe to enable it for ext3 file systems on linux though.
323
324 A value of zero (the default) deactivates this check.
325 "