[installation] Init with inital config for global
This commit is contained in:
706
share/doc/caps/html/apps/caps2caps.html
Normal file
706
share/doc/caps/html/apps/caps2caps.html
Normal file
@ -0,0 +1,706 @@
|
||||
<!doctype html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>caps2caps — 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="crex2caps" href="crex2caps.html" />
|
||||
<link rel="prev" title="Data Acquisition and Manipulation by Plugins" href="../base/plugins.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="crex2caps.html" title="crex2caps"
|
||||
accesskey="N">
|
||||
next
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="../base/plugins.html" title="Data Acquisition and Manipulation by Plugins"
|
||||
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="caps2caps">
|
||||
<span id="id1"></span><h1>caps2caps<a class="headerlink" href="#caps2caps" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>caps2caps synchronizes CAPS servers in real-time</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p><em>caps2caps</em> can connect two <cite>CAPS</cite> server instances to synchronize the data
|
||||
in real time. When one server 1 fails and the
|
||||
other one, server 2, continues to operate, the server 1 can back fill the data
|
||||
as soon as it becomes alive again.</p>
|
||||
<p><em>caps2caps</em> can run on either side to pull the data from the other server or to
|
||||
push the data to this server:</p>
|
||||
<ul class="simple">
|
||||
<li><p>For <strong>pulling data</strong> from a remote to a local server configure the input and the
|
||||
output parameters with the remote and the local server, respectively.</p></li>
|
||||
<li><p>For <strong>pushing data</strong> from a local to a remote server configure the input and the
|
||||
output parameters with the local and the remote server, respectively.</p></li>
|
||||
</ul>
|
||||
<figure class="align-center" id="id12">
|
||||
<span id="fig-caps2caps"></span><a class="reference internal image-reference" href="../_images/caps2caps.png"><img alt="../_images/caps2caps.png" src="../_images/caps2caps.png" style="width: 18cm;" /></a>
|
||||
<figcaption>
|
||||
<p><span class="caption-text">caps2caps instances connecting two <cite>CAPS</cite> servers pulling data from the
|
||||
remote into the local server.</span><a class="headerlink" href="#id12" title="Permalink to this image">¶</a></p>
|
||||
</figcaption>
|
||||
</figure>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<ul>
|
||||
<li><p>Run caps2caps as daemon module.</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Configure input and output hosts (<a class="reference internal" href="caps_plugin.html#confval-input.address"><code class="xref std std-confval docutils literal notranslate"><span class="pre">input.address</span></code></a>,
|
||||
<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>) in caps2caps module configuration,
|
||||
<code class="file docutils literal notranslate"><span class="pre">caps2caps.cfg</span></code>.</p></li>
|
||||
<li><p>Enable and start caps2caps</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>caps2caps
|
||||
seiscomp<span class="w"> </span>start<span class="w"> </span>caps2caps
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><p>Run caps2caps on demand in a terminal with specific, explicitly specifying
|
||||
input and output hosts without encryption</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>caps2caps<span class="w"> </span>-I<span class="w"> </span>caps://inputServer:18002<span class="w"> </span>-O<span class="w"> </span>caps://outputServer:18003
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The same as above but with encrypted data transfer controlled by user name and
|
||||
password</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>caps2caps<span class="w"> </span>-I<span class="w"> </span>capss://user:password@inputServer:18002<span class="w"> </span>-O<span class="w"> </span>capss://user:password@inputServer:output:18003
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Pull or push data depending on module configuration but ignore the journal
|
||||
file. This allows resending the data</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>caps2caps<span class="w"> </span>-j<span class="w"> </span><span class="s2">""</span>
|
||||
</pre></div>
|
||||
</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/caps2caps.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/caps2caps.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/caps2caps.cfg</span></code></div>
|
||||
</div>
|
||||
<p>caps2caps 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">@DATADIR@/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>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-streams">
|
||||
<span class="sig-name descname"><span class="pre">streams</span></span><a class="headerlink" href="#confval-streams" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>Comma separated list of streams. Stream format: NET.STA.LOC.CHA.
|
||||
Streams may contain wildcards</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-begin">
|
||||
<span class="sig-name descname"><span class="pre">begin</span></span><a class="headerlink" href="#confval-begin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>Start time of data time window, default is ‘GMT’. Date time format:
|
||||
[YYYY-MM-DD HH:MM:SS].</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-end">
|
||||
<span class="sig-name descname"><span class="pre">end</span></span><a class="headerlink" href="#confval-end" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>End time of data time window. Date time format:
|
||||
[YYYY-MM-DD HH:MM:SS].</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-maxDays">
|
||||
<span class="sig-name descname"><span class="pre">maxDays</span></span><a class="headerlink" href="#confval-maxDays" 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>Maximum number of days to acquire regardless if the time window
|
||||
is configured or read from journal. A value of 0 or less disables
|
||||
the check.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-days">
|
||||
<span class="sig-name descname"><span class="pre">days</span></span><a class="headerlink" href="#confval-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-daysBefore">
|
||||
<span class="sig-name descname"><span class="pre">daysBefore</span></span><a class="headerlink" href="#confval-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-timeWindowUpdateInterval">
|
||||
<span class="sig-name descname"><span class="pre">timeWindowUpdateInterval</span></span><a class="headerlink" href="#confval-timeWindowUpdateInterval" 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>s</em></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>Sets the interval in seconds at which the relative request
|
||||
time window defined by option days and/or daysBefore is
|
||||
updated.
|
||||
Use a value less or equal zero to disable the update.
|
||||
This feature is supported in archive mode only.
|
||||
A typical use case is when data has to be transmitted
|
||||
continuously with a time delay.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-maxRealTimeGap">
|
||||
<span class="sig-name descname"><span class="pre">maxRealTimeGap</span></span><a class="headerlink" href="#confval-maxRealTimeGap" 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>s</em></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>Sets the maximum real-time data gap in seconds. This means,
|
||||
if the start time of the requested time window of a channel
|
||||
is before this value with respect to the current system time
|
||||
then the request is split into a real-time request starting
|
||||
at system time - marginRealTimeGap and a backfill request
|
||||
from requested start time to time - marginRealTimeGap.
|
||||
That prioritizes real-time data and backfills old data in
|
||||
parallel.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-marginRealTimeGap">
|
||||
<span class="sig-name descname"><span class="pre">marginRealTimeGap</span></span><a class="headerlink" href="#confval-marginRealTimeGap" 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>The time margin used to request real-time data in combination
|
||||
with maxRealTimeGap with respect to system time.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-realtime">
|
||||
<span class="sig-name descname"><span class="pre">realtime</span></span><a class="headerlink" href="#confval-realtime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p>Type: <em>boolean</em></p>
|
||||
<p>Enable real-time mode. Archived data is not fetched.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-outOfOrder">
|
||||
<span class="sig-name descname"><span class="pre">outOfOrder</span></span><a class="headerlink" href="#confval-outOfOrder" 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 out of order mode. Allows transfering data
|
||||
which is not in timely order.</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note" id="input">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>input.*</strong>
|
||||
<em>Configuration of data input host.</em></p>
|
||||
</div>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-input.address">
|
||||
<span class="sig-name descname"><span class="pre">input.address</span></span><a class="headerlink" href="#confval-input.address" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>URL. Format: [[caps|capss]://][user:pass@]host[:port] .</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note" id="output">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>output.*</strong>
|
||||
<em>Configuration of data output host.</em></p>
|
||||
</div>
|
||||
<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>URL. Format: [[caps|capss]://][user:pass@]host[:port] .</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>byte</em></p>
|
||||
<p>Type: <em>uint</em></p>
|
||||
<p>Size 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>uint</em></p>
|
||||
<p>Length of backfilling buffer which is a tool to mitigate
|
||||
out-of-order data. 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. A value of 0 disables this feature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-output.mseed">
|
||||
<span class="sig-name descname"><span class="pre">output.mseed</span></span><a class="headerlink" href="#confval-output.mseed" 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 Steim2 encoding for received RAW packets.</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>
|
||||
|
||||
<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">@ROOTDIR@/var/run/caps2caps/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 in the given interval.</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 given 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 the
|
||||
given seconds.</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="id2"></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-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-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-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-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-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 doesn’t need to be started with &.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="verbosity">
|
||||
<span id="id3"></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-print-component">
|
||||
<span class="sig-name descname"><span class="pre">--print-component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-print-component" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>For each log entry print the component right after the
|
||||
log level. By default the component output is enabled
|
||||
for file output but disabled for console output.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-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-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-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="id4">
|
||||
<span id="id5"></span><h3>Input<a class="headerlink" href="#id4" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-I">
|
||||
<span id="cmdoption-input"></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">--input</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>Overrides configuration parameter <a class="reference internal" href="caps_plugin.html#confval-input.address"><code class="xref std std-confval docutils literal notranslate"><span class="pre">input.address</span></code></a>.</p>
|
||||
<p>URL of data input host. Format:
|
||||
[[caps|capss]://][user:password@]host[:port] .</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-max-real-time-gap">
|
||||
<span class="sig-name descname"><span class="pre">--max-real-time-gap</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-max-real-time-gap" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Maximum length of data gap after reconnecting. If exceeded,
|
||||
a real-time stream and backfilling stream will be created in
|
||||
parallel. Setting this value will give highest priority to
|
||||
real-time streams, e.g., for rapid response systems.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="streams">
|
||||
<span id="id6"></span><h3>Streams<a class="headerlink" href="#streams" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-i">
|
||||
<span id="cmdoption-inventory"></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">--inventory</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>Inventory XML defining the streams to add.</p>
|
||||
</dd></dl>
|
||||
|
||||
<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>List of streamIDs [NET.STA.LOC.CHA] to add. Wildcards are
|
||||
supported. Use comma-separation without blanks for multiple
|
||||
IDs.</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 request. Applied only on streams not
|
||||
found in the journal. Format: ‘YYYY-MM-DD hh:mm:ss.sss’.</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 request. Format: ‘YYYY-MM-DD hh:mm:ss.sss’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-max-days">
|
||||
<span class="sig-name descname"><span class="pre">--max-days</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-max-days" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Unit: <em>day</em></p>
|
||||
<p>Maximum number of days to acquire regardless if the time
|
||||
window is configured or read from journal. A value of 0 or
|
||||
less disables the check.</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="mode">
|
||||
<span id="id7"></span><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-archive">
|
||||
<span class="sig-name descname"><span class="pre">--archive</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-archive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Disable real-time mode. Only archived data is fetched and
|
||||
missing records are ignored.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-out-of-order">
|
||||
<span class="sig-name descname"><span class="pre">--out-of-order</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-out-of-order" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use to enable out-of-order mode. Allows transfering data
|
||||
which is not in timely order.</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>URL of data output host. Format:
|
||||
[[caps|capss]://][user:password@]host[:port] .</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 exceeded, a sync of
|
||||
the journal is forced.</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>Enables Steim2 encoding for received RAW packets.</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>Journal file to store stream states. Use an empty string to
|
||||
ignore the journal file which will transfer the data
|
||||
independent of previous transfers.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-flush">
|
||||
<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-flush" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Unit: <em>s</em></p>
|
||||
<p>Flush stream states to disk every given seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-waitForAck">
|
||||
<span class="sig-name descname"><span class="pre">--waitForAck</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-waitForAck" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Unit: <em>s</em></p>
|
||||
<p>Wait when a sync has been forced, up to the given seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-w">
|
||||
<span id="cmdoption-waitForLastAck"></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">--waitForLastAck</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>Unit: <em>s</em></p>
|
||||
<p>Wait on shutdown to receive acknowledgment messages, up
|
||||
to the given seconds.</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="#">caps2caps</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="#id4">Input</a></li>
|
||||
<li><a class="reference internal" href="#streams">Streams</a></li>
|
||||
<li><a class="reference internal" href="#mode">Mode</a></li>
|
||||
<li><a class="reference internal" href="#id8">Output</a></li>
|
||||
<li><a class="reference internal" href="#id10">Journal</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../base/plugins.html"
|
||||
title="previous chapter">Data Acquisition and Manipulation by Plugins</a></p>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="crex2caps.html"
|
||||
title="next chapter">crex2caps</a></p>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/apps/caps2caps.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">
|
||||
© Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user