[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
272
share/doc/seiscomp/html/_sources/apps/scmm.rst.txt
Normal file
272
share/doc/seiscomp/html/_sources/apps/scmm.rst.txt
Normal file
@ -0,0 +1,272 @@
|
||||
.. highlight:: rst
|
||||
|
||||
.. _scmm:
|
||||
|
||||
####
|
||||
scmm
|
||||
####
|
||||
|
||||
**Messaging Monitor**
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
**scmm** is the messaging monitor, the graphical interface to :ref:`scm`. It allows to
|
||||
view the messages from all modules sent around by the SeisComP messaging system.
|
||||
Therefore, **scmm** can be used to debug configured message groups and module
|
||||
connections, e.g. in a system with several processing pipelines and specific
|
||||
message groups.
|
||||
|
||||
In addition, **scmm** allows to view the content of single messges
|
||||
as well as the memory consumption and other statistics of all modules connected
|
||||
to the SeisComP messaging system.
|
||||
|
||||
.. figure:: media/scmm_messages.png
|
||||
:width: 8cm
|
||||
:align: center
|
||||
|
||||
View message notifications.
|
||||
|
||||
.. figure:: media/scmm_message.png
|
||||
:width: 8cm
|
||||
:align: center
|
||||
|
||||
View the message content by clicking on individual messages.
|
||||
|
||||
.. figure:: media/scmm_clients.png
|
||||
:width: 8cm
|
||||
:align: center
|
||||
|
||||
View module memory consumptions.
|
||||
|
||||
.. figure:: media/scmm_statistics.png
|
||||
:width: 8cm
|
||||
:align: center
|
||||
|
||||
View module statistics.
|
||||
|
||||
|
||||
.. _scmm_configuration:
|
||||
|
||||
Module Configuration
|
||||
====================
|
||||
|
||||
| :file:`etc/defaults/global.cfg`
|
||||
| :file:`etc/defaults/scmm.cfg`
|
||||
| :file:`etc/global.cfg`
|
||||
| :file:`etc/scmm.cfg`
|
||||
| :file:`~/.seiscomp/global.cfg`
|
||||
| :file:`~/.seiscomp/scmm.cfg`
|
||||
|
||||
scmm inherits :ref:`global options<global-configuration>`.
|
||||
|
||||
|
||||
|
||||
|
||||
Command-Line Options
|
||||
====================
|
||||
|
||||
.. program:: scmm
|
||||
|
||||
:program:`scmm [options]`
|
||||
|
||||
|
||||
Generic
|
||||
-------
|
||||
|
||||
.. option:: -h, --help
|
||||
|
||||
Show help message.
|
||||
|
||||
.. option:: -V, --version
|
||||
|
||||
Show version information.
|
||||
|
||||
.. option:: --config-file arg
|
||||
|
||||
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.
|
||||
|
||||
.. option:: --plugins arg
|
||||
|
||||
Load given plugins.
|
||||
|
||||
.. option:: --auto-shutdown arg
|
||||
|
||||
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\).
|
||||
|
||||
.. option:: --shutdown-master-module arg
|
||||
|
||||
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.
|
||||
|
||||
.. option:: --shutdown-master-username arg
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Verbosity
|
||||
---------
|
||||
|
||||
.. option:: --verbosity arg
|
||||
|
||||
Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
|
||||
4:debug.
|
||||
|
||||
.. option:: -v, --v
|
||||
|
||||
Increase verbosity level \(may be repeated, eg. \-vv\).
|
||||
|
||||
.. option:: -q, --quiet
|
||||
|
||||
Quiet mode: no logging output.
|
||||
|
||||
.. option:: --component arg
|
||||
|
||||
Limit the logging to a certain component. This option can
|
||||
be given more than once.
|
||||
|
||||
.. option:: -s, --syslog
|
||||
|
||||
Use syslog logging backend. The output usually goes to
|
||||
\/var\/lib\/messages.
|
||||
|
||||
.. option:: -l, --lockfile arg
|
||||
|
||||
Path to lock file.
|
||||
|
||||
.. option:: --console arg
|
||||
|
||||
Send log output to stdout.
|
||||
|
||||
.. option:: --debug
|
||||
|
||||
Execute in debug mode.
|
||||
Equivalent to \-\-verbosity\=4 \-\-console\=1 .
|
||||
|
||||
.. option:: --log-file arg
|
||||
|
||||
Use alternative log file.
|
||||
|
||||
.. option:: --print-component arg
|
||||
|
||||
For each log entry print the component right after the
|
||||
log level. By default the component output is enabled
|
||||
for file output but disabled for console output.
|
||||
|
||||
.. option:: --trace
|
||||
|
||||
Execute in trace mode.
|
||||
Equivalent to \-\-verbosity\=4 \-\-console\=1 \-\-print\-component\=1
|
||||
\-\-print\-context\=1 .
|
||||
|
||||
|
||||
Messaging
|
||||
---------
|
||||
|
||||
.. option:: -u, --user arg
|
||||
|
||||
Overrides configuration parameter :confval:`connection.username`.
|
||||
|
||||
.. option:: -H, --host arg
|
||||
|
||||
Overrides configuration parameter :confval:`connection.server`.
|
||||
|
||||
.. option:: -t, --timeout arg
|
||||
|
||||
Overrides configuration parameter :confval:`connection.timeout`.
|
||||
|
||||
.. option:: -g, --primary-group arg
|
||||
|
||||
Overrides configuration parameter :confval:`connection.primaryGroup`.
|
||||
|
||||
.. option:: -S, --subscribe-group arg
|
||||
|
||||
A group to subscribe to.
|
||||
This option can be given more than once.
|
||||
|
||||
.. option:: --content-type arg
|
||||
|
||||
Overrides configuration parameter :confval:`connection.contentType`.
|
||||
|
||||
.. option:: --start-stop-msg arg
|
||||
|
||||
Set sending of a start and a stop message.
|
||||
|
||||
|
||||
Database
|
||||
--------
|
||||
|
||||
.. option:: --db-driver-list
|
||||
|
||||
List all supported database drivers.
|
||||
|
||||
.. option:: -d, --database arg
|
||||
|
||||
The database connection string, format:
|
||||
service:\/\/user:pwd\@host\/database.
|
||||
\"service\" is the name of the database driver which
|
||||
can be queried with \"\-\-db\-driver\-list\".
|
||||
|
||||
.. option:: --config-module arg
|
||||
|
||||
The config module to use.
|
||||
|
||||
.. option:: --inventory-db arg
|
||||
|
||||
Load the inventory from the given database or file, format:
|
||||
[service:\/\/]location .
|
||||
|
||||
.. option:: --db-disable
|
||||
|
||||
Do not use the database at all
|
||||
|
||||
|
||||
Records
|
||||
-------
|
||||
|
||||
.. option:: --record-driver-list
|
||||
|
||||
List all supported record stream drivers.
|
||||
|
||||
.. option:: -I, --record-url arg
|
||||
|
||||
The recordstream source URL, format:
|
||||
[service:\/\/]location[#type].
|
||||
\"service\" is the name of the recordstream driver
|
||||
which can be queried with \"\-\-record\-driver\-list\".
|
||||
If \"service\" is not given, \"file:\/\/\" is
|
||||
used.
|
||||
|
||||
.. option:: --record-file arg
|
||||
|
||||
Specify a file as record source.
|
||||
|
||||
.. option:: --record-type arg
|
||||
|
||||
Specify a type for the records being read.
|
||||
|
||||
|
||||
User interface
|
||||
--------------
|
||||
|
||||
.. option:: -F, --full-screen
|
||||
|
||||
Start the application in fullscreen
|
||||
|
||||
.. option:: -N, --non-interactive
|
||||
|
||||
Use non interactive presentation mode
|
||||
|
||||
Reference in New Issue
Block a user