[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
867
share/doc/seiscomp/html/apps/scheli.html
Normal file
867
share/doc/seiscomp/html/apps/scheli.html
Normal file
@ -0,0 +1,867 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>scheli — SeisComP Release documentation</title>
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=72bcf2f2" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
|
||||
<script type="text/javascript" src="../_static/seiscomp.js"></script>
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="scmm" href="scmm.html" />
|
||||
<link rel="prev" title="scesv" href="scesv.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="container">
|
||||
<div class="brand">
|
||||
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
|
||||
<!-- span class="title">SeisComP Release</span -->
|
||||
<span class="version">6.9.0</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="nav">
|
||||
<div class="container">
|
||||
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
||||
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<ul>
|
||||
<li class="right">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">
|
||||
index
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="scmm.html" title="scmm"
|
||||
accesskey="N">
|
||||
next
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="scesv.html" title="scesv"
|
||||
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="../gui.html" accesskey="U">Graphical User Interfaces</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="container">
|
||||
<div class="fitted content" id="anchors-container">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="scheli">
|
||||
<span id="id1"></span><h1>scheli<a class="headerlink" href="#scheli" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>Real-time helicorder view for one stream.</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p><strong class="program">scheli</strong> visualizes waveforms from a single stream or multiple stations
|
||||
mimicking a drum-recorder plot (see <a class="reference internal" href="#fig-scheli"><span class="std std-ref">scheli in GUI mode</span></a>):</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong class="program">scheli</strong> plots one configurable trace in helicorder style in the
|
||||
<a class="reference internal" href="../base/glossary.html#term-GUI"><span class="xref std std-term">GUI</span></a> (<a class="reference internal" href="#scheli-show"><span class="std std-ref">GUI mode</span></a>).</p></li>
|
||||
<li><p>Configurable GUI: trace colors, visualized time spans, number of rows, data filtering,
|
||||
amplitude ranges and much more.</p></li>
|
||||
<li><p>Automatic image capturing: Capture helicorder images at configurable time intervals
|
||||
of one trace in <a class="reference internal" href="#scheli-show"><span class="std std-ref">GUI mode</span></a> or a set of multiple channels in
|
||||
<a class="reference internal" href="#scheli-capture"><span class="std std-ref">capture mode</span></a>.
|
||||
The images can be used, e.g. for showing data images on web sites.</p></li>
|
||||
</ul>
|
||||
<figure class="align-center" id="id2">
|
||||
<span id="fig-scheli"></span><a class="reference internal image-reference" href="../_images/scheli.png"><img alt="../_images/scheli.png" src="../_images/scheli.png" style="width: 16cm;" /></a>
|
||||
<figcaption>
|
||||
<p><span class="caption-text">scheli in GUI mode</span><a class="headerlink" href="#id2" 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>
|
||||
<ol class="arabic" id="scheli-show">
|
||||
<li><p><strong>GUI mode - Simple helicorder window:</strong></p>
|
||||
<ul>
|
||||
<li><p>Learn about the plenty command-line options for <strong class="program">scheli</strong>:</p>
|
||||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scheli -h
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Start <strong class="program">scheli</strong> with the configured values and informative debug output:</p>
|
||||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scheli --debug
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Let <strong class="program">scheli</strong> show data from the CX station PB01 for the previous 5 hours
|
||||
overriding configuration by command-line paramaters:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scheli<span class="w"> </span>--stream<span class="w"> </span>CX.PB01..HHZ<span class="w"> </span>--rows<span class="w"> </span><span class="m">10</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Define the data request window by end time and duration; scale traces to the
|
||||
maximum amplitude per row:</p>
|
||||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scheli --stream IU.TSUM.00.BHZ --end-time "2021-04-22 14:00:00" --time-span 600 --amp-scaling row
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
<ol class="arabic" id="scheli-capture" start="2">
|
||||
<li><p><strong>Capture mode - Image capturing:</strong></p>
|
||||
<p>Capture the helicorder plot for 3 stations in intervals of 10 seconds.
|
||||
The data is retrieved using seedlink and the plots are stored as PNG images.
|
||||
The image files are named according to network, station, stream and location codes
|
||||
of the requested stations. Command-line parameters override the module configuration.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scheli<span class="w"> </span>capture<span class="w"> </span>--stream<span class="w"> </span>CX.PB01..HHZ<span class="w"> </span>--stream<span class="w"> </span>CX.PB02..HHZ<span class="w"> </span>--stream<span class="w"> </span>CX.PB04..HHZ<span class="w"> </span>--interval<span class="w"> </span><span class="m">10</span><span class="w"> </span>-o<span class="w"> </span><span class="s2">"/tmp/heli_%N_%S_%L_%C.png"</span><span class="w"> </span>-H<span class="w"> </span>localhost<span class="w"> </span>-I<span class="w"> </span>slink://localhost
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The output file names will be generated based on network code (%N), station code (%S),
|
||||
location code (%L) and stream code (%C):</p>
|
||||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>/tmp/CX.PB01..HHZ.png
|
||||
/tmp/CX.PB02..HHZ.png
|
||||
/tmp/CX.PB04..HHZ.png
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="setup">
|
||||
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Specifc <strong class="program">scheli</strong> parameters are adjusted in the <a class="reference internal" href="#scheli-configuration"><span class="std std-ref">module configuration</span></a>.
|
||||
Colors of traces etc. can be adjusted by setting the <em>scheme</em> parameters in
|
||||
the global configuration of scheli. For alternating colors between the traces
|
||||
set the parameters scheme.colors.records.foreground and
|
||||
scheme.colors.records.alternateForeground in <code class="file docutils literal notranslate"><span class="pre">scheli.cfg</span></code>:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># The general color of records/traces.</span>
|
||||
scheme.colors.records.foreground<span class="w"> </span><span class="o">=</span><span class="w"> </span>4286F4
|
||||
|
||||
<span class="c1"># A general trace color of the alternate trace (eg scheli).</span>
|
||||
scheme.colors.records.alternateForeground<span class="w"> </span><span class="o">=</span><span class="w"> </span>B72D0E
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="module-configuration">
|
||||
<span id="scheli-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading">¶</a></h2>
|
||||
<div class="line-block">
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
|
||||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scheli.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/scheli.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/scheli.cfg</span></code></div>
|
||||
</div>
|
||||
<p>scheli inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.streams">
|
||||
<span class="sig-name descname"><span class="pre">heli.streams</span></span><a class="headerlink" href="#confval-heli.streams" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>list:string</em></p>
|
||||
<p>List of stream codes to be plotted (net.sta.loc.cha).
|
||||
If not in capture mode only the first stream is shown.
|
||||
When using a list, the first entry is considered.
|
||||
Use commas for separating streams.</p>
|
||||
<p>Example: GR.MOX..BHZ</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.filter">
|
||||
<span class="sig-name descname"><span class="pre">heli.filter</span></span><a class="headerlink" href="#confval-heli.filter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>Filter to be applied on the data.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.numberOfRows">
|
||||
<span class="sig-name descname"><span class="pre">heli.numberOfRows</span></span><a class="headerlink" href="#confval-heli.numberOfRows" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">48</span></code></p>
|
||||
<p>Type: <em>integer</em></p>
|
||||
<p>Filter to be applied on the data.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.rowTimeSpan">
|
||||
<span class="sig-name descname"><span class="pre">heli.rowTimeSpan</span></span><a class="headerlink" href="#confval-heli.rowTimeSpan" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1800</span></code></p>
|
||||
<p>Type: <em>double</em></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Length of data per trace.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.timeFormat">
|
||||
<span class="sig-name descname"><span class="pre">heli.timeFormat</span></span><a class="headerlink" href="#confval-heli.timeFormat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">%F</span></code></p>
|
||||
<p>Type: <em>string</em></p>
|
||||
<p>The time format used to print the start and end time of the
|
||||
whole plot (upper right corner). The format specification is
|
||||
the one used in the strftime function (man strftime).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.recordTime">
|
||||
<span class="sig-name descname"><span class="pre">heli.recordTime</span></span><a class="headerlink" href="#confval-heli.recordTime" 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>Set current time to last data sample.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.lineWidth">
|
||||
<span class="sig-name descname"><span class="pre">heli.lineWidth</span></span><a class="headerlink" href="#confval-heli.lineWidth" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
|
||||
<p>Type: <em>integer</em></p>
|
||||
<p>Unit: <em>px</em></p>
|
||||
<p>Line width of traces.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.colors">
|
||||
<span class="sig-name descname"><span class="pre">heli.colors</span></span><a class="headerlink" href="#confval-heli.colors" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">FF0000,</span> <span class="pre">0000FF</span></code></p>
|
||||
<p>Type: <em>list:string</em></p>
|
||||
<p>A list of alternating row colors cycled through for painting
|
||||
traces.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.antialiasing">
|
||||
<span class="sig-name descname"><span class="pre">heli.antialiasing</span></span><a class="headerlink" href="#confval-heli.antialiasing" 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>Use anti aliasing to plot the traces. The default uses the
|
||||
settings from scheme.records.antiAliasing</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.stream.description">
|
||||
<span class="sig-name descname"><span class="pre">heli.stream.description</span></span><a class="headerlink" href="#confval-heli.stream.description" 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>Add stream description to traces.</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>heli.amplitudeRange.*</strong>
|
||||
<em>Gain-corrected amplitudes given in units of the sensor.</em>
|
||||
<em>For example: m/s.</em></p>
|
||||
</div>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.amplitudeRange.scaling">
|
||||
<span class="sig-name descname"><span class="pre">heli.amplitudeRange.scaling</span></span><a class="headerlink" href="#confval-heli.amplitudeRange.scaling" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">minmax</span></code></p>
|
||||
<p>Type: <em>string</em></p>
|
||||
<p>Define the method to scale traces within rows. Possible
|
||||
values are:</p>
|
||||
<p>minmax: Scale all rows to configured minimum and maximum
|
||||
amplitudes configured by amplitudeRange.min and
|
||||
amplitudeRange.max</p>
|
||||
<p>row: Scale each row to the maximum within this row.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.amplitudeRange.min">
|
||||
<span class="sig-name descname"><span class="pre">heli.amplitudeRange.min</span></span><a class="headerlink" href="#confval-heli.amplitudeRange.min" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-0.00001</span></code></p>
|
||||
<p>Type: <em>double</em></p>
|
||||
<p>Unit: <em>unit of input data</em></p>
|
||||
<p>Minimum amplitude to show in trace. Requires
|
||||
amplitudeRange.scale = "minmax".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.amplitudeRange.max">
|
||||
<span class="sig-name descname"><span class="pre">heli.amplitudeRange.max</span></span><a class="headerlink" href="#confval-heli.amplitudeRange.max" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.00001</span></code></p>
|
||||
<p>Type: <em>double</em></p>
|
||||
<p>Unit: <em>unit of input data</em></p>
|
||||
<p>Minimum amplitude to show in trace. Requires
|
||||
amplitudeRange.scale = "minmax".</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>heli.dump.*</strong>
|
||||
<em>Control dumping of PNG images.</em>
|
||||
<em>Execute “scheli capture” for image generation in</em>
|
||||
<em>the background without the graphics.</em></p>
|
||||
</div>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.dump.interval">
|
||||
<span class="sig-name descname"><span class="pre">heli.dump.interval</span></span><a class="headerlink" href="#confval-heli.dump.interval" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code></p>
|
||||
<p>Type: <em>integer</em></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Image creation interval. Negative values disable image
|
||||
dumping.
|
||||
If enabled, images are generated at the configured
|
||||
interval.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.dump.outputFile">
|
||||
<span class="sig-name descname"><span class="pre">heli.dump.outputFile</span></span><a class="headerlink" href="#confval-heli.dump.outputFile" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">/tmp/heli_%N_%S_%L_%C.png</span></code></p>
|
||||
<p>Type: <em>string</em></p>
|
||||
<p>Name of output file.
|
||||
The filename can contain placeholders
|
||||
that are replaced by the corresponding streamID parts:</p>
|
||||
<p>%N : network code</p>
|
||||
<p>%S : station code</p>
|
||||
<p>%L : location code</p>
|
||||
<p>%C : channel code</p>
|
||||
<p>Placeholders are important if more than one stream
|
||||
is given and capture mode is active.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.dump.dpi">
|
||||
<span class="sig-name descname"><span class="pre">heli.dump.dpi</span></span><a class="headerlink" href="#confval-heli.dump.dpi" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">300</span></code></p>
|
||||
<p>Type: <em>integer</em></p>
|
||||
<p>Unit: <em>dpi</em></p>
|
||||
<p>Image resolution.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.dump.xres">
|
||||
<span class="sig-name descname"><span class="pre">heli.dump.xres</span></span><a class="headerlink" href="#confval-heli.dump.xres" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1024</span></code></p>
|
||||
<p>Type: <em>integer</em></p>
|
||||
<p>Unit: <em>px</em></p>
|
||||
<p>Number of pixels horizontally.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-heli.dump.yres">
|
||||
<span class="sig-name descname"><span class="pre">heli.dump.yres</span></span><a class="headerlink" href="#confval-heli.dump.yres" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">768</span></code></p>
|
||||
<p>Type: <em>integer</em></p>
|
||||
<p>Unit: <em>px</em></p>
|
||||
<p>Number of pixels vertically.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-scripts.postprocessing">
|
||||
<span class="sig-name descname"><span class="pre">scripts.postprocessing</span></span><a class="headerlink" href="#confval-scripts.postprocessing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>path</em></p>
|
||||
<p>Define the path to a script that is called whenever an image
|
||||
has been captured and written to disc. The only parameter is
|
||||
the path to the generated image.</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>
|
||||
<p><strong class="program">scheli [options]</strong></p>
|
||||
<section id="generic">
|
||||
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-h">
|
||||
<span id="cmdoption-scheli-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-scheli-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-scheli-V">
|
||||
<span id="cmdoption-scheli-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-scheli-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-scheli-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-scheli-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-scheli-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-scheli-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-scheli-D">
|
||||
<span id="cmdoption-scheli-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-scheli-D" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run as daemon. This means the application will fork itself
|
||||
and doesn’t need to be started with &.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-auto-shutdown">
|
||||
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-auto-shutdown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enable/disable self-shutdown because a master module shutdown.
|
||||
This only works when messaging is enabled and the master
|
||||
module sends a shutdown message (enabled with --start-stop-msg
|
||||
for the master module).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-shutdown-master-module">
|
||||
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-shutdown-master-module" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the name of the master-module used for auto-shutdown.
|
||||
This is the application name of the module actually
|
||||
started. If symlinks are used, then it is the name of
|
||||
the symlinked application.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-shutdown-master-username">
|
||||
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-shutdown-master-username" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the name of the master-username of the messaging
|
||||
used for auto-shutdown. If "shutdown-master-module" is
|
||||
given as well, this parameter is ignored.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="verbosity">
|
||||
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-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-scheli-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-scheli-v">
|
||||
<span id="cmdoption-scheli-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-scheli-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-scheli-q">
|
||||
<span id="cmdoption-scheli-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-scheli-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-scheli-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-scheli-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-scheli-s">
|
||||
<span id="cmdoption-scheli-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-scheli-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-scheli-l">
|
||||
<span id="cmdoption-scheli-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-scheli-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-scheli-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-scheli-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-scheli-debug">
|
||||
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-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-scheli-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-scheli-log-file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use alternative log file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-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-scheli-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-scheli-trace">
|
||||
<span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-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>
|
||||
|
||||
</section>
|
||||
<section id="messaging">
|
||||
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-u">
|
||||
<span id="cmdoption-scheli-user"></span><span class="sig-name descname"><span class="pre">-u</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">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-u" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-H">
|
||||
<span id="cmdoption-scheli-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-scheli-H" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-t">
|
||||
<span id="cmdoption-scheli-timeout"></span><span class="sig-name descname"><span class="pre">-t</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">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-t" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-g">
|
||||
<span id="cmdoption-scheli-primary-group"></span><span class="sig-name descname"><span class="pre">-g</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">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-g" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-S">
|
||||
<span id="cmdoption-scheli-subscribe-group"></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">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-S" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A group to subscribe to.
|
||||
This option can be given more than once.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-content-type">
|
||||
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-content-type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-start-stop-msg">
|
||||
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-start-stop-msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set sending of a start and a stop message.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="database">
|
||||
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-db-driver-list">
|
||||
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-db-driver-list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List all supported database drivers.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-d">
|
||||
<span id="cmdoption-scheli-database"></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">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-d" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The database connection string, format:
|
||||
<a class="reference external" href="service://user:pwd@host/database">service://user:pwd@host/database</a>.
|
||||
"service" is the name of the database driver which
|
||||
can be queried with "--db-driver-list".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-config-module">
|
||||
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-config-module" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The config module to use.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-inventory-db">
|
||||
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-inventory-db" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load the inventory from the given database or file, format:
|
||||
[<a class="reference external" href="service://]location">service://]location</a> .</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-config-db">
|
||||
<span class="sig-name descname"><span class="pre">--config-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-config-db" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load the configuration from the given database or file,
|
||||
format: [<a class="reference external" href="service://]location">service://]location</a> .</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="records">
|
||||
<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-scheli-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-scheli-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-scheli-I">
|
||||
<span id="cmdoption-scheli-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-scheli-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].
|
||||
"service" is the name of the recordstream driver
|
||||
which can be queried with "--record-driver-list".
|
||||
If "service" is not given, "<a class="reference external" href="file://">file://</a>" is
|
||||
used.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-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-scheli-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-scheli-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-scheli-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="user-interface">
|
||||
<h3>User interface<a class="headerlink" href="#user-interface" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-F">
|
||||
<span id="cmdoption-scheli-full-screen"></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">--full-screen</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-F" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Start the application filling the entire screen.
|
||||
This only works with GUI applications.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-N">
|
||||
<span id="cmdoption-scheli-non-interactive"></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">--non-interactive</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-N" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use non-interactive presentation mode. This only works with
|
||||
GUI applications.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="mode">
|
||||
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-offline">
|
||||
<span class="sig-name descname"><span class="pre">--offline</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scheli-offline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do not connect to a messaging server and do not use the
|
||||
database.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-end-time">
|
||||
<span class="sig-name descname"><span class="pre">--end-time</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-end-time" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the acquisition end time, e.g. ‘2017-09-08 13:30:00’,
|
||||
default: ‘gmt’</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="data">
|
||||
<h3>Data<a class="headerlink" href="#data" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-stream">
|
||||
<span class="sig-name descname"><span class="pre">--stream</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-stream" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The record stream that should be displayed. Can be used
|
||||
multiple times for multiple streams.</p>
|
||||
<p>Example: GR.MOX..BHZ (net.sta.loc.cha)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-filter">
|
||||
<span class="sig-name descname"><span class="pre">--filter</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-filter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The filter to apply</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-gain">
|
||||
<span class="sig-name descname"><span class="pre">--gain</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-gain" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gain applied to the data before plotting</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-amp-scaling">
|
||||
<span class="sig-name descname"><span class="pre">--amp-scaling</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-amp-scaling" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lower bound of amplitude range per row. Possible values:</p>
|
||||
<p>minmax: Scale all rows to configured minimum and maximum
|
||||
amplitudes.</p>
|
||||
<p>row: Scale each row to the maximum within this row.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-amp-range-min">
|
||||
<span class="sig-name descname"><span class="pre">--amp-range-min</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-amp-range-min" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Lower bound of amplitude range per row</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-amp-range-max">
|
||||
<span class="sig-name descname"><span class="pre">--amp-range-max</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-amp-range-max" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Upper bound of amplitude range per row</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-amp-range">
|
||||
<span class="sig-name descname"><span class="pre">--amp-range</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-amp-range" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Arround zero bound of amplitude range per row</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-record-time">
|
||||
<span class="sig-name descname"><span class="pre">--record-time</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-record-time" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do the last row always contain the last record received</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="output">
|
||||
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-desc">
|
||||
<span class="sig-name descname"><span class="pre">--desc</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-desc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enable/disable the display of a station description</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-rows">
|
||||
<span class="sig-name descname"><span class="pre">--rows</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-rows" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Configure the number of rows to display</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-time-span">
|
||||
<span class="sig-name descname"><span class="pre">--time-span</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-time-span" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Configure the time-span (in secs) per row. Unit: seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-aa">
|
||||
<span class="sig-name descname"><span class="pre">--aa</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-aa" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set antialiasing for rendering the traces</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-xres">
|
||||
<span class="sig-name descname"><span class="pre">--xres</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-xres" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Output x resolution when generating images. Unit: dpi.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-yres">
|
||||
<span class="sig-name descname"><span class="pre">--yres</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-yres" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Output y resolution when generating images. Unit: dpi.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-dpi">
|
||||
<span class="sig-name descname"><span class="pre">--dpi</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-dpi" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Output dpi when generating postscript. Unit:dpi.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-o">
|
||||
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-o" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Output filename. Placeholders are %N,%S,%L,%C for network
|
||||
code, station code, location code, channel code.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scheli-interval">
|
||||
<span class="sig-name descname"><span class="pre">--interval</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scheli-interval" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Snapshot interval (less than 0 disables timed snapshots).
|
||||
Unit: 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="#">scheli</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="#setup">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="#messaging">Messaging</a></li>
|
||||
<li><a class="reference internal" href="#database">Database</a></li>
|
||||
<li><a class="reference internal" href="#records">Records</a></li>
|
||||
<li><a class="reference internal" href="#user-interface">User interface</a></li>
|
||||
<li><a class="reference internal" href="#mode">Mode</a></li>
|
||||
<li><a class="reference internal" href="#data">Data</a></li>
|
||||
<li><a class="reference internal" href="#output">Output</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="scesv.html"
|
||||
title="previous chapter">scesv</a></p>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="scmm.html"
|
||||
title="next chapter">scmm</a></p>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/apps/scheli.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="container">
|
||||
<div class="horizontal layout content">
|
||||
<a class="fade-in" href="https://www.gempa.de" target="_blank">
|
||||
<img class="brand" src="../_static/brands/gempa.svg"/>
|
||||
</a>
|
||||
<div class="stretched align-center fitted content">
|
||||
<div>
|
||||
Version <b>6.9.0</b> Release
|
||||
</div>
|
||||
<div class="copyright">
|
||||
Copyright © gempa GmbH, GFZ Potsdam.
|
||||
</div>
|
||||
</div>
|
||||
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
|
||||
<img class="brand" src="../_static/brands/gfz.svg"/>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user