Oops, cleanup and move the license to the standard location
[matthijs/upstream/backupninja.git] / man / backupninja.conf.5
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH BACKUPNINJA.CONF 5 "October 10, 2005" "riseup" "backupninja package"
6 .SH NAME 
7 BACKUPNINJA.CONF \- Configuration file(s) for \fBbackupninja (1)\fP.
8
9 .\" Please adjust this date whenever revising the manpage.
10 .\"
11 .\" Some roff macros, for reference:
12 .\" .nh        disable hyphenation
13 .\" .hy        enable hyphenation
14 .\" .ad l      left justify
15 .\" .ad b      justify to both left and right margins
16 .\" .nf        disable filling
17 .\" .fi        enable filling
18 .\" .br        insert line break
19 .\" .sp <n>    insert n+1 empty lines
20 .\" for manpage-specific macros, see man(7)
21 .br
22 .SH SYNOPSIS
23 .B "/etc/backupninja.conf "
24 .br
25 .SH DESCRIPTION
26 .B backupninja.conf
27 is the general configuration file. In this file you can set the log level and change the default directory locations.  You can force a different general configuration file with "backupninja -f /path/to/conf".
28
29 .SH OPTIONS
30
31 .TP
32 .B loglevel
33 How verbose to make the logs. 
34 .br
35 5 = Debugging messages
36 .br
37 4 = Informational messages
38 .br
39 3 = Warnings
40 .br
41 2 = Errors
42 .br
43 1 = Fatal errors 
44
45 .TP
46 .B reportemail
47 Send a summary of the backup status to this email address
48
49 .TP
50 .B reportsuccess
51 If set to 'yes', a report email will be generated even if all modules reported success.
52
53 .TP
54 .B reportwarning
55 If set to 'yes', a report email will be generated even if there was no error.
56
57 .TP
58 .B logfile
59 The path of the logfile.
60
61 .TP
62 .B configdirectory
63 The directory where all the backup action configuration files live.
64
65 .TP 
66 .B scriptdirectory 
67 Where backupninja handler scripts are found
68
69 .TP
70 .B usecolors
71 If set to 'yes', use colors in the log file and debug output.
72
73 .SH DEFAULTS
74
75 loglevel = 4
76 .br
77 reportemail = root
78 .br
79 reportsuccess = yes
80 .br
81 reportwarning = yes
82 .br
83 logfile = /var/log/backupninja.log
84 .br
85 configdirectory = /etc/backup.d
86 .br
87 scriptdirectory = /usr/share/backupninja
88 .br
89 usecolors = yes 
90
91 .SH SEE ALSO
92 .BR backupninja (1), 
93 .BR ninjahelper (1), 
94 .BR backup.d (5), 
95 .br
96 .SH AUTHOR
97 BACKUPNINJA was written by the riseup.net collective.