COMP

Synopsis

HELP:   Create a new or update an existing FLAM archive
TYPE:   OBJECT
SYNTAX: COMP(READ/FROM.{},TO/WRITE.{},DIR(),LOGGING.{},MESSAGE(),NORUN)

Description

The COMP subcommand can be used to write data to an archive. There are three modes of operation on archives, one of which must be selected via the TO parameter:

All existing methods (input/read) for reading original data can be used to put it into an archive. For a new archive, the FLAM parameters for compression and encryption can be specified. If the archive already exists, these are adopted or the correct values can be specified for decryption. In this case, implicit re-keying can be carried out together with writing a new version if the new version is to be provided with new rights.

To save a new archive, it must not already exist. However, you can use the OVERWRITE switch to force it to be deleted beforehand. If you access an existing archive using the OLD or MODIFY parameter, you have the option to delete the previous version or all older versions after the new version was written successfully. Remember that deleting old versions only marks the data as deleted. To actually remove all deleted segment data that is no longer required the archive must be pruned (PRUNE). Depending on the storage backend, this can be an expensive operation. For file-based archives, the whole archive is rewritten.

If you process a large number of files using directory walk via wildcards, you may not want a rollback for the entire archive if an error occurs when processing some files. In this case, you should set the NORLBK parameter to the acceptable number of errors. If this threshold is surpassed, the archive is rolled back. If you specify the parameter but do not assign a value to it, it is 2^31-1 by default. Members that are only written partially due to an error can be deleted with the REMOVE switch. If appending to an existing archive member, the entire incomplete member is deleted in the new version of the archive. If an error is encountered while opening the original file or processing its first block, nothing is written. The member remains unchanged.

To get syntax information, please use:

   flcl SYNTAX ARCHIVE.COMP

To get help for a parameter, please use:

   flcl HELP ARCHIVE.COMP.parameter[.parameter[...]]

To read the manual page for a parameter, please use:

   flcl MANPAGE ARCHIVE.COMP.parameter[.parameter[...]]
      or
   flcl HELP ARCHIVE.COMP.parameter[.parameter[...]] MAN

To generate the user manual for the command, please use:

   flcl GENDOCU ARCHIVE.COMP=filename

Parameters can be defined via command line (directly or by parameter file) or via properties taken from the corresponding property file.

Arguments