.de IN
.in +.5i
..
.de BK
.in -.5i
..
.ce
\fB\s+2Config File Format\s-2\fR
.sp 1
.NH
Introduction
.PP
The config file consists of two parts.  The first part is a list of global
assignments that will be in effect for all saves on all machines.
The second part is a list of machines to be backed up,
with each machine listing the partitions that it needs backed up.
.NH
Format of items in the file.
.LP
The format of the each token is as follows:
.IN
.IP Number .8i
Any string of digits
.IP String
Any string of characters enclosed in quotes.  The string cannot include
the quote character or a newline.
.IP Path
A string of characters beginning with a slash (/)
.BK
.NH
Global assignments
.LP
The following global assignments can be made:
.IN
mail <string>
.IN
This string is used to send a mail message to an administrator that
will show what took place on the operator's console.  If not specified,
no mail is sent.
.BK
data_file <path>
.IN
The file that holds the dates of the fullsaves.
.BK
timeout <number>
.IN
Maximum number of minutes any save on one machine should take.  If
not specified, there is no timeout.
.BK
save_name <string>
.IN
Specifies a format for creating the savelist filename.  See the
section on save name and tape name formats.
.BK
savelistdir <path>
.IN
Specifies the directory where savelists are kept.
.BK
tapedev <path>
.IN
Name of the local tape device.
.BK
sets <string> <string> . . .
.IN
Specifies the names of weekly sets of tapes.  The number of sets
listed here determines how many weeks are in the cycle of sets.
.BK
.BK
.NH
Machine list
.LP
There can be as many machines in the config file as you like.  Each has the
following format:
.DS L
.LP
.IN
machine <string>
.IN
[fullsave|incremental]
.IN
path: <path> <path> . . .
.br
when: [Sun|Mon|Tue|Wed|Thu|Fri|Sat] . . .
.br
tape: <string>
.BK
 . . .
.IN
.IN
.KE
.LP
Following is an explanation of each line:
.IN
machine <string>
.IN
Specifies the machine on which the save will take place.
.BK
[fullsave|incremental]
.IN
The type of save.  There can be more than one of these under the
machine heading to specify all saves needed.  \*Qfullsave\*U
denotes that all files in the given paths should be saved.
\*Qincremental\*U denotes that only files that have changed since the
last fullsave should be backed up.
.BK
path: <path> <path> . . .
.IN
This is a list of paths to be backed up during this save.  Note that for each
filesystem you want backed up, there must be a separate path since the save
will not cross file systems.
.BK
when: [Sun|Mon|Tue|Wed|Thu|Fri|Sat] . . .
.IN
This is a list of the days of the week on which this particular save
should be done.
.BK
tape: <string>
.IN
The name of the tape (not the device name).  This is the name given
to the tape to be inserted into the drive, and should be a name that
the operator will recognize.  This is a save/tape format string.  See
the section below on this format for more information.
.BK
.BK
.NH
Format strings
.LP
The savelist and tape name are specified as format strings.  They are used as
is unless they contain a percent (%) character.  This is an escape that
causes some other text to be inserted into the name at that point.  The
following percent formats are available:
.IN
.IP %h .8i
The hostname on which this save is taking place
.IP %d
The day of the week on which the backup was started. (ie Mon, Tue)
.IP %D
Same as %d, but the full text of the day is used (ie Monday).
.IP %s
Set name.  This is taken from the \*Qsets\*U specifier.
.IP %t
The tape name.  This is useful only in specifying save names.
