Fix typo in license headers
[oweals/cde.git] / cde / programs / dtksh / ksh93 / src / cmd / pax / bax.1
1 .\" $XConsortium: bax.1 /main/2 1996/10/29 15:40:10 drk $
2 .\"
3 .\" Glenn Fowler
4 .\" AT&T Bell Laboratories
5 .\"
6 .\" @(#)bax.1 (gsf@research.att.com) 05/09/95
7 .\"
8 .TH BAX 1
9 .SH NAME
10 bax \- tw + pax delta backup
11 .SH SYNOPSIS
12 .B bax
13 .I file
14 .I base
15 [
16 .I "dir ..."
17 ]
18 .SH DESCRIPTION
19 .I bax
20 generates backup tapes using
21 .I tw
22 and
23 .IR pax .
24 .I file
25 is the name of the backup archive to be generated.
26 If
27 .I base
28 is
29 .L \-
30 then a full backup is generated in
31 .IR file .
32 Otherwise
33 .I base
34 names a previous full backup against which a delta backup archive is
35 generated in 
36 .IR file .
37 The backup starts at the directories
38 .IR "dir ..." ,
39 .L /
40 by default.
41 File system boundaries are not crossed;  multiple file systems
42 must be specified as separate
43 .I dir
44 arguments.
45 .P
46 Variables defined in the shell script
47 .L ../lib/bax/init
48 located on
49 .L $PATH
50 customize the files and directories to be backed up.
51 The variables and their default values are:
52 .TP
53 \fBarch_name\f5='arch'\fR
54 .TP
55 \fBarch_keep\f5='bin|fun|lib'\fR
56 Shell patterns that match the architecture specific root directories and files.
57 The architecture specific files that match
58 \f5*/${\fIarch_name\f5}/*/${\fIarch_keep\f5}\fR are retained;
59 all other architecture specific files are skipped.
60 .TP
61 \fBbig_size\f5=5000000\fR
62 .TP
63 \fBbig_magic_keep\f5='mail'\fR
64 Files larger than \f5${\fIbig_size\f5}\fR must have a magic file type
65 that matches \f5${\fIbig_magic_keep\f5}\fR.
66 .TP
67 \fBname_skip\f5'?(*.)(old|save|tmp)?(.*)|.*-cache'\fR
68 File base names that match \f5${\fIname_skip\f5}\fR are skipped.
69 .TP
70 \fBpath_skip\f5='/dev|/usr/local/ast/ship'\fR
71 File path names that match \f5${\fIpath_skip\f5}\fR are skipped.
72 .TP
73 \fBreg_magic_skip\f5='core|cql * index|history|TeX dvi'\fR
74 Regular files with a magic file type that matches \f5${\fIreg_magic_skip\f5}\fR
75 are skipped.
76 .TP
77 \fBsrc_name\f5='src'\fR
78 .TP
79 \fBsrc_magic_skip\f5='executable|object|(archive|shared) library'\fR
80 Files under \f5*/${\fIsrc_name\f5}/*\fR with a magic file type that
81 matches \f5${\fIreg_magic_skip\f5}\fR are skipped.
82 .SH EXAMPLES
83 To generate a full backup on \f5/dev/st0\fP:
84 .EX
85 bax /dev/st0 -
86 .EE
87 To generate a delta backup in \f5/tmp/delta.bax\fP for the full backup above:
88 .EX
89 bax /tmp/delta.bax /dev/st0
90 .EE
91 or if you have two tape drives:
92 .EX
93 mt /dev/st1 eod # to append the next delta
94 bax /dev/st1 /dev/st0
95 .EE
96 .SH "SEE ALSO"
97 file(1), pax(1), tw(1), vdelta(3)