[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
303
share/man/man1/scmm.1
Normal file
303
share/man/man1/scmm.1
Normal file
@ -0,0 +1,303 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
.de1 rstReportMargin
|
||||
\\$1 \\n[an-margin]
|
||||
level \\n[rst2man-indent-level]
|
||||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
-
|
||||
\\n[rst2man-indent0]
|
||||
\\n[rst2man-indent1]
|
||||
\\n[rst2man-indent2]
|
||||
..
|
||||
.de1 INDENT
|
||||
.\" .rstReportMargin pre:
|
||||
. RS \\$1
|
||||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||||
. nr rst2man-indent-level +1
|
||||
.\" .rstReportMargin post:
|
||||
..
|
||||
.de UNINDENT
|
||||
. RE
|
||||
.\" indent \\n[an-margin]
|
||||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.nr rst2man-indent-level -1
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SCMM" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scmm \- SeisComP Documentation
|
||||
.sp
|
||||
\fBMessaging Monitor\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
\fBscmm\fP is the messaging monitor, the graphical interface to \fI\%scm\fP\&. It allows to
|
||||
view the messages from all modules sent around by the SeisComP messaging system.
|
||||
Therefore, \fBscmm\fP can be used to debug configured message groups and module
|
||||
connections, e.g. in a system with several processing pipelines and specific
|
||||
message groups.
|
||||
.sp
|
||||
In addition, \fBscmm\fP 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.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
View message notifications..UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
View the message content by clicking on individual messages..UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
View module memory consumptions..UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
View module statistics..UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scmm.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scmm.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scmm.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scmm inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscmm [options]\fP
|
||||
.SS Generic
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h, \-\-help
|
||||
Show help message.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-V, \-\-version
|
||||
Show version information.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-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.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-plugins arg
|
||||
Load given plugins.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-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).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-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.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-shutdown\-master\-username arg
|
||||
Set the name of the master\-username of the messaging
|
||||
used for auto\-shutdown. If \(dqshutdown\-master\-module\(dq is
|
||||
given as well, this parameter is ignored.
|
||||
.UNINDENT
|
||||
.SS Verbosity
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-verbosity arg
|
||||
Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
|
||||
4:debug.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-v, \-\-v
|
||||
Increase verbosity level (may be repeated, eg. \-vv).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-q, \-\-quiet
|
||||
Quiet mode: no logging output.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-component arg
|
||||
Limit the logging to a certain component. This option can
|
||||
be given more than once.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-s, \-\-syslog
|
||||
Use syslog logging backend. The output usually goes to
|
||||
/var/lib/messages.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-l, \-\-lockfile arg
|
||||
Path to lock file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-console arg
|
||||
Send log output to stdout.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-debug
|
||||
Execute in debug mode.
|
||||
Equivalent to \-\-verbosity=4 \-\-console=1 .
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-log\-file arg
|
||||
Use alternative log file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-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.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-trace
|
||||
Execute in trace mode.
|
||||
Equivalent to \-\-verbosity=4 \-\-console=1 \-\-print\-component=1
|
||||
\-\-print\-context=1 .
|
||||
.UNINDENT
|
||||
.SS Messaging
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-u, \-\-user arg
|
||||
Overrides configuration parameter \fI\%connection.username\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-H, \-\-host arg
|
||||
Overrides configuration parameter \fI\%connection.server\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-t, \-\-timeout arg
|
||||
Overrides configuration parameter \fI\%connection.timeout\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-g, \-\-primary\-group arg
|
||||
Overrides configuration parameter \fI\%connection.primaryGroup\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-S, \-\-subscribe\-group arg
|
||||
A group to subscribe to.
|
||||
This option can be given more than once.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-content\-type arg
|
||||
Overrides configuration parameter \fI\%connection.contentType\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-start\-stop\-msg arg
|
||||
Set sending of a start and a stop message.
|
||||
.UNINDENT
|
||||
.SS Database
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-db\-driver\-list
|
||||
List all supported database drivers.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-d, \-\-database arg
|
||||
The database connection string, format:
|
||||
\fI\%service://user:pwd@host/database\fP\&.
|
||||
\(dqservice\(dq is the name of the database driver which
|
||||
can be queried with \(dq\-\-db\-driver\-list\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-config\-module arg
|
||||
The config module to use.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-inventory\-db arg
|
||||
Load the inventory from the given database or file, format:
|
||||
[\fI\%service://]location\fP .
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-db\-disable
|
||||
Do not use the database at all
|
||||
.UNINDENT
|
||||
.SS Records
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-record\-driver\-list
|
||||
List all supported record stream drivers.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-I, \-\-record\-url arg
|
||||
The recordstream source URL, format:
|
||||
[\fI\%service://\fP]location[#type].
|
||||
\(dqservice\(dq is the name of the recordstream driver
|
||||
which can be queried with \(dq\-\-record\-driver\-list\(dq.
|
||||
If \(dqservice\(dq is not given, \(dq\fI\%file://\fP\(dq is
|
||||
used.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-record\-file arg
|
||||
Specify a file as record source.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-record\-type arg
|
||||
Specify a type for the records being read.
|
||||
.UNINDENT
|
||||
.SS User interface
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-F, \-\-full\-screen
|
||||
Start the application in fullscreen
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-N, \-\-non\-interactive
|
||||
Use non interactive presentation mode
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
Reference in New Issue
Block a user