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 "November 19, 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 .TP
  74 .B when
  75 When to process each configuration file. The value used here will
  76 be applied for each configuration file. It is possibile to override
  77 this "when" in each each configuration file, see also section
  78 "Scheduling" in backup.d(5).
  79
  80 For example:
  81
  82   when = sundays at 02:00
  83   when = 30th at 22
  84   when = 30 at 22:00
  85   when = everyday at 01            <-- the default
  86   when = Tuesday at 05:00
  87
  88 These values for 'when' are equivalent:
  89
  90   when = tuesday at 05:30
  91   when = TUESDAYS at 05
  92
  93 These values for 'when' are invalid:
  94
  95   when = tuesday at 2am
  96   when = tuesday at 2
  97   when = tues at 02
  98
  99 .TP
 100 .B vservers
 101 If you are using Linux-Vservers (http://linux-vserver.org), there are some
 102 special capabilities that different handlers have to make vserver backups easier.
 103 See the example configuration files for each handler to configure the vserver specific
 104 variables.
 105
 106 .SH DEFAULTS
 107
 108 loglevel = 4
 109 .br
 110 reportemail = root
 111 .br
 112 reportsuccess = yes
 113 .br
 114 reportwarning = yes
 115 .br
 116 logfile = /var/log/backupninja.log
 117 .br
 118 configdirectory = /etc/backup.d
 119 .br
 120 scriptdirectory = /usr/share/backupninja
 121 .br
 122 usecolors = yes
 123 .br
 124 when = everyday at 01:00
 125 .br
 126 vservers = no
 127
 128 .SH SEE ALSO
 129 .BR backupninja (1),
 130 .BR ninjahelper (1),
 131 .BR backup.d (5),
 132 .br
 133 .SH AUTHOR
 134 BACKUPNINJA was written by the riseup.net collective.