Update manpage
[sitarba.git] / sitarba.1
1 '\" -*- coding: us-ascii -*-
2 .if \n(.g .ds T< \\FC
3 .if \n(.g .ds T> \\F[\n[.fam]]
4 .de URL
5 \\$2 \(la\\$1\(ra\\$3
6 ..
7 .if \n(.g .mso www.tmac
8 .TH sitarba 1 2013-01-06 "" ""
9 .SH NAME
10 sitarba \- a simple backup solution
11 .SH SYNOPSIS
12 'nh
13 .fi
14 .ad l
15 \fBsitarba\fR \kx
16 .if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
17 'in \n(.iu+\nxu
18 [options] {\fIcommand\fR}
19 'in \n(.iu-\nxu
20 .ad b
21 'hy
22 .SH DESCRIPTION
23 \fBsitarba\fR is a simple backup solution
24 which packs user-defined file sets with tar. Each
25 backup belongs to an epoch, which is 'sporadic' or one
26 of the user-defined epochs. Standard epochs are year,
27 month, week, day, or hour. The backup can be made
28 either full, differential or incremental.
29 \fBsitarba\fR takes care for pruning old
30 backups. The user defines for every epoch the number of
31 backups to keep, except for 'sporadic'. Sporadic
32 backups need to be removed manually.
33 .SH COMMANDS
34 .TP
35 \*(T<\fBbackup\fR\*(T>
36 Make a backup
37 .TP
38 \*(T<\fBlist\fR\*(T>
39 List all backups
40 .TP
41 \*(T<\fBprune\fR\*(T>
42 Prune outdated/stale backups
43 .SH OPTIONS
44 .TP
45 \*(T<\fB\-h, \-\-help\fR\*(T>
46 Print out a help summary.
47 .TP
48 \*(T<\fB\-c, \-\-conf FILE\fR\*(T>
49 Use given configuration file instead of
50 /etc/sitarba.conf.
51 .TP
52 \*(T<\fB\-e, \-\-epoch EPOCH\fR\*(T>
53 Do not determine epoch automatically, but
54 use EPOCH, which can be sporadic or one
55 of the epochs defined in the
56 configuration file.
57 .TP
58 \*(T<\fB\-m, \-\-mode MODE\fR\*(T>
59 Instead of configured mode use MODE,
60 which can be full, diff or incr.
61 .TP
62 \*(T<\fB\-n, \-\-dry\-run\fR\*(T>
63 Don't do anything, just tell what would be done.
64 .TP
65 \*(T<\fB\-v, \-\-verbose\fR\*(T>
66 Be more verbose and interact with user.
67 Equal to --verbosity info.
68 .TP
69 \*(T<\fB\-\-verbosity LEVEL\fR\*(T>
70 Set verbosity to LEVEL, which can be
71 error, warning, info, debug.
72 .TP
73 \*(T<\fB\-V, \-\-version\fR\*(T>
74 Print version info.
75 .SH AUTHOR
76 Stefan HUBER