afclient.conf.8.in

一套客户/服务器模式的备份系统代码,跨平台,支持linux,AIX, IRIX, FreeBSD, Digital Unix (OSF1), Solaris and HP-UX.

.TH AFCLIENT.CONF 8 "2001 April 1" "Debian Project"
.SH NAME
@clientconf@ \- client side configuration file for afbackup
.SH DESCRIPTION
This file needs not be edited by hand with an editor,
instead the program @clientbindir@/afclientconfig
can be used. If you are 
running X, the programs are the same, but start with an 'x';
(Tcl/Tk must be installed): 
and @clientbindir@/xafclientconfig.
The parameters described below are the same for both versions.
Entries consist of lines starting with the parameter name,
then follows a colon and the value of the parameter. Comment
lines can be inserted as desired starting with the # character.
.SH ENTRIES
.TP
 BackupHosts
These are the hostnames of the machines where a server side
of the backup service resides. Some kind of streamer device
must be connected to these machines. The files and directories,
that should be saved, are packed, eventually processed somehow,
and then sent to the named machines, who writes them to the
connected device. The named machines are tested for service
availability. If a server is busy, the next one is tried.
BackupPorts can be configured in the same order as the host
entries supplied here. The servers in this list may be
separated by whitespace and/or commas. If a backup server
is the same host as the client, the use of the name localhost
is encouraged.
.TP
.B BackupPorts
These are the port numbers on the backup server machines, where
the backup server processes listen. The default is 2988 or the
number found in the file /etc/services (or in NIS if it is
configured). Several ports can be supplied, positionally according
to the backup server hosts supplied in the BackupHosts parameter.
The numbers can be separated by whitespace and/or commas. If
fewer numbers are supplied than backup servers, the default port
2988 applies for the rest. If more port numbers are given, the
superfluous ones are ignored.
.TP
.B CartridgeSets
The cartridge sets on the server side to use for backups.
They must bes legal number between 1 and the number of cartridge
sets configured on the appropriate server side. Several sets can
be supplied, positionally according to the backup server hosts
supplied in the BackupHosts parameter. The numbers can be separated
by whitespace and/or commas. If fewer numbers are supplied than
backup servers, the default set # 1 applies for the rest. If more
cartridge set numbers are given, the superfluous ones are ignored.
.TP
.B PrintServerMessages
By default the server sends messages about current problems or
required actions to a maintainer or, if determinable and configured,
to the
user on the client side. They cannot be seen as output on the
client side. When this parameter is set, these messages are also
output on the client side. The first word must consist of the
letters b, v, r and c i.e. messages are output during backup,
verify, restore, and/or copy-tape depending on what letters
appear. The next fields must name the respective single stream
server ports or service names according to the configured ports
in BackupPorts, i.e. wherever a multi stream port appears in the
configuration in BackupPorts, here the respective single stream
service must be named. If not given the values default to
the ones configured in BackupPorts. If this parameter is not properly
configured, the messages might not be seen on the client side
for technical reasons.
.TP
.B RootDirectory
This is the directory, the backup client changes to before
packing the files and directories. Their names should be
supplied relative to this directory, e.g. ./home .
.TP
.B DirsToBackup
These are the names of files and directories, that should be
saved. Wildcards in the usual manner are allowed (shell-
style or glob-style). They should be supplied relative to
the working directory, the client changes to when starting.
Descending into directories can be limited to the current
filesystem by preceding the filename with the four
characters .//. or the option -m (and a space). The prefix .//.
is stripped off the name before saving. Supplying a filename
preceded with the four characters /../ (what makes no sense
normally) or the option -r (and a space) forces the file
contents to be saved regardless of the file type. This way
raw partitions or similar things can be saved. The prefix
/../ is stripped off the name before saving. These file
contents are by default never processed for safety reasons.
If you want to force processing nonetheless, use //../ as
prefix or precede the name with the option -R (and a space).
To save the output of a command, supply (in double quotes) a
triple bar |||, followed by a space and the command. Another
triple bar must follow, after that another command doing the
opposite of the first one. This command gets the data written
by the first one as input at restore time. A triple sharp ###
and a comment may follow.
A command can be supplied here, whose output is read and used
as if it were written here literally. If this is desired, the
entry must start with a bar |, followed by a mandatory space
and the shell-command to execute. If the pattern %T appears
in this command, it is replaced with a specifier for the type
of backup: F, if it's a full backup; F<N>, if the full backup
is split into several parts with <N> being the part number,
e.g. F2; I, if it's an incremental backup; L<N> for a level <N>
backup e.g. L5
.TP
.B DirsToBackupX
These are the names of files and directories, that should
be saved as part X. Wildcards in the usual manner are
allowed (shell-style or glob-style). They should be
supplied relative to the working directory the client
changes to when starting (See: RootDirectory). Descending
into directories can be limited to the current filesystem by
preceding the filename with the four characters .//. or
the option -m (and a space). The prefix .//. is stripped
off the name before saving. Supplying a filename preceded
with the four characters /../ (what makes no sense normally)
or the option -r (and a space) forces the file contents to
be saved regardless of the file type. This way raw
partitions or similar things can be saved. The prefix /../
is stripped off the name before saving. These file contents
are by default never processed for safety reasons. If you
want to force processing nonetheless, use //../ as prefix
or precede the name with the option -R (and a space). To
save the output of a command, supply (in double quotes) a
triple bar |||, followed by a space and the command. Another
triple bar must follow, after that another command doing the
opposite of the first one. This command gets the data written
by the first one as input at restore time. A triple sharp ###
and a comment may follow.
A command can be supplied here, whose output is read and used
as if it were written here literally. If this is desired, the
entry must start with a bar |, followed by a mandatory space
and the shell-command to execute. If the pattern %T appears
in this command, it is replaced with a specifier for the type
of backup: F, if it's a full backup; F<N>, if the full backup
is split into several parts with <N> being the part number,
e.g. F2; I, if it's an incremental backup; L<N> for a level <N>
backup e.g. L5
These parameters may only be supplied if the parameter
NumBackupParts is set greater than 1 (!). Otherwise they
must be commented out to prevent a mismatch.
.TP
.B FilesToSkip
These are the names of files, that should not be saved.
Wildcards in the usual manner are allowed (shell-style or
glob-style, furthermore path-patterns in the style of GNU's
find program with option -path. Note, that e.g. a*d matches
ab/cd). E.g. it does not usually make much sense to back up
object files, as they can be easily reproduced from existing
program sources.
.TP
.B DirsToSkip
These are the names of directories, that should not be saved.
Wildcards in the usual manner are allowed (shell-style or
glob-style, furthermore path-patterns in the style of GNU's
find program with option -path. Note, that e.g. a*d matches
ab/cd). E.g. it does not usually make much sense to back up
the lost+found directory or such only containing object files,
as they can be easily reproduced from existing program sources.
.TP
.B FilesystemTypes
A list of filesystem types, separated by whitespace
and/or commas. The type names can be prefixed
with a plus, what is identical with no prefix,
with a dash - or a slash / . No prefix or a plus
means, that only files in filesystems of the
given type are saved, no others. A minus means,
files in a filesystem of the named type are not
saved, nonetheless such filesystems are traversed
to search for filesystems of other types probably
mounted underneath. The slash means, that such
filesystems are not even entered or traversed
.TP
.B ExcludeListFile
A file with the name supplied here can be present in any
directory. It should contain a list of file-/directory-names
(or glob-style patterns), that should be skipped during backup.
Each entry must be in an own line. The given names/patterns are
valid only in the same directory, where the file resides. Thus
each directory can have it's individual exclusion list."
.TP
.B WriteChecksums
This flag specifies, whether CRC32 checksums are written to
the backup or not. Checksumming costs performance but might
be desired to achieve additional safety, that the recovered
files are intact
.TP
.B UseCTime
When this flag is set, not only a filesystem entry's modification
time (mtime) is evaluated when selecting objects to store during
incremental or a level X backup, but also the inode change time
(ctime). In this mode the filesystem entries access time (atime)
is not restored to the value it had before saving it, because
that would again change the ctime, thus each incremental backup
would result in a full backup
.TP
.B NumBackupParts
If you have to backup a large amount of files and the
full backup can't be done during one run (e.g. over a
weekend), you can divide the full backup into pieces.
This number determines, how many pieces you need. If
this number is not equal to 1, you have to supply which
files and directories you want to save in which piece.
You do so by setting the parameters DirsToBackupX with X
equal to the number of the backup part the files belong
to.
.TP
.B ProcessCmd
If you want your files to be processed during save (e.g.
compressed), you can supply the name of the program that
should perform the desired processing here. If you do so,
you MUST also supply the appropriate unprocess- program.
Note that this program may be specified with options but