afclient.conf.8.in

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

no shell-like constructions such as pipes, variables or
wildcards. This program must read standard input and write
to standard output. For pattern replacements see Logging File.
.TP
.B UnprocessCmd
The counterpart to the process program. You must either
supply both process- and unprocess-program or neither of
them. Like the Process program, the unprocess-program must
read standard input and write to standard output. For pattern
replacements see LoggingFile.
.TP
.B Built-inCompressionLevel
A number, that specifies the level of built-in compression, if
present, otherwise no built-in compression will be performed.
If a processing program is also specified, the order of processing
is: First the data is piped through the external program and
then built-in compression is done. Uncompressing works the other
way round.
.TP
.B IndexFilePart
The name of the file where the names of the saved files
are stored. The current number is appended to this filename.
The number is incremented each time a full backup starts.
For pattern replacements see LoggingFile.
.TP
.B IndexProcessCmd
The program to preprocess the index file, in most cases some kind of
compression. If this parameter is not set, it defaults to the setting
of the ProcessCmd. If you set it, you MUST also supply the
appropriate unprocess- program. Note that this program may be
specified with options but no shell-like constructions such as
pipes, variables or wildcards. This program must read standard
input and write to standard output. For pattern replacements see
LoggingFile
.TP
.B IndexUnprocessCmd
The counterpart to the index processing program. If not given, it
defaults to the setting of the UnprocessCmd. You must either
supply both process- and unprocess-program or neither of them.
Like the index process program, the unprocess-program must read
standard input and write to standard output. For pattern
replacements see LoggingFile
.TP
.B ProcessBackupedFiles
This flag specifies, whether the files, that are saved,
should be processed by the configured processing program.
.TP
.B ProcessLogfiles
This flag specifies, whether the filename logging files
should be processed by the configured processing program.
.TP
.B DoNotProcess
These patterns or filenames specify files, that no processing
is attempted on. Normally this is done for all files. This
might be unefficient, e.g. compressing files, that are already
compressed, so their compression can be suppressed with this
parameter. The value of this parameter must be a list separated
by whitespace. Double quotes may enclose list elements.
.TP
.B NumIndexesToStore
This number determines how many log files of previous full
backups are saved. These files may serve for the restore
of older files than those present in the current backup.
Of course there must be sufficient space to hold all the
data for the backups. It doesn't help to save all the
saved filenames but not to have them available on tape.
.TP
.B DaysToStoreIndexes
Instead of the number of index files to be kept (previous
parameter), their maximum age can be configured in days
(floating point number allowed). Older index files will
be automatically removed. If this parameter is configured
and the previous one at the same time, the longer duration
will be applied to avoid accidental removal of indexes on
configuration errors.
.TP
.B NumIndexesToScan
This is the maximum number of index files, that will be
scanned during restore. This can be helpful, if it takes
too much time to scan through all index files, what is
done, if restrictions are given, such as before time, after
time or certain tapes. This parameter can be overridden by
option -N of afrestore.
.TP
.B DaysToScanIndexes
Instead of configuring the maximum number of index files
to be scanned (previous parameter), their maximum age in
days can be configured (floating point number allowed).
This parameter can be overridden by option -O of afrestore.
.TP
.B CheckRestoreAccessPerms
When this flag is set, during restore started by a normal
user (not the superuser) it is checked, whether the user
has sufficient access permissions in the directory, where
the files are recovered. When relocating using option -C
this is default behaviour. With this flag set it will be
enforced also when not relocating. This has pros and cons.
It might be desirable, that users can also restore their
own files in directories owned by root (e.g. at-job files
or the CDE calendar stuff). On the other side this might
be considered a security problem.
.TP
.B LoggingFile
The name of a file error messages or other notable events
are written to. A dash - stands for no logging. The pattern
%V will be replaced with the full path to the var-directory,
%B with the bin directory, %L with the lib directory, %C with
the configuration directory and %I with the logging directory
(usually == %V)
.TP
.B ClientIdentifier
The identifier for the client. Default: The official hostname.
This entry is required, it several afbackup clients reside on
one host and the multi stream server is used. In this case the
multi stream server must be able to distinguish the clients to
distribute the pieces of backup data on tape correctly.
Otherwise the data would be mixed up and be unusable for the
reading client.
The multi-stream server writes the data to backup piecewise to
tape, each chunk preceded with an identifier. This identifier
is by default the official hostname of the connected client.
If several client programs are running on the same client
host, this procedure must fail. Any data prefixed with the
name of the client would be delivered to the client program
when reading (restore, verify, ...) and thus be a mixture of
data previously sent to the server by both client programs
with the same identifier (official hostname by default).
For this reason the server denies to serve several connected
clients with the same identifier. If several afbackup clients
should be installed on one host, different client identifiers
must be set in their configuration files.
.TP
.B VarDirectory
The directory, where varying files should be put in.
These files must not be deleted. The information they
contain is necessary for restore.
.TP
.B EncryptionKeyFile
The file containing the encryption key for authenticating
the backup client to the server. This file must contain
at least 5 characters and must not have read permission
for group or world. For pattern replacements see LoggingFile.
.TP
.B LockFile
To prevent client programs from being started several times
a lock file is created and this is it's name.
For pattern replacements see LoggingFile.
.TP
.B StartupInfoProgram
This is the (shell-) command to run to save the startup
information of an incremental or full backup, sometimes
called bootstrap information. This program should read the
standard input and do something reasonable with it, e.g.
append it to some file. The produced information can be
used to recover from a hard crash, when the files are
lost, that are containing the names of the saved files.
Therefore this information should not be saved locally on
the client host, but e.g. on an NFS-mounted filesystem, a
floppy disc or in a mail-file (then this command should
be sth. like: mail someuser). For pattern replacements
see LoggingFile.
.TP
.B InitProgram
A (shell-) command to be run before a backup is attempted.
If this program returns an exit status unequal to 0, no
backup is performed. This parameter makes only sense when
backup is started remotely, cause in that case no shell-
command can be supplied. If backup is started locally, there
is no problem to run whatever is necessery before the backup
explicitly. For pattern replacements see LoggingFile.
.TP
.B ExitProgram
This parameter may specify a (shell-) command to run at
exit time of a full or incremental backup. The following
patterns are replaced as explained:
.B %l 
by the name of the file containing the filelists
.br
.B %r
by the name of the file containing statistics (this
file is automatically removed after execution of this
program)
.br
.B %e
by the overall exit status
.br
.B %i
with the minimum restore information
.br
For more pattern replacements see LoggingFile.
Under very troublesome circumstances (e.g. several clients are
trying to connect a busy single stream server and timeout, or a
client program is killed) it might happen, that the ExitProgram
is not executed. If you rely on the actions of the ExitProgram
you better implement the desired functionality outside of the
afbackup system.
.SH FILES
.IP @serverlibdir@/@serverconf@
Server configuration file
.IP @serverlogdir@
The directory for logging the server actions
.IP @servervardir@
Some internal state information of the server.
.SH SEE ALSO
afclientconfig(8), xafclientconfig(8), full_backup(8),
incr_backup(8), afverify(8), afrestore(8), xafrestore(8),
update_indexes(8), 
copy_tape(8), afclient.conf(8), afserver(8), afmserver(8),
afserver.conf(8), tar(1) 
.SH AUTHOR
.B afbackup 
was written by Albert Fluegel ([e-mail]). This manpage was
extracted from the text docs by Christian Meder 
([e-mail]).