Difference between revisions of "OS4X plugin os4xplugin gzip"

From OS4X
Jump to navigation Jump to search
 
Line 1: Line 1:
 
[[Category:Plugins]]
 
[[Category:Plugins]]
== Zweck ==
 
  
Komprimieren jeder einzelnen in der übergebenen XML definierten Datei per gzip. Die Originaldateien werden hierbei im Filesystem durch den gzip-Prozess ausgetauscht. Die Endung ".gz" wird an jede Datei angehängt. Der neue Dateiname wird in der XML-Datei geändert. Das Kompressionsnode "<code>compression</code>" in der XML wird bei jeder Datei auf "gzip" umgestellt.
+
== Purpose ==
 +
Compressing every single file defined in the passed XML via gzip. The original files are exchanged in the file system using the gzip process. The extension ".gz" 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 "gzip" for each file.
  
== 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>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.
  
== Konfiguration ==
+
== Return codes ==
 
+
*0: everything OK
Das Programm "<code>gzip</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 gzip-Version beeinflusst werden.
 
 
 
== Rückgabewerte ==
 
0: alles OK
 

Latest revision as of 08:40, 29 July 2024


Purpose

Compressing every single file defined in the passed XML via gzip. The original files are exchanged in the file system using the gzip process. The extension ".gz" 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 "gzip" for each file.

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