Difference between revisions of "OS4X plugin os4xplugin zip"

From OS4X
Jump to navigation Jump to search
 
Line 1: Line 1:
 
[[Category:Plugins]]
 
[[Category:Plugins]]
−
== Zweck ==
 
−
Alle Dateien des OS4X-Jobs werden in ein neues ZIP-Archiv gepackt. Hierbei wird das im Betriebssystem (über PATH gefundene) ZIP-Programm genutzt. Der Name des ZIP-Archivs wird dynamisch temporär zur Laufzeit ermittelt.
 
−
Verzeichnis-Hierarchien werden hierbei eliminiert.
 
  
−
Alle Dateien des Auftrags werden aus der Auftragsbeschreibung entfernt (logisch, nicht physikalisch), das erzeugte ZIP-Archiv ist dann der einzige Datei-Eintrag.
+
== Purpose ==
 +
All files from the OS4X job will be packed into a new ZIP archive. The ZIP program in the operating system (found via PATH) is used here. The name of the ZIP archive is determined dynamically and temporarily at runtime.
 +
Directory hierarchies are eliminated here.
  
−
== Voraussetzungen ==
+
All files of the order are removed from the order description (logically, not physically); the ZIP archive created is then the only file entry.
  
−
* 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.  
+
== 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.
  
−
== Konfiguration ==
+
== Configuration ==
 +
The program "<code>zip</code>" is searched for in the <code>PATH</code> of the shell under which the plugin is started. This means that the zip version used can be influenced by clever positioning or definition of the default PATH.
  
−
Das Programm "<code>zip</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 zip-Version beeinflusst werden.
+
== Return codes ==
−
 
+
*0: everything OK
−
== Rückgabewerte ==
+
*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: alles OK
+
*all others: the return code of the ZIP call
−
*1: XML konnte nicht geparsed werden
 
−
*alle anderen: der Returncode des ZIP-Aufrufs
 

Latest revision as of 08:48, 29 July 2024


Purpose

All files from the OS4X job will be packed into a new ZIP archive. The ZIP program in the operating system (found via PATH) is used here. The name of the ZIP archive is determined dynamically and temporarily at runtime. Directory hierarchies are eliminated here.

All files of the order are removed from the order description (logically, not physically); the ZIP archive created is then the only file entry.

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 "zip" is searched for in the PATH of the shell under which the plugin is started. This means that the zip 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
  • all others: the return code of the ZIP call
Retrieved from "https://wiki.os4x.com/index.php?title=OS4X_plugin_os4xplugin_zip&oldid=3770"