[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
618
share/doc/seiscomp/html/apps/scvoice.html
Normal file
618
share/doc/seiscomp/html/apps/scvoice.html
Normal file
@ -0,0 +1,618 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>scvoice — 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="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">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="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">
|
||||
|
||||
<section id="scvoice">
|
||||
<span id="id1"></span><h1>scvoice<a class="headerlink" href="#scvoice" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>Real time voice alert.</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</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>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<section id="event-script">
|
||||
<h3>Event script<a class="headerlink" href="#event-script" title="Permalink to this heading">¶</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<span class="w"> </span>+x<span class="w"> </span>/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="w"> </span><span class="o">[</span><span class="w"> </span><span class="s2">"</span><span class="nv">$2</span><span class="s2">"</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"1"</span><span class="w"> </span><span class="o">]</span><span class="p">;</span><span class="w"> </span><span class="k">then</span>
|
||||
<span class="nb">echo</span><span class="w"> </span><span class="s2">" </span><span class="nv">$1</span><span class="s2">"</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sed<span class="w"> </span><span class="s1">'s/,/, ,/g'</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>festival<span class="w"> </span>--tts<span class="p">;</span>
|
||||
<span class="k">else</span>
|
||||
<span class="nb">echo</span><span class="w"> </span><span class="s2">"Event updated, </span><span class="nv">$1</span><span class="s2">"</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sed<span class="w"> </span><span class="s1">'s/,/, ,/g'</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>festival<span class="w"> </span>--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="w"> </span><span class="o">=</span><span class="w"> </span>/home/sysop/.seiscomp/event.sh
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="amplitude-script">
|
||||
<h3>Amplitude script<a class="headerlink" href="#amplitude-script" title="Permalink to this heading">¶</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<span class="w"> </span>~/.seiscomp/beep.wav<span class="w"> </span>-v<span class="w"> </span><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="w"> </span><span class="o">=</span><span class="w"> </span>/home/sysop/.seiscomp/amplitude.sh
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="alert-script">
|
||||
<h3>Alert script<a class="headerlink" href="#alert-script" title="Permalink to this heading">¶</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<span class="w"> </span>/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="w"> </span><span class="o">=</span><span class="w"> </span>/home/sysop/.seiscomp/alert.sh
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</section>
|
||||
</section>
|
||||
<section id="module-configuration">
|
||||
<span id="scvoice-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/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="std confval">
|
||||
<dt class="sig sig-object std" id="confval-firstNew">
|
||||
<span class="sig-name descname"><span class="pre">firstNew</span></span><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="std confval">
|
||||
<dt class="sig sig-object std" id="confval-agencyIDs">
|
||||
<span class="sig-name descname"><span class="pre">agencyIDs</span></span><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="std confval">
|
||||
<dt class="sig sig-object std" id="confval-poi.message">
|
||||
<span class="sig-name descname"><span class="pre">poi.message</span></span><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:
|
||||
@region@, @dist@ and @poi@.
|
||||
Example: "@region@, @dist@ kilometers from @poi@ away".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-poi.maxDist">
|
||||
<span class="sig-name descname"><span class="pre">poi.maxDist</span></span><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="std confval">
|
||||
<dt class="sig sig-object std" id="confval-poi.minPopulation">
|
||||
<span class="sig-name descname"><span class="pre">poi.minPopulation</span></span><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="std confval">
|
||||
<dt class="sig sig-object std" id="confval-scripts.amplitude">
|
||||
<span class="sig-name descname"><span class="pre">scripts.amplitude</span></span><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="std confval">
|
||||
<dt class="sig sig-object std" id="confval-scripts.alert">
|
||||
<span class="sig-name descname"><span class="pre">scripts.alert</span></span><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="std confval">
|
||||
<dt class="sig sig-object std" id="confval-scripts.event">
|
||||
<span class="sig-name descname"><span class="pre">scripts.event</span></span><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>
|
||||
|
||||
</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">scvoice [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-scvoice-h">
|
||||
<span id="cmdoption-scvoice-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-scvoice-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-scvoice-V">
|
||||
<span id="cmdoption-scvoice-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-scvoice-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-scvoice-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-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 -> scautopick2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-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-scvoice-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-scvoice-D">
|
||||
<span id="cmdoption-scvoice-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-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 &.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-first-new">
|
||||
<span class="sig-name descname"><span class="pre">--first-new</span></span><span class="sig-prename descclassname"></span><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>
|
||||
|
||||
</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-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-v">
|
||||
<span id="cmdoption-scvoice-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-scvoice-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-scvoice-q">
|
||||
<span id="cmdoption-scvoice-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-scvoice-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-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-s">
|
||||
<span id="cmdoption-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-l">
|
||||
<span id="cmdoption-scvoice-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-scvoice-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-scvoice-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-scvoice-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-scvoice-debug">
|
||||
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-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-scvoice-log-file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use alternative log file.</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-scvoice-u">
|
||||
<span id="cmdoption-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-H">
|
||||
<span id="cmdoption-scvoice-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-scvoice-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-scvoice-t">
|
||||
<span id="cmdoption-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-g">
|
||||
<span id="cmdoption-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-S">
|
||||
<span id="cmdoption-scvoice-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-scvoice-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-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-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-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>
|
||||
|
||||
</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-scvoice-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-scvoice-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-scvoice-d">
|
||||
<span id="cmdoption-scvoice-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-scvoice-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-scvoice-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-scvoice-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-scvoice-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-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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-db-disable">
|
||||
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><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>
|
||||
|
||||
</section>
|
||||
<section id="alert">
|
||||
<h3>Alert<a class="headerlink" href="#alert" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-amp-type">
|
||||
<span class="sig-name descname"><span class="pre">--amp-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-amp-script">
|
||||
<span class="sig-name descname"><span class="pre">--amp-script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-alert-script">
|
||||
<span class="sig-name descname"><span class="pre">--alert-script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-event-script">
|
||||
<span class="sig-name descname"><span class="pre">--event-script</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><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>
|
||||
|
||||
</section>
|
||||
<section id="cities">
|
||||
<h3>Cities<a class="headerlink" href="#cities" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-max-dist">
|
||||
<span class="sig-name descname"><span class="pre">--max-dist</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><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="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-min-population">
|
||||
<span class="sig-name descname"><span class="pre">--min-population</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><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>
|
||||
|
||||
</section>
|
||||
<section id="debug">
|
||||
<h3>Debug<a class="headerlink" href="#debug" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scvoice-E">
|
||||
<span id="cmdoption-scvoice-eventid"></span><span class="sig-name descname"><span class="pre">-E</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">--eventid</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><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>
|
||||
|
||||
</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="#">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>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="scsohlog.html"
|
||||
title="previous chapter">scsohlog</a></p>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="scxmldump.html"
|
||||
title="next chapter">scxmldump</a></p>
|
||||
</div>
|
||||
<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>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