[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
340
share/doc/seiscomp/html/apps/sczip.html
Normal file
340
share/doc/seiscomp/html/apps/sczip.html
Normal file
@ -0,0 +1,340 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>sczip — SeisComP Release documentation</title>
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=72bcf2f2" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
|
||||
<script type="text/javascript" src="../_static/seiscomp.js"></script>
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="seiscomp" href="seiscomp.html" />
|
||||
<link rel="prev" title="scxmlmerge" href="scxmlmerge.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="container">
|
||||
<div class="brand">
|
||||
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
|
||||
<!-- span class="title">SeisComP Release</span -->
|
||||
<span class="version">6.9.0</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="nav">
|
||||
<div class="container">
|
||||
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
||||
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<ul>
|
||||
<li class="right">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">
|
||||
index
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="seiscomp.html" title="seiscomp"
|
||||
accesskey="N">
|
||||
next
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="scxmlmerge.html" title="scxmlmerge"
|
||||
accesskey="P">
|
||||
previous
|
||||
</a>
|
||||
</li>
|
||||
<li class="nav-item nav-item-0">
|
||||
<a href="../index.html">Home</a>
|
||||
</li>
|
||||
<li class="nav-item nav-item-1">
|
||||
<a href="../modules.html" >Modules</a>
|
||||
</li>
|
||||
<li class="nav-item nav-item-2">
|
||||
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="container">
|
||||
<div class="fitted content" id="anchors-container">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="sczip">
|
||||
<span id="id1"></span><h1>sczip<a class="headerlink" href="#sczip" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>Compress or expand files with ZIP algorithm</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p>sczip can compress and decompress data using the ZIP algorithm (PKZIP). It
|
||||
is not meant to supersede any available packagers but a little helper to
|
||||
decompress zipped SeisComPML formats. Like GZip, sczip can only handle one file
|
||||
and does not support archives. It compresses a byte stream and outputs a byte
|
||||
stream.</p>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Decompress a file</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sczip<span class="w"> </span>-d<span class="w"> </span>file.xml.zip<span class="w"> </span>-o<span class="w"> </span>file.xml
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sczip<span class="w"> </span>-d<span class="w"> </span>file.xml.zip<span class="w"> </span>-o<span class="w"> </span>file.xml
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Compress a file</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sczip<span class="w"> </span>file.xml<span class="w"> </span>-o<span class="w"> </span>file.xml.zip
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>sczip<span class="w"> </span><<span class="w"> </span>file.xml<span class="w"> </span>><span class="w"> </span>file.xml.zip
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="module-configuration">
|
||||
<span id="sczip-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="line-block">
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/sczip.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/sczip.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/sczip.cfg</span></code></div>
|
||||
</div>
|
||||
<p>sczip inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
|
||||
</section>
|
||||
<section id="command-line-options">
|
||||
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading">¶</a></h2>
|
||||
<p><strong class="program">sczip file.dat -o file.zip</strong></p>
|
||||
<p><strong class="program">sczip file.dat -d -o file.zip</strong></p>
|
||||
<section id="generic">
|
||||
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-h">
|
||||
<span id="cmdoption-sczip-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-h" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show help message.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-V">
|
||||
<span id="cmdoption-sczip-version"></span><span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-V" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show version information.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-config-file">
|
||||
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-config-file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use alternative configuration file. When this option is
|
||||
used the loading of all stages is disabled. Only the
|
||||
given configuration file is parsed and used. To use
|
||||
another name for the configuration create a symbolic
|
||||
link of the application or copy it. Example:
|
||||
scautopick -> scautopick2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-plugins">
|
||||
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-plugins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load given plugins.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-D">
|
||||
<span id="cmdoption-sczip-daemon"></span><span class="sig-name descname"><span class="pre">-D</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-D" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run as daemon. This means the application will fork itself
|
||||
and doesn’t need to be started with &.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-auto-shutdown">
|
||||
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-auto-shutdown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enable/disable self-shutdown because a master module shutdown.
|
||||
This only works when messaging is enabled and the master
|
||||
module sends a shutdown message (enabled with --start-stop-msg
|
||||
for the master module).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-shutdown-master-module">
|
||||
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-shutdown-master-module" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the name of the master-module used for auto-shutdown.
|
||||
This is the application name of the module actually
|
||||
started. If symlinks are used, then it is the name of
|
||||
the symlinked application.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-shutdown-master-username">
|
||||
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-shutdown-master-username" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the name of the master-username of the messaging
|
||||
used for auto-shutdown. If "shutdown-master-module" is
|
||||
given as well, this parameter is ignored.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="verbosity">
|
||||
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-verbosity">
|
||||
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-verbosity" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
|
||||
4:debug.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-v">
|
||||
<span id="cmdoption-sczip-v"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-v" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-q">
|
||||
<span id="cmdoption-sczip-quiet"></span><span class="sig-name descname"><span class="pre">-q</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-q" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Quiet mode: no logging output.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-component">
|
||||
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-component" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Limit the logging to a certain component. This option can
|
||||
be given more than once.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-s">
|
||||
<span id="cmdoption-sczip-syslog"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-s" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use syslog logging backend. The output usually goes to
|
||||
/var/lib/messages.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-l">
|
||||
<span id="cmdoption-sczip-lockfile"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-l" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Path to lock file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-console">
|
||||
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-console" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Send log output to stdout.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-debug">
|
||||
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-debug" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Execute in debug mode.
|
||||
Equivalent to --verbosity=4 --console=1 .</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-log-file">
|
||||
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-sczip-log-file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use alternative log file.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="mode">
|
||||
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-d">
|
||||
<span id="cmdoption-sczip-decompress"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--decompress</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-sczip-d" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Decompress.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-sczip-o">
|
||||
<span id="cmdoption-sczip-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-sczip-o" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Output file name. Default is stdout.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
<div id="anchors-bottom"></div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar" role="navigation" aria-label="main navigation">
|
||||
<div id="anchors-top"></div>
|
||||
<div id="anchors" class="content">
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||||
<div>
|
||||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">sczip</a><ul>
|
||||
<li><a class="reference internal" href="#description">Description</a></li>
|
||||
<li><a class="reference internal" href="#examples">Examples</a></li>
|
||||
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
|
||||
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
|
||||
<li><a class="reference internal" href="#generic">Generic</a></li>
|
||||
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
|
||||
<li><a class="reference internal" href="#mode">Mode</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="scxmlmerge.html"
|
||||
title="previous chapter">scxmlmerge</a></p>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="seiscomp.html"
|
||||
title="next chapter">seiscomp</a></p>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/apps/sczip.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="container">
|
||||
<div class="horizontal layout content">
|
||||
<a class="fade-in" href="https://www.gempa.de" target="_blank">
|
||||
<img class="brand" src="../_static/brands/gempa.svg"/>
|
||||
</a>
|
||||
<div class="stretched align-center fitted content">
|
||||
<div>
|
||||
Version <b>6.9.0</b> Release
|
||||
</div>
|
||||
<div class="copyright">
|
||||
Copyright © gempa GmbH, GFZ Potsdam.
|
||||
</div>
|
||||
</div>
|
||||
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
|
||||
<img class="brand" src="../_static/brands/gfz.svg"/>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user