Difference between revisions of "OS4X plugin os4xplugin gtar"

From OS4X
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
== Zweck ==
+
[[Category:Plugins]]
Alle Dateien des OS4X-Jobs werden in ein neues TAR-Archiv gepackt. Hierbei wird das im Betriebssystem (über PATH gefundene) TAR-Programm genutzt. Der Name des TAR-Archivs wird dynamisch temporär zur Laufzeit ermittelt.  
+
== Purpose ==
Verzeichnis-Hierarchien werden hierbei eliminiert.
+
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.
  
Alle Dateien des Auftrags werden aus der Auftragsbeschreibung entfernt (logisch, nicht physikalisch), das erzeugte TAR-Archiv ist dann der einzige Datei-Eintrag. Das erzeugte TAR-Archiv erhält einen temporären Namen (mit dem Präfix "<code>os4x_gtar_</code>") im [[OS4X_Core_configuration#temporary_directory|temporären OS4X-Verzeichnis]].
+
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]].
  
== Voraussetzungen ==
+
== 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.
  
* Datei <code>/etc/os4x.conf</code> bzw. Konfigurationsdatei in der Umgebungsvariable <code>$OS4X_CFGFILE</code> definiert. Über die Datenbank, die hier konfiguriert ist, wird das temporäre Verzeichnis sowie das Lizenzfile bezogen.  
+
== 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).
  
== Konfiguration ==
+
== Return codes ==
 
+
*0: everything OK
Das Programm "<code>tar</code>" wird im <code>PATH</code> der Shell gesucht, unter der das Plugin gestartet wird. Somit kann durch geschickte Positionierung oder Definition des Default-PATHs die genutzte tar-Version beeinflusst werden (unter den meisten Linux-Distributionen ist dies standardmäßig GNU TAR).
+
*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
== Rückgabewerte ==
 
*0: alles OK
 
*1: XML konnte nicht geparsed werden
 
*alle anderen: der Returncode des TAR-Aufrufs
 

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.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 "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.conf not found; Config in database not readable; License not valid; XML file invalid
  • all others: the return code of the TAR call