178 lines
7.4 KiB
HTML
178 lines
7.4 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<title>text — 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="ncurses" href="scm_ncurses.html" />
|
|
<link rel="prev" title="email" href="scm_email.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.1</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="scm_ncurses.html" title="ncurses"
|
|
accesskey="N">
|
|
next
|
|
</a>
|
|
</li>
|
|
<li class="right">
|
|
<a href="scm_email.html" title="email"
|
|
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="../toc/extensions.html" >Extensions</a>
|
|
</li>
|
|
<li class="nav-item nav-item-2">
|
|
<a href="../toc/extensions/scm.html" accesskey="U">scm</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="container">
|
|
<div class="fitted content" id="anchors-container">
|
|
<div class="body" role="main">
|
|
|
|
<section id="text">
|
|
<span id="scm-text"></span><h1>text<a class="headerlink" href="#text" title="Permalink to this heading">¶</a></h1>
|
|
<p>Text output plugin for scm.</p>
|
|
<section id="description">
|
|
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
|
<p>The text plugin writes for each client a status text file to a
|
|
<a class="reference internal" href="#confval-mtextplugin.outputDir"><code class="xref std std-confval docutils literal notranslate"><span class="pre">configurable</span></code></a> directory. Each text file
|
|
is named after the client with the extension “.txt”.</p>
|
|
</section>
|
|
<section id="plugin">
|
|
<h2>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading">¶</a></h2>
|
|
<p>The text plugin is installed under <code class="file docutils literal notranslate"><span class="pre">share/plugins/monitor/mtextplugin.so</span></code>.</p>
|
|
<p>To add the plugin to <a class="reference internal" href="scm.html#scm"><span class="std std-ref">scm</span></a>, add it to the plugin list:</p>
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,<span class="w"> </span>mtextplugin
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
<section id="module-configuration">
|
|
<span id="scm-text-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading">¶</a></h2>
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-mtextplugin.outputDir">
|
|
<span class="sig-name descname"><span class="pre">mtextplugin.outputDir</span></span><a class="headerlink" href="#confval-mtextplugin.outputDir" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">@LOGDIR@/scm/</span></code></p>
|
|
<p>Type: <em>string</em></p>
|
|
<p>Output directory where [client].txt is written to. Additionally
|
|
an file description.txt will be created to show the order of
|
|
tags used in the client status file.</p>
|
|
</dd></dl>
|
|
|
|
</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="#">text</a><ul>
|
|
<li><a class="reference internal" href="#description">Description</a></li>
|
|
<li><a class="reference internal" href="#plugin">Plugin</a></li>
|
|
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
<div>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="scm_email.html"
|
|
title="previous chapter">email</a></p>
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="scm_ncurses.html"
|
|
title="next chapter">ncurses</a></p>
|
|
</div>
|
|
<div role="note" aria-label="source link">
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/apps/scm_text.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.1</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> |