benjamin
/
seiscomp-training
1
0
Fork 0
Code Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '906e9ccf6b'
${ noResults }
seiscomp-training/share/doc/seiscomp/html/apps/scvoice.html

611 lines
35 KiB
HTML
Raw Blame History Unescape Escape

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html>
<html >
<head>
<meta charset="utf-8" />
<title>scvoice &#8212; 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/graphviz.css" />
<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 src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scxmldump" href="scxmldump.html" />
<link rel="prev" title="scsohlog" href="scsohlog.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">5.3.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="scxmldump.html" title="scxmldump"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scsohlog.html" title="scsohlog"
accesskey="P">
previous
</a>
</li>
<li class="nav-item nav-item-0">
<a href="../index.html">Home</a>
</li>
<li class="nav-item nav-item-1">
<a href="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<div class="section" id="scvoice">
<span id="id1"></span><h1>scvoice<a class="headerlink" href="#scvoice" title="Permalink to this headline"></a></h1>
<p><strong>Real time voice alert.</strong></p>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>This tool runs an external script whenever an event has been created or updated.
It can also run a script in case an amplitude of a particular type or a
preliminary origin (heads-up message) has been sent. The common purpose for
this tool is to play a sound or to convert a message to speech using external
tools like festival or espeak.
There are three possible trigger mechanisms for calling scripts:</p>
<ul class="simple">
<li><p>Event creation/update</p></li>
<li><p>Amplitude creation</p></li>
<li><p>Origin creation (with status = preliminary)</p></li>
</ul>
<p>Although this tool was designed to alert the user acoustically it can also be
used to send e-mails, sms or to do any other kind of alert. scvoice can only
run one script per call type at a time! A template (<a class="reference internal" href="scalert.html#scalert"><span class="std std-ref">scalert</span></a>) Python script with
more options has been added to <cite>SeisComP</cite> to be used as source for custom notifications.</p>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="section" id="event-script">
<h3>Event script<a class="headerlink" href="#event-script" title="Permalink to this headline"></a></h3>
<p>The following script is used as event script. It requires
<a class="reference external" href="http://www.cstr.ed.ac.uk/projects/festival/">festival</a> which should be
available in almost any Linux distribution.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>When saving the scripts given below do not forget to set the executable
bit otherwise scvoice cannot call the scripts. In Linux just run:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>chmod +x /path/to/file
</pre></div>
</div>
</div>
<ol class="arabic">
<li><p>Save an executable script file, e.g., under, e.g. <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/event.sh</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<span class="k">if</span> <span class="o">[</span> <span class="s2">&quot;</span><span class="nv">$2</span><span class="s2">&quot;</span> <span class="o">=</span> <span class="s2">&quot;1&quot;</span> <span class="o">]</span><span class="p">;</span> <span class="k">then</span>
<span class="nb">echo</span> <span class="s2">&quot; </span><span class="nv">$1</span><span class="s2">&quot;</span> <span class="p">|</span> sed <span class="s1">&#39;s/,/, ,/g&#39;</span> <span class="p">|</span> festival --tts<span class="p">;</span>
<span class="k">else</span>
<span class="nb">echo</span> <span class="s2">&quot;Event updated, </span><span class="nv">$1</span><span class="s2">&quot;</span> <span class="p">|</span> sed <span class="s1">&#39;s/,/, ,/g&#39;</span> <span class="p">|</span> festival --tts<span class="p">;</span>
<span class="k">fi</span>
</pre></div>
</div>
</li>
<li><p>Add the file to the configuration of <a class="reference internal" href="#confval-scripts.event"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.event</span></code></a> in the file
<code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/etc/scvoice.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scvoice.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scripts.event <span class="o">=</span> /home/sysop/.seiscomp/event.sh
</pre></div>
</div>
</li>
</ol>
</div>
<div class="section" id="amplitude-script">
<h3>Amplitude script<a class="headerlink" href="#amplitude-script" title="Permalink to this headline"></a></h3>
<ol class="arabic">
<li><p>Save an executable script file, e.g., under <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/amplitude.sh</span></code></p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
<span class="c1"># Play a wav file with a particular volume</span>
<span class="c1"># derived from the amplitude itself.</span>
playwave ~/.seiscomp/beep.wav -v <span class="nv">$3</span>
</pre></div>
</div>
</li>
<li><p>Add the file to the configuration of <a class="reference internal" href="#confval-scripts.amplitude"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.amplitude</span></code></a> in the
file <code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/etc/scvoice.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scvoice.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scripts.amplitude <span class="o">=</span> /home/sysop/.seiscomp/amplitude.sh
</pre></div>
</div>
</li>
</ol>
</div>
<div class="section" id="alert-script">
<h3>Alert script<a class="headerlink" href="#alert-script" title="Permalink to this headline"></a></h3>
<ol class="arabic">
<li><p>Create a sound file <code class="file docutils literal notranslate"><span class="pre">siren.wav</span></code> for accoustic alerts.</p></li>
<li><p>Save an executable script file under, e.g., <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/alert.sh</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
playwave /home/sysop/.seiscomp/siren.wav
</pre></div>
</div>
</li>
<li><p>Add the script filename to the configuration of <a class="reference internal" href="#confval-scripts.alert"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.alert</span></code></a> in
the file <code class="file docutils literal notranslate"><span class="pre">SEISCOMP_ROOT/etc/scvoice.cfg</span></code> or <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scvoice.cfg</span></code>.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scripts.alert <span class="o">=</span> /home/sysop/.seiscomp/alert.sh
</pre></div>
</div>
</li>
</ol>
</div>
</div>
<div class="section" id="module-configuration">
<span id="scvoice-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this headline"></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/scvoice.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/scvoice.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/scvoice.cfg</span></code></div>
</div>
<p>scvoice inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="confval">
<dt id="confval-firstNew">
<code class="sig-name descname">firstNew</code><a class="headerlink" href="#confval-firstNew" 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>Treat an event as new event when it is seen the first time.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-agencyIDs">
<code class="sig-name descname">agencyIDs</code><a class="headerlink" href="#confval-agencyIDs" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Define a white list of agencyIDs to alert an event. The
agencyID is extracted from the preferred origin of the event.
If this list is empty, all agencies are allowed.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-poi.message">
<code class="sig-name descname">poi.message</code><a class="headerlink" href="#confval-poi.message" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>The default message string for the event-script is
“earthquake, [HOURS] hours [MINS] minutes ago, [DESC],
magnitude [MAG], depth [DEP] kilometers” whereas [DESC]
is the string given in the event.description attribute.
This string can be overwritten using one of the following
options. There are three placeholders that can be used:
&#64;region&#64;, &#64;dist&#64; and &#64;poi&#64;.
Example: “&#64;region&#64;, &#64;dist&#64; kilometers from &#64;poi&#64; away”.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-poi.maxDist">
<code class="sig-name descname">poi.maxDist</code><a class="headerlink" href="#confval-poi.maxDist" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">20</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>When using the nearest point of interest (city) as part of the
message string, specify the maximum distance in degrees from the
event. Any point of interest farther away will be ignored.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-poi.minPopulation">
<code class="sig-name descname">poi.minPopulation</code><a class="headerlink" href="#confval-poi.minPopulation" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">50000</span></code></p>
<p>Type: <em>double</em></p>
<p>Minimum population for a city to become a point of interest.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-scripts.amplitude">
<code class="sig-name descname">scripts.amplitude</code><a class="headerlink" href="#confval-scripts.amplitude" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Specify the script to be called if an amplitude
arrives, network-, stationcode and amplitude are passed
as parameters $1, $2 and $3.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-scripts.alert">
<code class="sig-name descname">scripts.alert</code><a class="headerlink" href="#confval-scripts.alert" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Specify the script to be called if a preliminary
origin arrives, latitude and longitude are passed as
parameters $1 and $2.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-scripts.event">
<code class="sig-name descname">scripts.event</code><a class="headerlink" href="#confval-scripts.event" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Specify the script to be called when an event has been
declared; the message string, a flag (1=new event,
0=update event), the EventID, the arrival count and the
magnitude (optional when set) are passed as parameter
$1, $2, $3, $4 and $5.</p>
</dd></dl>
</div>
<div class="section" id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this headline"></a></h2>
<p><strong class="program">scvoice [options]</strong></p>
<div class="section" id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scvoice-h">
<code class="sig-name descname">-h</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--help</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scvoice-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-v">
<code class="sig-name descname">-V</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scvoice-v" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-config-file">
<code class="sig-name descname">--config-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-plugins">
<code class="sig-name descname">--plugins</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-d">
<code class="sig-name descname">-D</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--daemon</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-auto-shutdown">
<code class="sig-name descname">--auto-shutdown</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-shutdown-master-module">
<code class="sig-name descname">--shutdown-master-module</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-shutdown-master-username">
<code class="sig-name descname">--shutdown-master-username</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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>
<dl class="option">
<dt id="cmdoption-scvoice-first-new">
<code class="sig-name descname">--first-new</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scvoice-first-new" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-firstNew"><code class="xref std std-confval docutils literal notranslate"><span class="pre">firstNew</span></code></a>.</p>
</dd></dl>
</div>
<div class="section" id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scvoice-verbosity">
<code class="sig-name descname">--verbosity</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="id2">
<code class="sig-name descname">-v</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--v</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#id2" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-q">
<code class="sig-name descname">-q</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--quiet</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scvoice-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-component">
<code class="sig-name descname">--component</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-s">
<code class="sig-name descname">-s</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--syslog</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-l">
<code class="sig-name descname">-l</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--lockfile</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-console">
<code class="sig-name descname">--console</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-debug">
<code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-log-file">
<code class="sig-name descname">--log-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</div>
<div class="section" id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scvoice-u">
<code class="sig-name descname">-u</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--user</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-host">
<code class="sig-name descname">-H</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--host</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-host" 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="option">
<dt id="cmdoption-scvoice-t">
<code class="sig-name descname">-t</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--timeout</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-g">
<code class="sig-name descname">-g</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--primary-group</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-subscribe-group">
<code class="sig-name descname">-S</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--subscribe-group</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-subscribe-group" 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="option">
<dt id="cmdoption-scvoice-content-type">
<code class="sig-name descname">--content-type</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-start-stop-msg">
<code class="sig-name descname">--start-stop-msg</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</div>
<div class="section" id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scvoice-db-driver-list">
<code class="sig-name descname">--db-driver-list</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scvoice-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-database">
<code class="sig-name descname">-d</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--database</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-database" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
“service” is the name of the database driver which
can be queried with “–db-driver-list”.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-config-module">
<code class="sig-name descname">--config-module</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-inventory-db">
<code class="sig-name descname">--inventory-db</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-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="option">
<dt id="cmdoption-scvoice-db-disable">
<code class="sig-name descname">--db-disable</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scvoice-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</div>
<div class="section" id="alert">
<h3>Alert<a class="headerlink" href="#alert" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scvoice-amp-type">
<code class="sig-name descname">--amp-type</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-amp-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify the amplitude type to listen to.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-amp-script">
<code class="sig-name descname">--amp-script</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-amp-script" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-scripts.amplitude"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.amplitude</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-alert-script">
<code class="sig-name descname">--alert-script</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-alert-script" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-scripts.alert"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.alert</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-event-script">
<code class="sig-name descname">--event-script</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-event-script" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-scripts.event"><code class="xref std std-confval docutils literal notranslate"><span class="pre">scripts.event</span></code></a>.</p>
</dd></dl>
</div>
<div class="section" id="cities">
<h3>Cities<a class="headerlink" href="#cities" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scvoice-max-dist">
<code class="sig-name descname">--max-dist</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-max-dist" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-poi.maxDist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">poi.maxDist</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scvoice-min-population">
<code class="sig-name descname">--min-population</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-min-population" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="#confval-poi.minPopulation"><code class="xref std std-confval docutils literal notranslate"><span class="pre">poi.minPopulation</span></code></a>.</p>
</dd></dl>
</div>
<div class="section" id="debug">
<h3>Debug<a class="headerlink" href="#debug" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scvoice-e">
<code class="sig-name descname">-E</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--eventid</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scvoice-e" title="Permalink to this definition"></a></dt>
<dd><p>Specify event ID that is used for testing.
After running the alert scripts scvoice will exit.</p>
</dd></dl>
</div>
</div>
</div>
<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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scvoice</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a><ul>
<li><a class="reference internal" href="#event-script">Event script</a></li>
<li><a class="reference internal" href="#amplitude-script">Amplitude script</a></li>
<li><a class="reference internal" href="#alert-script">Alert script</a></li>
</ul>
</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="#alert">Alert</a></li>
<li><a class="reference internal" href="#cities">Cities</a></li>
<li><a class="reference internal" href="#debug">Debug</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="scsohlog.html"
title="previous chapter">scsohlog</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="scxmldump.html"
title="next chapter">scxmldump</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scvoice.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>5.3.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>
View Git Blame Copy Permalink