X-Git-Url: https://git.stderr.nl/gitweb?p=matthijs%2Fupstream%2Fbackupninja.git;a=blobdiff_plain;f=man%2Fbackupninja.conf.5;fp=man%2Fbackupninja.conf.5;h=f96c931e3cd8d2cbf45c919b4c26853b6f041ed5;hp=0000000000000000000000000000000000000000;hb=d71a43f4c140156115ae1ca8492f71833dc40015;hpb=d943cfdaa9bb9e297319c63c2302995999ffe5c3

diff --git a/man/backupninja.conf.5 b/man/backupninja.conf.5
new file mode 100644
index 0000000..f96c931
--- /dev/null
+++ b/man/backupninja.conf.5
@@ -0,0 +1,97 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH BACKUPNINJA.CONF 5 "October 10, 2005" "riseup" "backupninja package"
+.SH NAME 
+BACKUPNINJA.CONF \- Configuration file(s) for \fBbackupninja (1)\fP.
+
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.br
+.SH SYNOPSIS
+.B "/etc/backupninja.conf "
+.br
+.SH DESCRIPTION
+.B backupninja.conf
+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".
+
+.SH OPTIONS
+
+.TP
+.B loglevel
+How verbose to make the logs. 
+.br
+5 = Debugging messages
+.br
+4 = Informational messages
+.br
+3 = Warnings
+.br
+2 = Errors
+.br
+1 = Fatal errors 
+
+.TP
+.B reportemail
+Send a summary of the backup status to this email address
+
+.TP
+.B reportsuccess
+If set to 'yes', a report email will be generated even if all modules reported success.
+
+.TP
+.B reportwarning
+If set to 'yes', a report email will be generated even if there was no error.
+
+.TP
+.B logfile
+The path of the logfile.
+
+.TP
+.B configdirectory
+The directory where all the backup action configuration files live.
+
+.TP 
+.B scriptdirectory 
+Where backupninja handler scripts are found
+
+.TP
+.B usecolors
+If set to 'yes', use colors in the log file and debug output.
+
+.SH DEFAULTS
+
+loglevel = 4
+.br
+reportemail = root
+.br
+reportsuccess = yes
+.br
+reportwarning = yes
+.br
+logfile = /var/log/backupninja.log
+.br
+configdirectory = /etc/backup.d
+.br
+scriptdirectory = /usr/share/backupninja
+.br
+usecolors = yes 
+
+.SH SEE ALSO
+.BR backupninja (1), 
+.BR ninjahelper (1), 
+.BR backup.d (5), 
+.br
+.SH AUTHOR
+BACKUPNINJA was written by the riseup.net collective.