config.in

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

  This is the (shell-) command to run to eject a cartridge
  currently placed inside the streamer device. This is normally
  something like  mt -f <device> rewoffl  (but better consult
  your man-pages). You have to supply this either if you have
  no cartridge handling system (robot) or if you have no
  command to set the cartridge directly by number. In the latter
  case this package tries to maintain the number of the current
  cartridge in a file and to (hopefully) keep it consistent
  with the reality. In this case the cartridge handling system
  must be configured to sequential mode (automatically putting
  the next cartridge in, when the current one is ejected). The
  pattern %c, if used in this command, will be replaced with
  number of the current cartridge, %n with the number of the
  next one, that is expected to be put into the streamer by a
  robot in sequential mode. %b can be used instead of %c if
  counting of cartridges starts with 0 and not with 1. The
  same applies for %m, what means %n minus 1. %d is replaced
  with the device name.


 Init-Media-Command

  The (shell-) command, the server runs before accessing the
  storage media for the first time or after changing it. %d
  will be replaced with the device. This command can be used
  e.g. to automatically mount a removable disk after inserting.
  This command might be called several times on the same media,
  this has to kept in mind when configuring it. For more
  pattern replacements see: Status-file


 Erasetape-Command

  The (shell-) command to run, if the tape must be erased.
  (currently not needed).
  For pattern replacements see: Status-file


 Tape-Full-Command

  The (shell-) command to run, when a tape is full. %d is
  replaced with the device name, %c with the number of the
  cartridge, that became full, %n with the number of cycles,
  the cartridge has become full until now and %C with the
  full path to the configuration file. For more pattern
  replacements see: Status-file


 User To Inform

  If you don't have a cartridge handling system (robot), a
  human maintainer must put the appropriate cartridge into the
  tape device. If you supply a mail program, an e-mail is sent
  to the user given here, which informs him, that and which
  cartridge (by number) must be put into the tape device.
  If a timespan is configured, after that an automatic e-mail
  should be sent due to an unaccessible tape device, it is
  directed to this user (see Device-unavail-send-mail-after-min)


 Mail-Program

  The mail program used to send messages to a human maintainer.
  This is done, whenever another cartridge must be put into the
  tape device and it can't be done automatically (by a robot or
  whatever). If you don't want to type the username again here,
  you can instead write %u . The pattern %U will be replaced with
  the login name of a current user on the client side, %H with
  the name of the client host. If none could be figured out, the
  entire word containing %U or %H is deleted from the command.
  If you don't want mails to be sent, you may instead supply any
  other command, that reads the standard input and does something
  reasonable with it, e.g. redirects it to the console:
   cat > /dev/console
  For more pattern replacements see: Status-file


 Var-Directory

  The directory, where varying files should be put in. These
  files should not be deleted. The information they contain is
  necessary for the server to work properly


 Tape-Pos-File

  In this file some values are stored, e.g. the number of the
  cartridge currently placed inside the streamer device. For
  pattern replacements see: Status-file


 Logging-file

  Logging information concerning errors or other notable events
  is redirected to this file. If the first word of this entry
  is starting with @, then logging is directed to the syslog as
  well. If there are characters immediately following the @,
  this word is used as the syslog identifier, otherwise the
  identifier is afbackup. If writing to the syslog is configured,
  the rest of the entry is used as additional logging file, if
  present. For more pattern replacements see: Status-file


 Status-file

  The current status of the server is written to this file. If
  it starts with >>, then the file is created and status messages
  will be appended to it. Otherwise the file is removed before
  writing.
  %L will be replaced with the full path of the lib-directory
  of the server, %B with the bin-directory, %C with the config
  directory and %V with the var-directory.


 Lock-file

  To prevent the server program from being started several times
  a lock file is created and this is it's name. For pattern
  replacements see: Status-file


 Encryption-Key-Files

  Entries specifying files, that contain encryption keys for
  authenticating backup clients to the server. Each entry
  consists of a filename, optionally followed by a colon : and
  a specifier for client selection. If an entry lacks a client
  selector, this one will apply for all clients, that are not
  matched by any other entry. The client selector is either a
  list of comma-separated hostnames, a filename starting with
  a slash / containing hostnames one per line, or a command
  starting with a bar, that is stripped off before starting
  the command. The command gets the current client name as
  input on stdin, aside from arguments containing patterns
  (see below). If the command returns an exit status of 0,
  the client name will match the entry. Entries are separated
  by whitespace. If an entry must contain whitespace, it must
  be enclosed by double quotes. If colons are needed within
  the filenames, they must be escaped using a backslash. Each
  key file must contain at least 5 characters and must not
  have read permission for group or world. The pattern %H is
  replaced with the client name resolved from the IP-address.
  %h is similar to %H, but everything from and including the
  first dot is stripped off. For more pattern replacements see:
  Status-file. 


 Program-Directory

  If you are using the remote start option for backing up
  clients, this is the directory, where programs must reside,
  that can be started remotely. No other programs can be
  started remotely (for security reasons). For pattern
  replacements see: Status-file


 Init-Command

  Here you may supply a (shell-) command to be run, when the
  backup server side wakes up, i.e. the server process starts.
  A %p appearing in this command is replaced with the name
  of the client, that connected the backup service.
  For more pattern replacements see: Status-file


 Exit-Command

  Here you may supply a (shell-) command to be run, when the
  backup server side goes to sleep, i.e. the server process ends.
  A %p appearing in this command is replaced with the name
  of the client, that connected the backup service.
  For more pattern replacements see: Status-file


Client configuration parameters
-------------------------------

 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.


 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.


 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.


 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 .


 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
  

 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.


 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