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