Difference between revisions of "OS4X plugin os4xplugin bzip2"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
[[Category:Plugins]] | [[Category:Plugins]] | ||
| − | |||
| − | + | == Purpose == | |
| + | Compressing each individual file defined in the passed XML using bzip2. The original files are exchanged in the file system using the bzip2 process. The extension ".bz2" is appended to each file. The new file name is changed in the XML file. The compression node "<code>compression</code>" in the XML is changed to "bzip2" for each file. | ||
| − | == | + | == 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>bzip2</code>" is searched for in the <code>PATH</code> of the shell under which the plugin is started. This means that the bzip2 version used can be influenced by clever positioning or definition of the default PATH. | ||
| − | + | The compression factor (0-9, where 0 represents no compression and 9 is the highest compression level) can be passed when calling the plugin via the optional configuration XML. The default compression factor is 9. | |
| − | + | == 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 | |
| − | + | *all others: return value of the bzip2 call | |
| − | == | ||
| − | *0: | ||
| − | *1: | ||
| − | * | ||
Latest revision as of 08:50, 29 July 2024
Purpose
Compressing each individual file defined in the passed XML using bzip2. The original files are exchanged in the file system using the bzip2 process. The extension ".bz2" is appended to each file. The new file name is changed in the XML file. The compression node "compression" in the XML is changed to "bzip2" for each file.
Requirements
- File
/etc/os4x.confor 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 "bzip2" is searched for in the PATH of the shell under which the plugin is started. This means that the bzip2 version used can be influenced by clever positioning or definition of the default PATH.
The compression factor (0-9, where 0 represents no compression and 9 is the highest compression level) can be passed when calling the plugin via the optional configuration XML. The default compression factor is 9.
Return codes
- 0: everything OK
- 1: Number of parameters != 1; Config file
/etc/os4x.confnot found; Config in database not readable; License not valid; XML file invalid - all others: return value of the bzip2 call