diff options
Diffstat (limited to 'hardlinkedbackups.1.in')
| -rw-r--r-- | hardlinkedbackups.1.in | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/hardlinkedbackups.1.in b/hardlinkedbackups.1.in new file mode 100644 index 0000000..480aa18 --- /dev/null +++ b/hardlinkedbackups.1.in @@ -0,0 +1,57 @@ +.TH hardlinkedbackups 8 "" "hardlinkedbackups #VERSION#" "" +.SH NAME +hardlinkedbackups \- hardlinked incremental backups via rsync (and possibly through a SOCKS\-tunnel via ssh) +.SH SYNOPSIS +.TP +\fBbackup /tmp/pidFile /path/to/destination/ user@source:path [proxy_user@ssh_host]\fP +.TP +\fBlastBackups\fP +.SH DESCRIPTION +\fBbackup\fP generates incremental backups (by hardlinking old unchanged files) via rsync and possibly a SOCKS\-tunnel. +\fBlastBackups\fP shows date of backups and warns about outdated ones. +.SH USAGE +.TP +.B "backup /tmp/pidFile /path/to/destination/ user@source:path" +Creates incremental backup in \fB/path/to/destination/\fP from \fBuser@source:path\fP, saving its PID in \fB/tmp/pidFile\fP. +.TP +.B "backup /tmp/pidFile /path/to/destination/ user@source:path proxy_user@ssh_host" +Same as above, but tunneling via SSH through \fBproxy_user@ssh_host\fP. +.TP +.B "symLinkName -> #BINDIR#/backup" +Same as one of the above. +Command line parameters are filled from variable \fB$backups["symLinkName"]\fP in \fB#ETCDIR#/backup.conf\fP. +This is designed to be called from a cron daemon for daily backups. +.TP +.B "lastBackups" +reports about actuality of backups defined in \fB#ETCDIR#/backup.conf\fP +.SH CONFIGURATION +The configfile \fB#ETCDIR#/backup.conf\fP is a bash script, which defines the following variables: +.TP +.B "excludes" +array of paths to exclude from backup +.TP +.B "backups" +array with command line arguments for predefined backups +.TP +.B "maxWait" +maximum time to wait for destination directories to appear in lastBackups [seconds] +.TP +.B "outdatedLimit" +time before backups are considered outdated [seconds] +.TP +.B "recognSubdirRegex" +regular expression of subdirectories which should be appended to the parent directory in the report +.SH FILES +.TP +.B "#BINDIR#/backup" +program for creation of backups +.TP +.B "#BINDIR#/lastBackups" +program for check of backups +.TP +.B "#ETCDIR#/backup.conf" +configuration of backups +.SH AUTHOR +.nf +Erich Eckner <opensource at eckner dot net> +.fi |