Add some comments to compute_next_snapshot_time().
[dss.git] / INSTALL
1 Type
2
3 make
4
5 in the dss source directory to build the dss executable and copy it to
6 some directory that is included in your PATH, e.g. to $HOME/bin or to
7 /usr/local/bin.
8
9 Note that you'll likely need a recent version of
10 ftp://ftp.gnu.org/pub/gnu/gengetopt/ (gnu gengetopt) to compile dss.
11
12 dss is known to compile on Linux, MacOS, Solaris, FreeBSD and
13 NetBSD. However, it is run-tested only on Linux.
14
15 Also make sure that http://rsync.samba.org/ (rsync) is installed on
16 your system. Version 2.6.1 or newer is required.
17
18 Example:
19 --------
20
21 Suppose you'd like to create snapshots of the existing directory
22
23 /foo/bar
24
25 in the directory
26
27 /baz/qux.
28
29 Create the config file
30
31 ~/.dssrc
32
33 that contains the values for the source and the destination directories
34 as follows:
35
36 echo 'source-dir "/foo/bar"' > ~/.dssrc
37 echo 'dest-dir "/baz/qux"' >> ~/.dssrc
38
39 Then execute the commands
40
41 mkdir /baz/qux
42 dss --run
43
44 In order to print the list of all snapshots created so far, use
45
46 dss --list
47
48 Yes, it's really that easy. Of course, dss supports many more
49 features and config options such as taking snapshots from remote
50 hosts and several hooks that are executed on certain events, for
51 example whenever a snapshot was created successfully. Try
52
53 dss -h
54
55 for an overview of all supported command line options or
56
57 dss --detailed-help
58
59 for the full help text.