NAME

incfile - create, restore an incremental filesystem archive

SYNOPSIS

incfile -B [-dilmortvxAENSV] bkjobid ofsname  ofsdev  ofslab
descript

incfile -T bkjobid tocfname descript

incfile -RC [-dilmortvxAENSV] ofsname ofsdev refsname  redev
rsjobid descript

incfile  -RF  [-dilmortvxAENSV]  ofsname   ofsdev   descript
rsjobid:uid:date:type:name
[:[rename]:[inode]] ...

DESCRIPTION

incfile is invoked as a child process by other shell commands. The command name, incfile, is read either from the bkhist.tab file or the bkreg -m command and option. The -B, -T, -R, -F, and -C options are passed to incfile by the shell commands backup, restore, and urestore(1) described below. The minus options are passed from the bkhist.tab file or the bkreg -p command and option. The arguments are sent to incfile from various locations in the backup service.

incfile -B is invoked as a child process by the bkdaemon command to perform an incremental backup of the filesystem ofsname (the originating filesystem). All files in ofsname that have been modified or have had an inode change since the last full backup are archived. The resulting backup is created in cpio file format. The backup is recorded in the backup history log, /etc/bkup/bkhist.tab.

bkjobid

the job id assigned by backup. The method uses the bkjobid when it creates history log and table-ofcontents entries.

ofsname

the name of the filesystem that is to be backed up.

ofsdev

the name of the UNIX block special device on which the filesystem resides.

ofslab

the volume name on the filesystem [see labelit(1M)].

descript

is a description for a destination device in the form:

     dgroup:dname:dchar:dlabels
dgroup specifies a device group [see devgroup.tab(4)].
dname  specifies  a   particular   device   name   [see
device.tab(4)].
dchars specifies characteristics  associated  with  the
device.  If specified, dchar overrides the defaults for
the specified device and group.  [See device.tab(4) for
a further description of device characteristics].
dlabels specifies the volume names for the media to  be
used for reading or writing the archive.

incfile -T is invoked as a child process by the backup to archive a table-of-contents on the volumes described by descript.

tocfname

the name of the file containing the table-of-contents.

incfile -RC and incfile -RF are invoked as child processes by the rsoper command to extract files from an incremental filesystem archive created by incfile -B. The filesystem archive is assumed to be in cpio format.

If the -RC option is selected, all files recorded in the archive are restored.

refsname

if non-null, the name of the filesystem to be restored to instead of ofsname.

redev

if non-null, the partition to be restored to instead of ofsdev.

At least one of refsname and redev must be null.

If the -RF option is specified, only selected objects from the archive are restored. Each 7-tuple, composed of rsjobid:uid:date:type:name:rename:inode, specifies an object to be restored from the filesystem archive. The 7-tuple objects come to incfile from the rsstatus.tab file.

rsjobid

the restore jobid assigned by restore or urestore.

uid the real uid of the user who requested the object to be restored. It must match the uid of the owner of the object at the time the archive was made, or it must be the superuser uid.

date the newest "last modification time" that is  acceptable
     for  a  restorable object.  The object is restored from
     the archive immediately older than this date.  date  is
     a  hexadecimal representation of the date and time pro-
     vided by the time system call.

type either F or D, indicating that the object is a file  or
     a directory, respectively.

name the name the object had in the filesystem archive.

rename

the name that the object should be restored to (it may differ from the name the object had in the filesystem archive). If omitted, the object is restored to name.

inode

the inode number of the object as it was stored in the filesystem archive. [inode] is not used by incfile -R, and is provided only for command-line compatibility with other restoral methods.

Options

Some options are only significant during incfile -B invocations; they are accepted but ignored during incfile -R invocations because the command is invoked and options are specified automatically by restore. These options are flagged with an asterisk (*).

d* Inhibits the recording of the archive in the backup history log.

i* Excludes from the backup those files that have only had an inode change.

l* Creates a long form of the backup history log that includes a table of contents for the archive. This includes the data used to generate a listing of each file in the archive like that produced by the ls -l command.

m* Mounts the originating filesystem read-only before starting the backup and remounts it with its original permissions after completing the backup. Cannot be used with root or /usr filesystems.

o Permits the user to override media insertion requests [see the getvol(1M), -o option].

r* Includes remotely mounted resources in the archive.

t* Creates a table of contents for the backup on additional media instead of in the backup history log.

v* Validates the archive as it is written. A checksum is computed as the archive is being written; as each medium is completed, it is re-read and the checksum is recomputed to verify that each block is readable and correct. If either check fails, the medium is considered unreadable. If -A has been specified, the archiving operation fails; otherwise, the operator is prompted to replace the failed medium.

x* Ignores the exception list; backs up all changed or modified files.

A Establishes automated mode, (i.e., does not prompt the user to insert or remove media).

E* Reports an estimate of media usage for the archive, then performs the backup.

N* Reports an estimate of media usage for the archive, but does not perform the backup.

S Displays a period (.) for every 100 (512 byte) blocks read-from or written-to the archive on the destination device.

V Displays the name of each file written-to or extracted-from the archive on the destination device.

User Interactions

The connection between an archiving method and the backup command is more complex than a simple fork/exec or pipe. The backup command is responsible for all interactions with the user, either directly, or through the bkoper command. Therefore, incfile neither reads from standard-input nor writes to standard-output or standard-error. A method library must be used [see libbrmeth(3)] to communicate reports (estimates, filenames, periods, status, etc.) to the backup command.

DIAGNOSTICS

The exit codes for incfile are the following:

0 = successful completion of the task
1 = one or more parameters to incfile are invalid.
2 = an error has occurred which caused incfile to fail to
      complete all portions of its task.

FILES

/etc/bkup/bkexcept.tab

lists the files that are to be excluded from an incremental filesystem backup.

/etc/bkup/bkhist.tab

lists the labels of all volumes that have been used for backup operations.

/etc/bkup/rsstatus.tab

tracks the status of all restore requests from users.

/etc/bkup/bklog lists errors generated by the backup methods and the backup command.

/etc/bkup/rslog logs errors generated by the restore methods and the restore command.

$TMP/filelist$$ temporarily stores a table of contents for a backup archive.

SEE ALSO

backup(1M),  bkoper(1M)  cpio(1),  cpio(4),   device.tab(4),
fdp(1), ff(1M), ffile(1), fimage(1), getvol(1M), incfile(1),
labelit(1M), libbrmeth(3), ls(1),  restore(1M),  rsoper(1M),
time(2)