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 'main'
${ noResults }
seiscomp-training/share/doc/seiscomp/html/apps/scsendjournal.html

412 lines
22 KiB
HTML
Raw Permalink 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>scsendjournal &#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="scsendorigin" href="scsendorigin.html" />
<link rel="prev" title="scqueryqc" href="scqueryqc.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="scsendorigin.html" title="scsendorigin"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scqueryqc.html" title="scqueryqc"
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="scsendjournal">
<span id="id1"></span><h1>scsendjournal<a class="headerlink" href="#scsendjournal" title="Permalink to this headline"></a></h1>
<p><strong>Send journaling information to the messaging to manipulate event parameter objects.</strong></p>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>scsendjournal sends journals to the scname messaging system.
Currently, journals can be used to command <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>.
The journals command <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> to manipulate event parameters according to
the <a class="reference internal" href="#scsendjournal-actions"><span class="std std-ref">journal actions</span></a> which must be known to
<a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>.</p>
<p>The actions allow to:</p>
<ul class="simple">
<li><p>Create new events,</p></li>
<li><p>Modify event parameters,</p></li>
<li><p>Control the association of origins to events.</p></li>
</ul>
</div>
<div class="section" id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
<p>scsendjournal [opts] {objectID} {action} [parameters]</p>
</div>
<div class="section" id="actions">
<span id="scsendjournal-actions"></span><h2>Actions<a class="headerlink" href="#actions" title="Permalink to this headline"></a></h2>
<p>There are specific journal actions for handling non-events and events. The documentation
of <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> contains a <a class="reference internal" href="scevent.html#scevent-journals"><span class="std std-ref">complete list of journals known to scevent</span></a>.</p>
<div class="section" id="none-event-specific-actions">
<h3>None-event specific actions<a class="headerlink" href="#none-event-specific-actions" title="Permalink to this headline"></a></h3>
<ul>
<li><p><strong>EvNewEvent</strong>: Create a new event from origin with the provided origin ID.
The origin must be known to <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>.</p>
<p>Example: Create a new event from the
origin with given originID. Apply the action in the message system on <em>localhost</em>:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H localhost Origin#20170505130954.736019.318 EvNewEvent
</pre></div>
</div>
</li>
</ul>
</div>
<div class="section" id="origin-association">
<h3>Origin association<a class="headerlink" href="#origin-association" title="Permalink to this headline"></a></h3>
<ul>
<li><p><strong>EvGrabOrg</strong>: Grab origin and move the origin to the event with the given eventID.
If the origins is already associated to another event, remove this reference
in the other event.</p></li>
<li><p><strong>EvMerge</strong>: Merge events into one event.</p>
<p>Example: Merge all origins from the source event with eventID <em>eventS</em> into the
target event with eventID <em>eventT</em>. Remove event <em>eventS</em>. Apply the action in
the message system on <em>host</em>:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H {host} {eventT} EvMerge {eventS}
</pre></div>
</div>
</li>
<li><p><strong>EvSplitOrg</strong>: Split origins to 2 events.</p></li>
</ul>
</div>
<div class="section" id="event-parameters">
<h3>Event parameters<a class="headerlink" href="#event-parameters" title="Permalink to this headline"></a></h3>
<ul>
<li><p><strong>EvName</strong>: Set <em>EventDescription</em> of type <em>earthquake name</em>.</p>
<p>Example, setting the name of the event with
eventID <em>gempa2021abcd</em> to <em>Petrinja</em></p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H localhost gempa2020abcd EvName &quot;Petrinja&quot;
</pre></div>
</div>
</li>
<li><p><strong>EvOpComment</strong>: Set event operator’s comment.</p></li>
<li><p><strong>EvPrefFocMecID</strong>: Set event preferred focal mechanism.</p></li>
<li><p><strong>EvPrefMagTypev:</strong> Set preferred magnitude type.</p></li>
<li><p><strong>EvPrefMw</strong>: Set Mw from focal mechanism as preferred magnitude.</p></li>
<li><p><strong>EvPrefOrgAutomatic</strong>: Set the preferred mode to <em>automatic</em> corresponding to <em>unfix</em> in scolv.</p></li>
<li><p><strong>EvPrefOrgEvalMode</strong>: Set preferred origin by evaluation mode.</p></li>
<li><p><strong>EvPrefOrgID</strong>: Set preferred origin by ID.</p></li>
<li><p><strong>EvRefresh</strong>: Select the preferred origin, the preferred magnitude, update
the region. Call processors loaded with plugins, e.g. the
<a class="reference internal" href="scevent_regioncheck.html#scevent-regioncheck"><span class="std std-ref">evrc</span></a> plugin for scevent.</p>
<p>Example:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H localhost gempa2021abcd EvRefresh
</pre></div>
</div>
</li>
<li><p><strong>EvType</strong>: Set event type.</p>
<p>Example: Set the type of the event with eventID <em>gempa2021abcd</em> to <em>nuclear explosion</em>.</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scsendjournal -H localhost gempa2021abcd EvType &quot;nuclear explosion&quot;
</pre></div>
</div>
</li>
<li><p><strong>EvTypeCertainty</strong>: set event type certainty.</p></li>
</ul>
</div>
</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">scsendjournal [opts] {objectID} {action} [parameters]</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-scsendjournal-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-scsendjournal-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scsendjournal-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-scsendjournal-v" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scsendjournal-config-file">
<code class="sig-name descname">--config-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-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-scsendjournal-plugins">
<code class="sig-name descname">--plugins</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scsendjournal-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-scsendjournal-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-scsendjournal-auto-shutdown">
<code class="sig-name descname">--auto-shutdown</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-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-scsendjournal-shutdown-master-module">
<code class="sig-name descname">--shutdown-master-module</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-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-scsendjournal-shutdown-master-username">
<code class="sig-name descname">--shutdown-master-username</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-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>
</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-scsendjournal-verbosity">
<code class="sig-name descname">--verbosity</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-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-scsendjournal-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-scsendjournal-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scsendjournal-component">
<code class="sig-name descname">--component</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scsendjournal-console">
<code class="sig-name descname">--console</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scsendjournal-debug">
<code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scsendjournal-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-scsendjournal-log-file">
<code class="sig-name descname">--log-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-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-scsendjournal-start-stop-msg">
<code class="sig-name descname">--start-stop-msg</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scsendjournal-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>
</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="#">scsendjournal</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#actions">Actions</a><ul>
<li><a class="reference internal" href="#none-event-specific-actions">None-event specific actions</a></li>
<li><a class="reference internal" href="#origin-association">Origin association</a></li>
<li><a class="reference internal" href="#event-parameters">Event parameters</a></li>
</ul>
</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>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="scqueryqc.html"
title="previous chapter">scqueryqc</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="scsendorigin.html"
title="next chapter">scsendorigin</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scsendjournal.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