Subversion Repositories general

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
1365 dev 1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2
.\"
3
.\" Standard preamble:
4
.\" ========================================================================
5
.de Sh \" Subsection heading
6
.br
7
.if t .Sp
8
.ne 5
9
.PP
10
\fB\\$1\fR
11
.PP
12
..
13
.de Sp \" Vertical space (when we can't use .PP)
14
.if t .sp .5v
15
.if n .sp
16
..
17
.de Vb \" Begin verbatim text
18
.ft CW
19
.nf
20
.ne \\$1
21
..
22
.de Ve \" End verbatim text
23
.ft R
24
.fi
25
..
26
.\" Set up some character translations and predefined strings.  \*(-- will
27
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28
.\" double quote, and \*(R" will give a right double quote.  | will give a
29
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31
.\" expand to `' in nroff, nothing in troff, for use with C<>.
32
.tr \(*W-|\(bv\*(Tr
33
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34
.ie n \{\
35
.    ds -- \(*W-
36
.    ds PI pi
37
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39
.    ds L" ""
40
.    ds R" ""
41
.    ds C` ""
42
.    ds C' ""
43
'br\}
44
.el\{\
45
.    ds -- \|\(em\|
46
.    ds PI \(*p
47
.    ds L" ``
48
.    ds R" ''
49
'br\}
50
.\"
51
.\" If the F register is turned on, we'll generate index entries on stderr for
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53
.\" entries marked with X<> in POD.  Of course, you'll have to process the
54
.\" output yourself in some meaningful fashion.
55
.if \nF \{\
56
.    de IX
57
.    tm Index:\\$1\t\\n%\t"\\$2"
58
..
59
.    nr % 0
60
.    rr F
61
.\}
62
.\"
63
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64
.\" way too many mistakes in technical documents.
65
.hy 0
66
.if n .na
67
.\"
68
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70
.    \" fudge factors for nroff and troff
71
.if n \{\
72
.    ds #H 0
73
.    ds #V .8m
74
.    ds #F .3m
75
.    ds #[ \f1
76
.    ds #] \fP
77
.\}
78
.if t \{\
79
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80
.    ds #V .6m
81
.    ds #F 0
82
.    ds #[ \&
83
.    ds #] \&
84
.\}
85
.    \" simple accents for nroff and troff
86
.if n \{\
87
.    ds ' \&
88
.    ds ` \&
89
.    ds ^ \&
90
.    ds , \&
91
.    ds ~ ~
92
.    ds /
93
.\}
94
.if t \{\
95
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101
.\}
102
.    \" troff and (daisy-wheel) nroff accents
103
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110
.ds ae a\h'-(\w'a'u*4/10)'e
111
.ds Ae A\h'-(\w'A'u*4/10)'E
112
.    \" corrections for vroff
113
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115
.    \" for low resolution devices (crt and lpr)
116
.if \n(.H>23 .if \n(.V>19 \
117
\{\
118
.    ds : e
119
.    ds 8 ss
120
.    ds o a
121
.    ds d- d\h'-1'\(ga
122
.    ds D- D\h'-1'\(hy
123
.    ds th \o'bp'
124
.    ds Th \o'LP'
125
.    ds ae ae
126
.    ds Ae AE
127
.\}
128
.rm #[ #] #H #V #F C
129
.\" ========================================================================
130
.\"
131
.IX Title "FSBACKUP 1"
132
.TH FSBACKUP 1 "2002-05-16" "perl v5.8.5" "User Contributed Perl Documentation"
133
.SH "NAME"
134
fsbackup \- file system backup and synchronization utility. 
135
.SH "SYNOPSIS"
136
.IX Header "SYNOPSIS"
137
.Vb 1
138
\&    fsbackup.pl [options] <configuration file>
139
.Ve
140
.SH "DESCRIPTION"
141
.IX Header "DESCRIPTION"
142
\&\f(CW\*(C`fsbackup.pl\*(C'\fR is a incremental backup creation utility. 
143
\&\f(CW\*(C`fsbackup.pl\*(C'\fR support backup compression and encryption. Backup can be stored
144
on local file system and on remote host stored over \s-1SSH\s0 or \s-1FTP\s0. Some addition 
145
scripts allow backups \s-1SQL\s0 tables from PostgreSQL and MySQL (\f(CW\*(C`pgsql_backup.sh\*(C'\fR 
146
and \f(CW\*(C`mysql_backup.sh\*(C'\fR)), save system configuration files and list of installed 
147
packages (\f(CW\*(C`sysbackup.sh\*(C'\fR). 
148
Backuped with \f(CW\*(C`fsbackup.pl\*(C'\fR files can be recovered by script \f(CW\*(C`fsrestore.sh\*(C'\fR,
149
backuped with \f(CW\*(C`sysbackup.sh\*(C'\fR system packeges can be reinstalled by \f(CW\*(C`sysrestore.sh\*(C'\fR
150
.SH "OPTIONS"
151
.IX Header "OPTIONS"
152
The following command-line options can be used with \f(CW\*(C`fsbackup.pl\*(C'\fR:
153
.ie n .IP """\-n""" 4
154
.el .IP "\f(CW\-n\fR" 4
155
.IX Item "-n"
156
Create new backup without checking files in previously stored hash.
157
.ie n .IP """\-f""" 4
158
.el .IP "\f(CW\-f\fR" 4
159
.IX Item "-f"
160
Create full backup, like as \f(CW\*(C`\-n\*(C'\fR option.
161
.ie n .IP """\-h""" 4
162
.el .IP "\f(CW\-h\fR" 4
163
.IX Item "-h"
164
Only rebuild hash, no storing files in backup archive.
165
.ie n .IP """\-c""" 4
166
.el .IP "\f(CW\-c\fR" 4
167
.IX Item "-c"
168
Clean incremental backup storage and create new full backup without checking
169
\&\f(CW$cfg_increment_level\fR config parameter.
170
.SH "ADDITION SCRIPTS"
171
.IX Header "ADDITION SCRIPTS"
172
.ie n .IP """create_backup.sh""" 4
173
.el .IP "\f(CWcreate_backup.sh\fR" 4
174
.IX Item "create_backup.sh"
175
Backup planner running from \f(CW\*(C`crontab\*(C'\fR. For example: 
176
.Sp
177
18 4 * * * /usr/local/fsbackup/create_backup.sh
178
.ie n .IP """install.pl""" 4
179
.el .IP "\f(CWinstall.pl\fR" 4
180
.IX Item "install.pl"
181
Script to install fsbackup package and some required perl modules.
182
.ie n .IP """fsbackup.pl""" 4
183
.el .IP "\f(CWfsbackup.pl\fR" 4
184
.IX Item "fsbackup.pl"
185
File system backup utility.
186
.ie n .IP """cfg_example""" 4
187
.el .IP "\f(CWcfg_example\fR" 4
188
.IX Item "cfg_example"
189
Example of configuration file.
190
.ie n .IP """scripts/pgsql_backup.sh""" 4
191
.el .IP "\f(CWscripts/pgsql_backup.sh\fR" 4
192
.IX Item "scripts/pgsql_backup.sh"
193
.PD 0
194
.ie n .IP """scripts/mysql_backup.sh""" 4
195
.el .IP "\f(CWscripts/mysql_backup.sh\fR" 4
196
.IX Item "scripts/mysql_backup.sh"
197
.PD
198
Script for backup \s-1SQL\s0 tables from PostreSQL and MySQL.
199
.ie n .IP """scripts/sysbackup.sh""" 4
200
.el .IP "\f(CWscripts/sysbackup.sh\fR" 4
201
.IX Item "scripts/sysbackup.sh"
202
Script for store system configuration files and information about installed
203
packages.
204
.ie n .IP """scripts/fsrestore.sh""" 4
205
.el .IP "\f(CWscripts/fsrestore.sh\fR" 4
206
.IX Item "scripts/fsrestore.sh"
207
Script for restore files backuped by \f(CW\*(C`fsbackup.pl\*(C'\fR.
208
.ie n .IP """scripts/sysrestore.sh""" 4
209
.el .IP "\f(CWscripts/sysrestore.sh\fR" 4
210
.IX Item "scripts/sysrestore.sh"
211
Script for reinstall packages stored by \f(CW\*(C`sysbackup.sh\*(C'\fR.
212
.SH "CONFIGURATION FILE"
213
.IX Header "CONFIGURATION FILE"
214
.IP "\fB$cfg_backup_name\fR = 'test_host'" 4
215
.IX Item "$cfg_backup_name = 'test_host'"
216
Name of backup, single word.
217
.IP "\fB$cfg_cache_dir\fR = '/usr/local/fsbackup/cache'" 4
218
.IX Item "$cfg_cache_dir = '/usr/local/fsbackup/cache'"
219
Path of internal cache directory for local backup method.
220
.IP "\fB$prog_md5sum\fR = 'md5sum \-b'" 4
221
.IX Item "$prog_md5sum = 'md5sum -b'"
222
.PD 0
223
.IP "\fB$prog_tar\fR = 'tar'" 4
224
.IX Item "$prog_tar = 'tar'"
225
.IP "\fB$prog_ssh\fR = 'ssh'" 4
226
.IX Item "$prog_ssh = 'ssh'"
227
.IP "\fB$prog_rm\fR = 'rm'" 4
228
.IX Item "$prog_rm = 'rm'"
229
.IP "\fB$prog_gzip\fR = 'gzip'" 4
230
.IX Item "$prog_gzip = 'gzip'"
231
.IP "\fB$prog_pgp\fR = 'gpg'" 4
232
.IX Item "$prog_pgp = 'gpg'"
233
.PD
234
Full path of some external program running from \f(CW\*(C`fsbackup.pl\*(C'\fR.
235
\&\fB$prog_gzip = ''\fR \- not use compression, \fB$prog_pgp = ''\fR \- not use 
236
encryption.
237
.IP "\fB$cfg_checksum\fR = 'timesize'" 4
238
.IX Item "$cfg_checksum = 'timesize'"
239
File checksum method: 
240
.Sp
241
timesize \- checksum of file attributes (default, best speed) 
242
.Sp
243
md5      \- checksum of file attributes + \s-1MD5\s0 checksum of file content.
244
.IP "\fB$cfg_backup_style\fR = 'backup'" 4
245
.IX Item "$cfg_backup_style = 'backup'"
246
Backup style:
247
.Sp
248
backup \- incremental backup (copy only new and changed files).
249
.Sp
250
full_backup \- full backup (copy all files).	
251
.Sp
252
sync \- file tree synchronization.
253
.Sp
254
hash \- hash creation without storing archive (spying for new or changed files).
255
.IP "\fB$cfg_increment_level\fR = 7" 4
256
.IX Item "$cfg_increment_level = 7"
257
Incremental level (after how many incremental copy make full refresh of backup)
258
.IP "\fB$cfg_type\fR = 'remote_ssh'" 4
259
.IX Item "$cfg_type = 'remote_ssh'"
260
Type of backup storage:
261
.Sp
262
.Vb 3
263
\&    local  - store backup on local file system.
264
\&    remote_ssh - store backup on remote host over SSH connection.
265
\&    remote_ftp - store backup on remote FTP server.
266
.Ve
267
.IP "\fB$cfg_remote_host\fR = 'backup\-server.test.ru'" 4
268
.IX Item "$cfg_remote_host = 'backup-server.test.ru'"
269
.PD 0
270
.IP "\fB$cfg_remote_login\fR = 'backup_login'" 4
271
.IX Item "$cfg_remote_login = 'backup_login'"
272
.IP "\fB$cfg_remote_path\fR = '/home/backup_login/backup'" 4
273
.IX Item "$cfg_remote_path = '/home/backup_login/backup'"
274
.PD
275
Connection parameters for remote_ssh storage type.
276
.IP "\fB$cfg_remote_password\fR = 'Test1234'" 4
277
.IX Item "$cfg_remote_password = 'Test1234'"
278
Password of remote login for remote_ftp storage type.
279
.IP "\fB$cfg_local_path\fR = '/var/backup/'" 4
280
.IX Item "$cfg_local_path = '/var/backup/'"
281
Path of directory to store backup on local file system for local storage type.
282
.IP "\fB$cfg_time_limit\fR = 0" 4
283
.IX Item "$cfg_time_limit = 0"
284
Limit of file creation time in days. If not 0, don't backup files created or 
285
modified later then \f(CW$cfg_time_limit\fR (days).
286
.IP "\fB$cfg_size_limit\fR = 0" 4
287
.IX Item "$cfg_size_limit = 0"
288
Limit of maximum file size. If not 0, don't backup files witch size more then 
289
\&\f(CW$cfg_time_limit\fR kilobytes.
290
.IP "\fB$cfg_root_path\fR = '/'" 4
291
.IX Item "$cfg_root_path = '/'"
292
Root path for initial chdir.
293
.IP "\fB$cfg_pgp_userid\fR = ''" 4
294
.IX Item "$cfg_pgp_userid = ''"
295
Name of user in public key ring with public key will be used for \s-1PGP\s0 encryption.
296
Not use encryption if not set.
297
.IP "\fB$cfg_verbose\fR = 3" 4
298
.IX Item "$cfg_verbose = 3"
299
Verbose level.
300
.Sp
301
.Vb 3
302
\&    0   - Silent mode, suspend all output, except fatal configuration errors.
303
\&    1   - Output errors and warnings.
304
\&    2   - Output all the  available  data.
305
.Ve
306
.IP "\fB$cfg_save_old_backup\fR = 1" 4
307
.IX Item "$cfg_save_old_backup = 1"
308
Save previous backup to \s-1OLD\s0 directory before rotation or before storing full backup.
309
.Sp
310
.Vb 2
311
\&    0 - don't save old backup
312
\&    1 - save old backup.
313
.Ve
314
.IP "\fB$cfg_maximum_archive_size\fR = 0" 4
315
.IX Item "$cfg_maximum_archive_size = 0"
316
Size of maximum size (in KiloBytes) of single unpacked archive file (0 \- unlimited file size).
317
.IP "\fB$cfg_stopdir_prune\fR = 0" 4
318
.IX Item "$cfg_stopdir_prune = 0"
319
Recursive review of the prohibited directories.
320
 
321
    1 \- not use a recursive entrance to directory prohibited for backup (speed is increased, reduces flexibility of customization).
322
.IP "\fB_\|_DATA_\|_\fR \- list of backuped path and regexp mask." 4
323
.IX Item "__DATA__ - list of backuped path and regexp mask."
324
.Vb 3
325
\&    /dir[/file] - backup file or directory.
326
\&    !/dir[/file] - NOT include this file or directory to backup.
327
\&    # - ignore this line.
328
.Ve
329
.Sp
330
Mask:
331
.Sp
332
.Vb 6
333
\&    =~ - regexp mask for include file or directory to backup.
334
\&    f~ - regexp file mask for include file to backup.
335
\&    d~ - regexp directory mask for include directory to backup.
336
\&    =! - regexp mask for NOT include file or directory to backup.
337
\&    f! - regexp file mask for NOT include file to backup.
338
\&    d! - regexp directory mask for NOT include directory to backup.
339
.Ve
340
.Sp
341
Operation priority:
342
.Sp
343
.Vb 8
344
\&    1. =!
345
\&    2. f!
346
\&    3. f~
347
\&    4. d!
348
\&    5. =~
349
\&    6. d~
350
\&    7. !path
351
\&    8. path
352
.Ve
353
.SH "COPYRIGHT"
354
.IX Header "COPYRIGHT"
355
Copyright (c) 2001 by Maxim Chirkov <mc@tyumen.ru>
356
http://www.opennet.ru/dev/fsbackup/
357
.SH "BUGS"
358
.IX Header "BUGS"
359
Look \s-1TODO\s0 file.
360
.SH "AUTHORS"
361
.IX Header "AUTHORS"
362
Maxim Chirkov <mc@tyumen.ru>