Difference between revisions of "OS4X plugin os4xplugin gzip decompress"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
[[Category:Plugins]] | [[Category:Plugins]] | ||
− | |||
− | |||
− | == | + | == Purpose == |
+ | Tests each individual file in the job to see whether it is a gzip compressed file. If successful, the file will be decompressed. If the file does not have the ending "<code>.gz</code>" it will be renamed before decompression. If the file has the ending "<code>.tgz</code>", the decompressed file will have the ending "<code>.tar</code>". | ||
− | * | + | == Requirements == |
+ | * File <code>/etc/os4x.conf</code> or configuration file referenced by environment variable <code>$OS4X_CFGFILE</code>. The temporary directory and the license file are obtained via the database that is configured here. | ||
− | == | + | == Configuration == |
+ | The program "<code>gzip</code>" is searched for in the <code>PATH</code> of the shell under which the plugin is started. This means that the gzip version used can be influenced by clever positioning or definition of the default PATH. | ||
− | + | == Return codes == | |
− | + | *0: everything OK | |
− | == | + | *1: Number of parameters != 1; Config file <code>/etc/os4x.conf</code> not found; Config in database not readable; License not valid; XML file invalid |
− | *0: | ||
− | *1: |
Latest revision as of 08:58, 29 July 2024
Purpose
Tests each individual file in the job to see whether it is a gzip compressed file. If successful, the file will be decompressed. If the file does not have the ending ".gz
" it will be renamed before decompression. If the file has the ending ".tgz
", the decompressed file will have the ending ".tar
".
Requirements
- File
/etc/os4x.conf
or configuration file referenced by environment variable$OS4X_CFGFILE
. The temporary directory and the license file are obtained via the database that is configured here.
Configuration
The program "gzip
" is searched for in the PATH
of the shell under which the plugin is started. This means that the gzip version used can be influenced by clever positioning or definition of the default PATH.
Return codes
- 0: everything OK
- 1: Number of parameters != 1; Config file
/etc/os4x.conf
not found; Config in database not readable; License not valid; XML file invalid