[installation] Init with inital config for global

This commit is contained in:
2025-10-30 15:08:17 +01:00
commit 7640b452ed
3678 changed files with 2200095 additions and 0 deletions

View File

@ -0,0 +1,734 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>rs2caps &#8212; CAPS: Common Acquisition Protocol Server documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/gempa.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/gempa.css?v=c960eebf" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<script type="text/javascript" src="../_static/gempa.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=b3ba4146"></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="rtpd2caps" href="rtpd2caps.html" />
<link rel="prev" title="orb2caps" href="orb2caps.html" />
</head>
<body>
<div class="header">
<div class="container">
<img class="background" src="../_static/icon.png"/>
<div class="content">
<span class="title">CAPS: Common Acquisition Protocol Server </span>
<span class="version">2025.254#f0c77b29e</span></h1>
</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="rtpd2caps.html" title="rtpd2caps"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="orb2caps.html" title="orb2caps"
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="../base/plugins.html" accesskey="U">Data Acquisition and Manipulation by Plugins</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="rs2caps">
<span id="id1"></span><h1>rs2caps<a class="headerlink" href="#rs2caps" title="Permalink to this heading"></a></h1>
<p><strong>Recordstream data acquisition plugin</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><em>rs2caps</em> uses the <cite>SeisComP</cite> <span id="id2"><em>RecordStream</em> [<a class="reference internal" href="../base/references.html#id225" title="RecordStream. SeisComP interface. URL: https://docs.gempa.de/seiscomp/current/apps/global_recordstream.html.">6</a>]</span> to feed data into <a class="reference internal" href="caps.html#caps"><span class="std std-ref">caps</span></a>
of to stdout.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<ul>
<li><p>Inject data into the CAPS server:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>start<span class="w"> </span>caps
rs2caps<span class="w"> </span>-I<span class="w"> </span>data.mseed<span class="w"> </span>--passthrough
</pre></div>
</div>
<p>Read the <a class="reference internal" href="../base/examples.html#sec-caps-example-offline"><span class="std std-ref">examples section</span></a> to learn how to
use <em>rs2caps</em> to input data into the CAPS server.</p>
</li>
<li><p>Read data from the file <em>data.mseed</em> resample to 10 Hz sample rate by the
RecordStream and write the resulting data to stdout:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>rs2caps<span class="w"> </span>-I<span class="w"> </span>resample://file?rate<span class="o">=</span><span class="m">10</span>/data.mseed<span class="w"> </span>--passthrough<span class="w"> </span>--dump-packets<span class="w"> </span>--mseed<span class="w"> </span>&gt;<span class="w"> </span>test.mseed
</pre></div>
</div>
<p>You may join the command with <span id="id3"><em>capstool</em> [<a class="reference internal" href="../base/references.html#id120" title="capstool. gempa plugin. URL: https://docs.gempa.de/caps/current/apps/capstool.html.">10</a>]</span> and <span id="id4"><em>scmssort</em> [<a class="reference internal" href="../base/references.html#id266" title="scmssort. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scmssort.html.">16</a>]</span>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;2024,01,01,00,00,00 2024,01,01,00,10,00 * * * *&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>capstool<span class="w"> </span>-H<span class="w"> </span>localhost<span class="w"> </span><span class="p">|</span><span class="se">\</span>
rs2caps<span class="w"> </span>-I<span class="w"> </span>resample://file?rate<span class="o">=</span><span class="m">10</span>/-<span class="w"> </span>--passthrough<span class="w"> </span>--dump-packets<span class="w"> </span>--mseed<span class="w"> </span><span class="p">|</span><span class="se">\</span>
scmssort<span class="w"> </span>-E<span class="w"> </span>&gt;<span class="w"> </span>test.mseed
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A similar action with additional data processing may be executed using
<a class="reference internal" href="sproc2caps.html#sproc2caps"><span class="std std-ref">sproc2caps</span></a>.</p>
</div>
</li>
</ul>
</section>
<section id="module-configuration">
<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/rs2caps.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/rs2caps.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/rs2caps.cfg</span></code></div>
</div>
<p>rs2caps inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Modules/plugins may require a license file. The default path to license
files is <code class="file docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/licenses/</span></code> which can be overridden by global
configuration of the parameter <code class="xref std std-confval docutils literal notranslate"><span class="pre">gempa.licensePath</span></code>. Example:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>gempa.licensePath = @CONFIGDIR@/licenses
</pre></div>
</div>
</div>
<span class="target" id="output"></span><dl class="std confval">
<dt class="sig sig-object std" id="confval-output.address">
<span class="sig-name descname"><span class="pre">output.address</span></span><a class="headerlink" href="#confval-output.address" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">localhost:18003</span></code></p>
<p>Type: <em>string</em></p>
<p>Data output URL [[caps|capss]://][user:pass&#64;]host[:port]. This parameter
superseds the host and port parameter of previous versions and takes precedence.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.host">
<span class="sig-name descname"><span class="pre">output.host</span></span><a class="headerlink" href="#confval-output.host" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">localhost</span></code></p>
<p>Type: <em>string</em></p>
<p>Data output host. Deprecated: Use output.address instead.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.port">
<span class="sig-name descname"><span class="pre">output.port</span></span><a class="headerlink" href="#confval-output.port" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">18003</span></code></p>
<p>Type: <em>int</em></p>
<p>Data output port. Deprecated: Use output.address instead.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.timeout">
<span class="sig-name descname"><span class="pre">output.timeout</span></span><a class="headerlink" href="#confval-output.timeout" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">60</span></code></p>
<p>Unit: <em>s</em></p>
<p>Type: <em>int</em></p>
<p>Timeout when sending a packet. If the timeout expires
the connection will be closed and re-established.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.maxFutureEndTime">
<span class="sig-name descname"><span class="pre">output.maxFutureEndTime</span></span><a class="headerlink" href="#confval-output.maxFutureEndTime" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">120</span></code></p>
<p>Unit: <em>s</em></p>
<p>Type: <em>int</em></p>
<p>Maximum allowed relative end time for packets. If the packet
end time is greater than the current time plus this value,
the packet will be discarded. By default this value is set
to 120 seconds.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.bufferSize">
<span class="sig-name descname"><span class="pre">output.bufferSize</span></span><a class="headerlink" href="#confval-output.bufferSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1048576</span></code></p>
<p>Unit: <em>bytes</em></p>
<p>Type: <em>uint</em></p>
<p>Size (bytes) of the packet buffer.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.backFillingBufferSize">
<span class="sig-name descname"><span class="pre">output.backFillingBufferSize</span></span><a class="headerlink" href="#confval-output.backFillingBufferSize" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Unit: <em>s</em></p>
<p>Type: <em>int</em></p>
<p>Length of backfilling buffer. Whenever a gap is detected, records
will be held in a buffer and not sent out. Records are flushed from
front to back if the buffer size is exceeded.</p>
</dd></dl>
<span class="target" id="output-mseed"></span><dl class="std confval">
<dt class="sig sig-object std" id="confval-output.mseed.enable">
<span class="sig-name descname"><span class="pre">output.mseed.enable</span></span><a class="headerlink" href="#confval-output.mseed.enable" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Enable on-the-fly miniSEED
encoding. If the encoder does not support the input
type of a packet it will be forwarded. Re-encoding of
miniSEED packets is not supported.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.mseed.encoding">
<span class="sig-name descname"><span class="pre">output.mseed.encoding</span></span><a class="headerlink" href="#confval-output.mseed.encoding" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">Steim2</span></code></p>
<p>Type: <em>string</em></p>
<p>miniSEED encoding to use. (Uncompressed, Steim1 or Steim2)</p>
</dd></dl>
<span class="target" id="streams"></span><dl class="std confval">
<dt class="sig sig-object std" id="confval-streams.begin">
<span class="sig-name descname"><span class="pre">streams.begin</span></span><a class="headerlink" href="#confval-streams.begin" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Start time of data time window, default GMT</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-streams.end">
<span class="sig-name descname"><span class="pre">streams.end</span></span><a class="headerlink" href="#confval-streams.end" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>End time of data time window</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-streams.days">
<span class="sig-name descname"><span class="pre">streams.days</span></span><a class="headerlink" href="#confval-streams.days" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code></p>
<p>Unit: <em>day</em></p>
<p>Type: <em>int</em></p>
<p>Use to set the start time of data time window n days before the current time.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-streams.daysBefore">
<span class="sig-name descname"><span class="pre">streams.daysBefore</span></span><a class="headerlink" href="#confval-streams.daysBefore" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code></p>
<p>Unit: <em>day</em></p>
<p>Type: <em>int</em></p>
<p>Use to set the end time of data time window n days before the current time.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-streams.passthrough">
<span class="sig-name descname"><span class="pre">streams.passthrough</span></span><a class="headerlink" href="#confval-streams.passthrough" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Do not subscribe to any stream and
accept everything a record source is
passing. This is useful in combination
with files.</p>
</dd></dl>
<span class="target" id="journal"></span><dl class="std confval">
<dt class="sig sig-object std" id="confval-journal.file">
<span class="sig-name descname"><span class="pre">journal.file</span></span><a class="headerlink" href="#confval-journal.file" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;ROOTDIR&#64;/var/run/rs2caps/journal</span></code></p>
<p>Type: <em>string</em></p>
<p>File to store stream states</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-journal.flush">
<span class="sig-name descname"><span class="pre">journal.flush</span></span><a class="headerlink" href="#confval-journal.flush" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
<p>Unit: <em>s</em></p>
<p>Type: <em>uint</em></p>
<p>Flush stream states to disk every n seconds</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-journal.waitForAck">
<span class="sig-name descname"><span class="pre">journal.waitForAck</span></span><a class="headerlink" href="#confval-journal.waitForAck" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">60</span></code></p>
<p>Unit: <em>s</em></p>
<p>Type: <em>uint</em></p>
<p>Wait when a sync has been forced, up to n seconds</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-journal.waitForLastAck">
<span class="sig-name descname"><span class="pre">journal.waitForLastAck</span></span><a class="headerlink" href="#confval-journal.waitForLastAck" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">5</span></code></p>
<p>Unit: <em>s</em></p>
<p>Type: <em>uint</em></p>
<p>Wait on shutdown to receive acknownledgement messages, up to n seconds</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-journal.syncWithBindings">
<span class="sig-name descname"><span class="pre">journal.syncWithBindings</span></span><a class="headerlink" href="#confval-journal.syncWithBindings" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Whether to synchronize the journal file with bindings.
If enabled then each time update-config is called, the
bound stations will be synchronized with the current
journal file. Unbound stations will be removed from
the journal. Synchronizing with bindings will disable
reading the inventory.</p>
</dd></dl>
<span class="target" id="statuslog"></span><dl class="std confval">
<dt class="sig sig-object std" id="confval-statusLog.enable">
<span class="sig-name descname"><span class="pre">statusLog.enable</span></span><a class="headerlink" href="#confval-statusLog.enable" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Log information status information e.g.
max bytes buffered</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-statusLog.flush">
<span class="sig-name descname"><span class="pre">statusLog.flush</span></span><a class="headerlink" href="#confval-statusLog.flush" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
<p>Type: <em>uint</em></p>
<p>Flush status every n seconds to disk</p>
</dd></dl>
</section>
<section id="bindings-parameters">
<h2>Bindings Parameters<a class="headerlink" href="#bindings-parameters" title="Permalink to this heading"></a></h2>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-selectors">
<span class="sig-name descname"><span class="pre">selectors</span></span><a class="headerlink" href="#confval-selectors" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of stream selectors in format LOC.CHA.
If left empty all available streams will be requested.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<section id="generic">
<span id="id5"></span><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-h">
<span id="cmdoption-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-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-V">
<span id="cmdoption-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-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-D">
<span id="cmdoption-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-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
</section>
<section id="verbosity">
<span id="id6"></span><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-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-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-v">
<span id="cmdoption-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-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-q">
<span id="cmdoption-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-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-s">
<span id="cmdoption-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-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-l">
<span id="cmdoption-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-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-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-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-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-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-trace">
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to --verbosity=4 --console=1 --print-component=1
--print-context=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-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-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="records">
<span id="id7"></span><h3>Records<a class="headerlink" href="#records" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-record-driver-list">
<span class="sig-name descname"><span class="pre">--record-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-record-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported record stream drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-I">
<span id="cmdoption-record-url"></span><span class="sig-name descname"><span class="pre">-I</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">--record-url</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-I" title="Permalink to this definition"></a></dt>
<dd><p>The recordstream source URL, format:
[<a class="reference external" href="service://">service://</a>]location[#type].
&quot;service&quot; is the name of the recordstream driver
which can be queried with &quot;--record-driver-list&quot;.
If &quot;service&quot; is not given, &quot;<a class="reference external" href="file://">file://</a>&quot; is
used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-record-file">
<span class="sig-name descname"><span class="pre">--record-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-record-file" title="Permalink to this definition"></a></dt>
<dd><p>Specify a file as record source.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-record-type">
<span class="sig-name descname"><span class="pre">--record-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-record-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify a type for the records being read.</p>
</dd></dl>
</section>
<section id="id8">
<span id="id9"></span><h3>Output<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-O">
<span id="cmdoption-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">arg</span></span><a class="headerlink" href="#cmdoption-O" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="sproc2caps.html#confval-output.address"><code class="xref std std-confval docutils literal notranslate"><span class="pre">output.address</span></code></a>.</p>
<p>This is the CAPS server which shall receive the data.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-agent">
<span class="sig-name descname"><span class="pre">--agent</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-agent" title="Permalink to this definition"></a></dt>
<dd><p>Sets the agent string. Allows the server to identify the
application that sends data.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-b">
<span id="cmdoption-buffer-size"></span><span class="sig-name descname"><span class="pre">-b</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">--buffer-size</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-b" title="Permalink to this definition"></a></dt>
<dd><p>Size (bytes) of the journal buffer. If the value ist
exceeded, a synchronization of the journal is forced.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-backfilling">
<span class="sig-name descname"><span class="pre">--backfilling</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-backfilling" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
<p>Buffer size in seconds for backfilling gaps.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-mseed">
<span class="sig-name descname"><span class="pre">--mseed</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-mseed" title="Permalink to this definition"></a></dt>
<dd><p>Enable on-the-fly miniSEED encoding. If the encoder does not
support the input type of a packet, it will be forwarded.
Re-encoding of miniSEED packets is not supported.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-encoding">
<span class="sig-name descname"><span class="pre">--encoding</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-encoding" title="Permalink to this definition"></a></dt>
<dd><p>miniSEED encoding to use: Uncompressed, Steim1 or Steim2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-rec-len">
<span class="sig-name descname"><span class="pre">--rec-len</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-rec-len" title="Permalink to this definition"></a></dt>
<dd><p>miniSEED record length expressed as a power of
2. A 512 byte record would be 9.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-max-future-endtime">
<span class="sig-name descname"><span class="pre">--max-future-endtime</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-max-future-endtime" title="Permalink to this definition"></a></dt>
<dd><p>Maximum allowed relative end time for packets. If the packet
end time is greater than the current time plus this value,
the packet will be discarded. By default this value is set
to 120 seconds.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dump-packets">
<span class="sig-name descname"><span class="pre">--dump-packets</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dump-packets" title="Permalink to this definition"></a></dt>
<dd><p>Dump packets to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-test">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-test" title="Permalink to this definition"></a></dt>
<dd><p>Disable socket communication.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-dump">
<span class="sig-name descname"><span class="pre">--dump</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-dump" title="Permalink to this definition"></a></dt>
<dd><p>Dump all received data to stdout and dont use the input
port.</p>
</dd></dl>
</section>
<section id="id10">
<span id="id11"></span><h3>Journal<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-j">
<span id="cmdoption-journal"></span><span class="sig-name descname"><span class="pre">-j</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">--journal</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-j" title="Permalink to this definition"></a></dt>
<dd><p>File to store stream states. Use an empty string to log to
stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-f">
<span id="cmdoption-flush"></span><span class="sig-name descname"><span class="pre">-f</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">--flush</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-f" title="Permalink to this definition"></a></dt>
<dd><p>Flush stream states to disk every n seconds.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-wait-for-ack">
<span class="sig-name descname"><span class="pre">--wait-for-ack</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-wait-for-ack" title="Permalink to this definition"></a></dt>
<dd><p>Wait when a sync has been forced, up to n seconds.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-w">
<span id="cmdoption-wait-for-last-ack"></span><span class="sig-name descname"><span class="pre">-w</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">--wait-for-last-ack</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-w" title="Permalink to this definition"></a></dt>
<dd><p>Wait on shutdown to receive acknownledgement messages, up to
the given number of seconds.</p>
</dd></dl>
</section>
<section id="status">
<span id="id12"></span><h3>Status<a class="headerlink" href="#status" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-status-log">
<span class="sig-name descname"><span class="pre">--status-log</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-status-log" title="Permalink to this definition"></a></dt>
<dd><p>Log information status information, e.g., max bytes buffered.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-status-flush">
<span class="sig-name descname"><span class="pre">--status-flush</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-status-flush" title="Permalink to this definition"></a></dt>
<dd><p>Flush status every n seconds to disk.</p>
</dd></dl>
</section>
<section id="id13">
<span id="id14"></span><h3>Streams<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-A">
<span id="cmdoption-add-stream"></span><span class="sig-name descname"><span class="pre">-A</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">--add-stream</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-A" title="Permalink to this definition"></a></dt>
<dd><p>StreamID [net.sta.loc.cha] to add.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-id-file">
<span class="sig-name descname"><span class="pre">--id-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-id-file" title="Permalink to this definition"></a></dt>
<dd><p>File to read stream IDs from.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-passthrough">
<span class="sig-name descname"><span class="pre">--passthrough</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-passthrough" title="Permalink to this definition"></a></dt>
<dd><p>Do not subscribe to any stream and accept everything a
record source is passing. This is useful in combination with
files.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-begin">
<span class="sig-name descname"><span class="pre">--begin</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-begin" title="Permalink to this definition"></a></dt>
<dd><p>Start time of data time window.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-end">
<span class="sig-name descname"><span class="pre">--end</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-end" title="Permalink to this definition"></a></dt>
<dd><p>End time of data time window.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-days">
<span class="sig-name descname"><span class="pre">--days</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-days" title="Permalink to this definition"></a></dt>
<dd><p>Unit: <em>day</em></p>
<p>Begin of data request time window given as days before current time.
Applied only on streams not found in the journal.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-days-before">
<span class="sig-name descname"><span class="pre">--days-before</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-days-before" title="Permalink to this definition"></a></dt>
<dd><p>Unit: <em>day</em></p>
<p>End of data request time window given as number of days
before current time.</p>
</dd></dl>
</section>
<section id="polling">
<span id="id15"></span><h3>Polling<a class="headerlink" href="#polling" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-poll">
<span class="sig-name descname"><span class="pre">--poll</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-poll" title="Permalink to this definition"></a></dt>
<dd><p>For non-streaming inputs polling can be
used to simulate real-time streaming.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-poll-window">
<span class="sig-name descname"><span class="pre">--poll-window</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-poll-window" title="Permalink to this definition"></a></dt>
<dd><p>Time window in seconds to be used with polling.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-poll-interval">
<span class="sig-name descname"><span class="pre">--poll-interval</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-poll-interval" title="Permalink to this definition"></a></dt>
<dd><p>Time interval in seconds used for polling.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-poll-serial">
<span class="sig-name descname"><span class="pre">--poll-serial</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-poll-serial" title="Permalink to this definition"></a></dt>
<dd><p>Will request each channel seperately rather all channels in
one request.</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="#">rs2caps</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="#bindings-parameters">Bindings Parameters</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="#records">Records</a></li>
<li><a class="reference internal" href="#id8">Output</a></li>
<li><a class="reference internal" href="#id10">Journal</a></li>
<li><a class="reference internal" href="#status">Status</a></li>
<li><a class="reference internal" href="#id13">Streams</a></li>
<li><a class="reference internal" href="#polling">Polling</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="orb2caps.html"
title="previous chapter">orb2caps</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="rtpd2caps.html"
title="next chapter">rtpd2caps</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/rs2caps.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="container">
<div class="content">
Release <b></b> version <b>2025.254#f0c77b29e</b>
<div class="copyright">
&copy; Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
</div>
</div>
</div>
</div>
</body>
</html>