summaryrefslogtreecommitdiff
path: root/hardlinkedbackups.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'hardlinkedbackups.1.in')
-rw-r--r--hardlinkedbackups.1.in82
1 files changed, 0 insertions, 82 deletions
diff --git a/hardlinkedbackups.1.in b/hardlinkedbackups.1.in
deleted file mode 100644
index 7902568..0000000
--- a/hardlinkedbackups.1.in
+++ /dev/null
@@ -1,82 +0,0 @@
-.TH hardlinkedbackups 1 "" "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
-.TP
-\fBbackupStatistics [options]\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.
-\fBbackupStatistics\fP exhaustively searches backups for duplicate but not hard-linked files.
-.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
-.TP
-.B "backupStatistics"
-Exhaustively search backups defined in \fB#ETCDIR#/backup.conf\fP for duplicate files which are not hard linked.
-For detail see section \fBBACKUPSTATISTICS\fP.
-.SH BACKUPSTATISTICS
-execution happens in several stages:
-.TP
-1.
-.TP
-blabla
-.TP
-.B "-d | --dummy"
-do not modify backed up files
-.TP
-.B "-m | --max \fImaxStage\fP"
-stop execution after completing stage \fImaxStage\fP
-.TP
-.B "-s | --skip \fIskipStages\fP"
-start execution right after stage \fIskipStages\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
-.TP
-.B "cacheDir"
-directory for caching valuable information in \fBbackupStatistics\fP
-.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