NOAA/seiscomp-training
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
seiscomp-training/share/doc/caps/html/apps/slink2caps.html

576 lines
35 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>slink2caps &#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="sproc2caps" href="sproc2caps.html" />
<link rel="prev" title="rtpd2caps" href="rtpd2caps.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="sproc2caps.html" title="sproc2caps"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="rtpd2caps.html" title="rtpd2caps"
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="slink2caps">
<span id="id1"></span><h1>slink2caps<a class="headerlink" href="#slink2caps" title="Permalink to this heading"></a></h1>
<p><strong>Data retrieval to CAPS using SeedLink plugins.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><em>slink2caps</em> uses the available <a class="reference internal" href="../base/glossary.html#term-SeedLink"><span class="xref std std-term">SeedLink</span></a> plugins to feed data from other
sources into <a class="reference internal" href="caps.html#caps"><span class="std std-ref">caps</span></a> server. Data can be retrieved from any sources for
which a <a class="reference internal" href="../base/glossary.html#term-SeedLink"><span class="xref std std-term">SeedLink</span></a> plugin exists. The data will be converted into
<a class="reference internal" href="../base/archive.html#sec-pt-miniseed"><span class="std std-ref">MiniSeed</span></a> format or other formats depending on the plugin itself.</p>
<p>For retrieving data from a <a class="reference internal" href="caps.html#caps"><span class="std std-ref">caps</span></a> server you may use <a class="reference internal" href="capstool.html#capstool"><span class="std std-ref">capstool</span></a> or
<a class="reference internal" href="rifftool.html#rifftool"><span class="std std-ref">rifftool</span></a>.</p>
</section>
<section id="transient-packets">
<h2>Transient Packets<a class="headerlink" href="#transient-packets" title="Permalink to this heading"></a></h2>
<p>The plugin data acquisition and the CAPS outgoing connection is not
synchronized so that packets might be received by plugins but could not be forwarded to
CAPS since the plugin is not allowed to send data to the server or the server
is not reachable. In this case packets are in transient state and would be lost
on shutdown. To prevent packet loss the plugin stores all transient packets to
disk during shutdown by default. Configure <a class="reference internal" href="#confval-buffer"><code class="xref std std-confval docutils literal notranslate"><span class="pre">buffer</span></code></a> for using an
alternative location.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Keep in mind to remove the buffer file before starting the plugin in case you
wish to reset the data acquisition completely.</p>
</div>
</section>
<section id="module-setup">
<h2>Module Setup<a class="headerlink" href="#module-setup" title="Permalink to this heading"></a></h2>
<p>Very few configuration steps are required as a minium to use slink2caps:</p>
<ol class="arabic">
<li><p>Identify the <a class="reference internal" href="../base/glossary.html#term-SeedLink"><span class="xref std std-term">SeedLink</span></a> instance to consider. Let’s assume in this
description this instance is <strong class="program">seedlink</strong>. In general you may use any
instance (alias) of <a class="reference internal" href="../base/glossary.html#term-SeedLink"><span class="xref std std-term">SeedLink</span></a>.</p></li>
<li><p>Configure the <a class="reference internal" href="../base/glossary.html#term-SeedLink"><span class="xref std std-term">SeedLink</span></a> instance to consider:</p>
<ul>
<li><p>Disable the time tables in module configuration (<code class="file docutils literal notranslate"><span class="pre">&#64;SYSTEMCONFIGDIR&#64;/seedlink.cfg</span></code>):</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">plugins.chain.loadTimeTable</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">false</span>
</pre></div>
</div>
</li>
<li><p>Create bindings as usual for <a class="reference internal" href="../base/glossary.html#term-SeedLink"><span class="xref std std-term">SeedLink</span></a>.</p></li>
</ul>
</li>
<li><p>If any other instance than <strong class="program">seedlink</strong> is considered, then you need
to configure the parameters in the <span class="xref std std-ref">seedlink</span> section of the module
configuration of slink2caps.</p></li>
<li><p>Apply the configuration changes and stop the considered <a class="reference internal" href="../base/glossary.html#term-SeedLink"><span class="xref std std-term">SeedLink</span></a>
instance. Then, enable and start slink2caps:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span>stop<span class="w"> </span>seedlink
seiscomp<span class="w"> </span>disable<span class="w"> </span>seedlink
seiscomp<span class="w"> </span>update-config<span class="w"> </span>seedlink
seiscomp<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>slink2caps
seisomp<span class="w"> </span>start<span class="w"> </span>slink2caps
</pre></div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The seedlink instance which is considered must not be running while using
slink2caps. E.g. when using <strong class="program">seedlink</strong> stop and disable this
instance first.</p>
</div>
</li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As for many other <cite>SeisComP</cite> and gempa modules, you may create aliases from
slink2caps for running multiple instances with different configurations at
the same time. In this case you must adjust the <a class="reference internal" href="#confval-buffer"><code class="xref std std-confval docutils literal notranslate"><span class="pre">buffer</span></code></a> and the
<span class="xref std std-ref">journal.*</span> parameters.</p>
<p>You may create or remove a module alias using the <strong class="program">seiscomp</strong> tool,
e.g.:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>create<span class="w"> </span>slink2caps-alias<span class="w"> </span>slink2caps
seiscomp<span class="w"> </span>--interactive<span class="w"> </span><span class="nb">alias</span><span class="w"> </span>remove<span class="w"> </span>slink2caps-alias
</pre></div>
</div>
</div>
</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/slink2caps.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/slink2caps.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/slink2caps.cfg</span></code></div>
</div>
<p>slink2caps 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>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-buffer">
<span class="sig-name descname"><span class="pre">buffer</span></span><a class="headerlink" href="#confval-buffer" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;ROOTDIR&#64;/var/lib/slink2caps/buffer.mseed</span></code></p>
<p>Type: <em>path</em></p>
<p>Path to buffer file where transient packets are stored on disk during shutdown.
Transient means packets that have been received from input plugins,
e.g., chain_plugin but have not been acknowledged by CAPS. Without local storage
on disk those packets would be lost. During start the plugin
reads the buffer file and tries to send the packets again. Please keep in mind
to remove the buffer file before plugin start in case of the data
acquisition should be reset.</p>
</dd></dl>
<div class="admonition note" id="seedlink">
<p class="admonition-title">Note</p>
<p><strong>seedlink.*</strong>
<em>Data input control</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-seedlink.config">
<span class="sig-name descname"><span class="pre">seedlink.config</span></span><a class="headerlink" href="#confval-seedlink.config" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;ROOTDIR&#64;/var/lib/seedlink/seedlink.ini</span></code></p>
<p>Type: <em>path</em></p>
<p>Path to Seedlink configuration file. Use the respective name
if seedlink runs as an alias.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-seedlink.name">
<span class="sig-name descname"><span class="pre">seedlink.name</span></span><a class="headerlink" href="#confval-seedlink.name" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">seedlink</span></code></p>
<p>Type: <em>string</em></p>
<p>Name of Seedlink configuration section. Use the respective name
if seedlink runs as an alias.</p>
</dd></dl>
<div class="admonition note" id="output">
<p class="admonition-title">Note</p>
<p><strong>output.*</strong>
<em>Data output control</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-output.stdout">
<span class="sig-name descname"><span class="pre">output.stdout</span></span><a class="headerlink" href="#confval-output.stdout" 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>Write miniSEED records to stdout instead of pushing them
to CAPS.</p>
</dd></dl>
<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">131072</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="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>
<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="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 -&gt; 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 &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-f">
<span id="cmdoption-seedlink-config"></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">--seedlink-config</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>Default: <code class="docutils literal notranslate"><span class="pre">&#64;ROOTDIR&#64;/var/lib/seedlink/seedlink.ini</span></code></p>
<p>Path to Seedlink configuration file. Default: &#64;ROOTDIR&#64;/var/lib/seedlink/seedlink.ini</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-n">
<span id="cmdoption-section-name"></span><span class="sig-name descname"><span class="pre">-n</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">--section-name</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-n" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">seedlink</span></code></p>
<p>Name of Seedlink configuration section. Default: seedlink.</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>Output<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-H">
<span id="cmdoption-host"></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">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-H" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">localhost</span></code></p>
<p>Data output host. Default: localhost.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-p">
<span id="cmdoption-port"></span><span class="sig-name descname"><span class="pre">-p</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">--port</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-p" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">18003</span></code></p>
<p>Data output port. Default: 18003.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-c">
<span id="cmdoption-stdout"></span><span class="sig-name descname"><span class="pre">-c</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">--stdout</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-c" title="Permalink to this definition"></a></dt>
<dd><p>Write records to stdout.</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>
</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="#">slink2caps</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#transient-packets">Transient Packets</a></li>
<li><a class="reference internal" href="#module-setup">Module Setup</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">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="rtpd2caps.html"
title="previous chapter">rtpd2caps</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="sproc2caps.html"
title="next chapter">sproc2caps</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/slink2caps.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>
Reference in New Issue View Git Blame Copy Permalink