Codex SDK: Plug-In Directive Files

Compression Directive File

The Compression Directive File is a plain-text file that is created by the Codex runtime during archive compression operations. This directive file includes information about which files are to be compressed into which archive. A plug-in supporting compression needs to parse this directive file to obtain information about the compression operation desired.

Fields

destination archive file

The full path to the destination archive.

This is the first line of the directive file and is a mandatory field.

files for recursive compression

File masks, with full path information and possibly wildcards, indicating which files are to be recursively compressed into the archive. A single line must contain a single file mask. Multiple lines may be used.

This field is on the second and following lines of the directive file and is an optional field.

$

The character literal '$' (without the quotes). Indicates the list of files for recursive compression has ended.

This is a mandatory field. It can occur anywhere in the directive file starting from the second line, depending on how many lines were taken up by the files for recursive compression field.

files for non-recursive compression

File masks, with full path information and possibly wildcards, indicating which files are to be non-recursively compressed into the archive. A line must contain a single file mask. Multiple lines may be used.

This field may start as early as the third line and also take place on the following lines of the directive file. This is an optional field.

$

The character literal '$' (without the quotes). Indicates the list of files for non-recursive compression has ended. Also indicates the end of the directive file.

This is a mandatory field. It can occur anywhere in the directive file starting from the third line, depending on how many lines were taken up by the files for recursive compression and files for non-recursive compression fields, plus the character literal '$'.

Examples

If the compression directive file for a ZIP plug-in contains the following:

c:\backups\test
c:\my documents\presentation plan\*.*
c:\my documents\figures.doc
$
$

then, the ZIP plug-in should:

1. Create or update a test.zip archive in the folder "c:\backups",

2. Add the entire contents of the "c:\my documents\presentation plan" folder, with all files and subfolders to this archive,

3. Add all instances of the file "figures.doc" found under the folder "c:\my documents" and all subfolders to this archive,

4. Finish processing.

 

If the compression directive file for a GZIP plug-in contains the following:

c:\backups\test
$
c:\my documents\sales.doc
$

then, the GZIP plug-in should:

1. Create a test.gzip archive in the folder "c:\backups",

2. Add the file "sales.doc" found in the folder "c:\my documents" to this archive,

3. Finish processing.

See Also

SDK Overview, Plug-In Features, Decompression Directive File, Custom Tool Directive File