afclient.8.in

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

.TH AFCLIENT 8 "2001 April 1" "Debian Project"
.SH NAME
afclient \- controls the client functions of the afbackup package
.SH SYNOPSIS
.B afclient 
-cxtd [-[RraunlOUvgIiqQZwbjGK]]
[-D <destination>]
[-M <message>]
[-m <message-poll-interval>]
[-h <backup-server>]
[-z <proccmd> <unproccmd>]
[-T <to-extract-file/tmpdir-for-copytape>]
[-C <cartridge-number>]
[-F <filenumber-on-tape>]
[-f <archive-filename>]
[-e <errorlog-filename>]
[-p <server-port-number>]
[-N <newer-than-filename>]
[-o <user-ID>]
[-k <encrption-key-file>]
[-s <dont-process-filepattern> [-s ...]]
[-H <header>]
[-V <statistics-report-file>]
[-A <after-time-seconds>]
[-B <before-time-seconds>]
[-W <identity>]
.I [<files> <directories> ...]
.br
.B afclient 
-X <program>
[ -h <backup-client> ]
.br
.B afclient 
-?  
.br
.B afclient 
-usage
.PP
The first form is similar to 
.B tar
(1), except that it contacts a
backup server, if the -f option is not supplied.
.PP
The second form is used to start a program remotely on
another host. In most cases this will be one of:
.PP
.RS
.B afclient 
-X full_backup -h <some-host>
.br
.B afclient 
-X incr_backup -h <some-host>
.br
.RE
.PP
Normally this host is a backup client and a backup is started
this way. Only programs can be started, that reside in the
directory, that is configured in the backup server's
configuration file unter "Program-Directory".
.PP
The third form produces the following help text:
.SH DESCRIPTION
This program is used to maintain archives on a backup server
host or in a file. Archives can be created, extracted or their
contents be listed. One of the following flags has always to
be supplied:
.TP
.B -c 
to create an archive
.TP
.B -x 
to extract from an archive
.TP
.B -t 
to list the contents of an archive
.TP
.B -d 
to verify (compare) the contents of an archive
.TP
.B -C  
to set a certain cartridge on the backup server
(makes only sense extracting or listing with 
.B -x 
or
.B -t, 
the writing position can't be changed by clients)
.TP
.B -F  
to set a certain file on the backup server's tape
(same applies as for 
.B -C
)
.TP
.B -q  
to printout the current cartridge and tape file number
on the backup server
.TP
.B -Q  
to printout the cartridge and tape file number for the
the next write access on the backup server
.TP
.B -X  
followed by the full path name of a program to be started on
the client. This can be used to trigger a backup remotely.
If the program needs arguments, the command together with
the arguments has to be enclosed by quotes
.TP
.B -I
to printout an index of the backups written to the current
cartridge
.TP
.B -w
to check the status of the streamer on the server side, e.g.
whether it is ready and waiting for requests to service,
see below for possible states
.TP
.B -G
to request a new cartridge for the next writing operation.
If the current writing position is already at the beginning
of a new or reused tape, nothing happens
.TP
.B -D <destination>
to make an exact copy of a tape to another one
(duplicate). See below how to specify the destination tape.
Duplication can be either from one cartridge to another on
the same server, or from one server to another one. When
copying to the same server chunks of data are stored in a
temporary directory on the client, where the command is
started, what should preferably be the source server
.TP
.B -M <message>
Send a message to the server. Messages will in the
most cases contain whitespace, so they should be enclosed
in quotes. Server messages should be sent to the single
stream server (port), the multi stream server might hang
receiving a message due to systematical reasons. Several
messages can be put into the string. They must be separated
by a real newline character or the usual C-like \n .
The following messages are currently supported:
.RS
.TP
PreciousTapes: <list-of-tapes>
The list of tapes is inserted into the table
with the tapes, that are crucial for clients
to restore all files, that are listed in all
existing index files. These tapes will not be
overwritten until explicitly permitted. This
message is generated automatically and should
not be used in other user contexts
.TP
ReuseTapes: <list-of-tapes>
The opposite of PreciousTapes. Sending this
message permits the server to overwrite the
listed tapes, though they are crucial for
some client
.TP
TapesReadOnly: <list-of-tapes>
The list of tapes is inserted into the file
listing the files, that should not be written
any more for whatever reason
.TP
TapesReadWrite: <list-of-tapes>
This reverts the status of tapes set read-only
to read-write, the opposite of TapesReadOnly
.TP
CartridgeReady
When an operator is requested to do something
the server is waiting for, this message can be
sent to trigger the server to proceed. This
message has the same effect as the cartready
command
.TP
DeleteClient: <client-identifier>
The tapes, that are marked as reserved for a
client to recover all the data in his indexes,
are freed. That is, the appropriate line is
removed from the server's precious_tapes file
.RE
.PP  
.B -c, -x, -t, -d, -X, -d
and
.B -I
are mutual exclusive. The other options can
be supplied as needed. To set the cartridge and/or the tape file
on the backup server is only making sense when not creating
an archive. The serial order of writing to tape is handled by
the server machine independently of the client.
.PP  
More options in alphabetical order:
.TP
.B -
in combination with -c: read standard input and
write it to tape, in combination with -x: read
tape and write it to standard output
.TP
.B -A <time>
process files (save or extract) modified after
the given time in seconds since 1.1.1970 00:00
.TP  
.B -a
in combination with 
.B -x
: extract all files and directories in the archive
.TP  
.B -b
don't enter buffering mode
.TP
.B -B <time>
process files (save or extract) modified before
the given time in seconds since 1.1.1970 00:00
.TP
.B -e <errlog>  
Use the file <errlog> to write error messages to
instead of the standard error output
.TP  
.B -f <file>    
write to or read from a file instead of querying
the backup server
.TP  
.B -g           
while extracting/reading: ignore leading garbage,
suppress error messages at the beginning. This
is useful when extracting from tape files, that
are not the first ones of a whole archive.
.TP
.B -H <header>
put the supplied informational header to the begin
of the backup. If a - is supplied (no space may
follow -H i.e. -H-) the information is read from
the first line of stdin. Backslash sequences of
C-like style are replaced
.TP
.B -h <host>    
use the backup server with the name <host>
default host is the machine with the name
backuphost
.TP  
.B -i           
while extracting: ignore the stored ownership and
do not restore it
.TP
.B -j
when starting to write: request starting a new
tape file
.TP
.B -K
when packing, do not keep the access time of the
file. By default after packing a filesystem entry
it's previous atime is restored
.TP  
.B -k <file>    
use the contents of the given file as encryption
key for authenticating to the server
.TP  
.B -l
for each packed or unpacked filename, if sending