[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
276
share/man/man1/scsohlog.1
Normal file
276
share/man/man1/scsohlog.1
Normal file
@ -0,0 +1,276 @@
|
||||
.\" 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 "SCSOHLOG" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scsohlog \- SeisComP Documentation
|
||||
.sp
|
||||
\fBConnect to the messaging and collect all information sent from connected
|
||||
clients.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scsohlog connects to the messaging and collects all information sent from connected
|
||||
clients. It creates an XML file and writes that to disc at a configurable interval.
|
||||
That output can be read by any consumer and converted to the desired output.
|
||||
.SH EXAMPLE
|
||||
.sp
|
||||
Create an output XML file every 60 seconds and execute a custom script to process
|
||||
that XML file.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
#!/bin/sh
|
||||
scsohlog \-o stat.xml \-i 60 \-\-script process\-stat.sh
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
You can also preconfigure these values:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
monitor.output.file = /path/to/stat.xml
|
||||
monitor.output.interval = 60
|
||||
monitor.output.script = /path/to/script.sh
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scsohlog.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scsohlog.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scsohlog.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scsohlog inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B monitor.output.interval
|
||||
Default: \fB60\fP
|
||||
.sp
|
||||
Type: \fIuint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
The output interval in seconds.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B monitor.output.file
|
||||
Default: \fB@LOGDIR@/server.xml\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The output XML file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B monitor.output.script
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The script to execute.
|
||||
Example: @CONFIGDIR@/scripts/scsohlog_script.sh.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscsohlog [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 \-D, \-\-daemon
|
||||
Run as daemon. This means the application will fork itself
|
||||
and doesn\(aqt need to be started with &.
|
||||
.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
|
||||
.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 Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-file file
|
||||
The output XML file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-interval arg
|
||||
The output interval in seconds.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-script arg
|
||||
The script to execute. Example: path/scsohlog_script.sh.
|
||||
.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