Add INSTALL -- installation and usage notes.
[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 In order to create snapshots of the existing directory
16
17 /tmp/foo
18
19 in the directory
20
21 /tmp/bar,
22
23 execute the commands
24
25 mkdir /tmp/bar
26 ./dss --run --source-dir /tmp/foo --dest-dir /tmp/bar
27
28 To print a list of all snapshots created so far, use
29
30 ./dss --list --source-dir /tmp/foo --dest-dir /tmp/bar
31
32 You might want to create the config file
33
34 ~/.dssrc
35
36 that contains the values for the source and the destination
37 directories. In the above example, this file would contain the
38 following lines:
39
40 source-dir "/tmp/foo"
41 dest-dir "/tmp/bar"
42
43 Using a configuration file allows you to simply type
44
45 ./dss --run
46
47 to start snapshot creation and
48
49 ./dss --list
50
51 to list all avalable snapshots.
52
53 Try
54
55 ./dss -h
56
57 for an overview of all supported command line options or
58
59 ./dss --detailed-help
60
61 for the full help text.