Difference between revisions of "OS4X plugin os4xplugin gtar"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
[[Category:Plugins]] | [[Category:Plugins]] | ||
| − | == | + | == Purpose == |
| − | + | All files of the OS4X job are packed into a new TAR archive. The TAR program in the operating system (found via PATH) is used here. The name of the TAR archive is determined dynamically and temporarily at runtime. | |
| − | + | Directory hierarchies are eliminated here. | |
| − | + | All files in the job are removed from the job description (logically, not physically); the TAR archive created is then the only file entry. The created TAR archive receives a temporary name (with the prefix "<code>os4x_gtar_</code>") in the [[OS4X_Core_configuration#temporary_directory|temporary OS4X directory]]. | |
| − | == | + | == 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>tar</code>" is searched for in the <code>PATH</code> of the shell under which the plugin is started. This means that the tar version used can be influenced by clever positioning or definition of the default PATH (under most Linux distributions this is GNU TAR by default). | ||
| − | == | + | == 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: the return code of the TAR call | |
| − | |||
| − | |||
| − | |||
| − | * | ||
Latest revision as of 08:47, 29 July 2024
Purpose
All files of the OS4X job are packed into a new TAR archive. The TAR program in the operating system (found via PATH) is used here. The name of the TAR archive is determined dynamically and temporarily at runtime. Directory hierarchies are eliminated here.
All files in the job are removed from the job description (logically, not physically); the TAR archive created is then the only file entry. The created TAR archive receives a temporary name (with the prefix "os4x_gtar_") in the temporary OS4X directory.
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 "tar" is searched for in the PATH of the shell under which the plugin is started. This means that the tar version used can be influenced by clever positioning or definition of the default PATH (under most Linux distributions this is GNU TAR by default).
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: the return code of the TAR call