diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile.am | 6 | ||||
| -rw-r--r-- | man/Makefile.in | 385 | ||||
| -rw-r--r-- | man/backup.d.5 | 106 | ||||
| -rw-r--r-- | man/backupninja.1 | 137 | ||||
| -rw-r--r-- | man/backupninja.conf.5 | 134 | ||||
| -rw-r--r-- | man/ninjahelper.1 | 62 |
6 files changed, 830 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..8800248 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,6 @@ + + +man_MANS = backup.d.5 backupninja.conf.5 backupninja.1 ninjahelper.1 + +EXTRA_DIST = $(man_MANS) + diff --git a/man/Makefile.in b/man/Makefile.in new file mode 100644 index 0000000..87c4075 --- /dev/null +++ b/man/Makefile.in @@ -0,0 +1,385 @@ +# Makefile.in generated by automake 1.10.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +subdir = man +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.in +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_CLEAN_FILES = +SOURCES = +DIST_SOURCES = +man1dir = $(mandir)/man1 +am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" +man5dir = $(mandir)/man5 +NROFF = nroff +MANS = $(man_MANS) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +BASH = @BASH@ +CFGDIR = @CFGDIR@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +HAVE_RPM = @HAVE_RPM@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +MKTEMP = @MKTEMP@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_cv_have_rpm = @ac_cv_have_rpm@ +am__leading_dot = @am__leading_dot@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build_alias = @build_alias@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host_alias = @host_alias@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +man_MANS = backup.d.5 backupninja.conf.5 backupninja.1 ninjahelper.1 +EXTRA_DIST = $(man_MANS) +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ + && exit 0; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu man/Makefile'; \ + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu man/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +install-man1: $(man1_MANS) $(man_MANS) + @$(NORMAL_INSTALL) + test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)" + @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \ + l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \ + for i in $$l2; do \ + case "$$i" in \ + *.1*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \ + else file=$$i; fi; \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + case "$$ext" in \ + 1*) ;; \ + *) ext='1' ;; \ + esac; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed -e 's/^.*\///'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst"; \ + done +uninstall-man1: + @$(NORMAL_UNINSTALL) + @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \ + l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \ + for i in $$l2; do \ + case "$$i" in \ + *.1*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + case "$$ext" in \ + 1*) ;; \ + *) ext='1' ;; \ + esac; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed -e 's/^.*\///'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " rm -f '$(DESTDIR)$(man1dir)/$$inst'"; \ + rm -f "$(DESTDIR)$(man1dir)/$$inst"; \ + done +install-man5: $(man5_MANS) $(man_MANS) + @$(NORMAL_INSTALL) + test -z "$(man5dir)" || $(MKDIR_P) "$(DESTDIR)$(man5dir)" + @list='$(man5_MANS) $(dist_man5_MANS) $(nodist_man5_MANS)'; \ + l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \ + for i in $$l2; do \ + case "$$i" in \ + *.5*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \ + else file=$$i; fi; \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + case "$$ext" in \ + 5*) ;; \ + *) ext='5' ;; \ + esac; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed -e 's/^.*\///'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man5dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man5dir)/$$inst"; \ + done +uninstall-man5: + @$(NORMAL_UNINSTALL) + @list='$(man5_MANS) $(dist_man5_MANS) $(nodist_man5_MANS)'; \ + l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \ + for i in $$l2; do \ + case "$$i" in \ + *.5*) list="$$list $$i" ;; \ + esac; \ + done; \ + for i in $$list; do \ + ext=`echo $$i | sed -e 's/^.*\\.//'`; \ + case "$$ext" in \ + 5*) ;; \ + *) ext='5' ;; \ + esac; \ + inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \ + inst=`echo $$inst | sed -e 's/^.*\///'`; \ + inst=`echo $$inst | sed '$(transform)'`.$$ext; \ + echo " rm -f '$(DESTDIR)$(man5dir)/$$inst'"; \ + rm -f "$(DESTDIR)$(man5dir)/$$inst"; \ + done +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(MANS) +installdirs: + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +info: info-am + +info-am: + +install-data-am: install-man + +install-dvi: install-dvi-am + +install-exec-am: + +install-html: install-html-am + +install-info: install-info-am + +install-man: install-man1 install-man5 + +install-pdf: install-pdf-am + +install-ps: install-ps-am + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-man + +uninstall-man: uninstall-man1 uninstall-man5 + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic distclean \ + distclean-generic distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-man1 install-man5 install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic pdf \ + pdf-am ps ps-am uninstall uninstall-am uninstall-man \ + uninstall-man1 uninstall-man5 + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/man/backup.d.5 b/man/backup.d.5 new file mode 100644 index 0000000..5090051 --- /dev/null +++ b/man/backup.d.5 @@ -0,0 +1,106 @@ +.\" 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 BACKUP.D 5 "October 10, 2005" "riseup" "backupninja package" +.SH NAME +BACKUP.D \- Action configuration files 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/backup.d/* " +.br +.SH DESCRIPTION + +To preform the actual backup actions, backupninja processes each action configuration file in +/etc/backup.d according to the file's suffix. + +.IP .sh 10 +run this file as a shell script. +.IP .rdiff +backup action for rdiff-backup. +.IP .dup +backup action for duplicity. +.IP .maildir +backup action for slow, incremental rsyncs of tens of thousands of maildirs. +.IP .mysql +backup action for safe MySQL dumps. +.IP .pgsql +backup action for safe PostgreSQL dumps. +.IP .ldap +backup action for safe OpenLdap dumps. +.IP .sys +backup action for general system reports and hardware information. +.IP .svn +backup action for safe backups of subversion repositories. +.IP .trac +backup action for safe backups of trac repositories. +.IP .makecd +backup action for burning backups to CD/DVD or creating ISOs. + +.TP +These files must be owned by root and must not be world or group readable/writable. Support for additional configuration types can be added by dropping bash scripts with the name of the suffix into /usr/share/backupninja. +.TP +The configuration files are processed in alphabetical order. However, it is suggested that you name the config files in "sysvinit style." +.TP +For example: + 10-local.ldap.disabled + 15-runthisfirst.sh + 20-runthisnext.mysql + 90-runthislast.rdiff +.TP +Typically, you will put a '.rdiff' config file last, so that any database dumps you make are included in the filesystem backup. Action configurations which end with .disabled are skipped. +.TP +Example templates for the action configuration files can be found in /usr/share/doc/backupninja/examples. You can also use \fBninjahelper(1)\fP, a console based "wizard" for creating backup actions. + +.SH SCHEDULING + +By default, each configuration file is processed everyday at 01:00 (1 AM). This can be changed by specifying the 'when' option in a backup action's config file or in the global configuration file. + +For example: + when = sundays at 02:00 + when = 30th at 22 + when = 30 at 22:00 + when = everyday at 01 + when = Tuesday at 05:00 + when = hourly + +These values for "when" are invalid: + when = tuesday at 2am + when = tuesday at 2 + when = tues at 02 + +A configuration file will be processed at the time(s) specified by the "when" option. If multiple "when" options are present, then they all apply. If two configurations files are scheduled to run in the same hour, then we fall back on the alphabetical ordering specified above. The "when" must occur before any sections in the action configuration file. + +.SH FILE FORMAT + +The file format of the action configuration files is "ini style." Sections are created by using square bracket. Long lines are connected with a backslash. For example: + + # this is a comment + [fishes] + fish = red + fish = blue + [fruit] + apple = yes + pear = no thanks \\ + i will not have a pear. + +.SH SEE ALSO +.BR backupninja (1), +.BR ninjahelper (1), +.BR backupninja.conf (5), +.br +.SH AUTHOR +BACKUPNINJA was written by the riseup.net collective. diff --git a/man/backupninja.1 b/man/backupninja.1 new file mode 100644 index 0000000..53b1e3c --- /dev/null +++ b/man/backupninja.1 @@ -0,0 +1,137 @@ +.\" 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 1 "October 10, 2005" "riseup" "backupninja package" +.\" 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) +.SH NAME +BACKUPNINJA \- A lightweight, extensible meta-backup system +.br +.I +"a silent flower blossom death strike to lost data." +.SH SYNOPSIS +.B "backupninja [ \-h ] [ \-d ] [ \-n ] [ \-t ] [ \-f filename ] [ \-\-run filename ]" +.br +.SH DESCRIPTION +.B Backupninja +allows you to coordinate system backups by dropping a few +simple configuration files into /etc/backup.d/. Most programs you +might use for making backups don't have their own configuration file +format. Backupninja provides a centralized way to configure and +coordinate many different backup utilities. +.PP + +.SH FEATURES +.IP - 2 +easy to read ini style configuration files. +.IP - +you can drop in scripts to handle new types of backups. +.IP - +backup actions can be scheduled. +.IP - +you can choose when status report emails are mailed to you (always, on warning, on error, never). +.IP - +console-based wizard (ninjahelper) makes it easy to create backup action configuration files. +.IP - +passwords are never sent via the command line to helper programs. +.IP - +in order to backup a db or sql database, you cannot simply copy database files. backupninja helps you safely export the data to a format which you can backup. +.IP - +works with Linux-Vservers. + +.B Backup types include: +.IP - 2 +secure, remote, incremental filesytem backup (via rdiff-backup). incremental data is compressed. permissions are retained even with an unpriviledged backup user. +.IP - +basic system and hardware information. +.IP - +encrypted remote backups (via duplicity). +.IP - +safe backup of MySQL, PostgreSQL, OpenLDAP, and subversion databases. +.IP - +burn CD/DVDs or create ISOs. + +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invoke bold face and italics, +.\" respectively. + +.SH OPTIONS +.TP +.B \-h, \-\-help +Show summary of options +.TP +.B \-d, \-\-debug +Run in debug mode, where all log messages are output to the current shell. +.TP +.B \-f, \-\-conffile CONF_FILE +Use CONF_FILE for the main configuration instead of /etc/backupninja.conf +.TP +.B \-t, \-\-test +Run in test mode, no actions are actually taken. +.TP +.B \-n, \-\-now +Perform actions now, instead of when they might be scheduled. +.TP +.B \-\-run ACTION_FILE +Runs the action configuration ACTION_FILE and exits. + +.SH CONFIGURATION + +General settings are configured in /etc/backupninja.conf. In this file you +can set the log level and change the default directory locations. See \fBbackupninja.conf(5)\fP. + +To preform the actual backup actions, backupninja processes each action configuration file in +/etc/backup.d according to the file's suffix. See \fBbackup.d(5)\fP. + +.SH EXAMPLE USAGE +.TP +Backupninja can be used to impliment whatever backup strategy you choose. It is intended, however, to be used like so: +.TP +First, databases are safely copied or exported to /var/backups. Often, you cannot make a file backup of a database while it is in use, hence the need to use special tools to make a safe copy or export into /var/backups. +.TP +Then, vital parts of the file system, including /var/backups, are nightly pushed to a remote, off-site, hard disk (using rdiff-backup). The local user is root, but the remote user is not privileged. Hopefully, the remote filesystem is encrypted. +.TP +In order for this to work (ie for diff-backup to run unattended), you must create ssh keys on the source server and copy the public key to the remote user's authorized keys file. For example: +.br +root@srchost# ssh-keygen -t dsa +.br +root@srchost# ssh-copy-id -i /root/.ssh/id_dsa.pub backup@desthost +.TP +Now, you should be able to ssh from user 'root' on srchost to user 'backup' on desthost without specifying a password. When prompted for a password by ssh-keygen, just leave it blank by hitting return. The "wizard" \fBninjahelper(1)\fP will walk you through these steps. + +.SH FILES +.PD 0 +\fB/usr/sbin/backupninja\fP main script +.br +\fB/etc/backupninja.conf\fP main configuration file; general options +.br +\fB/etc/cron.d/backupninja\fP runs main script hourly +.br +\fB/etc/logrotate.d/backupninja\fP rotates backupninja.log +.br +\fB/etc/backup.d\fP directory for configuration files +.br +\fB/usr/share/backupninja\fP directory for handler scripts +.br +\fB/usr/share/doc/backupninja/examples\fP example action configuration files. +.br +.PD + +.SH SEE ALSO +.BR ninjahelper (1), +.BR backupninja.conf (5), +.BR backup.d (5), +.br +.SH AUTHOR +BACKUPNINJA was written by the riseup.net collective. diff --git a/man/backupninja.conf.5 b/man/backupninja.conf.5 new file mode 100644 index 0000000..7911fdf --- /dev/null +++ b/man/backupninja.conf.5 @@ -0,0 +1,134 @@ +.\" 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 "November 19, 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. + +.TP +.B when +When to process each configuration file. The value used here will +be applied for each configuration file. It is possibile to override +this "when" in each each configuration file, see also section +"Scheduling" in backup.d(5). + +For example: + + when = sundays at 02:00 + when = 30th at 22 + when = 30 at 22:00 + when = everyday at 01 <-- the default + when = Tuesday at 05:00 + +These values for 'when' are equivalent: + + when = tuesday at 05:30 + when = TUESDAYS at 05 + +These values for 'when' are invalid: + + when = tuesday at 2am + when = tuesday at 2 + when = tues at 02 + +.TP +.B vservers +If you are using Linux-Vservers (http://linux-vserver.org), there are some +special capabilities that different handlers have to make vserver backups easier. +See the example configuration files for each handler to configure the vserver specific +variables. + +.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 +.br +when = everyday at 01:00 +.br +vservers = no + +.SH SEE ALSO +.BR backupninja (1), +.BR ninjahelper (1), +.BR backup.d (5), +.br +.SH AUTHOR +BACKUPNINJA was written by the riseup.net collective. diff --git a/man/ninjahelper.1 b/man/ninjahelper.1 new file mode 100644 index 0000000..34b1ce4 --- /dev/null +++ b/man/ninjahelper.1 @@ -0,0 +1,62 @@ +.\" 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 NINJAHELPER 1 "january 19, 2006" "riseup" "backupninja package" +.\" 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) +.SH NAME +NINJAHELPER \- A menu driven curses-based interface to walk you through +backupninja configuration. +.br +.SH SYNOPSIS +.B "ninjahelper" +.br +.SH DESCRIPTION +.B Ninjahelper +is an helper script to walk you through configuration of the backup +tasks for backupninja. It is a curses based "wizard" with an intuitive +menu-driven interface. +.PP +.SH ADDING NEW HELPERS +.br +To add an additional 'wizard' to ninjahelper, follow these steps: +.IP (1) +create a file in the handlers directory (eg. /usr/share/backupninja) using +the .helper extention. For example, if you wish to create a helper for the +handler "blue", create the file /usr/share/backupninja/blue.helper. +.IP (2) +next, add your helper to the global HELPERS variable and define the main +function for your helper (the function name is always <helper>_wizard). To +use the blue.helper as an example: +HELPERS="$HELPERS blue:description_of_this_helper" + blue_wizard() { + ... do work here ... + } +.IP (3) +look at the existing helpers to see how they are written. Try to re-use +functions, such as the dialog functions that are defined in easydialog.sh, +or the vserver functions defined in lib/vserver. +.IP (4) +test, re-test, and test again. Try to break the helper by going backwards, +try to think like someone who has no idea how to configure your handler +would think, try to make your helper as simple as possible. Walk like a cat, +become your shadow, don't let your senses betray you. + +.SH SEE ALSO +.BR backupninja (1), +.BR backupninja.conf (5), +.BR backup.d (5), +.br +.SH AUTHOR +BACKUPNINJA was written by the riseup.net collective. |