docs/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 "January 2, 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 .B "/etc/backup.d/* "
  26 .br
  27 .SH DESCRIPTION
  28 .B backupninja.conf
  29 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".
  30
  31 .TP
  32 To perform the actual backup, backupninja processes each configuration file in /etc/backup.d according to the file's suffix:
  33 .br
  34   .sh      --  run this file as a shell script.
  35   .rdiff   --  this is a configuration for rdiff-backup
  36   .maildir --  this is a configuration to backup maildirs
  37   .mysql   --  mysql backup configuration
  38   .ldap    --  ldap backup configuration
  39   .sys     --  general system reports
  40
  41 .TP
  42 Support for additional configuration types can be added by dropping bash scripts with the name of the suffix into /usr/share/backupninja.
  43
  44 .TP
  45 The configuration files are processed in alphabetical order. However, it is suggested that you name the config files in "sysvinit style."
  46
  47 .TP
  48 For example:
  49   00-disabled.ldap
  50   10-runthisfirst.sh
  51   20-runthisnext.mysql
  52   90-runthislast.rdiff
  53
  54 .TP
  55 Typically, you will put a '.rdiff' config file last, so that any database dumps you make are included in the filesystem backup.  Configurations files which begin with 0 (zero) are skipped.
  56
  57 .TP
  58 Unless otherwise specified, the config file format is "ini style."
  59
  60 .TP
  61 For example:
  62
  63  # this is a comment
  64
  65  [fishes]
  66  fish = red
  67  fish = blue
  68
  69  [fruit]
  70  apple = yes
  71  pear = no thanks \
  72  i will not have a pear.
  73
  74
  75 .PP
  76
  77 .SH SCHEDULING
  78 .br
  79 By default, each configuration file is processed everyday at 01:00 (1
  80 AM). This can be changed by specifying the 'when' in a config file.
  81
  82 For example:
  83
  84   when = sundays at 02:00
  85   when = 30th at 22
  86   when = 30 at 22:00
  87   when = everyday at 01            <-- the default
  88   when = Tuesday at 05:00
  89
  90 A configuration file will be processed at the time(s) specified by the
  91 "when" option. If multiple "when" options are present, then they all
  92 apply. If two configurations files are scheduled to run in the same
  93 hour, then we fall back on the alphabetical ordering specified above.
  94 If two configurations files are scheduled close to one another in
  95 time, it is possible to have multiple copies of backupninja running if
  96 the first instance is not finished before the next one starts.
  97
  98 These values for 'when' are equivalent:
  99
 100   when = tuesday at 05:30
 101   when = TUESDAYS at 05
 102
 103 These values for 'when' are invalid:
 104
 105   when = tuesday at 2am
 106   when = tuesday at 2
 107   when = tues at 02
 108 .br
 109
 110 .SH SEE ALSO
 111 .BR backupninja (1),
 112 .br
 113 .SH AUTHOR
 114 BACKUPNINJA was written by <elijah@riseup.net>.
 115 .br
 116 BACKUPNINJA was packaged by <micah@riseup.net>.
 117 .br
 118 .PP
 119 This manual page was written by  <stefani@riseup.net>.