blob: 79025689b803ea803cb2745e0fb2c9704e0db4ee (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
.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
|
