69 lines
5.3 KiB
ReStructuredText
69 lines
5.3 KiB
ReStructuredText
.. Automatically generated by KiBot, please don't edit this file
|
|
|
|
.. index::
|
|
pair: Archiver (files compressor); compress
|
|
|
|
Archiver (files compressor)
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Generates a compressed file containing output files.
|
|
This is used to generate groups of files in compressed file format.
|
|
|
|
Type: ``compress``
|
|
|
|
|
|
Parameters:
|
|
|
|
- **comment** :index:`: <pair: output - compress; comment>` [string=''] A comment for documentation purposes. It helps to identify the output.
|
|
- **dir** :index:`: <pair: output - compress; dir>` [string='./'] Output directory for the generated files.
|
|
If it starts with `+` the rest is concatenated to the default dir.
|
|
- **name** :index:`: <pair: output - compress; name>` [string=''] Used to identify this particular output definition.
|
|
Avoid using `_` as first character. These names are reserved for KiBot.
|
|
- **options** :index:`: <pair: output - compress; options>` [dict] Options for the `compress` output.
|
|
|
|
- Valid keys:
|
|
|
|
- **files** :index:`: <pair: output - compress - options; files>` [list(dict)] Which files will be included.
|
|
|
|
- Valid keys:
|
|
|
|
- **from_output** :index:`: <pair: output - compress - options - files; from_output>` [string=''] Collect files from the selected output.
|
|
When used the `source` option is ignored.
|
|
- **source** :index:`: <pair: output - compress - options - files; source>` [string='*'] File names to add, wildcards allowed. Use ** for recursive match.
|
|
By default this pattern is applied to the output dir specified with `-d` command line option.
|
|
See the `from_cwd` and `from_output_dir` options.
|
|
- ``dest`` :index:`: <pair: output - compress - options - files; dest>` [string=''] Destination directory inside the archive, empty means the same of the file.
|
|
- ``filter`` :index:`: <pair: output - compress - options - files; filter>` [string='.*'] A regular expression that source files must match.
|
|
- ``from_cwd`` :index:`: <pair: output - compress - options - files; from_cwd>` [boolean=false] Use the current working directory instead of the dir specified by `-d`.
|
|
- ``from_output_dir`` :index:`: <pair: output - compress - options - files; from_output_dir>` [boolean=false] Use the current directory specified by the output instead of the dir specified by `-d`.
|
|
Note that it only applies when using `from_output` and no `dest` is specified.
|
|
It has more prescedence than `from_cwd`.
|
|
|
|
- **format** :index:`: <pair: output - compress - options; format>` [string='ZIP'] [ZIP,TAR,RAR] Output file format.
|
|
- **output** :index:`: <pair: output - compress - options; output>` [string='%f-%i%I%v.%x'] Name for the generated archive (%i=name of the output %x=according to format). Affected by global options.
|
|
- ``compression`` :index:`: <pair: output - compress - options; compression>` [string='auto'] [auto,stored,deflated,bzip2,lzma] Compression algorithm. Use auto to let KiBot select a suitable one.
|
|
- ``follow_links`` :index:`: <pair: output - compress - options; follow_links>` [boolean=true] Store the file pointed by symlinks, not the symlink.
|
|
- ``move_files`` :index:`: <pair: output - compress - options; move_files>` [boolean=false] Move the files to the archive. In other words: remove the files after adding them to the archive.
|
|
- *remove_files* :index:`: <pair: output - compress - options; remove_files>` Alias for move_files.
|
|
- ``skip_not_run`` :index:`: <pair: output - compress - options; skip_not_run>` [boolean=false] Skip outputs with `run_by_default: false`.
|
|
|
|
- **type** :index:`: <pair: output - compress; type>` [string=''] Type of output.
|
|
- ``category`` :index:`: <pair: output - compress; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
|
|
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
|
|
The categories are currently used for `navigate_results`.
|
|
|
|
- ``disable_run_by_default`` :index:`: <pair: output - compress; disable_run_by_default>` [string|boolean] Use it to disable the `run_by_default` status of other output.
|
|
Useful when this output extends another and you don't want to generate the original.
|
|
Use the boolean true value to disable the output you are extending.
|
|
- ``extends`` :index:`: <pair: output - compress; extends>` [string=''] Copy the `options` section from the indicated output.
|
|
Used to inherit options from another output of the same type.
|
|
- ``groups`` :index:`: <pair: output - compress; groups>` [string|list(string)=''] One or more groups to add this output. In order to catch typos
|
|
we recommend to add outputs only to existing groups. You can create an empty group if
|
|
needed.
|
|
|
|
- ``output_id`` :index:`: <pair: output - compress; output_id>` [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
|
|
- ``priority`` :index:`: <pair: output - compress; priority>` [number=10] [0,100] Priority for this output. High priority outputs are created first.
|
|
Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
|
|
- ``run_by_default`` :index:`: <pair: output - compress; run_by_default>` [boolean=true] When enabled this output will be created when no specific outputs are requested.
|
|
|