Qbs Manual | List of Modules | Module archiver

Qbs 1.8.1

# Module archiver

The `archiver` module contains the properties and rules for creating (compressed) archives. The output artifact has the file tag "archiver.archive". The sole input artifact is a text file containing the list of files to package, with one file path per line. The paths can be relative, in which case they will be looked for at `archiver.workingDirectory`. The file tag of this input artifact is "archiver.input-list".

## archiver Properties

Property | Type | Since | Default | Description
--- | --- | --- | --- | ---
flags | stringList | 1.4 | empty list | Custom options not covered by any of the other properties.
archiveBaseName | string | 1.4 | `product.targetName` | The base name of the archive file (in other words, the file name without any extensions).
compressionLevel | string | 1.4 | `undefined` | How much effort to put into the compression of a 7-Zip or zip archive. Possible values are `undefined`, "0", "1", "2", "3", "4", "5", "6", "7", "8" and "9" Higher numbers result in a smaller archive, but the compressing process will take more time. 7-Zip only supports 0 and odd numbers. A value of `undefined` means to use the default compression level.
compressionType | string | 1.4 | `"gz"` for tar archives, otherwise `undefined` | How to compress a tar or zip archive. Possible options are "none", "gz", "bz2", "Z", "xz", "deflate", "store". `undefined` uses the archiver's default compression type.
outputDirectory | string | 1.4 | `product.destinationDirectory` | Where to put the archive file.
type | string | 1.4 | `undefined` | Which kind of archiver to use. The currently supported values are: "tar", "7zip", "zip".
workingDirectory | string | 1.4 | undefined | The directory in which to execute `command`.
command | string | 1.4 | Depends on `type`. | The command with which to invoke the archiver.