[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
86
share/man/man1/access.1
Normal file
86
share/man/man1/access.1
Normal file
@ -0,0 +1,86 @@
|
||||
.\" 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 "ACCESS" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
access \- SeisComP Documentation
|
||||
.sp
|
||||
\fBAccess module for FDSNWS.\fP
|
||||
.SH BINDINGS PARAMETERS
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBaccess.*\fP
|
||||
\fIDefines access to restricted data. When defined it will add the listed users to the list of authorized users to access certain restricted data give the parameters on this binding.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B access.users
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
List of users (e\-mail addresses) allowed to access the restricted data.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B access.disableStationCode
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
When disableStationCode option is set to true the access entries will be generated only for the network level (and optionally stream level), no station code will be filled (this can potentially reduce the number of entries on the access table, and save memory on the request handler when used).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B access.streams
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
List of locations.streams this access rule applies to. The location code is optional (optional, allow wildcards).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B access.start
|
||||
Type: \fIdatetime\fP
|
||||
.sp
|
||||
Start of validity (optional).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B access.end
|
||||
Type: \fIdatetime\fP
|
||||
.sp
|
||||
End of validity (optional).
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
290
share/man/man1/bindings2cfg.1
Normal file
290
share/man/man1/bindings2cfg.1
Normal file
@ -0,0 +1,290 @@
|
||||
.\" 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 "BINDINGS2CFG" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
bindings2cfg \- SeisComP Documentation
|
||||
.sp
|
||||
\fBSynchronize key files with configuration database or convert them to
|
||||
configuration XML.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
bindings2cfg dumps the bindings configuration from a specific key directory
|
||||
to the given database or a configuration XML. In this way, the bindings parameters
|
||||
can be configured in a directory different from $SEISCOMP_ROOT/etc/. From this
|
||||
non\-standard directory the configuration XML can be created without
|
||||
prior writing the bindings to a database and reading from there using e.g.
|
||||
\fI\%scxmldump\fP\&.
|
||||
.sp
|
||||
This utility is useful for repeating parameter tuning.
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Write the bindings configuration from some key directory to a configuration
|
||||
XML file:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
bindings2cfg \-\-key\-dir ./etc/key \-o config.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Write the bindings configuration from some key directory to the seiscomp
|
||||
database on localhost
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
bindings2cfg \-\-key\-dir ./etc/key \-d mysql://sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/bindings2cfg.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/bindings2cfg.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/bindings2cfg.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
bindings2cfg inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBbindings2cfg [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 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 \-\-config\-db arg
|
||||
Load the configuration from the given database or file,
|
||||
format: [\fI\%service://]location\fP .
|
||||
.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 Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-key\-dir arg
|
||||
Override the location of the default key directory,
|
||||
which is $SEISCOMP_ROOT/etc/key .
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output arg
|
||||
If given, an output XML file is generated. Use \(aq\-\(aq for
|
||||
stdout.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-create\-notifier
|
||||
If given then a notifier message containing all notifiers
|
||||
will be written to the output XML. This option only applies
|
||||
if an output file is given. Notifier creation either requires
|
||||
and input database and an input config XML as reference.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
95
share/man/man1/diskmon.1
Normal file
95
share/man/man1/diskmon.1
Normal file
@ -0,0 +1,95 @@
|
||||
.\" 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 "DISKMON" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
diskmon \- SeisComP Documentation
|
||||
.sp
|
||||
\fBMonitors a disk and sends notifications.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
Diskmon is a SeisComP init script that checks on each call to \fBseiscomp check\fP
|
||||
the filesystem by running the following command:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
df | awk \-v max=\(dq%d\(dq \e\(aq{ if ( $5 > max ) print $0 }\e\(aq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
where \(dq%d\(dq is replaced by the configured threshold. If there are lines in the
|
||||
output (which means some filesystem exceed the usage threshold) it sends
|
||||
the output along with a description line to all configured receipients using
|
||||
the \fBmail\fP command.
|
||||
.sp
|
||||
To make diskmon work it is important that \fBmail\fP is working on the shell.
|
||||
.SH MODULE CONFIGURATION
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
diskmon is a \fI\%standalone module\fP and does not inherit \fI\%global options\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.nf
|
||||
\fBetc/defaults/diskmon.cfg\fP
|
||||
\fBetc/diskmon.cfg\fP
|
||||
\fB~/.seiscomp/diskmon.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B threshold
|
||||
Default: \fB95\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Disk usage threshold in percent. Each time when the disk usage exceeds this level,
|
||||
an alert e\-mail is send to the user. Note that disk usage is only checked when a
|
||||
cron job of seiscomp check is installed or seiscomp check is called
|
||||
regularly by other means.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B emails
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Comma\-separated list of e\-mail addresses to notify when disk usage
|
||||
threshold is exceeded.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
259
share/man/man1/dlsv2inv.1
Normal file
259
share/man/man1/dlsv2inv.1
Normal file
@ -0,0 +1,259 @@
|
||||
.\" 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 "DLSV2INV" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
dlsv2inv \- SeisComP Documentation
|
||||
.sp
|
||||
\fBConvert dataless SEED to SeisComP inventory XML.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
dlsv2inv converts dataless \fI\%SEED\fP to
|
||||
SeisComP XML (\fI\%SCML\fP). Due to the limitations of dataless SEED dlsv2inv allows to set
|
||||
attributes which are not available in dataless such as network type, network
|
||||
description and so on.
|
||||
.sp
|
||||
It takes basically two important parameters:
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
input file
|
||||
.IP 2. 3
|
||||
output file
|
||||
.UNINDENT
|
||||
.sp
|
||||
whereas the output file defaults to stdout if not given.
|
||||
.sp
|
||||
The SeisComP inventory network and station objects have the attribute archive
|
||||
which should contain the local datacenter where the information comes from.
|
||||
.sp
|
||||
While importing the attribute \fI\%datacenterID\fP is read and written into
|
||||
the archive attribute of all networks and stations available in the dataless.
|
||||
The datacenterID can be overridden with the \fB\-\-dcid\fP command\-line option.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Conversion of inventory in \fISeisComP\fP XML to dataless SEED is provided by \fI\%inv2dlsv\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Convert a given dataless SEED file to SeisComP XML.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
dlsv2inv GE.dataless GE.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Override the datacenterID and leave it blank in the output.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
dlsv2inv \-\-dcid \(dq\(dq GE.dataless GE.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/dlsv2inv.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/dlsv2inv.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/dlsv2inv.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
dlsv2inv inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBdlsv2inv [OPTIONS] input [output=stdout]\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
|
||||
.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 ArcLink
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-dcid arg
|
||||
Override the datacenter ID which is read from the
|
||||
datacenterID configuration parameter and written to the
|
||||
network and station archive attribute.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-net\-description arg
|
||||
Set the network description. It supports the following
|
||||
placeholders: ${code}, ${start}, ${end}, ${class} and
|
||||
${archive}.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-net\-start arg
|
||||
Set network start time. Format is %Y\-%m\-%d.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-net\-end arg
|
||||
Set network end time. Format is %Y\-%m\-%d.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-net\-type arg
|
||||
Set the network type (VBB, SM, etc.).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-temporary
|
||||
Set the network temporary flag to true.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-restricted
|
||||
Set the network restricted flag to true.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-private
|
||||
Set the network private flag to true.
|
||||
.UNINDENT
|
||||
.SS Convert
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-formatted
|
||||
Enable formatted XML output.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
369
share/man/man1/ew2sc.1
Normal file
369
share/man/man1/ew2sc.1
Normal file
@ -0,0 +1,369 @@
|
||||
.\" 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 "EW2SC" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
ew2sc \- SeisComP Documentation
|
||||
.sp
|
||||
\fBEarthworm hypo2000_arc messages importer\fP
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/ew2sc.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/ew2sc.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/ew2sc.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
ew2sc inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.configPath
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Folder to store logs and achives of hypo2000_arc files from Earthworm export_genericer
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.senderPort
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Earthworm export_generic\(aqs socket to listen to
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.modID
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Expected Earthworm Module ID (ew2sc3 will read the message only if its ModID is correct).
|
||||
Set to 0 (MOD_WILDCARD) to accept any Earthworm Module ID.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.instID
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Expected Earthworm Institute ID (ew2sc3 will read the message only if its InstID is correct)
|
||||
Set to 0 (INST_WILDCARD) to accept any Earthworm Institute ID.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.customAgencyID
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Institute name to use when storing origin into database.
|
||||
If blank, the origin will have the system AgencyID. If specified, the origin will have the given AgencyID.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.author
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Author name to use when storing origin into database.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.hostname
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Earthworm export_generic IP address to connect to
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.defaultLatitude
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Default event latitude to use if hypo2000_arc location is null (space filled)
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.defaultLongitude
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Default event longitude to use if hypo2000_arc location is null (space filled)
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.locatorProfile
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Name of the earth model used by Earthworm location process
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.enableArchiving
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enable/Disable hypo2000_arc message file archiving (usefull for troobleshooting)
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.myAliveInt
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Time interval (in sec) between two heartbeats messages sent by SeisComP.
|
||||
This parameter should be lower than Earthworm export_generic RcvAliveInt parameter
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.senderTimeout
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Maximum time (in millisecond) before the connection to Earthworm export_generic times out.
|
||||
This parameter has to be set accordingly to Earthworm export_generic parameters
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.maxMsgSize
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Maximum message size (in char) between the Earthworm export_generic and ew2sc3.
|
||||
This parameter has to be set accordingly to Earthworm export_generic MaxMsgSize parameter
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.myAliveString
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Alive string to send to Earthworm export_generic in order to keep the connection alive.
|
||||
This string should be identical as Earthworm export_generic RcvAliveText string
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.senderAliveString
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Alive string expected from Earthworm export_generic in order to keep the connection alive.
|
||||
This string should be identical as Earthworm export_generic SendAliveText string
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.enableUncertainties
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enable/Disable uncertainties conversions.
|
||||
Earthworm doesn\(aqt have uncertainties but weight from 0 to 4.
|
||||
If enabled, ew2sc3 will convert pick weight to uncertainties followind a simple mapping between weight and pickerUncertainties list.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.pickerUncertainties
|
||||
Type: \fIlist:double\fP
|
||||
.sp
|
||||
Uncertainty values (in sec) to use when enableUncertainties is enabled.
|
||||
Refer to scolv document for syntax.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ew2sc3.maxUncertainty
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Maximum weight value from Earthworm corresponding to maximum uncertainty
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.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 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
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
1471
share/man/man1/fdsnws.1
Normal file
1471
share/man/man1/fdsnws.1
Normal file
File diff suppressed because it is too large
Load Diff
211
share/man/man1/fdsnxml2inv.1
Normal file
211
share/man/man1/fdsnxml2inv.1
Normal file
@ -0,0 +1,211 @@
|
||||
.\" 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 "FDSNXML2INV" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
fdsnxml2inv \- SeisComP Documentation
|
||||
.sp
|
||||
\fBConvert station inventory between FDSN StationXML format and
|
||||
SeisComP XML.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
fdsnws2inv is an inventory converter. It converts station meta data from
|
||||
FDSN StationXML format to SeisComP XML (\fI\%SCML\fP) and back writing the
|
||||
output to a file, if given, or the command line (stdout).
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Convert an inventory file in FDSN StationXML format to SCML with formatted XML.
|
||||
Redirect the output to a new file:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
fdsnxml2inv \-f inventory_fdsn.xml inventory_sc.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Convert an inventory file in SCML format to FDSN StationXML with formatted XML.
|
||||
Redirect the output to a new file:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
fdsnxml2inv \-\-to\-staxml \-f inventory_sc.xml inventory_fdns.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/fdsnxml2inv.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/fdsnxml2inv.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/fdsnxml2inv.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
fdsnxml2inv inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBfdsnxml2inv [OPTIONS] input [output]\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
|
||||
.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 Convert
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-formatted
|
||||
Generate formatted SCML. Otherwise, output XML to a single line.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-to\-staxml
|
||||
Convert from SCML to StationXML and expects SCML as input.
|
||||
If not given, input is SCML and output is StationXML.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-relaxed\-ns\-check
|
||||
Enable relaxed XML namespace checks. This will also accept
|
||||
tags within a different namespace than defined in the
|
||||
supported schema.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-log\-stages
|
||||
Add more output to stderr for all channel response stages
|
||||
when converting from StationXML.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
8038
share/man/man1/global.1
Normal file
8038
share/man/man1/global.1
Normal file
File diff suppressed because it is too large
Load Diff
278
share/man/man1/import_inv.1
Normal file
278
share/man/man1/import_inv.1
Normal file
@ -0,0 +1,278 @@
|
||||
.\" 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 "IMPORT_INV" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
import_inv \- SeisComP Documentation
|
||||
.sp
|
||||
\fBImport inventory information from various sources.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
import_inv is a wrapper for inventory converters. Inventory converters convert
|
||||
an input format such as
|
||||
.TS
|
||||
center;
|
||||
|l|l|l|.
|
||||
_
|
||||
T{
|
||||
Format
|
||||
T} T{
|
||||
Converter
|
||||
T} T{
|
||||
Conversion
|
||||
T}
|
||||
_
|
||||
T{
|
||||
scml
|
||||
T} T{
|
||||
scml2inv
|
||||
T} T{
|
||||
\fI\%SeisComP inventory XML\fP, schema: \fB$SEISCOMP_ROOT/share/xml/\fP
|
||||
T}
|
||||
_
|
||||
T{
|
||||
sc3
|
||||
T} T{
|
||||
sc32inv
|
||||
T} T{
|
||||
Alias for scml for backwards compatibility to SeisComP3
|
||||
T}
|
||||
_
|
||||
T{
|
||||
arclink
|
||||
T} T{
|
||||
arclink2inv
|
||||
T} T{
|
||||
Arclink inventory XML
|
||||
T}
|
||||
_
|
||||
T{
|
||||
dlsv
|
||||
T} T{
|
||||
\fI\%dlsv2inv\fP
|
||||
T} T{
|
||||
\fI\%dataless SEED\fP
|
||||
T}
|
||||
_
|
||||
T{
|
||||
fdsnxml
|
||||
T} T{
|
||||
\fI\%fdsnxml2inv\fP
|
||||
T} T{
|
||||
\fI\%FDSN StationXML\fP
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.sp
|
||||
to SeisComP inventory XML which is read by the trunk config module to
|
||||
synchronize the local inventory file pool with the central inventory database.
|
||||
.sp
|
||||
For printing all available formats call
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ import_inv help formats
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
When \fBimport_inv help formats\fP is called it globs for
|
||||
\fB$SEISCOMP_ROOT/bin/*2inv\fP\&.
|
||||
If another format needs to be converted, it is very easy to provide a new
|
||||
converter.
|
||||
.SS Converter interface
|
||||
.sp
|
||||
For making a new converter work with import_inv it must implement an interface
|
||||
on shell level. Furthermore the converter program must be named
|
||||
\fIformat\fP\fB2inv\fP and must live in \fBSEISCOMP_ROOT/bin\fP\&.
|
||||
.sp
|
||||
The converter program must take the input location (file, directory, URL, ...)
|
||||
as first parameter and the output file (SeisComP XML) as second parameter. The
|
||||
output file must be optional and default to stdout.
|
||||
.sp
|
||||
To add a new converter for a new format, e.g. Excel, place the new converter
|
||||
program at \fB$SEISCOMP_ROOT/bin/excel2inv\fP\&.
|
||||
.SS Examples
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Convert inventory file in FDSN StationXML format (fdsnxml) and copy the content to
|
||||
\fB$SEISCOMP_ROOT/etc/inventoy/inventory.xml\fP\&. The call will invoke
|
||||
\fI\%fdsnxml2inv\fP for actually making the conversion:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ import_inv fdsnxml inventory_fdsn.xml $SEISCOMP_ROOT/etc/inventoy/inventory.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/import_inv.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/import_inv.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/import_inv.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
import_inv inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBimport_inv [FORMAT] input [output]\fP
|
||||
.sp
|
||||
\fBimport_inv help [topic]\fP
|
||||
.sp
|
||||
The first form takes the format as first parameter and the input
|
||||
and output location. The input location is either a file or directory
|
||||
depending on the format and its converter. If the output is not
|
||||
given it defaults to seiscomp/etc/inventory/{input}.xml. To write
|
||||
the output to stdout, \(dq\-\(dq must be used.
|
||||
.sp
|
||||
The second form provides help on a particular topic. The only topic
|
||||
currently supported is \(dqformats\(dq which prints all available input
|
||||
formats.
|
||||
.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
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
105
share/man/man1/inv2dlsv.1
Normal file
105
share/man/man1/inv2dlsv.1
Normal file
@ -0,0 +1,105 @@
|
||||
.\" 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 "INV2DLSV" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
inv2dlsv \- SeisComP Documentation
|
||||
.sp
|
||||
\fBConverts SC3 inventory XML to dataless SEED.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
inv2dlsv is a simple filter that converts inventory in \fISeisComP\fP XML (\fI\%SCML\fP)
|
||||
format from stdin (or a file) to dataless SEED on stdout (or a file). It does
|
||||
not support processing of input XML such as extraction of networks or channels.
|
||||
To accomplish this task, combine \fBinv2dlsv\fP with \fI\%invextr\fP\&.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Conversion of dataless SEED to \fISeisComP\fP XML is provided by \fI\%dlsv2inv\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\(dq\-\(dq can always be used as filename to refer to the standard input/output channel.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Convert an inventory XML file to a dataless SEED file
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
inv2dlsv inv.xml inv.seed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Convert an inventory XML file to a compressed dataless SEED file
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
inv2dlsv inv.xml | gzip > inv.seed.gz
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Convert a subset of an inventory XML using \fI\%invextr\fP\&.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
invextr \-\-chans \(dq*MORC*\(dq inv.xml | inv2dlsv \- inv.seed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBinv2dlsv [in_xml [out_dataless]]\fP
|
||||
.sp
|
||||
If in_xml is not given, stdin is used. If out_dataless is not given,
|
||||
stdout is used.
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
358
share/man/man1/invextr.1
Normal file
358
share/man/man1/invextr.1
Normal file
@ -0,0 +1,358 @@
|
||||
.\" 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 "INVEXTR" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
invextr \- SeisComP Documentation
|
||||
.sp
|
||||
\fBExtract channels from inventory.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
invextr reads and modifies inventory XML provided as file or on stdin:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Extract or remove networks, stations and channels based on
|
||||
.INDENT 2.0
|
||||
.IP \(bu 2
|
||||
channel IDs
|
||||
.IP \(bu 2
|
||||
geographic region
|
||||
.IP \(bu 2
|
||||
time
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Clean inventories from unused objects such as data loggers, sensors or
|
||||
instrument responses.
|
||||
.UNINDENT
|
||||
.sp
|
||||
The important parameters are:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Channel ID list (required)
|
||||
.IP \(bu 2
|
||||
Input file or stdin
|
||||
.IP \(bu 2
|
||||
Output file or stdout
|
||||
.IP \(bu 2
|
||||
Region bounding box (optional)
|
||||
.UNINDENT
|
||||
.sp
|
||||
whereas the output file defaults to stdout and the input file to
|
||||
stdin if not given.
|
||||
.sp
|
||||
The optional region box will be used to filter the read inventory based on the
|
||||
coordinates of sensor locations. Only stations with sensor locations within the
|
||||
region will be considered. All others will be ignored.
|
||||
.sp
|
||||
A channel ID is a simple string that is matched against the final channel ID
|
||||
in the inventory. This final channel ID is constructed by joining the codes of
|
||||
all stages with a dot where the stages are network, station, location and
|
||||
channel.
|
||||
.sp
|
||||
The content of the resulting inventory may be listed using \fI\%scinv\fP\&.
|
||||
.SS Examples
|
||||
.sp
|
||||
Suppose an inventory with network GE, a station MORC and several channels:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
network GE
|
||||
station MORC
|
||||
location __
|
||||
channel BHZ ID: GE.MORC..BHZ
|
||||
channel BHN ID: GE.MORC..BHN
|
||||
channel BHE ID: GE.MORC..BHE
|
||||
channel LHZ ID: GE.MORC..LHZ
|
||||
channel LHN ID: GE.MORC..LHN
|
||||
channel LHE ID: GE.MORC..LHE
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
The IDs are matched against streams passed with \-\-chans.
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
invextr \-\-chans \(dqGE*\(dq inv.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
All streams are passed and nothing is filtered because GE* matches all
|
||||
available IDs and region filter is not used. Since \fBinv.xml\fP only
|
||||
contains stations from the GE network the option \fB\-\-chans\fP is not
|
||||
useful here at all.
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
invextr \-r 0,\-180,90,180 inv.xml
|
||||
|
||||
All streams located in the northern hemisphere are passed as commanded by the
|
||||
region bounding box.
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Nothing is filtered again because \fIMORC\fP matches all available IDs.
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
invextr \-\-chans \(dq*MORC*\(dq inv.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Everything is filtered because GE.MORC does not match with any ID. To make it
|
||||
work, an asterisk needs to be appended: GE.MORC* or GE.MORC.*.
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
invextr \-\-chans \(dqGE.MORC\(dq inv.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
To extract all vertical components, use:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
invextr \-\-chans \(dq*Z\(dq inv.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
To extract BHN and LHZ, use:
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
invextr \-\-chans \(dq*BHN,*LHZ\(dq inv.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
To remove all HH and SH channels, use:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
invextr \-\-rm \-\-chans \(dq*HH?,*SH?\(dq inv.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/invextr.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/invextr.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/invextr.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
invextr inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBinvextr [OPTIONS] [input=stdin] [output=stdout]\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
|
||||
.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 Extract
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-begin arg
|
||||
Begin time to consider streams. Streams ending at or
|
||||
before that time will be ignored.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-end arg
|
||||
End time to consider streams. Streams starting after
|
||||
that time will be ignored.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-chans arg
|
||||
A comma separated list of channel IDs to extract
|
||||
which can contain wildcards. Default: *.*.*.* meaning
|
||||
all streams.
|
||||
.sp
|
||||
Example: invextr \-\-chans \(dqGE.*.*.BHZ,GE.MORC.*.*\(dq inv.xml
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-nslc arg
|
||||
Stream list file to be used for extracting inventory.
|
||||
Wildcards can be used. \-\-chans is ignored.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-r, \-\-region arg
|
||||
Filter streams by geographic region given as
|
||||
\(dqSouth, East, North, West\(dq. Region is unused by default.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-rm arg
|
||||
Removes all channels given with \(aq\-\-chans\(aq instead of
|
||||
extracting them.
|
||||
.sp
|
||||
Example: invextr \-\-rm \-\-chans \(dqGE.*\(dq inv.xml
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-formatted
|
||||
Enables formatted XML output.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
98
share/man/man1/kernel.1
Normal file
98
share/man/man1/kernel.1
Normal file
@ -0,0 +1,98 @@
|
||||
.\" 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 "KERNEL" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
kernel \- SeisComP Documentation
|
||||
.sp
|
||||
\fBSeisComP kernel.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
The kernel is the basic configuration for the \fBseiscomp\fP tool.
|
||||
It contains configuration parameters for all init scripts in \fBetc/init\fP\&. Each init script can, but does not
|
||||
need to, read the kernel parameters and configure itself accordingly. Kernel parameters are not mandatory but
|
||||
should be taken as (serious) hints. If for example syslog is enabled in the kernel then all init scripts should
|
||||
configure syslog as logging backend for the programs they start. But if a program does not support syslog it can
|
||||
also be started without logging to syslog.
|
||||
.SH MODULE CONFIGURATION
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
kernel is a \fI\%standalone module\fP and does not inherit \fI\%global options\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.nf
|
||||
\fBetc/defaults/kernel.cfg\fP
|
||||
\fBetc/kernel.cfg\fP
|
||||
\fB~/.seiscomp/kernel.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B syslog
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Sends all logging output to the syslog backend which logs
|
||||
usually to /var/log/messages.
|
||||
.UNINDENT
|
||||
.SS messaging extension
|
||||
.sp
|
||||
SeisComP messaging component that enables communication of modules over the network.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B messaging.enable
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enables/disables local messaging (scmaster).
|
||||
The messaging component is an integral component
|
||||
of all modules (except e.g. acquisition modules).
|
||||
If you are not sure what to do, enable it.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B messaging.bind
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Defines the messaging unencrypted bind address. If
|
||||
left empty then the configuration file (see scmaster)
|
||||
will be used instead. Use this to override the
|
||||
unencrypted bind address. The format is
|
||||
\(dq[ip:]port\(dq.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
257
share/man/man1/msrtsimul.1
Normal file
257
share/man/man1/msrtsimul.1
Normal file
@ -0,0 +1,257 @@
|
||||
.\" 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 "MSRTSIMUL" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
msrtsimul \- SeisComP Documentation
|
||||
.sp
|
||||
\fBMiniSEED real time playback and simulation\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
msrtsimul simulates a real\-time data acquisition by injecting miniSEED data from a
|
||||
file into the seedlink buffer via the mseedfifo plugin for seedlink. It can be
|
||||
used for simulating real\-time conditions in playbacks for whole\-system
|
||||
demonstrations, user training, etc.
|
||||
.sp
|
||||
The data is played back as if they were recorded at current time. Therefore,
|
||||
creation times and the actual data times including pick times, event times etc.
|
||||
will be \fBobscured\fP\&. \fI\%Historic playbacks\fP allow
|
||||
keeping the actual data times.
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Playbacks on production systems are normally not recommended.
|
||||
.IP \(bu 2
|
||||
For real\-time playbacks, the data must be sorted by end time. This
|
||||
requirement may be violated. Use \fI\%scmssort\fP for sorting the data by
|
||||
(end) time.
|
||||
.IP \(bu 2
|
||||
Stop \fI\%slarchive\fP before running msrtsimul for avoiding that data with
|
||||
wrong times are archived.
|
||||
.IP \(bu 2
|
||||
Normally, \fI\%seedlink\fP assumes that the data is provided in records of
|
||||
512 bytes. msrtsimul issues a warning when detecting a record of other size.
|
||||
.IP \(bu 2
|
||||
Data available in other record sizes can be repacked to 512 bytes by
|
||||
external software such as \fBmsrepack\fP available with
|
||||
\fIlibmseed \- The miniSEED data format library\fP [\fI\%32\fP]\&.
|
||||
.IP \(bu 2
|
||||
Applications other than standard \fI\%seedlink\fP in \fISeisComP\fP or
|
||||
\fI\%seedlink\fP compiled specifically may accept other record sizes. For
|
||||
accepting these records use msrtsimul with \fB\-\-unlimited\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Non\-default seedlink pipes
|
||||
.sp
|
||||
By default, msrtsimul writes the data into the mseedfifo pipe
|
||||
\fI$SEISCOMP_ROOT/var/run/seedlink/mseedfifo\fP\&.
|
||||
If the data is to be written into the pipe of a \fBseedlink\fP alias or
|
||||
into any other pipe, the pipe name must be adjusted. Use the option
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fB\-\-seedlink\fP to replace \fIseedlink\fP by another name, e.g. a seedlink instance
|
||||
created as an alias, \fBseedlink\-test\fP\&. This would write into
|
||||
\fI$SEISCOMP_ROOT/var/run/seedlink\-test/mseedfifo\fP\&.
|
||||
.IP \(bu 2
|
||||
\fB\-\-stdout\fP to write to standard output and then redirect to any other location.
|
||||
.UNINDENT
|
||||
.SS Historic playbacks
|
||||
.sp
|
||||
You may use msrtsimul with the \fB\-m\fP \fIhistoric\fP option to maintain the
|
||||
time of the records,
|
||||
thus the times of picks, amplitudes, origins, etc. but not the creation times.
|
||||
Applying \fB\-m\fP \fIhistoric\fP will feed the data into the seedlink buffer at the time
|
||||
of the records. The time of the system is untouched. GUI, processing modules, logging,
|
||||
etc. will run with current system time. The historic mode allows to process waveforms
|
||||
with the stream inventory valid at the time when the data were recorded including
|
||||
streams closed at current time.
|
||||
.sp
|
||||
\fBWARNING:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
When repeating historic playbacks, the waveforms are fed multiple times to the
|
||||
seedlink buffer and the resulting picks are also repeated with the same pick
|
||||
times. This may confuse the real\-time system. Therefore, seedlink and other modules
|
||||
creating or processing picks should be
|
||||
stopped, the seedlink buffer should be cleared and the processing
|
||||
modules should be restarted to clear the buffers before starting the
|
||||
historic playbacks. Make sure \fI\%scautopick\fP is configured or started with
|
||||
the \fB\-\-playback\fP option. Example:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp stop
|
||||
rm \-rf $SEISCOMP_ROOT/var/lib/seedlink/buffer
|
||||
seiscomp start
|
||||
msrtsimul ...
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS seedlink setup
|
||||
.sp
|
||||
For supporting msrtsimul activate the \fI\%msrtsimul\fP parameter in the
|
||||
seedlink module configuration (\fBseedlink.cfg\fP), update the configuration
|
||||
and restart seedlink before running msrtsimul:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp update\-config seedlink
|
||||
seiscomp restart seedlink
|
||||
msrtsimul ...
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Examples
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Playback miniSEED waveforms in real time with verbose output:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ msrtsimul \-v miniSEED\-file
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Playback miniSEED waveforms in historic mode. This may require \fI\%scautopick\fP
|
||||
to be started with the option \fIplayback\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
msrtsimul \-v \-m historic miniSEED\-file
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Feed the data into the buffer of a specific seedlink instance, e.g. \fIseedlink\-test\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
msrtsimul \-v \-\-seedlink seedlink\-test miniSEED\-file
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/msrtsimul.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/msrtsimul.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/msrtsimul.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
msrtsimul inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBmsrtsimul [OPTION] miniSEED\-file\fP
|
||||
.SS Verbosity
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h, \-\-help
|
||||
Display this help message.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-v, \-\-verbose
|
||||
Verbose mode.
|
||||
.UNINDENT
|
||||
.SS Playback
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-c, \-\-stdout
|
||||
Write on standard output. The output my be redirected to a
|
||||
specific mseedfifo path.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-d, \-\-delays
|
||||
Add artificial delays.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-j, \-\-jump float
|
||||
Minutes to skip at the beginning.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-m, \-\-mode string
|
||||
Playback mode: choose between \(aqrealtime\(aq and \(aqhistoric\(aq
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-seedlink string
|
||||
The seedlink module name. Useful if a seedlink alias or
|
||||
non\-standard names are used. Replaces \(aqseedlink\(aq
|
||||
in the standard mseedfifo path.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-s, \-\-speed float
|
||||
Speed factor. 1 is normal speed.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-test
|
||||
Test mode.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-u, \-\-unlimited
|
||||
Allow miniSEED records which are not 512 bytes.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
844
share/man/man1/ql2sc.1
Normal file
844
share/man/man1/ql2sc.1
Normal file
@ -0,0 +1,844 @@
|
||||
.\" 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 "QL2SC" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
ql2sc \- SeisComP Documentation
|
||||
.sp
|
||||
\fBQuakeLink (gempa GmbH) to SeisComP event parameter exchange.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
ql2sc manages the import of SeisComP objects from one or several QuakeLink servers
|
||||
into a SeisComP system in real time. Like \fI\%scimex\fP but contrary to
|
||||
\fI\%scimport\fP the exchange of the SeisComP objects is event based. This means no
|
||||
messages will be exchanged until the exporting system has produced an event.
|
||||
.sp
|
||||
The user may control at various levels which information to import. Whenever
|
||||
possible server\-side filters should be preferred to reduce both the network
|
||||
bandwidth consumption as well as the CPU and memory utilization on the local
|
||||
machine.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
ql2sc does not delete events at the import system although quakelink
|
||||
allows the deletion of events. Deleted events are ignored by ql2sc and kept
|
||||
in the SeisComP database.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SERVER-SIDE EVENT FILTER
|
||||
.sp
|
||||
QuakeLink provides a filter syntax similar to SQL\-WHERE clauses which may be
|
||||
used to filter interesting events on the server side:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
clause := condition[ AND|OR [(]clause[)]]
|
||||
condition := MAG|DEPTH|LAT|LON|PHASES|DIST(lat,lon) op {float} |
|
||||
DIST(lat,lon) IN [{float}, {float}] |
|
||||
UPDATED|OTIME op time |
|
||||
AGENCY|AUTHOR|STATUS|ESTATUS|EMODE|TYPE|REGION|MAG_T op \(aqstring\(aq |
|
||||
MAG|DEPTH|LAT|LON|PHASES|OTIME|UPDATED IS [NOT] NULL
|
||||
op := =|!=|>|>=|<|<=|eq|gt|ge|lt|ge
|
||||
time := %Y,%m,%d[,%H,%M,%S,%f]
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
E.g., the following filter string would select only those events with a minimum
|
||||
magnitude of 6, detected by at least 10 stations and which are shallower than
|
||||
100km:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
MAG >= 6.0 AND PHASES >= 10 AND DEPTH < 100
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
The supported filter commands depend on the specific QuakeLink version. To
|
||||
list all available options you may connect to the server, e.g., using
|
||||
\fItelnet localhost 18010\fP, and request the help page of the \fISELECT\fP command
|
||||
using \fIhelp select\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SERVER-SIDE OBJECT FILTER
|
||||
.sp
|
||||
QuakeLink provides a coarse object filter for the most relevant SeisComP objects:
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Option
|
||||
T} T{
|
||||
Impact
|
||||
T}
|
||||
_
|
||||
T{
|
||||
picks
|
||||
T} T{
|
||||
include picks
|
||||
T}
|
||||
_
|
||||
T{
|
||||
amplitudes
|
||||
T} T{
|
||||
include amplitudes
|
||||
T}
|
||||
_
|
||||
T{
|
||||
arrivals
|
||||
T} T{
|
||||
include origin arrivals
|
||||
T}
|
||||
_
|
||||
T{
|
||||
staMags
|
||||
T} T{
|
||||
include origin station magnitudes
|
||||
T}
|
||||
_
|
||||
T{
|
||||
staMts
|
||||
T} T{
|
||||
include moment tensor station contributions and phase settings
|
||||
T}
|
||||
_
|
||||
T{
|
||||
preferred
|
||||
T} T{
|
||||
include only preferred origin and magnitude information
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.SH LOCAL OBJECT FILTER AND ROUTING
|
||||
.sp
|
||||
Subsequent to the server\-side filters a routing table defines which objects to
|
||||
import and to which message group to send them. Depending on the \fISeisComP\fP modules
|
||||
listening to the specified message groups an object may be further processed.
|
||||
Typically no modules (other than \fI\%scmaster\fP) is connected to the
|
||||
\fBIMPORT_GROUP\fP so that objects sent to this group are just stored to the
|
||||
database. If an object should be discarded, the special group identifier \fBNULL\fP
|
||||
may be used.
|
||||
.sp
|
||||
The routing table is defined as a comma\-separated list of
|
||||
\fBobject name:group name\fP pairs. Also the routing rules are inherited
|
||||
recursively within the SeisComP object tree. If no explicit rule exists for an
|
||||
object, the routing of its parent is evaluated up to the \fBEventParameters\fP
|
||||
root node.
|
||||
.SS Examples
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
EventParameters:IMPORT_GROUP
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Imports everything
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
EventParameters:IMPORT_GROUP,Comment:NULL
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Imports everything except comments
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
Origin:LOCATION,StationMagnitude:MAGNITUDE,Magnitude:MAGNITUDE
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Sends origins and it\(aqs children arrival, origin uncertainty to the \fBLOCATION\fP
|
||||
group but the magnitude children to the \fBMAGNITUDE\fP group. Skips picks,
|
||||
amplitudes, focal mechanisms and events.
|
||||
.SS Default routing table
|
||||
.sp
|
||||
The default use case of ql2sc is to import earthquake solutions from other data
|
||||
centers or in\-house redundant SeisComP systems. The intention is not to
|
||||
reprocess the solution but to add them to the local catalog.
|
||||
.sp
|
||||
By default we route:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Picks and Amplitudes to the \fBIMPORT_GROUP\fP group to prevent processing by
|
||||
the local locator and amplitude processor
|
||||
.IP \(bu 2
|
||||
Origins (including its StationMagnitude and Magnitude children) to the
|
||||
\fBLOCATION\fP to allow event association.
|
||||
.IP \(bu 2
|
||||
FocalMechanisms to the \fBFOCMECH\fP group to trigger processing by specialized
|
||||
applications, e.g., graphical user interfaces for strong motion analysis or
|
||||
tsunami risk assessment.
|
||||
.UNINDENT
|
||||
.sp
|
||||
We don\(aqt route events at all. With the help of \fI\%scevent\fP locations are
|
||||
either associated to existing events or will create new events with local
|
||||
settings.
|
||||
.sp
|
||||
We don\(aqt route StationMagnitudes and Magnitude to the \fBMAGNITDUE\fP group
|
||||
because \fI\%scmag\fP subscribes to \fBLOCATION\fP and \fBMAGNITUDE\fP\&. Separated
|
||||
groups might lead to duplicated magnitude types in case a manual magnitude
|
||||
solution is imported. In this case the foreign Origin with its Magnitudes would
|
||||
be split into at least two messages, the first one containing the Origin, the
|
||||
second one the Magnitude. The Origin message immediately triggers magnitude
|
||||
calculation, potentially for a magnitude type which is received with the second
|
||||
message.
|
||||
.sp
|
||||
The default routing table is set as given in \fI\%host.$name.routingTable\fP\&.
|
||||
.SH AGENCY LIST FILTER
|
||||
.sp
|
||||
In addition to the local object filter the user may choose to accept only those
|
||||
objects originating from a set of trusted agencies. If at least one agency is
|
||||
defined in the \fBprocessing.whitelist.agencies\fP or
|
||||
\fBprocessing.blacklist.agencies\fP configuration option, then the
|
||||
\fBcreationInfo.agencyID\fP of amplitudes, arrivals, comments, events, focal
|
||||
mechanisms, magnitudes, moment tensors, origins, picks and station magnitudes is
|
||||
evaluated. Objects with unmatched or unset agency information are filtered out.
|
||||
If objects with unset agency ID should match, then empty string \fB\(dq\(dq\fP has to be
|
||||
added to the white list.
|
||||
.sp
|
||||
The agency filter is applied on remote as well as local objects. In this way
|
||||
remote objects may be excluded from import and local objects my be protected
|
||||
from overriding or removing. Also the filter is applied recursively. If parent
|
||||
object (e.g., an origin) is filtered out, all of its children (e.g., magnitudes)
|
||||
are also skipped even if they carry a different agency ID.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
The agency white list filter might be essential to avoid circular event
|
||||
updates between cross\-connected SeisComP systems.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH PUBLICID PREFIX FILTER
|
||||
.sp
|
||||
In addition to the \fI\%agency filter\fP incoming or local objects
|
||||
can be skipped by checking their publicID prefix. It behaves similar to the
|
||||
\fI\%agency filter\fP but checks the \fBpublicID\fP attribute rather
|
||||
than the \fBcreationInfo.agencyID\fP attribute.
|
||||
Prefixes can be configure as white\- or blacklist with
|
||||
\fBprocessing.whitelist.publicIDs = ...\fP and
|
||||
\fBprocessing.blacklist.publicIDs = ...\fP\&.
|
||||
.SH WORKFLOW
|
||||
.sp
|
||||
Each event update received from a QuakeLink host is parsed and analyzed for
|
||||
differences to the local database. The comparison starts at the level of the
|
||||
top\-level elements in the following order: picks, amplitudes, origins, focal
|
||||
mechanisms, events.
|
||||
.sp
|
||||
For each top\-level element the object tree is traversed in a depth\-first search
|
||||
order. Objects on the same level are processed in the order of their appearance.
|
||||
The differences are collected as a list of notifier objects with the following
|
||||
operation types:
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Type
|
||||
T} T{
|
||||
Description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
ADD
|
||||
T} T{
|
||||
The object does not exist locally
|
||||
T}
|
||||
_
|
||||
T{
|
||||
UPDATE
|
||||
T} T{
|
||||
The object does exist locally but differs from the remote one
|
||||
T}
|
||||
_
|
||||
T{
|
||||
REMOVE
|
||||
T} T{
|
||||
The object exist locally but not remotely
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.sp
|
||||
The \fBADD\fP and \fBREMOVE\fP operation always generates notifies of the same type
|
||||
for all children of the current object. \fBADD\fP notifiers are collected top\-down,
|
||||
\fBREMOVE\fP notifiers are collected bottom\-up.
|
||||
.sp
|
||||
Because the order of child objects is arbitrary, e.g., the arrivals of an origin,
|
||||
each object on the remote side has to be found in the set of local objects. For
|
||||
public objects (e.g., origins, magnitudes, magnitudes..), the \fBpublicID\fP
|
||||
property is used for comparison. All other objects are compared by looking at
|
||||
their index properties. For e.g., arrivals this is the \fBpickID\fP property, for
|
||||
comments the \fBid\fP property.
|
||||
.sp
|
||||
Ones all notifiers are collected they are send to the local messaging system.
|
||||
For performance reasons and because of the processing logic of listening \fISeisComP\fP
|
||||
modules ql2sc tries to batch as many notifiers as possible into one notifier
|
||||
message. A separate notifier message is created if the target message group
|
||||
changes between successive notifiers or if the configurable \fI\%batchSize\fP
|
||||
limit is reached.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Care must be taken when configuring the \fBbatchSize\fP limit. If the value
|
||||
is to big the overall message size limit (default: 1MB) may be exceeded
|
||||
resulting in an undeliverable message. On the other hand a much to small
|
||||
value will create unwanted results in the \fISeisComP\fP processing chain. If for
|
||||
instance picks are routed to the \fBPICK\fP group and the pick set is split
|
||||
into several notifier messages the local \fI\%scautoloc\fP might create
|
||||
locations based on an incomplete dataset.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EVENT ATTRIBUTES
|
||||
.sp
|
||||
It might be desirable to synchronize event attributes set at the source with
|
||||
the local system. In particular the event type, the type uncertainty, event
|
||||
descriptions and comments might be of interest. Because it is not advisable
|
||||
to route events and let \fI\%scevent\fP associate imported origins it can
|
||||
happen that the imported event ID is different from the event ID of the local
|
||||
system. The input host configuration parameter \fBsyncEventAttributes\fP
|
||||
controls that behaviour. It is set to true by default which means that imported
|
||||
event attributes are going to be imported as well. ql2sc does not update
|
||||
directly the attributes but commandates scevent in as many cases as possible
|
||||
to do so. To find the matching local event it takes the first occurrence which
|
||||
has associated the currently imported preferred origin.
|
||||
.SS Limitations
|
||||
.sp
|
||||
There are limitations to this process to avoid infinite loops when cross
|
||||
connecting two systems. Prior to sending the commands to scevent to change a
|
||||
particular attribute ql2sc checks if that attribute has been set already by
|
||||
another module (via JournalEntry database table). If not, then ql2sc is allowed
|
||||
to request an attribute change otherwise not. To illustrate the issue take the
|
||||
following example:
|
||||
.sp
|
||||
scolv connected to system \fBA\fP changes the event type to \(aqearthquake\(aq. ql2sc
|
||||
of system \fBB\fP checks if the event type of the local event has been changed
|
||||
already which is not the case and it requests that change. System \fBA\fP
|
||||
changes the event type again to \(aqunset\(aq. ql2sc of system \fBB\fP notices that
|
||||
someone has already changed the event type and it was ql2sc itself. It requests
|
||||
again a change.
|
||||
.sp
|
||||
scolv connected to system \fBB\fP changes the event type to \(aqearthquake\(aq again.
|
||||
ql2sc of system \fBA\fP notices that \fBscolv@A\fP has already changed the
|
||||
event type and ignores the request.
|
||||
.sp
|
||||
That simple case would not create an infinite loop even if \fBql2sc@A\fP would
|
||||
accept the last change. The situation changes immediately if two subsequent
|
||||
attribute changes are being received by \fBql2sc@B\fP while both of them are
|
||||
already applied on system \fBA\fP\&. \fBql2sc@B\fP would \(dqrestore\(dq the old state due
|
||||
to the first received update and then apply the \(dqfinal\(dq state due to the
|
||||
second update. Each update triggers again an update at system \fBA\fP and the
|
||||
states start flapping. Without the described check there wouldn\(aqt be a well
|
||||
defined exit condition.
|
||||
.SH CAVEATS
|
||||
.sp
|
||||
Specific combinations of remote and local object filters may result in the loss
|
||||
of data. If for instance origins are imported from system \fBA\fP to \fBB\fP and
|
||||
additional magnitudes for the received origins are calculated on \fBB\fP, care must
|
||||
be taken. Without protection a new event update containing the same origin will
|
||||
\fBREMOVE\fP all newly calculated magnitudes on \fBB\fP since they are not included
|
||||
in the magnitude set sent by \fBA\fP\&.
|
||||
.sp
|
||||
To avoid losing these local magnitudes one may decide to block magnitudes from
|
||||
import by routing them to \fBNULL\fP\&. If magnitudes from \fBA\fP and from \fBB\fP
|
||||
should be available, an \fI\%agency filter\fP or
|
||||
\fI\%publicID filter\fP may be defined.
|
||||
.sp
|
||||
Make sure \fBA\fP and \fBB\fP use either distinct agency IDs or distinct publicID
|
||||
patterns and add the agency ID of \fBB\fP to \fBprocessing.blacklist.agencies\fP or
|
||||
the publicID prefix of \fBB\fP to \fBprocessing.blacklist.publicIDs\fP\&.
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/ql2sc.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/ql2sc.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/ql2sc.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
ql2sc inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B backLog
|
||||
Default: \fB1800\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Number of seconds to fetch missed updates on start up.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B cacheSize
|
||||
Default: \fB5000\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Number of public objects to cache.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B batchSize
|
||||
Default: \fB2000\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Maximum number of notifiers to batch in one message. If set
|
||||
to 0 no size limit is enforced. Make sure to not hit the
|
||||
overall message size limited of 16MiB which is enforced by
|
||||
the messaging system.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B eventAssociationTimeout
|
||||
Default: \fB10\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
If event synchronisation is enabled and an incoming origin
|
||||
is not yet associated with an event on the target machine,
|
||||
then this timeout defines the maximum number of seconds to
|
||||
wait for an association.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B hosts
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Registration of the host profiles defining the connection
|
||||
parameters to the QuakeLink hosts.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBhost.*\fP
|
||||
\fIDefinition of host profiles. For each host profile a connection\fP
|
||||
\fIto one QuakeLink server can established. The profiles must be registered\fP
|
||||
\fIin \(aqhosts\(aq to apply them.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBhost.$name.*\fP
|
||||
\fIProvide the connection parameters to one QuakeLink server.\fP
|
||||
$name is a placeholder for the name to be used and needs to be added to \fI\%hosts\fP to become active.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
hosts = a,b
|
||||
host.a.value1 = ...
|
||||
host.b.value1 = ...
|
||||
# c is not active because it has not been added
|
||||
# to the list of hosts
|
||||
host.c.value1 = ...
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.url
|
||||
Default: \fBql://localhost:18010\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
URL of the QuakeLink service, the scheme \(aqqls\(aq enables SSL.
|
||||
.sp
|
||||
Format: [ql[s]://][user:pwd@][host][:port].
|
||||
.sp
|
||||
If set to an empty string the application will run without any QuakeLink connection attempt.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.gzip
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enable/disable GZip (GNU zip) compression.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.native
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Request native data instead of XML format.
|
||||
Native data export may be disabled on some hosts.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.syncEventAttributes
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Try to update the event attributes of the target event
|
||||
with the attributes of the source event which includes
|
||||
event type and event certainty. It will not import
|
||||
events but tries to find the associated event of the
|
||||
input preferred origin at the target system and will
|
||||
update the event attributes via journaling.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.syncPreferred
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Synchronize the preferred origin and preferred
|
||||
magnitude selection if different from the imported
|
||||
selection. ql2sc will wait for the event association
|
||||
of an imported origin and check if the preferred origin
|
||||
or preferred magnitude is different from the imported
|
||||
Quakelink event. If so it will send a journal to
|
||||
force selection of the preferred origin and selection
|
||||
of the preferred magnitude type. These are the same
|
||||
operations as within scolv to fix an origin and
|
||||
a particular magnitude type.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.syncEventDelay
|
||||
Default: \fB0\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Delays the synchronization of event attributes in seconds
|
||||
if set to a value greater than zero.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.keepAlive
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Request server to send keep alive message every 30s to
|
||||
prevent connection reset by firewalls on long idle
|
||||
periods. If activated the client will reset the
|
||||
connection if no alive message is received within 60s.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.filter
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
SQL like WHERE clause to filter the result set.
|
||||
.sp
|
||||
clause := condition[ AND|OR [(]clause[)]] __
|
||||
condition := MAG|DEPTH|LAT|LON|PHASES|OTIME|UPDATED [op float|time]|[IS [NOT] NULL] __
|
||||
op := =|>|>=|<|<=|eq|gt|ge|lt|ge __
|
||||
time := %Y,%m,%d[,%H,%M,%S,%f]
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.routingTable
|
||||
Default: \fBPick:IMPORT_GROUP,Amplitude:IMPORT_GROUP,FocalMechanism:EVENT,Origin:EVENT\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Map datamodel class names to messaging groups. For unmapped objects
|
||||
the mapping of their parent objects is evaluated recursively. Objects
|
||||
may be excluded by mapping them to \(aqNULL\(aq.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBhost.$name.data.*\fP
|
||||
\fISpecify the XML components to fetch.\fP
|
||||
\fINote: These options are not used if \(aqnative\(aq data is requested.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.data.picks
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Include picks
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.data.amplitudes
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Include amplitudes
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.data.arrivals
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Include origin arrivals
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.data.staMags
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Include origin station magnitudes
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.data.staMts
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Include moment tensor station contributions and phase settings
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B host.$name.data.preferred
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Include only preferred origin and magnitude information
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B processing.blacklist.publicIDs
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Defines a blacklist of publicID prefixes that are
|
||||
not allowed for processing. Separate items by comma.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B processing.whitelist.publicIDs
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Defines a whitelist of publicID prefixes that are
|
||||
allowed for processing. Separate items by comma.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBql2sc [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
|
||||
.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 \-\-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 \-\-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 \-\-trace
|
||||
Execute in trace mode.
|
||||
Equivalent to \-\-verbosity=4 \-\-console=1 \-\-print\-component=1
|
||||
\-\-print\-context=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 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
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
457
share/man/man1/scalert.1
Normal file
457
share/man/man1/scalert.1
Normal file
@ -0,0 +1,457 @@
|
||||
.\" 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 "SCALERT" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scalert \- SeisComP Documentation
|
||||
.sp
|
||||
\fBReal time alert template.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
This module executes custom scripts upon arrival of objects or updates.
|
||||
It provides as template for custom modification and is not a replacement for \fI\%scvoice\fP\&.
|
||||
.sp
|
||||
There are four possible trigger mechanisms for calling scripts:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Event creation/update,
|
||||
.IP \(bu 2
|
||||
Amplitude creation,
|
||||
.IP \(bu 2
|
||||
Origin creation (with status = preliminary),
|
||||
.IP \(bu 2
|
||||
Pick creation with filter for phase hint.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
People started modifying \fI\%scvoice\fP to send emails or
|
||||
other alert messages. Then, the name \fIscvoice\fP is then just wrong.
|
||||
If you want to customize \fI\%scvoice\fP, use scalert instead.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scalert.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scalert.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scalert.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scalert inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B firstNew
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Treat an event as new event when it is seen the first time.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B agencyIDs
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
List of agency IDs to consider picks and origins. The agency ID
|
||||
is extracted from the pick or the preferred origin of the event
|
||||
and compared with the configured IDs.
|
||||
.sp
|
||||
unset (=): use agencyID defined in global, default
|
||||
.sp
|
||||
empty list (=\(dq\(dq): all agencies are allowed
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B authors
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
List of authors to consider picks and origins. The author
|
||||
is extracted from the pick or the preferred origin of the event
|
||||
and compared with the configured authors.
|
||||
empty list (=\(dq\(dq): all authors are allowed
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B poi.message
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The default message string for the event\-script is
|
||||
\(dqearthquake, [HOURS] hours [MINS] minutes ago, [DESC],
|
||||
magnitude [MAG], depth [DEP] kilometers\(dq whereas [DESC]
|
||||
is the string given in the event.description attribute. This
|
||||
string can be overwritten using one of the following options.
|
||||
There are three placeholders that can be used: @region@,
|
||||
@dist@ and @poi@.
|
||||
Example: \(dq@region@, @dist@ kilometers from @poi@
|
||||
away\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B poi.maxDist
|
||||
Default: \fB20\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
When using the nearest point of interest (city) as part of
|
||||
the message string, specify the maximum distance in degrees
|
||||
from the event. Any point of interest farther away will be
|
||||
ignored.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B poi.minPopulation
|
||||
Default: \fB50000\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Minimum population for a city to become a point of interest.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.pick
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The script to be called when a pick
|
||||
arrives. Network\-, station code, pick publicID are passed
|
||||
as parameters $1, $2, $3.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.amplitude
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The script to be called when an amplitude
|
||||
arrives. Network\-, station code, amplitude and amplitude
|
||||
public ID are passed as parameters $1, $2, $3, $4.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.alert
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The script to be called when a preliminary
|
||||
origin arrives. Latitude and longitude are passed as
|
||||
parameters $1 and $2.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.event
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The script to be called when an event has been
|
||||
declared. The message string, a flag (1=new event,
|
||||
0=update event), the EventID, the arrival count and the
|
||||
magnitude (optional when set) are passed as parameters
|
||||
$1, $2, $3, $4 and $5.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBconstraints.*\fP
|
||||
\fIConstraints for executing scripts\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B constraints.phaseHints
|
||||
Default: \fBP,S\fP
|
||||
.sp
|
||||
Type: \fIlist::string\fP
|
||||
.sp
|
||||
Start the pick script only when the phaseHint of the
|
||||
received pick has one of the value(s).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B constraints.phaseStreams
|
||||
Type: \fIlist::string\fP
|
||||
.sp
|
||||
Start the pick script only when the stream (NET.STA.LOC.CHA)
|
||||
of the received pick belongs to the list of stream IDs. If empty,
|
||||
all picks are accepted, otherwise only the ones whose stream ID
|
||||
matches one of the entry of this comma separated list. Each entry
|
||||
must follow the NET.STA.LOC.CHA format, but the special
|
||||
characters ? * | ( ) are also accepeted.
|
||||
E.g. \(dqCH.*,GR.STA??.*,*.*.*.HH?,*.*.*.??(Z|1)\(dq
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B constraints.phaseNumber
|
||||
Default: \fB1\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Start the pick script only when a minimum number of phases
|
||||
\(aqphaseNumber\(aq is received within \(aqphaseInterval\(aq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B constraints.phaseInterval
|
||||
Default: \fB1\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Start the pick script only when a minimum number of phases
|
||||
\(aqphaseNumber\(aq is received within \(aqphaseInterval\(aq.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscalert [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
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-first\-new
|
||||
Overrides configuration parameter \fI\%firstNew\fP\&.
|
||||
.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 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 Alert
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-amp\-type arg
|
||||
Specify the amplitude type to listen to.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-amp\-script arg
|
||||
Overrides configuration parameter \fI\%scripts.amplitude\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-alert\-script arg
|
||||
Overrides configuration parameter \fI\%scripts.alert\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-event\-script arg
|
||||
Overrides configuration parameter \fI\%scripts.event\fP\&.
|
||||
.UNINDENT
|
||||
.SS Cities
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-max\-dist arg
|
||||
Overrides configuration parameter \fI\%poi.maxDist\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-min\-population arg
|
||||
Overrides configuration parameter \fI\%poi.minPopulation\fP\&.
|
||||
.UNINDENT
|
||||
.SS Debug
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E, \-\-eventid arg
|
||||
Specify event ID that is used for testing. After running the
|
||||
alert scripts scvoice will exit.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
521
share/man/man1/scamp.1
Normal file
521
share/man/man1/scamp.1
Normal file
@ -0,0 +1,521 @@
|
||||
.\" 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 "SCAMP" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scamp \- SeisComP Documentation
|
||||
.sp
|
||||
\fBCalculates amplitudes on basis of incoming origins and the associated picks.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scamp measures several different kinds of amplitudes from waveform data.
|
||||
It listens for origins and measures amplitudes in time windows determined
|
||||
from the origin. Thus, in contrast to amplitudes measured by \fI\%scautopick\fP
|
||||
the considered time windows can depend on epicentral distance.
|
||||
The resulting amplitude objects are sent to the \(dqAMPLITUDE\(dq
|
||||
messaging group. scamp is the counterpart of \fI\%scmag\fP\&. Usually, all
|
||||
amplitudes are computed at once by scamp and then published.
|
||||
Only very rarely an amplitude needs to be recomputed if the location of an
|
||||
origin changes significantly. The amplitude can be reused by \fI\%scmag\fP, making
|
||||
magnitude computation and update efficient. Currently, the automatic picker
|
||||
in SeisComP, scautopick, also measures a small set of amplitudes
|
||||
(namely \(dqsnr\(dq and \(dqmb\(dq, the signal\-to\-noise ratio and the amplitude used in
|
||||
mb magnitude computation, respectively) for each automatic pick in fixed
|
||||
time windows. If there already exists an amplitude, e.g. a previously determined
|
||||
one by scautopick, scamp will not measure it again for the respective stream.
|
||||
.sp
|
||||
Amplitudes are also needed, however, for manual picks. scamp does this as well.
|
||||
Arrivals with weight smaller than 0.5 (default) in the corresponding Origin are
|
||||
discarded. This minimum weight can be configured with
|
||||
\fI\%amptool.minimumPickWeight\fP\&.
|
||||
.SH AMPLITUDE TYPES
|
||||
.sp
|
||||
Amplitudes of many types are currently computed for their corresponding
|
||||
magnitudes.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
In order to be used by scmag, the input amplitude names for the
|
||||
various magnitude types must typically match exactly. Exceptions:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%MN\fP requires \fIAMN\fP amplitudes,
|
||||
.IP \(bu 2
|
||||
\fI\%MLr\fP requires \fIMLv\fP amplitudes.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Local distances
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \fI\%Md\fP
|
||||
Duration magnitude as described in HYPOINVERSE (Klein [\fI\%50\fP]).
|
||||
.TP
|
||||
.B \fI\%Mjma\fP
|
||||
Mjma is computed on displacement data using body waves of period < 30s.
|
||||
.TP
|
||||
.B \fI\%ML\fP
|
||||
Local (Richter) magnitude calculated on the horizontal components using a
|
||||
correction term to fit with the standard ML (Richter [\fI\%57\fP]).
|
||||
.TP
|
||||
.B \fI\%MLc\fP
|
||||
Local custom magnitude calculated on the horizontal components according to
|
||||
Hessian Earthquake Service and Stange [\fI\%62\fP]
|
||||
.TP
|
||||
.B \fI\%MLh\fP
|
||||
Local magnitude calculated on the horizontal components according to SED
|
||||
specifications.
|
||||
.TP
|
||||
.B \fI\%MLv\fP
|
||||
Local magnitude calculated on the vertical component using a correction term
|
||||
to fit with the standard ML.
|
||||
.TP
|
||||
.B AMN for \fI\%MN\fP
|
||||
Nuttli magnitude for Canada and other Cratonic regions (Nuttli [\fI\%53\fP]).
|
||||
.UNINDENT
|
||||
.SS Teleseismic distances
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \fI\%mb\fP
|
||||
Narrow band body wave magnitude measured on a WWSSN\-SP filtered trace
|
||||
.TP
|
||||
.B \fI\%mBc\fP
|
||||
Cumulative body wave magnitude
|
||||
.TP
|
||||
.B \fI\%mB\fP
|
||||
Broad band body wave magnitude after Bormann and Saul [\fI\%38\fP]
|
||||
.TP
|
||||
.B \fI\%Mwp\fP
|
||||
The body wave magnitude of Tsuboi \fIet al.\fP [\fI\%63\fP]
|
||||
.TP
|
||||
.B \fI\%Ms_20\fP
|
||||
Surface\-wave magnitude at 20 s period
|
||||
.TP
|
||||
.B \fI\%Ms(BB)\fP
|
||||
Broad band surface\-wave magnitude
|
||||
.UNINDENT
|
||||
.SH ACCELERATION INPUT DATA
|
||||
.sp
|
||||
For amplitudes to be computed, the input waveforms are usually given in velocity.
|
||||
Acceleration data, e.g. from strong\-motion instruments must therefore be transformed
|
||||
to velocity. The transformation is enabled by activating the response correction.
|
||||
Activate the correction in the global bindings for all
|
||||
types or in a new Amplitude type profile for specific types.
|
||||
.sp
|
||||
Example global binding parameters for computing MLv amplitudes from accleration
|
||||
data. Here, the frequency range is limited to 0.5 \- 20 Hz:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
amplitudes.MLv.enableResponses = true
|
||||
amplitudes.MLv.resp.taper = 5
|
||||
amplitudes.MLv.resp.minFreq = 0.5
|
||||
amplitudes.MLv.resp.maxFreq = 20
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH RE-PROCESSING
|
||||
.sp
|
||||
\fIscamp\fP can be used to reprocess and to update amplitudes, e.g. when inventory paramters
|
||||
had to be changed retrospectively. Updating ampitudes requires waveform access.
|
||||
The update can be performed
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
In \fBoffline processing\fP based on XML files (\fB\-\-ep\fP). \fB\-\-reprocess\fP
|
||||
will replace exisiting amplitudes. Updated values can be dispatched to the messing by
|
||||
\fI\%scdispatch\fP making them available for further processing, e.g. by \fI\%scmag\fP\&.
|
||||
.sp
|
||||
\fBExample:\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ scamp \-\-ep evtID.xml \-d [type]://[host]/[database] \-\-reprocess > evtID_update.xml
|
||||
$ scdispatch \-O merge \-H [host] \-i evtID_update.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
\fBWith messaging\fP by setting \fBstart\-time\fP or \fBend\-time\fP\&.
|
||||
All parameters are read from the database. \fB\-\-commit\fP will
|
||||
send the updated parameters to the messing system making them available for
|
||||
further processing, e.g. by \fI\%scmag\fP\&. Otherwise, XML output is generated.
|
||||
.sp
|
||||
\fBExample:\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ scamp \-u testuser \-H [host] \-\-commit \e
|
||||
\-\-start\-time \(aq2016\-10\-15 00:00:00\(aq \-\-end\-time \(aq2016\-10\-16 19:20:00\(aq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scamp.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scamp.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scamp.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scamp inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B amplitudes
|
||||
Default: \fBMLv, mb, mB, Mwp\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Definition of magnitude types for which amplitudes are to be calculated.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B amptool.minimumPickWeight
|
||||
Default: \fB0.5\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
The minimum arrival weight within an origin to compute amplitudes for the associated pick.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B amptool.streamFromBindings
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled then global bindings will be used to replace
|
||||
location code and channel code of a pick with the configured
|
||||
values of detecLocid and detecStream for amplitude computation.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B amptool.initialAcquisitionTimeout
|
||||
Default: \fB30\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Timeout in seconds of the first data packet of waveform data acquisition.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B amptool.runningAcquisitionTimeout
|
||||
Default: \fB2\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Timeout in seconds of any subsequent data packet of waveform data acquisition.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.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
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-x, \-\-expiry time
|
||||
Time span in hours after which objects expire.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-O, \-\-origin\-id publicID
|
||||
OriginID to calculate amplitudes for and exit.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-dump\-records
|
||||
Dumps the filtered traces to ASCII when using \-O.
|
||||
.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
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-test
|
||||
Test mode where no messages are sent.
|
||||
.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 Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-ep file
|
||||
Defines an event parameters XML file to be read and processed. This
|
||||
implies offline mode and only processes all origins contained
|
||||
in that file. It computes amplitudes for all picks associated
|
||||
with an origin and outputs an XML file that additionally
|
||||
contains the amplitudes.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-p, \-\-picks
|
||||
Force measuring amplitudes for picks only. Origins are
|
||||
ignored and time windows are independent of distance. Works
|
||||
only in combination with \-\-ep.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-reprocess
|
||||
Reprocess and update existing amplitudes. Manual amplitudes
|
||||
will be skipped. Works only in combination with \-\-ep.
|
||||
This option can be used, e.g., for reprocessing amplitudes
|
||||
with new inventory information. Waveform access is required.
|
||||
.UNINDENT
|
||||
.SS Reprocess
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-force
|
||||
Forces reprocessing of all amplitudes, even manual ones.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-start\-time time
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-end\-time time
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-commit
|
||||
Send amplitude updates to the messaging otherwise an XML
|
||||
document will be output.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
3184
share/man/man1/scanloc.1
Normal file
3184
share/man/man1/scanloc.1
Normal file
File diff suppressed because it is too large
Load Diff
608
share/man/man1/scardac.1
Normal file
608
share/man/man1/scardac.1
Normal file
@ -0,0 +1,608 @@
|
||||
.\" 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 "SCARDAC" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scardac \- SeisComP Documentation
|
||||
.sp
|
||||
\fBWaveform archive data availability collector.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scardac scans an \fI\%SDS waveform archive\fP, e.g.,
|
||||
created by \fI\%slarchive\fP or \fI\%scart\fP for available
|
||||
\fI\%miniSEED\fP data. It will collect information about
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBDataExtents\fP \-\- the earliest and latest times data is available
|
||||
for a particular channel,
|
||||
.IP \(bu 2
|
||||
\fBDataAttributeExtents\fP \-\- the earliest and latest times data is available
|
||||
for a particular channel, quality and sampling rate combination,
|
||||
.IP \(bu 2
|
||||
\fBDataSegments\fP \-\- continuous data segments sharing the same quality and
|
||||
sampling rate attributes.
|
||||
.UNINDENT
|
||||
.sp
|
||||
scardac is intended to be executed periodically, e.g., as a cronjob.
|
||||
.sp
|
||||
The availability data information is stored in the SeisComP database under the
|
||||
root element \fI\%DataAvailability\fP\&. Access to the
|
||||
availability data is provided by the \fI\%fdsnws\fP module via the services:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%/fdsnws/station\fP (extent information only, see
|
||||
\fBmatchtimeseries\fP and \fBincludeavailability\fP request parameters).
|
||||
.IP \(bu 2
|
||||
\fI\%/fdsnws/ext/availability\fP (extent and segment information
|
||||
provided in different formats)
|
||||
.UNINDENT
|
||||
.SS Non\-SDS archives
|
||||
.sp
|
||||
scardac can be extended by plugins to scan non\-SDS archives. For example the
|
||||
\fBdaccaps\fP plugin provided by \fICAPS\fP [\fI\%3\fP] allows scanning archives generated
|
||||
by a CAPS server. Plugins are added to the global module configuration, e.g.:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
plugins = ${plugins}, daccaps
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Definitions
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBRecord\fP \-\- continuous waveform data of same sampling rate and quality bound
|
||||
by a start and end time. scardac will only read the record\(aqs meta data and not
|
||||
the actual samples.
|
||||
.IP \(bu 2
|
||||
\fBChunk\fP \-\- container for records, e.g., a \fI\%miniSEED\fP file,
|
||||
with the following properties:
|
||||
.INDENT 2.0
|
||||
.IP \(bu 2
|
||||
overall, theoretical time range of records it may contain
|
||||
.IP \(bu 2
|
||||
contains at least one record, otherwise it must be absent
|
||||
.IP \(bu 2
|
||||
each record of a chunk must fulfill the following conditions:
|
||||
.INDENT 2.0
|
||||
.IP \(bu 2
|
||||
\fIchunk start <= record start < chunk end\fP
|
||||
.IP \(bu 2
|
||||
\fIchunk start < record end < next chunk end\fP
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
chunks do not overlap, end time of current chunk equals start time of
|
||||
successive chunk, otherwise a \fBchunk gap\fP is declared
|
||||
.IP \(bu 2
|
||||
records may occur unordered within a chunk or across chunk boundaries,
|
||||
resulting in \fIDataSegments\fP marked as \fBoutOfOrder\fP
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBJitter\fP \-\- maximum allowed deviation between the end time of the current
|
||||
record and the start time of the next record in multiples of the current\(aqs
|
||||
record sampling rate. E.g., assuming a sampling rate of 100Hz and a jitter
|
||||
of 0.5 will allow for a maximum end to start time difference of 50ms. If
|
||||
exceeded a new \fIDataSegment\fP is created.
|
||||
.IP \(bu 2
|
||||
\fBMtime\fP \-\- time the content of a chunk was last modified. It is used to
|
||||
.INDENT 2.0
|
||||
.IP \(bu 2
|
||||
decided whether a chunk needs to be read in a secondary application run
|
||||
.IP \(bu 2
|
||||
calculate the \fBupdated\fP time stamp of a \fIDataSegment\fP,
|
||||
\fIDataAttributeExtent\fP and \fIDataExtent\fP
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBScan window\fP \-\- time window limiting the synchronization of the archive
|
||||
with the database configured via \fI\%filter.time.start\fP and
|
||||
\fI\%filter.time.end\fP respectively \fB\-\-start\fP and \fB\-\-end\fP\&.
|
||||
The scan window is useful to
|
||||
.INDENT 2.0
|
||||
.IP \(bu 2
|
||||
reduce the scan time of larger archives. Depending on the size and storage
|
||||
type of the archive it may take some time to just list available chunks and
|
||||
their mtime.
|
||||
.IP \(bu 2
|
||||
prevent deletion of availability information even though parts of the
|
||||
archive have been deleted or moved to a different location
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBModification window\fP \-\- the mtime of a chunk is compared with this time
|
||||
window to decide whether it needs to be read or not. It is configured via
|
||||
\fI\%mtime.start\fP and \fI\%mtime.end\fP repectively
|
||||
\fB\-\-modified\-since\fP and \fB\-\-modified\-until\fP\&. If no lower bound
|
||||
is defined then the \fBlastScan\fP time stored in the \fIDataExtent\fP is used
|
||||
instead. The mtime check may be disabled using \fI\%mtime.ignore\fP or
|
||||
\fB\-\-deep\-scan\fP\&.
|
||||
\fBNote:\fP Chunks in front or right after a chunk gap are read in any case
|
||||
regardless of the mtime settings.
|
||||
.UNINDENT
|
||||
.SS Workflow
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Read existing \fIDataExtents\fP from database.
|
||||
.IP 2. 3
|
||||
Collect a list of available stream IDs either by
|
||||
.INDENT 3.0
|
||||
.IP \(bu 2
|
||||
scanning the archive for available IDs or
|
||||
.IP \(bu 2
|
||||
reading an ID file defined by \fI\%nslcFile\fP\&.
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Identify extents to add, update or remove respecting \fIscan window\fP,
|
||||
\fI\%filter.nslc.include\fP and \fI\%filter.nslc.exclude\fP\&.
|
||||
.IP 4. 3
|
||||
Subsequently process the \fIDataExtents\fP using \fI\%threads\fP number of
|
||||
parallel threads. For each \fIDataExtent\fP:
|
||||
.INDENT 3.0
|
||||
.IP 1. 3
|
||||
Collect all available chunks within \fIscan window\fP\&.
|
||||
.IP 2. 3
|
||||
If the \fIDataExtent\fP is new (no database entry yet), store a new and
|
||||
empty \fIDataExtent\fP to database, else query existing \fIDataSegments\fP from
|
||||
the database:
|
||||
.INDENT 3.0
|
||||
.IP \(bu 2
|
||||
count segments outside \fIscan window\fP
|
||||
.IP \(bu 2
|
||||
create a database iterator for extents within \fIscan window\fP
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Create two in\-memory segment lists which collect segments to remove and
|
||||
segments to add/update
|
||||
.IP 4. 3
|
||||
For each chunk
|
||||
.INDENT 3.0
|
||||
.IP \(bu 2
|
||||
determine the \fIchunk window\fP and \fImtime\fP
|
||||
.IP \(bu 2
|
||||
decide whether the chunk needs to be read depending on the \fImtime\fP
|
||||
and a possible \fIchunk gap\fP\&. If necessary, read the chunk and
|
||||
.INDENT 3.0
|
||||
.IP \(bu 2
|
||||
create chunk segments by analyzing the chunk records for
|
||||
gaps/overlaps defined by \fI\%jitter\fP, sampling rate or quality
|
||||
changes
|
||||
.IP \(bu 2
|
||||
merge chunk segments with database segments and update the in\-memory
|
||||
segment lists.
|
||||
.UNINDENT
|
||||
.sp
|
||||
If not necessary, advance the database segment iterator to the end
|
||||
of the chunk window.
|
||||
.UNINDENT
|
||||
.IP 5. 3
|
||||
Remove and then add/update the collected segments.
|
||||
.IP 6. 3
|
||||
Merge segment information into \fIDataAttributeExtents\fP
|
||||
.IP 7. 3
|
||||
Merge \fIDataAttributeExtents\fP into overall \fIDataExtent\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Examples
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Get command line help or execute scardac with default parameters and informative
|
||||
debug output:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scardac \-h
|
||||
scardac \-\-debug
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Synchronize the availability of waveform data files existing in the standard
|
||||
\fI\%SDS\fP archive with the seiscomp database and create an XML file using
|
||||
\fI\%scxmldump\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scardac \-d mysql://sysop:sysop@localhost/seiscomp \-a $SEISCOMP_ROOT/var/lib/archive \-\-debug
|
||||
scxmldump \-Yf \-d mysql://sysop:sysop@localhost/seiscomp \-o availability.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Synchronize the availability of waveform data files existing in the standard
|
||||
\fI\%SDS\fP archive with the seiscomp database. Use \fI\%fdsnws\fP to fetch a flat file containing a list
|
||||
of periods of available data from stations of the CX network sharing the same
|
||||
quality and sampling rate attributes:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scardac \-d mysql://sysop:sysop@localhost/seiscomp \-a $SEISCOMP_ROOT/var/lib/archive
|
||||
wget \-O availability.txt \(aqhttp://localhost:8080/fdsnws/ext/availability/1/query?network=CX\(aq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
The \fISeisComP\fP module \fI\%fdsnws\fP must be running for executing this
|
||||
example.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scardac.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scardac.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scardac.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scardac inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B archive
|
||||
Default: \fB@SEISCOMP_ROOT@/var/lib/archive\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The URL to the waveform archive where all data is stored.
|
||||
.sp
|
||||
Format: [\fI\%service://\fP]location[#type]
|
||||
.sp
|
||||
\(dqservice\(dq: The type of the archive. If not given,
|
||||
\(dqsds://\(dq is implied assuming an SDS archive. The SDS
|
||||
archive structure is defined as
|
||||
YEAR/NET/STA/CHA/NET.STA.LOC.CHA.YEAR.DAYFYEAR, e.g.
|
||||
2018/GE/APE/BHZ.D/GE.APE..BHZ.D.2018.125
|
||||
.sp
|
||||
Other archive types may be considered by plugins.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B threads
|
||||
Default: \fB1\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Number of threads scanning the archive in parallel.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B jitter
|
||||
Default: \fB0.5\fP
|
||||
.sp
|
||||
Type: \fIfloat\fP
|
||||
.sp
|
||||
Acceptable derivation of end time and start time of successive
|
||||
records in multiples of sample time.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B maxSegments
|
||||
Default: \fB1000000\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Maximum number of segments per stream. If the limit is reached
|
||||
no more segments are added to the database and the corresponding
|
||||
extent is flagged as too fragmented. Set this parameter to 0 to
|
||||
disable any limits.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B nslcFile
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Line\-based text file of form NET.STA.LOC.CHA defining available
|
||||
stream IDs. Depending on the archive type, size and storage
|
||||
media used this file may offer a significant performance
|
||||
improvement compared to collecting the available streams on each
|
||||
startup. Filters defined under \fIfilter.nslc\fP still apply.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.*\fP
|
||||
\fIParameters of this section limit the data processing to either\fP
|
||||
**
|
||||
\fIreduce the scan time of larger archives or to\fP
|
||||
**
|
||||
\fIprevent deletion of availability information even though parts\fP
|
||||
\fIof the archive have been deleted or moved to a different\fP
|
||||
\fIlocation.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.time.*\fP
|
||||
\fILimit the processing by record time.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.time.start
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Start of data availability check given as date string or
|
||||
as number of days before now.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.time.end
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
End of data availability check given as date string or
|
||||
as number of days before now.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.nslc.*\fP
|
||||
\fILimit the processing by stream IDs.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.nslc.include
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Comma\-separated list of stream IDs to process. If
|
||||
empty all streams are accepted unless an exclude filter
|
||||
is defined. The following wildcards are supported: \(aq*\(aq
|
||||
and \(aq?\(aq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.nslc.exclude
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Comma\-separated list of stream IDs to exclude from
|
||||
processing. Excludes take precedence over includes. The
|
||||
following wildcards are supported: \(aq*\(aq and \(aq?\(aq.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBmtime.*\fP
|
||||
\fIParameters of this section control the rescan of data chunks.\fP
|
||||
\fIBy default the last update time of the extent is compared with\fP
|
||||
\fIthe record file modification time to read only files modified\fP
|
||||
\fIsince the list run.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B mtime.ignore
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If set to true all data chunks are read independent of their
|
||||
mtime.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B mtime.start
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Only read chunks modified after specific date given as date
|
||||
string or as number of days before now.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B mtime.end
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Only read chunks modified before specific date given as date
|
||||
string or as number of days before now.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscardac [OPTION]...\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
|
||||
.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 \-\-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 \-\-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 \-\-trace
|
||||
Execute in trace mode.
|
||||
Equivalent to \-\-verbosity=4 \-\-console=1 \-\-print\-component=1
|
||||
\-\-print\-context=1 .
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-log\-file arg
|
||||
Use alternative log file.
|
||||
.UNINDENT
|
||||
.SS Collector
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-a, \-\-archive arg
|
||||
Overrides configuration parameter \fI\%archive\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-threads arg
|
||||
Overrides configuration parameter \fI\%threads\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-j, \-\-jitter arg
|
||||
Overrides configuration parameter \fI\%jitter\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-nslc arg
|
||||
Overrides configuration parameter \fI\%nslcFile\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-start arg
|
||||
Overrides configuration parameter \fI\%filter.time.start\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-end arg
|
||||
Overrides configuration parameter \fI\%filter.time.end\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-include arg
|
||||
Overrides configuration parameter \fI\%filter.nslc.include\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-exclude arg
|
||||
Overrides configuration parameter \fI\%filter.nslc.exclude\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-deep\-scan
|
||||
Overrides configuration parameter \fI\%mtime.ignore\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-modified\-since arg
|
||||
Overrides configuration parameter \fI\%mtime.start\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-modified\-until arg
|
||||
Overrides configuration parameter \fI\%mtime.end\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-generate\-test\-data arg
|
||||
Do not scan the archive but generate test data for each
|
||||
stream in the inventory. Format:
|
||||
days,gaps,gapslen,overlaps,overlaplen. E.g., the following
|
||||
parameter list would generate test data for 100 days
|
||||
(starting from now()\-100) which includes 150 gaps with a
|
||||
length of 2.5s followed by 50 overlaps with an overlap of
|
||||
5s: \-\-generate\-test\-data=100,150,2.5,50,5
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
473
share/man/man1/scart.1
Normal file
473
share/man/man1/scart.1
Normal file
@ -0,0 +1,473 @@
|
||||
.\" 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 "SCART" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scart \- SeisComP Documentation
|
||||
.sp
|
||||
\fBImport/export MiniSEED data to/from SDS archives.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
The archive tool scart reads and writes \fI\%SDS\fP archives and files
|
||||
in miniSEED format and checks miniSEED archives or prints stream information.
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBDump mode:\fP Create miniSEED files (multiplexed), e.g. for playbacks, from
|
||||
\fI\%SDS\fP structured data (e.g. created by slarchive).
|
||||
.IP \(bu 2
|
||||
\fBDump mode:\fP Play back records directly out of an SDS structure.
|
||||
.IP \(bu 2
|
||||
\fBImport mode:\fP Import multiplexed miniSEED files into a local SDS waveform
|
||||
archive.
|
||||
.IP \(bu 2
|
||||
\fBImport mode:\fP Import data using the \fI\%RecordStream\fP interface
|
||||
into a local SDS waveform archive.
|
||||
.IP \(bu 2
|
||||
\fBImport mode:\fP Read data from any \fI\%RecordStream\fP interface
|
||||
and dump it to file.
|
||||
.IP \(bu 2
|
||||
\fBCheck mode:\fP Check an archive of miniSEED files for out\-of\-order records in
|
||||
files.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBWARNING:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
When creating \fI\%SDS\fP archives, scart simply appends the new records to
|
||||
existing ones. Multiple imports of the same data result in duplication.
|
||||
.IP \(bu 2
|
||||
Out\-of\-order imports of waveforms into a SDS archive result in out\-of\-order
|
||||
records which may not be processed. Clean your archive using \fI\%scmssort\fP\&.
|
||||
.IP \(bu 2
|
||||
\fBBefore importing miniSEED data\fP into an SDS archive they must be sorted
|
||||
by time and duplicate records must be removed. Otherwise, the SDS archive
|
||||
may not be correctly readable by other modules. Therefore, combine scart
|
||||
with \fI\%scmssort\fP for multiplexing and removal of duplicates.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
In dump and import mode output streams may be filtered by
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Time windows (\fB\-t\fP),
|
||||
.IP \(bu 2
|
||||
Network\-station\-location\-channel (NSLC) lists (\fB\-\-nslc\fP) created,
|
||||
e.g., with
|
||||
.INDENT 2.0
|
||||
.IP \(bu 2
|
||||
\fI\%scinv\fP from inventories,
|
||||
.IP \(bu 2
|
||||
\fI\%scdumpcfg\fP from bindings configuration,
|
||||
.IP \(bu 2
|
||||
scart itself from other miniSEED files or achives.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
In dump mode output streams may also be filtered by
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Time window \- stream lists (\fB\-\-list\fP, dump mode) generated by
|
||||
\fI\%scevtstreams\fP for particular events.
|
||||
.UNINDENT
|
||||
.sp
|
||||
Time strings may be given in
|
||||
* ISO time format, e.g., 2023\-03\-28T15:48:00
|
||||
* or the \(aqold\(aq SeisComP time format with empty character between date and time, e.g.,
|
||||
\(aq2023\-03\-28 15:48:00\(aq.
|
||||
.sp
|
||||
When omitting seconds, minutes or hours values of zero are implied.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH CONFIGURATION
|
||||
.sp
|
||||
scart can make use of \fI\%RecordStream\fP implementations which are
|
||||
provided by additional plugins. For loading additional plugins, e.g. the \fIxyz\fP
|
||||
plugin create and configure \fBscart.cfg\fP:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
plugins = xyz
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
The usage of wildcards in place of network, station, location or channel code
|
||||
is allowed in many options (\fB\-n\fP, \fB\-c\fP, \fB\-l\fP,
|
||||
\fB\-\-list\fP, \fB\-\-nslc\fP) and follows these rules:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Import mode: the wildcards are passed to the \fI\%RecordStream\fP interface,
|
||||
that interprets them. Normally both \(dq*\(dq and \(dq?\(dq are supported by RecordStreams.
|
||||
.IP \(bu 2
|
||||
Dump mode: the wildcards are interpreted by scart command that supports \(dq*\(dq for
|
||||
network, station, location codes and \(dq*\(dq, \(dq?\(dq, \(dq(\(dq, \(dq)\(dq, \(dq|\(dq for channel code.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Extract data from the default \fI\%SDS\fP archive in \fB$SEISCOMP_ROOT/var/lib/archive\fP
|
||||
or from a local \fI\%SDS\fP archive [SDS archive] into a miniSEED file \fBfile.mseed\fP
|
||||
and sort by end time of the records:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scart \-dsvE \-t \(aq[start\-time]~[end\-time]\(aq [SDS archive] > [file.mseed]
|
||||
scart \-dsvE \-t \(aq[start\-time]~[end\-time]\(aq > file.mseed
|
||||
scart \-dsvE \-t \(aq[start\-time]~[end\-time]\(aq \-n \(aq[NET1],[NET2]\(aq > file.mseed
|
||||
scart \-dsvE \-t \(aq[start\-time]~[end\-time]\(aq \-n \(aq[NET]\(aq \-c \(aq(E,H)H(1,2,3)\(aq > file.mseed
|
||||
scart \-dsvE \-t \(aq[start\-time]~[end\-time]\(aq \-n \(aq[N1.S1.L1.C1],[N2.S2.L2.C2]\(aq > file.mseed
|
||||
scart \-dsvE \-t \(aq[start\-time]~[end\-time]\(aq \-\-nslc list.file > file.mseed
|
||||
scart \-dsvE \-t \-\-list list.file > file.mseed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
It is possible to achieve the same result of the dump mode using a
|
||||
combination of the input mode and the \fI\%scmssort\fP command, which allows
|
||||
to read the input data from any supported \fI\%RecordStream\fP,
|
||||
not only an SDS archive:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scart \-I [record\-stream] \-\-list list.file \-\-stdout | scmssort \-u \-E \-v > file.mseed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
Sorting data is computational expensive but required for waveform playbacks.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Push miniSEED data from file \fBfile.mseed\fP or standard input
|
||||
(stdin) into a local \fI\%SDS\fP archive or a file. Additionally, you may
|
||||
check if the records of archived files are correctly ordered, filter by time
|
||||
and/or with NSLC list and print the output streams:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scmssort \-u \-E [file.mseed] > sorted.mseed
|
||||
scart \-I sorted.mseed \-\-with\-filecheck [SDS archive]
|
||||
|
||||
scart \-I [file.mseed] \-t \(aq[start\-time]~[end\-time]\(aq \-\-print\-streams \-\-nslc list.file \-o [out.mseed]
|
||||
|
||||
cat sorted.mseed | scart \-I \- [SDS archive]
|
||||
cat sorted.mseed | scart [SDS archive]
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Collect data using the \fI\%RecordStream\fP interface (e.g. FDSNWS server)
|
||||
and write to a miniSEED file or import it into a local \fI\%SDS\fP archive. The
|
||||
data streams and the time spans can be defined in several ways. The data streams
|
||||
(\fB\-\-list\fP) can be automatically generated, e.g., by \fI\%scevtstreams\fP\&.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scart \-I fdsnws://[server]:80 \-\-list list.file [SDS archive]
|
||||
scart \-I fdsnws://[server]:80 \-\-list list.file \-o file.mseed
|
||||
scart \-I fdsnws://[server]:80 \-t \(aq[start\-time]~[end\-time]\(aq \-\-nslc list.file [SDS archive]
|
||||
scart \-I fdsnws://[server]:80 \-t \(aq[start\-time]~[end\-time]\(aq \-n \(aq[NET1],[NET2]\(aq [SDS archive]
|
||||
scart \-I fdsnws://[server]:80 \-t \(aq[start\-time]~[end\-time]\(aq \-n \(aq[NET]\(aq \-c \(aqEH?\(aq [SDS archive]
|
||||
scart \-I fdsnws://[server]:80 \-t \(aq[start\-time]~[end\-time]\(aq \-n \(aq[N1.S1.L1.C1],[N2.S2.L2.C2]\(aq [SDS archive]
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 4. 3
|
||||
Check all files of an SDS archive or other directory structure for
|
||||
miniSEED files with out\-of\-order records:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scart \-\-check [archive]
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 5. 3
|
||||
Print stream information from miniSEED files in archives or from
|
||||
\fI\%RecordStream\fP without actually writing miniSEED data. In dump and
|
||||
import mode use the \fB\-\-test\fP if miniSEED data shall be read but not
|
||||
written.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scart \-\-print\-streams \-I [miniSEED file] \-\-test
|
||||
scart \-\-print\-streams \-d \-t [time span] \-\-test [SDS archive]
|
||||
scart \-\-print\-streams \-\-check [archive]
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The output looks like this:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
# streamID start end records samples samplingRate
|
||||
GE.RGN..BHZ 2022\-12\-08T15:34:41.895Z 2022\-12\-08T15:52:19.145Z 58 21145 20.0
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
where the header and the text body are printed to stderr.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscart [options] {archive\-dir}\fP
|
||||
.sp
|
||||
The last option has to be the archive directory when dump mode is enabled.
|
||||
When no archive directory is explicitly given,
|
||||
$SEISCOMP_ROOT/var/lib/archive or the current directory
|
||||
is used depending on whether $SEISCOMP_ROOT has been set or not.
|
||||
The default operation mode is import. That means that a multiplexed
|
||||
MiniSEED file or another record source such as ArcLink is used to import
|
||||
records into a SDS structure.
|
||||
.SS Verbosity
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-v, \-\-verbose
|
||||
Verbose mode.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h, \-\-help
|
||||
Display a help message.
|
||||
.UNINDENT
|
||||
.SS Mode
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-check
|
||||
Check mode. Check all files
|
||||
in the given directory for erroneous miniSEED records.
|
||||
All sub\-directories are included. If no directory is given,
|
||||
the default SDS archive is scanned. Checks are only complete
|
||||
for files containing exactly one stream. More complete checks
|
||||
are made with scmssort.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-d, \-\-dump
|
||||
Set export (dump) mode. Records are retrieved from an archive and
|
||||
written to standard output.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-I
|
||||
Import mode (default): Specify the recordstream URL to read
|
||||
the data from for archiving. When using any other
|
||||
recordstream than file, a stream list file is needed.
|
||||
Specifying \- implies \fI\%file://\fP\- (stdin). If no mode is
|
||||
explicitly specified, \-I \fI\%file://\fP\- is assumed.
|
||||
.UNINDENT
|
||||
.SS Processing
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-c channels
|
||||
Channel filter to be applied to the data streams.
|
||||
Default for Dump: \(dq(B|E|H|M|S)(D|H|L|N)(E|F|N|Z|1|2|3)\(dq
|
||||
Default for Import: \(dq*\(dq
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E
|
||||
Dump mode: sort records according to their end time.
|
||||
Default: start time.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-files count
|
||||
Dump mode: Specify the number of file handles to cache.
|
||||
Default: 100.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i
|
||||
Ignore records without data samples.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-l, \-\-list file
|
||||
Import, dump mode: Use a stream list file with time windows instead
|
||||
of defined networks and channels (\-n, \-c and \-t are ignored).
|
||||
The list can be generated from events by scevtstreams. One
|
||||
line per stream. Line format: starttime;endtime;streamID
|
||||
The time format is the same as described in option \(aq\-t\(aq.
|
||||
.sp
|
||||
Example:
|
||||
.sp
|
||||
2019\-07\-17 02:00:00;2019\-07\-17 02:10:00;GR.CLL..BH?
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-m, \-\-modify
|
||||
Dump mode: Modify the record time for real time playback.
|
||||
The first record time is NOW. The relative time of
|
||||
successive records to the first one are kept.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-n networks
|
||||
Import, dump mode: Data stream selection as a comma separated list
|
||||
\(dqstream1,stream2,streamX\(dq where each stream can be NET or NET.STA
|
||||
or NET.STA.LOC or NET.STA.LOC.CHA.
|
||||
If CHA is omitted, it defaults to the value of \-c option.
|
||||
Default: \(dq*\(dq
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-nslc file
|
||||
Import, dump mode: Stream list file to be used instead of
|
||||
defined networks and channels (\-n and \-c are ignored)
|
||||
for filtering the data by the given streams. Dump mode:
|
||||
Use in combination with \-t! One line per stream, line
|
||||
format: NET.STA.LOC.CHA
|
||||
.sp
|
||||
Example:
|
||||
.sp
|
||||
GR.CLL..BH?
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-rename rule
|
||||
Import, dump mode: Rename stream data according to the provided
|
||||
rule(s). A rule is \(dq[match\-stream:]rename\-stream\(dq and match\-stream
|
||||
is optional. match\-stream and rename\-stream are in the
|
||||
\(dqNET.STA.LOC.CHA\(dq format. match\-stream supports special
|
||||
charactes \(dq?\(dq \(dq*\(dq \(dq|\(dq \(dq(\(dq \(dq)\(dq. rename\-stream supports the
|
||||
special character \(dq\-\(dq that can be used in place of NET, STA,
|
||||
LOC, CHA codes with the meaning of not renaming those.
|
||||
\(dq\-\(dq can also be used as the last character in CHA code.
|
||||
Multiple rules can be provided as a comma separated list
|
||||
or by providing multiple \-\-rename options.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-s, \-\-sort
|
||||
Dump mode: Sort records by [start\-]time. To sort records by their
|
||||
end time use \-E.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-speed value
|
||||
Dump mode: Specify the speed to dump the records. A value of 0 means
|
||||
no delay otherwise speed is a multiplier of the real time difference
|
||||
between the records. When feeding the records directly into the replay
|
||||
pipe a value of 1 (real time) is recommended.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-t, \-\-time\-window timeWindow
|
||||
Import, dump mode: Specify the time window (as one properly
|
||||
quoted string) to dump records for. Times are UTC and
|
||||
separated by a tilde \(dq~\(dq. To dump one hour of
|
||||
waveform data between 2008/01/01 00:00:00 and 2008/01/01
|
||||
01:00:00 use
|
||||
<\-t 2008\-01\-01T00:00:00~2008\-01\-01T01:00:00>.
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output
|
||||
Dump, Import mode: Write data to given file instead of creating
|
||||
a SDS archive. Deactivates \-\-stdout. Deactivated by \-\-test.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-print\-streams
|
||||
Print stream information only and exit. Works in import, dump
|
||||
and check mode. Output: NET.STA.LOC.CHA StartTime EndTime.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-stdout
|
||||
Import mode: Write to stdout instead of creating a SDS archive.
|
||||
Deactivated by \-\-test and \-\-output.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-test
|
||||
Test input only, deactivate all miniSEED output. This switch is
|
||||
useful for debugging and printing stream information with
|
||||
\-\-print\-streams.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-with\-filecheck
|
||||
Import mode: Check all accessed files. Unsorted or unreadable
|
||||
files are reported to stderr. Checks are only complete
|
||||
for files containing exactly one stream. More complete
|
||||
checks are made with scmssort.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-with\-filename
|
||||
Import mode: Print all accessed files to stderr after import.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
1317
share/man/man1/scautoloc.1
Normal file
1317
share/man/man1/scautoloc.1
Normal file
File diff suppressed because it is too large
Load Diff
1058
share/man/man1/scautopick.1
Normal file
1058
share/man/man1/scautopick.1
Normal file
File diff suppressed because it is too large
Load Diff
418
share/man/man1/scbulletin.1
Normal file
418
share/man/man1/scbulletin.1
Normal file
@ -0,0 +1,418 @@
|
||||
.\" 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 "SCBULLETIN" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scbulletin \- SeisComP Documentation
|
||||
.sp
|
||||
\fBCreate bulletins from SCML.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scbulletin transforms the parameters of events or origins either to various formats.
|
||||
Currently supported output formats are:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
autoloc1,
|
||||
.IP \(bu 2
|
||||
autoloc3,
|
||||
.IP \(bu 2
|
||||
fdsnws,
|
||||
.IP \(bu 2
|
||||
kml.
|
||||
.UNINDENT
|
||||
.SH INPUT MODES
|
||||
.sp
|
||||
Two modes of parameter input are possible:
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Dump mode: Fetch all necessary information from database directly. Either
|
||||
choose one or more event or origin IDs. The database connection must be given
|
||||
with \fB\-o\fP\&.
|
||||
.IP 2. 3
|
||||
Input mode: Provide all event and origin information in XML (\fI\%SCML\fP)
|
||||
format from file or stdin. You may filter further by event or origin ID.
|
||||
.UNINDENT
|
||||
.sp
|
||||
If event IDs are given, the preferred origin will be derived and used for printing
|
||||
information.
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Events and origins are referred to by their public IDs. They can be provided
|
||||
by \fI\%scevtls\fP and \fI\%scorgls\fP, respectively, from graphical tools like
|
||||
\fI\%scolv\fP or by database queries supported by \fI\%scquery\fP\&. XML files
|
||||
can be generated by \fI\%scxmldump\fP or from other formats by \fI\%sccnv\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH OUTPUT MODES
|
||||
.sp
|
||||
The generated content is written to stdout or, with option \fB\-o\fP to a
|
||||
file. Different output formats are available by command\-line options:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fB\-1\fP for \fBautoloc1\fP: Print one bulletin per event.
|
||||
.IP \(bu 2
|
||||
\fB\-3\fP for \fBautoloc3\fP: Print one bulletin per event.
|
||||
.IP \(bu 2
|
||||
\fB\-3 \-x\fP for \fBextended autoloc3\fP\&.
|
||||
.IP \(bu 2
|
||||
\fB\-4\fP or \fB\-\-fdsnws\fP for FDSNWS event text: Print one line per event. Useful
|
||||
for generating event catalogs. This option offers an alternative to generating
|
||||
event catalogs by \fI\%fdsnws\-event\fP\&.
|
||||
.IP \(bu 2
|
||||
\fB\-5\fP or \fB\-\-kml\fP for KML/GIS file format. The output can be viewed, e.g.,
|
||||
in \fIGoogle Earth\fP\&.
|
||||
.UNINDENT
|
||||
.sp
|
||||
By default, the output precision of times or coordinates is optimized for events
|
||||
at teleseismic or regional distances. Use the option \fB\-e\fP for
|
||||
\fBenhanced\fP output at higher precision: All times and distances are in units
|
||||
of milliseconds and meters, respectively.
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Create a bulletin from one or multiple event(s) in database
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scbulletin \-d mysql://sysop:sysop@localhost/seiscomp \-E gfz2012abcd
|
||||
scbulletin \-d mysql://sysop:sysop@localhost/seiscomp \-E gfz2012abcd,gfz2022abcd
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Convert XML file to bulletin
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scbulletin \-i gfz2012abcd.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
cat gfz2012abcd.xml | scbulletin
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scbulletin < gfz2012abcd.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Convert XML file to bulletin but filter by event ID(s)
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scbulletin \-i gfz2012abcd.xml \-E gempa2022abcd
|
||||
scbulletin \-i gfz2012abcd.xml \-E gempa2022abcd,gfz2022abcd
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
When considering a single event XML file containing many events, the
|
||||
bulletins of all events will be generated unless \fB\-\-first\-only\fP is used.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scbulletin.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scbulletin.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scbulletin.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scbulletin inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscbulletin [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 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 Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-format arg
|
||||
Input format to use (xml [default], zxml (zipped xml), binary).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-input arg
|
||||
The input file. Default is stdin.
|
||||
.UNINDENT
|
||||
.SS Dump
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E, \-\-event arg
|
||||
ID of event(s) that is read from database and transformed into
|
||||
a bulletin. Separate multiple IDs by comma.\(dq
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-O, \-\-origin arg
|
||||
ID of origin(s) that is read from database and transformed into
|
||||
a bulletin. Separate multiple IDs by comma.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-event\-agency\-id
|
||||
Use the agency ID of the event instead of the preferred origin.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-first\-only
|
||||
Convert only the first event/origin to bulletin. Otherwise
|
||||
all events or origins will be converted to single bulletins
|
||||
which will be concatenated.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-p, \-\-polarities
|
||||
Dump onset polarities.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-w, \-\-weight arg
|
||||
Weight threshold for printed and counted picks.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-x, \-\-extra
|
||||
Use a specially detailed autoloc3 format. This options works only
|
||||
in combination with the autoloc3\-flag.
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-1, \-\-autoloc1
|
||||
Format: Use autoloc1 format for output. This is default.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-3, \-\-autoloc3
|
||||
Format: Use autoloc3 format for output.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-4, \-\-fdsnws
|
||||
Format: FDSNWS event text, e.g., for generating catalogs.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-5, \-\-kml
|
||||
Format: KML. GIS file format.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-e, \-\-enhanced
|
||||
Enhanced output with higher precision. Times: milliseconds,
|
||||
distances: meter. Use for bulletins of local earthquakes.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-k, \-\-dist\-in\-km
|
||||
Print distances in km instead of degree.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output
|
||||
Name of output file. If not given, all event parameters are
|
||||
printed to stdout.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-x, \-\-extra
|
||||
Use a specially detailed autoloc3 format. This options works
|
||||
only in combination with the autoloc3\-flag.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
110
share/man/man1/scchkcfg.1
Normal file
110
share/man/man1/scchkcfg.1
Normal file
@ -0,0 +1,110 @@
|
||||
.\" 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 "SCCHKCFG" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scchkcfg \- SeisComP Documentation
|
||||
.sp
|
||||
\fBChecks a module configuration.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scchkcfg checks for case\-sensitivity issues of parameter names of the module
|
||||
configuration file for a module. It reads all defined configuration stages
|
||||
(see \fI\%Modules\fP) and checks for each parameter read if it exists
|
||||
again with a different spelling.
|
||||
.sp
|
||||
If \fIstandalone\fP is not given, it checks all 6 configurations
|
||||
files (including \fBglobal.cfg\fP), 3 otherwise.
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ scchkcfg scautopick
|
||||
Read configuration files OK
|
||||
No possible conflict detected
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
scchkcfg checks only for possible conflicts since it does not know what parameters
|
||||
a module will read eventually.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ scchkcfg scautopick
|
||||
Read configuration files OK
|
||||
Conflict #1
|
||||
connection.server /home/sysop/seiscomp/etc/global.cfg:8
|
||||
connection.Server /home/sysop/.seiscomp/scautopick.cfg:1
|
||||
1 conflict detected
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
In this case everything is ok and the conflict needs to be fixed.
|
||||
\fBconnection.Server\fP is not a valid parameter name
|
||||
(but \fI\%connection.server\fP is) in
|
||||
\fB/home/sysop/.seiscomp/scautopick.cfg\fP and thus will not be used.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ scchkcfg scautopick
|
||||
Read configuration files OK
|
||||
Conflict #1
|
||||
module.trunk.global.amplitudes.mb.signalEnd \e
|
||||
/home/sysop/.seiscomp/scautopick.cfg:1
|
||||
module.trunk.global.amplitudes.mB.signalEnd \e
|
||||
/home/sysop/.seiscomp/scautopick.cfg:2
|
||||
1 conflict detected
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
In this case the configuration is OK and this is an example why the case\-sensitivity
|
||||
has changed from previous versions: mb != mB. scchkcfg detects a possible
|
||||
conflicts but does not know that this case is well defined. But it helps the user to
|
||||
decide whether it needs a fix or not.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscchkcfg {mod\-name} [standalone]\fP
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
336
share/man/man1/sccnv.1
Normal file
336
share/man/man1/sccnv.1
Normal file
@ -0,0 +1,336 @@
|
||||
.\" 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 "SCCNV" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
sccnv \- SeisComP Documentation
|
||||
.sp
|
||||
\fBConverts data in different formats.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
sccnv reads input given in a supported format, converts the content to another
|
||||
format and writes the output. Use the command\-line option \fBformat\-list\fP
|
||||
for a list of supported formats.
|
||||
.SH FORMATS
|
||||
.sp
|
||||
Different formats are supported for input and output files.
|
||||
.TS
|
||||
center;
|
||||
|l|l|l|l|.
|
||||
_
|
||||
T{
|
||||
Name
|
||||
T} T{
|
||||
Description
|
||||
T} T{
|
||||
Input
|
||||
T} T{
|
||||
Output
|
||||
T}
|
||||
_
|
||||
T{
|
||||
arclink
|
||||
T} T{
|
||||
\fI\%Arclink XML\fP
|
||||
T} T{
|
||||
X
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
bson
|
||||
T} T{
|
||||
T} T{
|
||||
X
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
bson\-json
|
||||
T} T{
|
||||
T} T{
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
csv
|
||||
T} T{
|
||||
comma\-separated values
|
||||
T} T{
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
hyp71sum2k
|
||||
T} T{
|
||||
Hypo71 format
|
||||
T} T{
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
ims10
|
||||
T} T{
|
||||
T} T{
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
json
|
||||
T} T{
|
||||
\fI\%JSON\fP format
|
||||
T} T{
|
||||
X
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
qml1.2
|
||||
T} T{
|
||||
\fI\%QuakeML\fP format
|
||||
T} T{
|
||||
*
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
qml1.2rt
|
||||
T} T{
|
||||
\fI\%QuakeML\fP real time (RT) format
|
||||
T} T{
|
||||
*
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
scdm0.51
|
||||
T} T{
|
||||
T} T{
|
||||
X
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
T{
|
||||
trunk
|
||||
T} T{
|
||||
SeisComP XML (\fI\%SCML\fP) \- \fI\%SCML API\fP
|
||||
T} T{
|
||||
X
|
||||
T} T{
|
||||
X
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.sp
|
||||
\fB*\fP: The conversion from files in QuakeML format is not supported by sccnv
|
||||
but can be realized by system tools. Read section \fI\%QuakeML\fP for
|
||||
details and instructions.
|
||||
.SS QuakeML
|
||||
.sp
|
||||
\fI\%QuakeML\fP is used in a variety of flavors involving, e.g.,
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Using non\-standard objects,
|
||||
.IP \(bu 2
|
||||
PublicID references which are not globally unique,
|
||||
.IP \(bu 2
|
||||
Missing references to parent objects,
|
||||
.IP \(bu 2
|
||||
Missing creationInfo parameters.
|
||||
.UNINDENT
|
||||
.sp
|
||||
The ability to convert from QuakeML to \fI\%SCML\fP is thus limited and it
|
||||
depends on the parameters provided with the input QuakeML file.
|
||||
.sp
|
||||
However, XSLT stylesheets are provided for mapping the parameters. The files
|
||||
are located in \fB@DATADIR@/xml/[version]/\fP for different \fISeisComP\fP data schema
|
||||
versions. The stylesheet files provide information on the mapping and on
|
||||
limitations as well as examples on their application.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
You may find out about the \fISeisComP\fP data schema version using modules along
|
||||
with the command\-line option \fI\-V\fP, e.g.,
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ sccnv \-V
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The style sheets can be used along with other stylesheet converter tools provided
|
||||
by your system, e.g., \fBxalan\fP or \fBxsltproc\fP\&. Examples are given
|
||||
in section \fI\%Examples\fP\&.
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Print the list of supported formats:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ sccnv \-\-format\-list
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Convert an event parameter file in \fI\%SCML\fP format to \fI\%QuakeML\fP and
|
||||
store the content in a file:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ sccnv \-i seiscomp.xml \-o qml1.2:quakeml.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Convert an inventory file in Arclink XML format to \fI\%SCML\fP and store the
|
||||
content in a file:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ sccnv \-i arclink:Package_inventory.xml \-o inventory.sc.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Convert an event parameter file in \fI\%SCML\fP format to ims1.0 and store the
|
||||
content in a file:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ sccnv \-i trunk:event.xml \-o ims10:event.ims
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Convert QuakeML in version 1.2 to SCML in data schema version 0.12:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ xsltproc $SEISCOMP_ROOT/share/xml/0.12/quakeml_1.2__sc3ml_0.12.xsl file.quakeml > file_sc.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBsccnv \-i format:file \-o format:file\fP
|
||||
.sp
|
||||
sccnv reads the input given in a supported format, converts the content
|
||||
and writes the output in another format. Use the option \fIformat\-list\fP
|
||||
for a list of supported formats.
|
||||
.SS Generic
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h, \-\-help
|
||||
Show help message.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-V, \-\-version
|
||||
Show version information.
|
||||
.UNINDENT
|
||||
.SS Verbosity
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-v, \-\-v
|
||||
Increase verbosity level (may be repeated, eg. \-vv).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-debug
|
||||
Execute in debug mode.
|
||||
Equivalent to \-\-verbosity=4 \-\-console=1 .
|
||||
.UNINDENT
|
||||
.SS Formats
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-format\-list
|
||||
List all supported formats
|
||||
.UNINDENT
|
||||
.SS Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-input arg
|
||||
Input stream [format:][file], default: trunk:\-
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output arg
|
||||
Output stream [format:][file], default trunk:\-
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-formatted
|
||||
Use formatted output
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-indent arg
|
||||
Formatted line indent. Default: 2
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
565
share/man/man1/scconfig.1
Normal file
565
share/man/man1/scconfig.1
Normal file
@ -0,0 +1,565 @@
|
||||
.\" 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 "SCCONFIG" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scconfig \- SeisComP Documentation
|
||||
.sp
|
||||
\fBConfiguration and system management frontend.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scconfig is a graphical user interface which allows to
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Retrieve \fI\%information\fP about the installed \fISeisComP\fP
|
||||
system,
|
||||
.IP \(bu 2
|
||||
\fI\%Control modules\fP (start/stop/check/enable/disable) and
|
||||
access logging file,
|
||||
.IP \(bu 2
|
||||
\fI\%Import, check, synchronize and remove\fP station meta
|
||||
data/inventory,
|
||||
.IP \(bu 2
|
||||
Configure the \fI\%module configuration\fP and
|
||||
\fI\%bindings\fP all SeisComP modules for which descriptions
|
||||
are provided,
|
||||
.IP \(bu 2
|
||||
Access the \fI\%documentation and the changelog\fP\&.
|
||||
.UNINDENT
|
||||
.sp
|
||||
The modules are usually programs part of the SeisComP system and have two
|
||||
distinct types of configuration:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%Modules configuration\fP, or just program
|
||||
configuration stored in file like \fBscautopick.cfg\fP\&.
|
||||
.IP \(bu 2
|
||||
\fI\%Bindings\fP, that are set of parameters to configure
|
||||
how the module will treat a certain station. I.e. station\-specific
|
||||
configurations per module. Bindings can be configured using profiles, or
|
||||
directly per station. A profile is a named set of parameters for a certain
|
||||
module that can be attributed for more than one station. Using profiles makes
|
||||
it easiear to maintain large number of station configuration. When two stations
|
||||
are configured by the same profile, both will have the same parameter set for
|
||||
a certain module.
|
||||
.UNINDENT
|
||||
.sp
|
||||
scconfig does not know anything about the SeisComP database, the only thing it
|
||||
can do is to actually read and write the content of files from \fBetc/\fP and
|
||||
\fB~/.seiscomp\fP folder. It allows you to manage this information in an
|
||||
organized and friendly manner. Also, it relies on other applications like the
|
||||
proper \fI\%seiscomp\fP tool to complete the system configuration.
|
||||
.SS First start
|
||||
.sp
|
||||
If scconfig is started for the first time it will ask the user to setup
|
||||
its new installation.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
If done already with the \fI\%command line interface\fP,
|
||||
this step can be skipped. If the setup has been run already, is indicated by
|
||||
the presence of the file \fBvar/run/seiscomp.init\fP\&.
|
||||
.sp
|
||||
If pressing yes, the setup wizard will be started and will configure exactly
|
||||
the same parameters as described in \fI\%Getting Started with SeisComP\fP\&.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Pressing \(aqFinish\(aq will run the setup and report the progress.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Pressing \(aqClose\(aq will launch the main configuration window.
|
||||
.SS Main Window
|
||||
.sp
|
||||
The layout of the main window is always the same regardless of what panel
|
||||
is selected.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Main window of scconfig: mode switch (red), panel selection (yellow),
|
||||
panel title and description (green),
|
||||
panel content (blue).UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
It is divided into 4 areas:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
red: the mode switch (user vs. system)
|
||||
.IP \(bu 2
|
||||
yellow: panel switch
|
||||
.IP \(bu 2
|
||||
green: title and description of current panel
|
||||
.IP \(bu 2
|
||||
blue: the content and interactive screen of the current panel
|
||||
.UNINDENT
|
||||
.sp
|
||||
The Main menu contains two entries: File and Edit\&.
|
||||
.sp
|
||||
The file menu allows to run the setup wizard (Wizard), to reload
|
||||
the configuration (Reload), to save the
|
||||
configuration (Save) and to close the configuration (Quit).
|
||||
.sp
|
||||
The Edit menu allows to switch the current configuration mode. Pressing the
|
||||
switch button in the upper left corner (red box) is a shortcut for this operation.
|
||||
.SS Information panel
|
||||
.sp
|
||||
This panel shows information about the \fISeisComP\fP environment
|
||||
(see figure \fI\%main window\fP). All variables
|
||||
(except PATH) can be used as placeholders in most of the configuration
|
||||
parameters which define directories or files, e.g.:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
autoloc.grid = @CONFIGDIR@/autoloc/local.grid
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS System panel
|
||||
.sp
|
||||
The system panel is a graphical frontend for the \fI\%seiscomp\fP script.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
It is divided into 3 parts: the toolbar on the top (red), the module list (green)
|
||||
and the log window (blue).
|
||||
The log window shows the output of all external programs called such as \fBseiscomp\fP\&.
|
||||
The standard output is colored black and standard error is colored brown.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Due to the buffering of the GUI it can happen that standard output and
|
||||
standard error logs are not in perfect order.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The toolbar gives access to the available operations. All operations
|
||||
will affect the currently selected modules (rows). If no row is selected, all
|
||||
modules are affected and the corresponding call to \fBseiscomp <arg>\fP is done
|
||||
without any module.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \fIUpdate\fP
|
||||
Updates the current module state by calling \fBseiscomp \-\-csv status\fP\&.
|
||||
.TP
|
||||
.B \fIStart\fP
|
||||
Calls \fBseiscomp start\fP\&.
|
||||
.TP
|
||||
.B \fIStop\fP
|
||||
Calls \fBseiscomp stop\fP\&.
|
||||
.TP
|
||||
.B \fIRestart\fP
|
||||
Calls \fBseiscomp restart\fP\&.
|
||||
.TP
|
||||
.B \fICheck\fP
|
||||
Calls \fBseiscomp check\fP\&.
|
||||
.TP
|
||||
.B \fIEnable module(s)\fP
|
||||
Enables all selected modules for autostart.
|
||||
At least one module must be selected.
|
||||
.TP
|
||||
.B \fIDisable module(s)\fP
|
||||
Disables all selected modules for autostart.
|
||||
At least one module must be selected.
|
||||
.TP
|
||||
.B \fIUpdate configuration\fP
|
||||
Calls \fBseiscomp update\-config\fP\&. This is important after the
|
||||
module configuration or bindings have changed and before restarting the
|
||||
affected modules.
|
||||
.UNINDENT
|
||||
.sp
|
||||
For applying an action to all modules deselect any modules selection pressing
|
||||
\fBESC\fP and press the corresponding action button. When one ore multiple
|
||||
modules are selected, the action is only applied to those.
|
||||
.sp
|
||||
To open the most recent log files of modules right click on the module name and
|
||||
select the available log.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Inventory panel
|
||||
.sp
|
||||
The inventory panel allows to import, check and synchronize inventory files as
|
||||
well as to inspect the content or to rename or remove the files. The panel shows
|
||||
a list of inventory XML files located in folder \fBetc/inventory\fP\&. Only
|
||||
\fI\%SCML\fP files can be used as source for inventory data but various importers
|
||||
exist to integrate inventory data from other formats. After the first start
|
||||
the list is empty and contains only a README file.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Importing station meta data is outlined in the
|
||||
\fI\%tutorial on adding a station\fP\&.
|
||||
.sp
|
||||
One source of importing inventory information is ArcLink as run at
|
||||
\fI\%http://www.webdc.eu\fP\&. After downloading the inventory XML file from ArcLink it
|
||||
can be imported into SeisComP by pressing the \(aqImport\(aq button in the toolbar
|
||||
on the top.
|
||||
.sp
|
||||
It will open a popup which allows to select for input format.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
If ArcLink is selected, the source location should then point to the ArcLink
|
||||
XML file downloaded before.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
If successfully imported a window will popup with the execution result and
|
||||
the import output.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
After closing the popup the imported inventory file will show up in the list of
|
||||
files. Selecting a files by right\-clicking allows:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Renaming,
|
||||
.IP \(bu 2
|
||||
Deleting,
|
||||
.IP \(bu 2
|
||||
Inspecting the content of
|
||||
.UNINDENT
|
||||
.sp
|
||||
the file.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The toolbar support 4 additional actions:
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \fICheck inventory\fP
|
||||
The inventory is checked for issues including inconsistencies wich are reported.
|
||||
The tests are based on \fI\%scinv\fP and listed in the documentation of this
|
||||
module. Adjust sensitivity by configuring \fI\%scinv\fP\&.
|
||||
.TP
|
||||
.B \fISync keys\fP
|
||||
This action is part of sync but can be called also standalone. It merges all
|
||||
inventory XML files and creates key files in \fBetc/key/station_*\fP if a
|
||||
key file does not yet exist. Existing key files are not touched unless the
|
||||
station is not part of the inventory anymore.
|
||||
.sp
|
||||
As a result, all stations in inventory will have a corresponding key file and
|
||||
each key file will have a corresponding station in inventory.
|
||||
.TP
|
||||
.B \fITest sync\fP
|
||||
The inventory XML files are not used directly with SeisComP. They need to
|
||||
be synchronized with the database first (see \fI\%Station meta data\fP).
|
||||
Synchronization needs to merge all existing XML files and create differences
|
||||
against the existing database tables. While merging conflicts can occur such
|
||||
as duplicate stations with different content (e.g. different description).
|
||||
This action is a dry\-run of the actual synchronisation. It performs merging
|
||||
and creates differences but does not send any update. This actions is useful
|
||||
to test all your existing inventory files before actually modifying the
|
||||
database.
|
||||
.INDENT 7.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.TP
|
||||
.B \fISync\fP
|
||||
Almost identical to \fITest sync\fP but it does send updates to the database and
|
||||
additionally synchronizes key files and resource files.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fISync\fP and \fISync keys\fP will cause a reload of the configuration to refresh the
|
||||
current binding tree (see \fI\%Bindings panel\fP).
|
||||
.SS Modules panel
|
||||
.sp
|
||||
The modules panel allows configuration of all registered modules.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The left/green part shows the list of available modules grouped by defined
|
||||
categories and the right/blue part shows the current active module configuration.
|
||||
The active configuration corresponds to the selected item in the list. See
|
||||
section \fI\%Editing parameters\fP for further information about the content panel.
|
||||
.SS Bindings panel
|
||||
.sp
|
||||
The binding panel configures a station for a module providing station\-specific
|
||||
configuration such as data acquisition or processing. You may configure station
|
||||
bindings or binding profiles. The profiles are typically applied to a set of
|
||||
station. Any change in the profile parameters apply to all stations bound to it.
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Working with \fI\%bindings profiles\fP allows to
|
||||
maintain a single set of binding parameters for one or multiple stations.
|
||||
\fI\%Station bindings\fP are useful if a set of
|
||||
binding parameters are applied only to a single station. Otherwise configure
|
||||
\fI\%binding profiles\fP\&.
|
||||
\fI\%Profiles\fP are therefore preferred over
|
||||
\fI\%station bindings\fP unless only one single
|
||||
station shall be configured.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The binding panel is separated into 3 main areas:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
the station tree (red + orange),
|
||||
.IP \(bu 2
|
||||
the binding content (green),
|
||||
.IP \(bu 2
|
||||
the module tree (blue + magenta).
|
||||
.UNINDENT
|
||||
.sp
|
||||
The station tree (red) shows a tree of all available networks and their
|
||||
stations. Each stations contains nodes of its configured bindings. The lower
|
||||
view (orange) represents the content of the currently selected item in the
|
||||
station tree.
|
||||
.sp
|
||||
The binding content shows the content of a binding and is similar to the
|
||||
module configuration content. See section \fI\%Editing parameters\fP for further
|
||||
information about this panel.
|
||||
.sp
|
||||
The module tree contains all modules which can be used along with bindings.
|
||||
The upper/blue window contains the modules and all available binding profiles
|
||||
for each module and the lower/magenta part shows all binding profiles of the
|
||||
currently selected module. This view is used to add new profiles and delete
|
||||
existing profiles.
|
||||
.SS Profiles
|
||||
.SS Create a profile
|
||||
.sp
|
||||
For creating a binding profile select a module in the module tree (blue area)
|
||||
and right\-click on the module or select the \(dqadd\(dq button in the lower (magenta)
|
||||
panel. Provide a descriptive name. Clicking on the name of the profile opens the
|
||||
profile allowing to adjust the parameters.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Create bindings
|
||||
.sp
|
||||
Assigning a binding profile to one or more stations creates one or more bindings.
|
||||
To assign a binding profile to a single station, a single network including all
|
||||
stations or all networks drag a profile from the right part (blue or magenta)
|
||||
to the target in the left part (red or orange).
|
||||
.sp
|
||||
For assigning to a set of stations/networks, select the target first by mouse
|
||||
click and then drag to profile onto the selection.
|
||||
.sp
|
||||
It is also possible to drag and drop multiple profiles with one action.
|
||||
.SS Station bindings
|
||||
.sp
|
||||
To create an exclusive station binding for a module, it must be opened in the
|
||||
binding view (orange box) by either selecting a station in the station tree
|
||||
(red) or opening/clicking that station in the binding view (orange). The
|
||||
binding view will then contain all currently configured bindings.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Clicking with the right mouse button into the free area will open a menu which
|
||||
allows to add a binding for a module which has not yet been added. Adding
|
||||
a binding will activate it and bring its content into the content panel.
|
||||
.sp
|
||||
To convert an existing profile into a station binding, right click on the
|
||||
binding icon and select Change profile ‣ None\&. The existing
|
||||
profile will be converted into a station binding and activated for editing.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Applying bindings
|
||||
.sp
|
||||
The bindings parameters must be additionally written to the database or as for a
|
||||
\fI\%standalone module\fP converted to the specific module configuration by
|
||||
updating the configuration. You may update configuration for all modules or just
|
||||
the specific one. To this end, change to the
|
||||
\fI\%System panel\fP select the specific module or none and
|
||||
press the button \(dq\fIUpdate configuration\fP\(dq.
|
||||
.sp
|
||||
Alternatively, execute the \fI\%seiscomp\fP script on the command line or all or
|
||||
the specific module:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp update\-config
|
||||
seiscomp update\-config module
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Editing parameters
|
||||
.sp
|
||||
The content panel of a configuration is organized as a tree. Each module/binding
|
||||
name is a toplevel item and all namespace are titles of collapsible sections.
|
||||
Namespaces are separated by dot in the configuration file, e.g.
|
||||
:file:
|
||||
.nf
|
||||
\(ga
|
||||
.fi
|
||||
scautopick.cfg which also reads :file:
|
||||
.nf
|
||||
\(ga
|
||||
.fi
|
||||
global.cfg would end up in a tree
|
||||
like this:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
+ global
|
||||
| |
|
||||
| +\-\- connection
|
||||
| | |
|
||||
| | +\-\- server (global.cfg: connection.server)
|
||||
| | |
|
||||
| | +\-\- username (global.cfg: connection.username)
|
||||
| |
|
||||
| +\-\- database (global.cfg: database)
|
||||
|
|
||||
+ scautopick
|
||||
|
|
||||
+\-\- connection
|
||||
| |
|
||||
| +\-\- server (scautopick.cfg: connection.server)
|
||||
| |
|
||||
| +\-\- username (scautopick.cfg: connection.username)
|
||||
|
|
||||
+\-\- database (scautopick.cfg: database)
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Figure \fI\%Content panel layout\fP describes each item in the content
|
||||
panel.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Content panel layout.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The content of the input widget (except for boolean types which are mapped
|
||||
to a simple checkbox) is the raw content of the configuration file without parsing.
|
||||
While typing a box pops up which contains the parsed and interpreted content as
|
||||
read by an application. It shows the number of parsed list items, possible
|
||||
errors and the content of each list item.
|
||||
.sp
|
||||
Each parameter has a lock icon. If the parameter is locked it is not written
|
||||
to the configuration file. If it is unlocked, it is written to the configuration
|
||||
file and editable. Locking is similar to remove the line with a text
|
||||
editor.
|
||||
.sp
|
||||
The configuration content that is displayed depends on the current mode. In system
|
||||
mode \fBetc/<module>.cfg\fP is configured while in user mode it is
|
||||
\fB~/.seiscomp/<module>.cfg\fP\&.
|
||||
.sp
|
||||
It may happen that a configuration parameter is editable but will not have any
|
||||
affect on the module configuration. This is caused by the different configuration
|
||||
stages. If the system configuration is active but a parameter has set in the
|
||||
user configuration it cannot be overriden in the system configuration. The user
|
||||
configuration is always of higher priority. scconfig will detect such problems
|
||||
and will color the input widget red in such situations.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The value in the edit widget will show the currently configured value in the
|
||||
active configuration file but the tooltip will show the evaluated value, the
|
||||
location of the definition and a warning.
|
||||
.SS Documentation and changelog
|
||||
.sp
|
||||
Access the documentation and the changelog of any installad package from the
|
||||
Docs panel.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
398
share/man/man1/scdb.1
Normal file
398
share/man/man1/scdb.1
Normal file
@ -0,0 +1,398 @@
|
||||
.\" 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 "SCDB" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scdb \- SeisComP Documentation
|
||||
.sp
|
||||
\fBPopulate a SQL database from XML files or messages.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
A major component of the SeisComP system is the database. Almost all
|
||||
applications have only read access to the database, but all the processing
|
||||
results and objects have to be written into the database. This was the task of
|
||||
scdb. In very first versions of SeisComP scdb was the only component that had
|
||||
write access to the database. Its task is to connect to \fI\%scmaster\fP and populate
|
||||
the database with all received notifier messages. Although it worked it
|
||||
introduced race conditions caused by the latency of the database backend since
|
||||
all other clients received the message at the same time. Accessing the database
|
||||
immediately at this point in time did not guarantee that the object was
|
||||
written already.
|
||||
.sp
|
||||
In consequence, the scmaster itself gained write access to the database and
|
||||
forwards messages to all clients after they are written to database.
|
||||
.sp
|
||||
\fI\%scdb\fP by definition does not check existing objects in the database. It only
|
||||
generates INSERT/UPDATE/DELETE statements based on the data used and sends
|
||||
these statements to the database. E.g. if \fI\%scdb\fP receives a message to
|
||||
insert a new object into the database and this object exists already, the
|
||||
database will raise an error because \fI\%scdb\fP hasn\(aqt checked it.
|
||||
.SS Online mode
|
||||
.sp
|
||||
Now scdb can be used to maintain a backup or archive the database that is not
|
||||
part of the real time processing. When running scdb as database write daemon it
|
||||
can inform a client about the database connection to use. A client sends a
|
||||
DatabaseRequest message and scdb sends back a DatabaseResponse message containing
|
||||
the database connection parameters.
|
||||
.sp
|
||||
For that it connects to a messaging server and writes all received messages to a
|
||||
configured database, e.g. a backup database.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
The database connection received from the messaging server during the
|
||||
handshake is reported to clients requesting a database address. To overwrite
|
||||
the read\-only database, just override the application\(aqs database address
|
||||
(with the \(aq\-d\(aq option)
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Offline mode
|
||||
.sp
|
||||
Another important task of \fI\%scdb\fP is to populate the database with any SeisComP
|
||||
data model content. In combination with \fI\%scxmldump\fP it can be used to copy events
|
||||
from one database to another.
|
||||
.sp
|
||||
For that it does not connect to a messaging server but reads data from XML
|
||||
files and writes it to the database. Offline mode will be used if the
|
||||
\(aq\-\-input/\-i\(aq option is provided. Multiple input files can be specified by
|
||||
providing this option multiple times with separate filenames.
|
||||
.sp
|
||||
\fBWARNING:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
When reading XML files the output database address is not passed
|
||||
with \-o but \-d. The application\(aqs database address is used.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Examples
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Connect to a messaging server and write all messages to the output database
|
||||
\fIseiscomp\fP running on the host \fIdb\-server\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdb \-H [server] \-o mysql://sysop:sysop@db\-server/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
As above, but with the read\-only database connection using the user \fIsysop\fP
|
||||
and the output database connection using the user \fIwriter\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdb \-H [server] \-d mysql://sysop:sysop@db\-server/seiscomp \e
|
||||
\-o mysql://writer:12345@db\-server/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Import data from the file \fBdata.xml\fP and write it to the database
|
||||
\fIseiscomp\fP on the host \fIdb\-server\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdb \-i data.xml \-d mysql://sysop:sysop@db\-server/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 4. 3
|
||||
Import data from three files at once:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdb \-i data1.xml \-i data2.xml \-i data3.xml \e
|
||||
\-d mysql://sysop:sysop@db\-server/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scdb.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scdb.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scdb.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scdb inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B connection.requestGroup
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Define the group on scmaster to subscribe for database
|
||||
requests.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B connection.provideGroup
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Define the group on scmaster to send database response
|
||||
messages to.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B output.type
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Define the output database connection type.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B output.parameters
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Define the output database connection parameters.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscdb [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
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-m, \-\-mode arg
|
||||
scdb can either process a XML file and write it to the
|
||||
database or collect messages from scmaster.
|
||||
If connected to scmaster, the mode defines what objects
|
||||
are handled: none (no objects at all), notifier (notifier
|
||||
only) or all (all objects whereas non\-notifier objects
|
||||
are INSERTED into the database).
|
||||
.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 \-\-config\-db arg
|
||||
Load the configuration from the given database or file,
|
||||
format: [\fI\%service://]location\fP .
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-o, \-\-output arg
|
||||
If connected to scmaster, this flag defines the database
|
||||
connection to use for writing. The configured application
|
||||
database connection (as received from scmaster) is reported
|
||||
to clients as part of a database response messages.
|
||||
.UNINDENT
|
||||
.SS Import
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-input arg
|
||||
Define the import XML file to be written to database.
|
||||
Can be provided multiple times to import multiple files.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
503
share/man/man1/scdbstrip.1
Normal file
503
share/man/man1/scdbstrip.1
Normal file
@ -0,0 +1,503 @@
|
||||
.\" 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 "SCDBSTRIP" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scdbstrip \- SeisComP Documentation
|
||||
.sp
|
||||
\fBClean up a database from event and waveform quality parameters.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
\fISeisComP\fP\(aqs \fI\%scmaster\fP is continuously writing to the database. This causes
|
||||
the database to grow and to occupy much space on the harddisc. scdbstrip taggles
|
||||
this problem and removes processed objects from the database older than a
|
||||
configurable time span. The time comparison considers the object time, not the
|
||||
time of their creation.
|
||||
.sp
|
||||
The parameters which scdbstrip removes are
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Event parameters including events, origins, magnitudes, amplitudes, arrivals, picks,
|
||||
focal mechanisms, moment tensors
|
||||
.IP \(bu 2
|
||||
Waveform quality control (QC) parameters.
|
||||
.UNINDENT
|
||||
.sp
|
||||
scdbstrip will remove all events with an origin time and QC parameters older or
|
||||
younger than specified. Default is \(aqolder\(aq. It will also remove all associated
|
||||
objects such as picks, origins, arrivals, amplitudes and so on.
|
||||
.sp
|
||||
scdbstrip does not run as a daemon. To remove old objects continuously scdbstrip
|
||||
should be added to the list of cronjobs running every e.g. 30 minutes. The more
|
||||
often it runs the less objects it has to remove and the faster it will unlock
|
||||
the database again. The timing and the parameters to be removed is controlled
|
||||
by module configuration or command\-line options.
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
For removing specific parameters and not all in a time range, use
|
||||
\fI\%scdispatch\fP along with XML files created by \fI\%scxmldump\fP and
|
||||
\fI\%scqueryqc\fP for event parameters and waveform QC parameters,
|
||||
respectively.
|
||||
.IP \(bu 2
|
||||
For removing data availability parameters use \fI\%scardac\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH KNOWN ISSUES
|
||||
.sp
|
||||
When running scdbstrip for the first time on a large database it can happen
|
||||
that it aborts in case of MYSQL with the following error message:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
[ 3%] Delete origin references of old events...08:48:22 [error]
|
||||
execute(\(dqdelete Object from Object, OriginReference, old_events where
|
||||
Object._oid=OriginReference._oid and
|
||||
OriginReference._parent_oid=old_events._oid\(dq) = 1206 (The total number
|
||||
of locks exceeds the lock table size)
|
||||
|
||||
Exception: ERROR: command \(aqdelete Object from Object, OriginReference,
|
||||
old_events where Object._oid=OriginReference._oid and
|
||||
OriginReference._parent_oid=old_events._oid\(aq failed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
That means your MYSQL server cannot hold enough data required for deletion.
|
||||
There are two solutions to this:
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Increase the memory pool used by MYSQL by changing the configuration. The
|
||||
minimum is 64 MBytes but modern system typically have a larger default:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
innodb_buffer_pool_size = 64M
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The size of the new buffer depends on the size of the database that should
|
||||
be cleaned up. Read also the section \fI\%Database Server Configuration\fP\&. It
|
||||
provides more options for optimizing your database server.
|
||||
.IP 2. 3
|
||||
Run scdbstrip on smaller batches for the first time:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-days 1000
|
||||
$ scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-days 900
|
||||
\&...
|
||||
$ scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-days 100
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
In the examples, database connection parameters correspond to default values.
|
||||
You may thus replace \fB\-d mysql://sysop:sysop@localhost/seiscomp\fP by
|
||||
\fB\-d localhost\fP or \fB\-d mysql://\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Remove event and waveform quality parameters older than 30 days
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-days 30
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Remove event and waveform quality parameters newer than 30 days
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-days 30 \-i
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Only remove waveform QC parameters older than 30 days but no others
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-days 30 \-\-qc\-only
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Remove event and waveform quality parameters before 2000\-01\-01 12:00:00
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-datetime 2000\-01\-01T12:00:00
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Remove event and waveform quality parameters after 2000\-01\-01 12:00:00
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-datetime 2000\-01\-01T12:00:00 \-i
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Remove event and waveform quality parameters between 2000\-01\-01 12:00:00 ~ 2000\-01\-01 14:00:00
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-time\-window 2000\-01\-01T12:00:00~2000\-01\-01T14:00:00
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Remove event and waveform quality parameters before 2000\-01\-01 12:00:00 and after 2000\-01\-01 14:00:00
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdbstrip \-d mysql://sysop:sysop@localhost/seiscomp \-\-time\-window 2000\-01\-01T12:00:00~2000\-01\-01T14:00:00 \-i
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scdbstrip.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scdbstrip.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scdbstrip.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scdbstrip inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B database.cleanup.invertMode
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Invert the selection of the specified time period, that is
|
||||
delete all parameters after the specified time period,
|
||||
not before. When a date range is specified, then delete all
|
||||
parameters before and after the time range, not in between.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B database.cleanup.eventParameters
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Strip all event parameters including events, origins,
|
||||
magnitudes, amplitudes, arrivals, picks, focal mechanisms.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B database.cleanup.qualityControl
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Strip waveform quality control (QC) parameters.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBdatabase.cleanup.keep.*\fP
|
||||
\fIParameters controlling the time to keep objects in the database.\fP
|
||||
\fIThe time comparison considers the object time, not the time of\fP
|
||||
\fItheir creation.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B database.cleanup.keep.days
|
||||
Default: \fB30\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
The number of days to preserve in the database. This
|
||||
value is added to the whole timespan. Hours
|
||||
and minutes are configured separately.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B database.cleanup.keep.hours
|
||||
Default: \fB0\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
The number of hours to preserve in the database. This
|
||||
value is added to the whole timespan. Days
|
||||
and minutes are configured separately.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B database.cleanup.keep.minutes
|
||||
Default: \fB0\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
The number of minutes to preserve in the database. This
|
||||
value is added to the whole timespan. Days
|
||||
and hours are configured separately.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscdbstrip [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 \-\-first\-new
|
||||
Overrides configuration parameter \fI\%firstNew\fP\&.
|
||||
.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 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 Mode
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-check
|
||||
Checks if unreachable objects exist.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-clean\-unused
|
||||
Remove all unreachable objects when in checkmode. Default:
|
||||
off.
|
||||
.UNINDENT
|
||||
.SS Objects
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E, \-\-ep\-only
|
||||
Strip only event parameters. Other parameters, like QC, are
|
||||
are ignored.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-Q, \-\-qc\-only
|
||||
Strip only waveform quality control (QC) parameters. Other
|
||||
parameters, like event parameters, are are ignored.
|
||||
Overrides \(aqeq\-only\(aq.
|
||||
.UNINDENT
|
||||
.SS Timespan
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-days arg
|
||||
Overrides configuration parameter \fI\%database.cleanup.keep.days\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-hours arg
|
||||
Overrides configuration parameter \fI\%database.cleanup.keep.hours\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-minutes arg
|
||||
Overrides configuration parameter \fI\%database.cleanup.keep.minutes\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-datetime arg
|
||||
Replaces the days:hours:minutes timespan definition by an
|
||||
arbitrary absolute timestamp in UTC. Format:
|
||||
%Y\-%m\-%dT%H:%M:%S.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-t, \-\-time\-window arg
|
||||
Delete objects in the specified time window.
|
||||
Replaces the days:hours:minutes timespan definition by an
|
||||
arbitrary absolute time range in UTC. Format:
|
||||
startTime~endTime that is %Y\-%m\-%dT%H:%M:%S~%Y\-%m\-%dT%H:%M:%S
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-invert
|
||||
Overrides configuration parameter \fI\%database.cleanup.invertMode\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-keep\-events
|
||||
IDs of events to keep in the database separated with comma.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
534
share/man/man1/scdispatch.1
Normal file
534
share/man/man1/scdispatch.1
Normal file
@ -0,0 +1,534 @@
|
||||
.\" 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 "SCDISPATCH" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scdispatch \- SeisComP Documentation
|
||||
.sp
|
||||
\fBRead objects (event, origin, etc) from a SCML file and sends the objects
|
||||
to the messaging system.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scdispatch reads an \fI\%SCML\fP file and creates notifier objects for them that
|
||||
are sent to the \fI\%messaging\fP and the corresponding
|
||||
messaging groups (see \fB\-\-routingtable\fP). In contrast to \fI\%scdb\fP
|
||||
which writes SCML files directly into the \fI\%database\fP
|
||||
scdispatch uses the messaging bus. If \fI\%scmaster\fP is configured with the
|
||||
database plugin, messages will end up in the database as well.
|
||||
.SS Modes
|
||||
.sp
|
||||
scdispatch can work in two modes applying different
|
||||
\fI\%operations\fP:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fIWithout database check:\fP One of the \fI\%operations\fP
|
||||
\fIadd\fP, \fIupdate\fP or \fIremove\fP is selected along with the option \fB\-O\fP\&. In
|
||||
that case all objects in the \fI\%SCML\fP are encapsulated in a notifier with
|
||||
that specific operation and sent to the messaging. No check is performed if
|
||||
the object is already in the database or not.
|
||||
.IP \(bu 2
|
||||
\fIWith database check:\fP The option \fB\-O\fP is not given or the
|
||||
option is used along with one of the \fI\%operations\fP
|
||||
\fImerge\fP or \fImerge\-without\-remove\fP\&. scdispatch first tries to load the corresponding
|
||||
objects from the database and calculates differences. It will then create the
|
||||
corresponding notifiers with operations \fIadd\fP, \fIupdate\fP or \fIremove\fP and sends
|
||||
them to the messaging. That mode is quite close to a sync operation with the
|
||||
exception that top level objects (such as origin or event) that are not part
|
||||
of the input SCML are left untouched in the database. It can be used to
|
||||
synchronize event information from one system with another.
|
||||
.UNINDENT
|
||||
.SS Operations
|
||||
.sp
|
||||
Different operations can be chosen along with the option \fB\-O\fP\&.
|
||||
If \fB\-O\fP is not given, \fImerge\fP is assumed by default.
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fIAdd\fP: All objects are sent trying to be added to the database. If they
|
||||
already exist in the database, they will be rejected and not spread through
|
||||
the messaging. Modules connected to the messaging will not receive rejected
|
||||
objects.
|
||||
.IP \(bu 2
|
||||
\fIRemove\fP: All sent objects with all their attributes and child objects are
|
||||
removed from the database. Modules connected to the messaging will not receive
|
||||
any sent object.
|
||||
.IP \(bu 2
|
||||
\fIUpdate\fP: All objects are sent trying to be updated to the database along with
|
||||
all of their child objects and attributes. Sent objects not existing in the
|
||||
database will be ignored and not received by any module connected to the
|
||||
messaging. Child objects and attributes existing in the database but not
|
||||
included in the sent object will be removed as well.
|
||||
.IP \(bu 2
|
||||
\fIMerge\fP (default): Applies \fIAdd\fP and \fIUpdate\fP and requires a database
|
||||
connection.
|
||||
.IP \(bu 2
|
||||
\fIMerge\-without\-remove\fP: Applies \fIAdd\fP and \fIUpdate\fP and requires a database
|
||||
connection. However, no objects are removed from the database.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
All \fISeisComP\fP objects along are listed and described along with their child
|
||||
objects and attributes in the \fI\%API documentation\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Examples
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Send different objects from a \fI\%SCML\fP file for merging (adding or
|
||||
updating). The option \fB\-O\fP can be ommitted because the default
|
||||
behavior is to merge:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-i test.xml \-O merge
|
||||
scdispatch \-i test.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Send all objects by ignoring events. When \fI\%scevent\fP receives origins it
|
||||
will create new events or associate the origins to existing ones. The ignored
|
||||
events may be already existing with different IDs. Hence, event duplication
|
||||
is avoided by ignoring them.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-i test.xml \-e
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Send new objects to be added:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-i test.xml \-O add
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 4. 3
|
||||
Send an update of objects:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-i test.xml \-O update
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 5. 3
|
||||
Send objects to be removed:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-i test.xml \-O remove
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 6. 3
|
||||
Compare new objects with the database content and send the difference (optionally without removing objects):
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-i test.xml \-O merge
|
||||
scdispatch \-i test.xml \-O merge\-without\-remove
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 7. 3
|
||||
Offline mode: all operations can be performed without the messaging system using xml files:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-i test.xml \-O operation \-\-create\-notifier > notifier.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
then:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdb \-i notifier.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 8. 3
|
||||
Subsets of SCML Objects
|
||||
.sp
|
||||
It can be useful to import a subset of QuakeML objects, e.g. Origins from other
|
||||
agencies and then allow \fI\%scevent\fP to associate them to existing
|
||||
events (and possibly prefer them based on the rules in scevent) or create new
|
||||
events for the origins. If the event objects from a SCML file are not required
|
||||
to be sent to the messaging then either they should be removed (e.g. using XSLT)
|
||||
and all the remaining objects in the file added:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-i test.xml \-O add
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
or the \fBevent objects\fP can be left out of the routing table, e.g.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-i test.xml \-O add \e
|
||||
\-\-routingtable Pick:PICK, \e
|
||||
Amplitude:AMPLITUDE, \e
|
||||
Origin:LOCATION,StationMagnitude:MAGNITUDE, \e
|
||||
Magnitude:MAGNITUDE
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
The option \fB\-\-no\-event\fP is a wrapper for removing Event:EVENT from
|
||||
the routing table. With this option no event objects will be sent which may
|
||||
be useful if just the origins with magnitudes, amplitudes, arrivals, picks, etc.
|
||||
shall be integrated, e.g. after XML\-based playbacks.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 9. 3
|
||||
Testing
|
||||
.sp
|
||||
For testing it is useful to watch the results of dispatch with \fI\%scolv\fP or
|
||||
\fI\%scxmldump\fP\&. It is also useful to clean the database and logs to remove
|
||||
objects from persistent storage to allow repeated reloading of a file.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
The following will clear all events from the database and any other
|
||||
other object persistence. Modify the mysql command to suit your db setup.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
mysql \-u root \-\-password=\(aqmy$q1\(aq \-e \(dqDROP DATABASE IF EXISTS seiscomp; \e
|
||||
CREATE DATABASE seiscomp CHARACTER SET utf8 COLLATE utf8_bin; \e
|
||||
GRANT ALL ON seiscomp.* TO \(aqsysop\(aq@\(aqlocalhost\(aq IDENTIFIED BY \(aqsysop\(aq; \e
|
||||
USE seiscomp;source seiscomp/trunk/share/db/mysql.sql;\(dq
|
||||
|
||||
seiscomp start
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scdispatch.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scdispatch.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scdispatch.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scdispatch inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscdispatch [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 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 Dispatch
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-e, \-\-no\-events
|
||||
Do not send any event object which are ignored when reading
|
||||
event parameters.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-input arg
|
||||
File from which the content is dispatched to the messaging.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-O, \-\-operation arg
|
||||
Merge and merge\-without\-remove require a database
|
||||
connection. Both will read the object corresponding to the
|
||||
sent object from the database and calculate the differences.
|
||||
Merge\-without\-remove behaves like merge with the exception
|
||||
that remove operations will be filtered out and no objects
|
||||
in the database will be removed.
|
||||
.sp
|
||||
If add, update or remove is specified, then all objects in
|
||||
XML are sent with the given operation regardless of their
|
||||
existence in the database.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-print\-objects
|
||||
Print names of routable objects.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-print\-routingtable
|
||||
Print routing table.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-routingtable arg
|
||||
Specify routing table as comma separated list of object:group
|
||||
pairs, e.g. \(dqOrigin:LOCATION,Event:EVENT\(dq. When an
|
||||
object should be routed to a group and no table entry for
|
||||
that particular class type is available, all parent objects
|
||||
are checked for valid routing entries and the first found is
|
||||
used. E.g. if only \(dqOrigin:LOCATION\(dq is specified
|
||||
but the input file contains also Arrivals which are child
|
||||
objects of Origin then the routing entry of Origin is used
|
||||
because of the parent\-child relationship between Origin and
|
||||
Arrival.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-test
|
||||
Test mode. Does not send any object.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-create\-notifier
|
||||
Do not send any object. All notifiers will be written to
|
||||
standard output in XML format.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
324
share/man/man1/scdumpcfg.1
Normal file
324
share/man/man1/scdumpcfg.1
Normal file
@ -0,0 +1,324 @@
|
||||
.\" 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 "SCDUMPCFG" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scdumpcfg \- SeisComP Documentation
|
||||
.sp
|
||||
\fBDump bindings or module configurations used by a specific module or global
|
||||
for particular stations.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scdumpcfg reads and prints the
|
||||
\fI\%module or bindings configuration\fP
|
||||
for a specific module or for global. It even prints the global bindings for modules
|
||||
which do not have module bindings, such as \fI\%scmv\fP\&.
|
||||
.sp
|
||||
This command\-line utility is therefore useful for debugging configuration parameters.
|
||||
.sp
|
||||
Instead of printing parameters and values for stations, the option \fB\-\-nlsc\fP
|
||||
allows printing a list of the channel considering bindings. The output may be
|
||||
used, e.g., for
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
filtering inventory by \fI\%invextr\fP
|
||||
.IP \(bu 2
|
||||
miniSEED records by \fI\%scart\fP or \fI\%scmssort\fP
|
||||
.IP \(bu 2
|
||||
event information by \fI\%scevtstreams\fP\&.
|
||||
.UNINDENT
|
||||
.sp
|
||||
Related to \fBscdumpcfg\fP is \fI\%bindings2cfg\fP which dumps the bindings
|
||||
configuration to \fI\%SCML\fP\&.
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Dump the global bindings configuration for all stations which have global bindings:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdumpcfg global \-d mysql://sysop:sysop@localhost/seiscomp \-B
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Dump the bindings configuration for all stations which have bindings to a
|
||||
\fI\%scautopick\fP profile. Additionally use \fI\-G\fP as \fI\%scautopick\fP inherits global
|
||||
bindings:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdumpcfg scautopick \-d localhost \-GB
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Dump the module global module configuration specifcally searching for the map
|
||||
zoom sensitivity and output the result in the format of the \fISeisComP\fP module
|
||||
configuration:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdumpcfg global \-d localhost \-\-cfg \-P map.zoom.sensitivity
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 4. 3
|
||||
Dump the module configuration of scautopick and output in the format of the
|
||||
\fISeisComP\fP module configuration:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdumpcfg scautopick \-d localhost \-\-cfg
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 5. 3
|
||||
Dump global bindings configuration considerd by scmv:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdumpcfg scmv \-d localhost \-BG
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 6. 3
|
||||
Dump the channel codes defined by scautopick binding as a list of NET.STA.LOC.CHA:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdumpcfg scautopick \-d localhost \-B \-\-nslc
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scdumpcfg.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scdumpcfg.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scdumpcfg.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scdumpcfg inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscdumpcfg [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 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 \-\-config\-db arg
|
||||
Load the configuration from the given database or file,
|
||||
format: [\fI\%service://]location\fP .
|
||||
.UNINDENT
|
||||
.SS Dump
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-B, \-\-bindings arg
|
||||
Dump bindings instead of module configuration.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-G, \-\-allow\-global arg
|
||||
Print global bindings if no module binding is available.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-P, \-\-param arg
|
||||
Specify the parameter name(s) to filter for. Use comma
|
||||
separation of multiple parameters.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-cfg
|
||||
Print output in .cfg format. Does not work along with \-B.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-nslc
|
||||
Print the list of channels which have bindings of the given
|
||||
module. Requires to set \-B. Can be used by other modules,
|
||||
e.g., invextr, scart, scmssort, scevtstreams.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
795
share/man/man1/scesv.1
Normal file
795
share/man/man1/scesv.1
Normal file
@ -0,0 +1,795 @@
|
||||
.\" 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 "SCESV" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scesv \- SeisComP Documentation
|
||||
.sp
|
||||
\fBEvent summary view.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scesv is the summary display of the event parameters. It shows the primary information
|
||||
about the current event including location, time, strength, type and processing status.
|
||||
Additional to the current event older events can also be chosen from the eventlist in the
|
||||
events tab.
|
||||
.sp
|
||||
The two tabs of scesv are
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Events tab showing the list of loaded events, compare Fig. \fI\%Eventlist tab\fP
|
||||
.IP \(bu 2
|
||||
Summary tab with the details of the selected event, see Fig. \fI\%Summary tab\fP\&.
|
||||
.UNINDENT
|
||||
.SH EVENTS TAB
|
||||
.sp
|
||||
The Events tab shows the eventlist of the time span defined on the bottom side of
|
||||
the window. A the Events tab is also available for other GUIs, such as \fI\%scolv\fP
|
||||
it can be configured in the global module configuration.
|
||||
The \fI\%description of the Events tab in scolv\fP provides more
|
||||
details.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Eventlist tab
|
||||
Tab1\-2: Summary/Events tab, EventList: list of the last events with summarized information,
|
||||
List options: Show fake events, Reading 1: spinbox to limit timespan of displayed events (in days),
|
||||
Reading 2: spinboxes to limit timespan of displayed events (specified dates), Status: connection status
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
As for \fI\%scolv\fP filtering of the event list and custom information can be
|
||||
added to the event list by configuration. Read the scolv documentation on
|
||||
\fI\%event filtering\fP and \fI\%custom action\fP
|
||||
for the details.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SUMMARY TAB
|
||||
.sp
|
||||
The most recent (default) or the event selected from the event list is shown in
|
||||
the Summary tab, see Fig. \fI\%Summary tab\fP\&.
|
||||
Here the information are highlighted in four sections:
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
section
|
||||
T} T{
|
||||
description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Time
|
||||
T} T{
|
||||
Orign time in UTC and relative to now
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Region
|
||||
T} T{
|
||||
A map of the region and location with the event and stations
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Magnitude
|
||||
T} T{
|
||||
Different magnitude types, the values and counts
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Hypocenter
|
||||
T} T{
|
||||
Origin information with location, depth, azimuthal gap etc.
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Summary tab
|
||||
Tab1\-2: Summary/Events tab, Origin Time: origin time in UTC and relative to now, Map: map with region
|
||||
and location and stations, Magnitude: different magnitude types with values and counts,
|
||||
Origin Info: hypocenter information with position, phase count and azimuthal gap,
|
||||
Event: earthquake location, Station: station with ray\-path, Details: \(dqShow Details\(dq button to open
|
||||
detailed information in \fI\%scolv\fP, Event Type: event type combo box to set event type, Status: connection status
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH HOTKEYS
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Hotkey
|
||||
T} T{
|
||||
Description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF1\fP
|
||||
T} T{
|
||||
Open \fISeisComP\fP documentation
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Shift + \fBF1\fP
|
||||
T} T{
|
||||
Open scesv documentation
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF2\fP
|
||||
T} T{
|
||||
Setup connection dialog
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF6\fP
|
||||
T} T{
|
||||
Show propagation of P and S wave
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF7\fP
|
||||
T} T{
|
||||
Show focal mechanism by beach ball
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Shift + \fBF7\fP
|
||||
T} T{
|
||||
Show focal mechanism by beach ball
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF8\fP
|
||||
T} T{
|
||||
Toggle auto update
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF9\fP
|
||||
T} T{
|
||||
Show raypaths and associated stations
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF10\fP
|
||||
T} T{
|
||||
Toggle tabs
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF11\fP
|
||||
T} T{
|
||||
Toggle fullscreen
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Mouse wheel
|
||||
T} T{
|
||||
Zoom map in/out
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Double click
|
||||
T} T{
|
||||
Center map
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scesv.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scesv.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scesv.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scesv inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B loadEventDB
|
||||
Default: \fB1\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdays\fP
|
||||
.sp
|
||||
Number of days to preload if scesv is started.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B showLastAutomaticSolution
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled, the last automatic solution is displayed next to the
|
||||
current solution in the summary panel. If the last automatic
|
||||
solution differs from the current solution it is displayed
|
||||
in red. If both solutions match it is displayed in gray.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B showOnlyMostRecentEvent
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled, only the most recent event is shown even if an update of
|
||||
an older event is being received.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B recenterMap
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled, the map is centered around the most recent event event.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B enableFixAutomaticSolutions
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled, an additional button is displayed which allows to
|
||||
switch back the latest automatic solution. This button triggers
|
||||
an command for scevent to prioritize automatic solutions until
|
||||
the next manual solution is available.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B visibleMagnitudes
|
||||
Default: \fBM,MLv,mb,mB,Mw(mB)\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
A list of magnitude types to be displayed.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B button0
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Label of button0 which triggers script0.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B button1
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Label of button1 which triggers script1.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ignoreOtherEvents
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If the event type is either \(dqother\(dq or
|
||||
\(dqnot existing\(dq and this flag is true then the
|
||||
event will not be shown.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.script0
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Path to a script if button0 is clicked.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.script1
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Path to a script if button1 is clicked.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.script0.exportMap
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled, the current map is exported to file.
|
||||
The filename is appened to the parameter list of script0.
|
||||
The script has to take ownership of the file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.script0.oldStyle
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled, the parameter list of script0 is event ID,
|
||||
arrival count, magnitude, description.
|
||||
.sp
|
||||
If disabled, the parameter list of script0 is event ID,
|
||||
preferredOriginID, preferredMagnitudeID,
|
||||
preferredFocalMechanismID.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.script1.exportMap
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled, the current map is exported to file.
|
||||
The filename is appened to the parameter list of script1.
|
||||
The script has to take ownership of the file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.script1.oldStyle
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled, the parameter list of script1 is event ID,
|
||||
arrivalCount, magnitude, description.
|
||||
.sp
|
||||
If disabled, the parameter list of script1 is event ID,
|
||||
preferredOriginID, preferredMagnitudeID,
|
||||
preferredFocalMechanismID.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B summary.borders
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Draw borders in the summary panel.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBdisplay.*\fP
|
||||
\fIAdjust content or display custom information in the Summary tab.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.lonmin
|
||||
Default: \fB\-180\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
Minimum longitude of initially displayed map region.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.lonmax
|
||||
Default: \fB180\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
Maximum longitude of initially displayed map region.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.latmin
|
||||
Default: \fB\-90\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
Minimum latitude of initially displayed map region.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.latmax
|
||||
Default: \fB90\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
Maximum latitude of initially displayed map region.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBdisplay.event.*\fP
|
||||
\fIEvent information\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.event.comment.id
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
ID of the event comment to be considered.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.event.comment.default
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Value to be shown in case no valid event comment is
|
||||
found.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.event.comment.label
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Label of the value to be shown.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBdisplay.origin.*\fP
|
||||
\fIOrigin information\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBdisplay.origin.comment.*\fP
|
||||
\fIDisplay origin comments.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.origin.comment.id
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
ID of the origin comment to be considered.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.origin.comment.default
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Value to be shown in case no valid origin comment is
|
||||
found.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.origin.comment.label
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Label of the value to be shown.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBpoi.*\fP
|
||||
\fIDisplay information related to a point of interest (POI)\fP
|
||||
\fIread from the cities XML file.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B poi.maxDist
|
||||
Default: \fB20\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
Maximum distance in degrees of a POI to be taken into account.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B poi.minPopulation
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
The minimum population of a POI to be taken into account.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B poi.message
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Message conversion string that converts a POI into the text
|
||||
displayed under the region label. There are different
|
||||
placeholders that can be used: @dist@, @dir@, @poi@ and @region@.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscesv [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 Cities
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-city\-xml arg
|
||||
The path to the cities XML file. This overrides the default
|
||||
paths. Compare with the global parameter \(dqcitiesXML\(dq.
|
||||
.UNINDENT
|
||||
.SS User interface
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-F, \-\-full\-screen
|
||||
Start the application filling the entire screen.
|
||||
This only works with GUI applications.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-N, \-\-non\-interactive
|
||||
Use non\-interactive presentation mode. This only works with
|
||||
GUI applications.
|
||||
.UNINDENT
|
||||
.SS Options
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-script0 arg
|
||||
Path to the script called when configurable
|
||||
button0 is pressed; EventID, arrival count, magnitude and
|
||||
the additional location information string are passed as
|
||||
parameters $1, $2, $3 and $4, respectively.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-script1 arg
|
||||
Path to the script called when configurable
|
||||
button1 is pressed; EventID, arrival count, magnitude and
|
||||
the additional location information string are passed as
|
||||
parameters $1, $2, $3 and $4, respectively.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-load\-event\-db arg
|
||||
Number of days to load from database.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
1323
share/man/man1/scevent.1
Normal file
1323
share/man/man1/scevent.1
Normal file
File diff suppressed because it is too large
Load Diff
283
share/man/man1/scevtlog.1
Normal file
283
share/man/man1/scevtlog.1
Normal file
@ -0,0 +1,283 @@
|
||||
.\" 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 "SCEVTLOG" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scevtlog \- SeisComP Documentation
|
||||
.sp
|
||||
\fBEvent log preserving the history of updates.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
Running SeisComP causes many database accesses for writing. Anytime a new
|
||||
event has been created a new row will be inserted in the database table.
|
||||
When the same event is updated the row in the database table is going to be
|
||||
changed as well. The information about the history of the event is lost because
|
||||
the database contains only the current event attributes. scevtlog saves the
|
||||
event history into files. While scevtlog is running it keeps the track of all
|
||||
event updates and stores this information in a directory that can be analyzed
|
||||
at anytime. The stored information is written as plain text in an easily
|
||||
readable format. Additionally scevtlog maintains an event summary file for an
|
||||
overview of the event history.
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scevtlog.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scevtlog.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scevtlog.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scevtlog inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B directory
|
||||
Default: \fB@LOGDIR@/events\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Specify the output directory. Within this directory the logging
|
||||
directory structure and the event files are stored.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B format
|
||||
Default: \fBxml\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Specify output event format (default is autoloc3). For completeness
|
||||
it is recommended to switch to xml as storage format. The autoloc3
|
||||
format can be easily reconstructed with scbulletin but not the other
|
||||
way around.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B gzip
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If format is xml then all XML files will be compressed with gzip
|
||||
and stored with file extension \(dq.xml.gz\(dq. They are also
|
||||
valid gzip files and can be used as input to e.g. zgrep.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscevtlog [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 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 Storage
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-directory arg
|
||||
Overrides configuration parameter \fI\%directory\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-format arg
|
||||
Overrides configuration parameter \fI\%format\fP\&.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
269
share/man/man1/scevtls.1
Normal file
269
share/man/man1/scevtls.1
Normal file
@ -0,0 +1,269 @@
|
||||
.\" 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 "SCEVTLS" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scevtls \- SeisComP Documentation
|
||||
.sp
|
||||
\fBList event IDs from database.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
\fIscevtls\fP lists the event IDs of all events available in a database or
|
||||
\fI\%SCML\fP file within a given time span. The list may be filtered by
|
||||
event type. The IDs are printed to stdout.
|
||||
.sp
|
||||
Similarly, use \fI\%scorgls\fP for listing all origin IDs. In extension to
|
||||
\fIscevtls\fP and \fI\%scorgls\fP, \fI\%scquery\fP can search for parameters based on
|
||||
complex custom queries.
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Print all event IDs for the complete year 2012:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtls \-d mysql://sysop:sysop@localhost/seiscomp \e
|
||||
\-\-begin \(dq2012\-01\-01 00:00:00\(dq \e
|
||||
\-\-end \(dq2013\-01\-01 00:00:00\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Print all event IDs with event type \fIquarry blast\fP:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtls \-d mysql://sysop:sysop@localhost/seiscomp \e
|
||||
\-\-event\-type \(dqquarry blast\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Print the IDs of all events provided with the XML file:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtls \-i events.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Print all event IDs along with the ID of the preferred origin:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtls \-d localhost \-p
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scevtls.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scevtls.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scevtls.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scevtls inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscevtls [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
|
||||
.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 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 Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-input arg
|
||||
Name of input XML file. Read from stdin if \(aq\-\(aq is given.
|
||||
Deactivates reading events from database.
|
||||
.UNINDENT
|
||||
.SS Events
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-begin time
|
||||
Specify the lower bound of the time interval. Format:
|
||||
2012\-01\-01T00:00:00.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-end time
|
||||
Specify the upper bound of the time interval. Format:
|
||||
2012\-01\-01T00:00:00.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-hours arg
|
||||
Start searching given hours before now. If set, \-\-begin and
|
||||
\-\-end are ignored.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-modified\-after time
|
||||
Print IDs of events modified after the specified time.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-event\-type arg
|
||||
The event type for filtering events.
|
||||
Use quotes for types with more than one word.
|
||||
Example: \(dqmining explosion\(dq.
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-D, \-\-delimiter string
|
||||
Specify the delimiter of the resulting event IDs.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-p, \-\-preferred\-origin
|
||||
Print the ID of the preferred origin along with the event
|
||||
ID.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
387
share/man/man1/scevtstreams.1
Normal file
387
share/man/man1/scevtstreams.1
Normal file
@ -0,0 +1,387 @@
|
||||
.\" 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 "SCEVTSTREAMS" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scevtstreams \- SeisComP Documentation
|
||||
.sp
|
||||
\fBExtract stream information with time windows from picks of an event.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scevtstreams reads all picks of an event and determines the time window between
|
||||
the first pick and the last pick. In addition a symmetric or an asymmetric time
|
||||
margin is added to this
|
||||
time window. It writes the streams that are picked including the determined
|
||||
time window for the event to stdout. This tool gives appropriate input
|
||||
information for \fI\%scart\fP, \fI\%fdsnws\fP and \fIcapstool\fP [\fI\%27\fP] for
|
||||
\fICAPS\fP [\fI\%3\fP] server (Common Acquisition Protocol Server by gempa GmbH) to dump
|
||||
waveforms from archives based on event data.
|
||||
.SH OUTPUT FORMAT
|
||||
.sp
|
||||
The generated list contains start and end time as well as stream information.
|
||||
.sp
|
||||
Generic:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
starttime;endtime;stream
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Example:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
2019\-07\-17 02:00:00;2019\-07\-17 02:10:00;GR.CLL..BHZ
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Get the time windows for an event in the database:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtstreams \-E gfz2012abcd \-d mysql://sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Get the asymmetric time windows for an event in an XML file. The time window
|
||||
starts 120 s before the first pick and ends 500 s after the last pick:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtstreams \-E gfz2012abcd \-i event.xml \-m 120,500
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Create a playback of an event with a time window of 5 minutes data and
|
||||
sort the records by end time:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtstreams \-E gfz2012abcd \-d mysql://sysop:sysop@localhost/seiscomp \-m 300 |\e
|
||||
scart \-dsvE \-\-list \- ~/seiscomp/acquisition/archive > gfz2012abcd\-sorted.mseed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 4. 3
|
||||
Download waveforms from Arclink and import into local archive. Include
|
||||
all stations from the contributing networks:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtstreams \-E gfz2012abcd \-d mysql://sysop:sysop@localhost/seiscomp \-m 300 \-R \-\-all\-stations |\e
|
||||
scart \-\-list \- ./my\-archive
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 5. 3
|
||||
Create lists compatible with \fI\%fdsnws\fP or \fI\%caps\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtstreams \-E gfz2012abcd \-i event.xml \-m 120,500 \-\-fdsnws
|
||||
scevtstreams \-E gfz2012abcd \-i event.xml \-m 120,500 \-\-caps
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scevtstreams.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scevtstreams.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scevtstreams.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scevtstreams inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscevtstreams [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 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 Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-input arg
|
||||
Input XML file name. Reads event from the XML file instead of
|
||||
database. Use \(aq\-\(aq to read from stdin.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-format arg
|
||||
Input format to use (xml [default], zxml (zipped xml),
|
||||
binary). Only relevant with \-i.
|
||||
.UNINDENT
|
||||
.SS Dump
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E, \-\-event arg
|
||||
The ID of the event to consider.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-net\-sta arg
|
||||
Filter read picks by network code or network and station
|
||||
code. Format: NET or NET.STA
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-nslc arg
|
||||
Stream list file to be used for filtering read picks by
|
||||
stream code. \(aq\-\-net\-sta\(aq will be ignored. One line per
|
||||
stream. Line format: NET.STA.LOC.CHA.
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-m, \-\-margin arg
|
||||
Time margin around the picked time window, default is 300.
|
||||
Added before the first and after the last pick,
|
||||
respectively. Use 2 comma\-separted values (before,after)
|
||||
for asymmetric margins. Example: 120,300.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-S, \-\-streams arg
|
||||
Comma separated list of streams per station to add.
|
||||
Example: BH,SH,HH.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-C, \-\-all\-components arg
|
||||
Specify whether to use all components (1) or just the
|
||||
picked ones (0). Default: 1.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-L, \-\-all\-locations arg
|
||||
Specify whether to use all location codes (1) or just
|
||||
the picked ones (0). Default: 1.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-all\-stations
|
||||
Dump all stations from the same network. If unused, just
|
||||
stations with picks are dumped.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-all\-networks
|
||||
Dump all networks. If unused, just networks with picks are
|
||||
dumped. This option implies \-\-all\-stations, \-\-all\-locations,
|
||||
\-\-all\-streams, \-\-all\-components and will only provide the
|
||||
time window.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-R, \-\-resolve\-wildcards flag
|
||||
If all components are used, use inventory to resolve stream
|
||||
components instead of using \(aq?\(aq (important when Arclink
|
||||
should be used).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-caps
|
||||
Dump in capstool format (Common Acquisition Protocol Server
|
||||
by gempa GmbH).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-fdsnws flag
|
||||
Dump in FDSN dataselect webservice POST format.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
761
share/man/man1/scheli.1
Normal file
761
share/man/man1/scheli.1
Normal file
@ -0,0 +1,761 @@
|
||||
.\" 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 "SCHELI" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scheli \- SeisComP Documentation
|
||||
.sp
|
||||
\fBReal\-time helicorder view for one stream.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
\fBscheli\fP visualizes waveforms from a single stream or multiple stations
|
||||
mimicking a drum\-recorder plot (see \fI\%scheli in GUI mode\fP):
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBscheli\fP plots one configurable trace in helicorder style in the
|
||||
\fI\%GUI\fP (\fI\%GUI mode\fP).
|
||||
.IP \(bu 2
|
||||
Configurable GUI: trace colors, visualized time spans, number of rows, data filtering,
|
||||
amplitude ranges and much more.
|
||||
.IP \(bu 2
|
||||
Automatic image capturing: Capture helicorder images at configurable time intervals
|
||||
of one trace in \fI\%GUI mode\fP or a set of multiple channels in
|
||||
\fI\%capture mode\fP\&.
|
||||
The images can be used, e.g. for showing data images on web sites.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
scheli in GUI mode.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
\fBGUI mode \- Simple helicorder window:\fP
|
||||
.INDENT 3.0
|
||||
.IP \(bu 2
|
||||
Learn about the plenty command\-line options for \fBscheli\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scheli \-h
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Start \fBscheli\fP with the configured values and informative debug output:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scheli \-\-debug
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Let \fBscheli\fP show data from the CX station PB01 for the previous 5 hours
|
||||
overriding configuration by command\-line paramaters:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scheli \-\-stream CX.PB01..HHZ \-\-rows 10
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Define the data request window by end time and duration; scale traces to the
|
||||
maximum amplitude per row:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scheli \-\-stream IU.TSUM.00.BHZ \-\-end\-time \(dq2021\-04\-22 14:00:00\(dq \-\-time\-span 600 \-\-amp\-scaling row
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.IP 2. 3
|
||||
\fBCapture mode \- Image capturing:\fP
|
||||
.sp
|
||||
Capture the helicorder plot for 3 stations in intervals of 10 seconds.
|
||||
The data is retrieved using seedlink and the plots are stored as PNG images.
|
||||
The image files are named according to network, station, stream and location codes
|
||||
of the requested stations. Command\-line parameters override the module configuration.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scheli capture \-\-stream CX.PB01..HHZ \-\-stream CX.PB02..HHZ \-\-stream CX.PB04..HHZ \-\-interval 10 \-o \(dq/tmp/heli_%N_%S_%L_%C.png\(dq \-H localhost \-I slink://localhost
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The output file names will be generated based on network code (%N), station code (%S),
|
||||
location code (%L) and stream code (%C):
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
/tmp/CX.PB01..HHZ.png
|
||||
/tmp/CX.PB02..HHZ.png
|
||||
/tmp/CX.PB04..HHZ.png
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SETUP
|
||||
.sp
|
||||
Specifc \fBscheli\fP parameters are adjusted in the \fI\%module configuration\fP\&.
|
||||
Colors of traces etc. can be adjusted by setting the \fIscheme\fP parameters in
|
||||
the global configuration of scheli. For alternating colors between the traces
|
||||
set the parameters scheme.colors.records.foreground and
|
||||
scheme.colors.records.alternateForeground in \fBscheli.cfg\fP:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
# The general color of records/traces.
|
||||
scheme.colors.records.foreground = 4286F4
|
||||
|
||||
# A general trace color of the alternate trace (eg scheli).
|
||||
scheme.colors.records.alternateForeground = B72D0E
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scheli.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scheli.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scheli.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scheli inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.streams
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
List of stream codes to be plotted (net.sta.loc.cha).
|
||||
If not in capture mode only the first stream is shown.
|
||||
When using a list, the first entry is considered.
|
||||
Use commas for separating streams.
|
||||
.sp
|
||||
Example: GR.MOX..BHZ
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.filter
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Filter to be applied on the data.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.numberOfRows
|
||||
Default: \fB48\fP
|
||||
.sp
|
||||
Type: \fIinteger\fP
|
||||
.sp
|
||||
Filter to be applied on the data.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.rowTimeSpan
|
||||
Default: \fB1800\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Length of data per trace.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.timeFormat
|
||||
Default: \fB%F\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The time format used to print the start and end time of the
|
||||
whole plot (upper right corner). The format specification is
|
||||
the one used in the strftime function (man strftime).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.recordTime
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Set current time to last data sample.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.lineWidth
|
||||
Default: \fB1\fP
|
||||
.sp
|
||||
Type: \fIinteger\fP
|
||||
.sp
|
||||
Unit: \fIpx\fP
|
||||
.sp
|
||||
Line width of traces.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.colors
|
||||
Default: \fBFF0000, 0000FF\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
A list of alternating row colors cycled through for painting
|
||||
traces.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.antialiasing
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Use anti aliasing to plot the traces. The default uses the
|
||||
settings from scheme.records.antiAliasing
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.stream.description
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Add stream description to traces.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBheli.amplitudeRange.*\fP
|
||||
\fIGain\-corrected amplitudes given in units of the sensor.\fP
|
||||
\fIFor example: m/s.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.amplitudeRange.scaling
|
||||
Default: \fBminmax\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Define the method to scale traces within rows. Possible
|
||||
values are:
|
||||
.sp
|
||||
minmax: Scale all rows to configured minimum and maximum
|
||||
amplitudes configured by amplitudeRange.min and
|
||||
amplitudeRange.max
|
||||
.sp
|
||||
row: Scale each row to the maximum within this row.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.amplitudeRange.min
|
||||
Default: \fB\-0.00001\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIunit of input data\fP
|
||||
.sp
|
||||
Minimum amplitude to show in trace. Requires
|
||||
amplitudeRange.scale = \(dqminmax\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.amplitudeRange.max
|
||||
Default: \fB0.00001\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIunit of input data\fP
|
||||
.sp
|
||||
Minimum amplitude to show in trace. Requires
|
||||
amplitudeRange.scale = \(dqminmax\(dq.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBheli.dump.*\fP
|
||||
\fIControl dumping of PNG images.\fP
|
||||
\fIExecute \(dqscheli capture\(dq for image generation in\fP
|
||||
\fIthe background without the graphics.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.dump.interval
|
||||
Default: \fB\-1\fP
|
||||
.sp
|
||||
Type: \fIinteger\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Image creation interval. Negative values disable image
|
||||
dumping.
|
||||
If enabled, images are generated at the configured
|
||||
interval.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.dump.outputFile
|
||||
Default: \fB/tmp/heli_%N_%S_%L_%C.png\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Name of output file.
|
||||
The filename can contain placeholders
|
||||
that are replaced by the corresponding streamID parts:
|
||||
.sp
|
||||
%N : network code
|
||||
.sp
|
||||
%S : station code
|
||||
.sp
|
||||
%L : location code
|
||||
.sp
|
||||
%C : channel code
|
||||
.sp
|
||||
Placeholders are important if more than one stream
|
||||
is given and capture mode is active.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.dump.dpi
|
||||
Default: \fB300\fP
|
||||
.sp
|
||||
Type: \fIinteger\fP
|
||||
.sp
|
||||
Unit: \fIdpi\fP
|
||||
.sp
|
||||
Image resolution.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.dump.xres
|
||||
Default: \fB1024\fP
|
||||
.sp
|
||||
Type: \fIinteger\fP
|
||||
.sp
|
||||
Unit: \fIpx\fP
|
||||
.sp
|
||||
Number of pixels horizontally.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B heli.dump.yres
|
||||
Default: \fB768\fP
|
||||
.sp
|
||||
Type: \fIinteger\fP
|
||||
.sp
|
||||
Unit: \fIpx\fP
|
||||
.sp
|
||||
Number of pixels vertically.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.postprocessing
|
||||
Type: \fIpath\fP
|
||||
.sp
|
||||
Define the path to a script that is called whenever an image
|
||||
has been captured and written to disc. The only parameter is
|
||||
the path to the generated image.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscheli [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
|
||||
.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 \-\-config\-db arg
|
||||
Load the configuration from the given database or file,
|
||||
format: [\fI\%service://]location\fP .
|
||||
.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 filling the entire screen.
|
||||
This only works with GUI applications.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-N, \-\-non\-interactive
|
||||
Use non\-interactive presentation mode. This only works with
|
||||
GUI applications.
|
||||
.UNINDENT
|
||||
.SS Mode
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-offline
|
||||
Do not connect to a messaging server and do not use the
|
||||
database.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-end\-time arg
|
||||
Set the acquisition end time, e.g. \(aq2017\-09\-08 13:30:00\(aq,
|
||||
default: \(aqgmt\(aq
|
||||
.UNINDENT
|
||||
.SS Data
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-stream arg
|
||||
The record stream that should be displayed. Can be used
|
||||
multiple times for multiple streams.
|
||||
.sp
|
||||
Example: GR.MOX..BHZ (net.sta.loc.cha)
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-filter arg
|
||||
The filter to apply
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-gain arg
|
||||
Gain applied to the data before plotting
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-amp\-scaling arg
|
||||
Lower bound of amplitude range per row. Possible values:
|
||||
.sp
|
||||
minmax: Scale all rows to configured minimum and maximum
|
||||
amplitudes.
|
||||
.sp
|
||||
row: Scale each row to the maximum within this row.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-amp\-range\-min arg
|
||||
Lower bound of amplitude range per row
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-amp\-range\-max arg
|
||||
Upper bound of amplitude range per row
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-amp\-range arg
|
||||
Arround zero bound of amplitude range per row
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-record\-time arg
|
||||
Do the last row always contain the last record received
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-desc arg
|
||||
Enable/disable the display of a station description
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-rows arg
|
||||
Configure the number of rows to display
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-time\-span arg
|
||||
Configure the time\-span (in secs) per row. Unit: seconds.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-aa arg
|
||||
Set antialiasing for rendering the traces
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-xres arg
|
||||
Output x resolution when generating images. Unit: dpi.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-yres arg
|
||||
Output y resolution when generating images. Unit: dpi.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-dpi arg
|
||||
Output dpi when generating postscript. Unit:dpi.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o arg
|
||||
Output filename. Placeholders are %N,%S,%L,%C for network
|
||||
code, station code, location code, channel code.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-interval arg
|
||||
Snapshot interval (less than 0 disables timed snapshots).
|
||||
Unit: seconds.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
506
share/man/man1/scimex.1
Normal file
506
share/man/man1/scimex.1
Normal file
@ -0,0 +1,506 @@
|
||||
.\" 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 "SCIMEX" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scimex \- SeisComP Documentation
|
||||
.sp
|
||||
\fBSeisComP event exchange between two systems.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scimex manages the \fISeisComP\fP object exchange between two or more different SeisComP systems in
|
||||
real time. scimex may import or export the data to one or several systems. In
|
||||
contrary to \fI\%scimport\fP the exchange of the \fISeisComP\fP objects is event based.
|
||||
This means no messages will be exchanged until the exporting system has produced
|
||||
an event.
|
||||
.sp
|
||||
By default all objects (picks, amplitudes, origins, arrivals, station
|
||||
magnitudes, magnitudes, magnitude references) are transferred to the other
|
||||
system. The user can define filters at both the sender and the receiver, to
|
||||
limit the events for which objects are transferred. Possible filter parameters
|
||||
are the event location, magnitude, arrival count and agency. scimex supports
|
||||
two modi: \fIimport\fP and \fIexport\fP\&. In export mode scimex collects all objects
|
||||
relevant for an event (e.g. picks, amplitudes, origins, magnitudes) from
|
||||
scmaster\(aqs message groups at the source and checks if the filter criteria
|
||||
match. Once the criteria are fulfilled, the whole package of objects is send
|
||||
to the scmaster IMPORT group of the receiving system.
|
||||
.sp
|
||||
At the receiving \fISeisComP\fP system an instance of scimex runs in import mode. It
|
||||
fetches the whole event information from its own IMPORT group, checks the local
|
||||
filter criteria of the system and sends the collected objects to the different
|
||||
message groups, e.g. Pick, Amplitude, Magnitude, Location. In export mode
|
||||
several recipients can be defined and for each recipient individual filters
|
||||
can be set. To run several instances of scimex on one system, aliases have to
|
||||
be defined, e.g. for import:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp alias create scimex_import scimex
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
and for export:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp alias create scimex_export scimex
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Then the configuration can be split into scimex_import.cfg and
|
||||
scimex_export.cfg.
|
||||
.SH EXAMPLES
|
||||
.sp
|
||||
For a push\-type configuration, in which the exporting server must be able to
|
||||
connect to the messaging server on the receiving host. On the receiving host:
|
||||
.sp
|
||||
scimex_import.cfg
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
connection.username = scimexIm
|
||||
connection.server = localhost
|
||||
|
||||
mode = IMPORT
|
||||
|
||||
cleanupinterval = 86400
|
||||
|
||||
importHosts = import1
|
||||
|
||||
criteria.world.longitude = \-180:180
|
||||
criteria.world.latitude = \-90:90
|
||||
criteria.world.magnitude = 1:9
|
||||
criteria.world.agencyID = \(dq\(dq
|
||||
criteria.world.arrivalcount = 15
|
||||
|
||||
hosts.import1.address = localhost
|
||||
# The criterion \(dqworld\(dq has been defined above
|
||||
hosts.import1.criteria = world
|
||||
# optional and true per default
|
||||
hosts.import1.filter = false
|
||||
# optional and true per default
|
||||
hosts.import1.useDefinedRoutingTable = true
|
||||
hosts.import1.routingtable = Pick:IMPORT,StationAmplitude:IMPORT,
|
||||
Origin:LOCATION,Arrival:LOCATION,
|
||||
StationMagnitude:MAGNITUDE,
|
||||
Magnitude:MAGNITUDE,
|
||||
StationMagnitudeContribution:MAGNITUDE,
|
||||
OriginReference:EVENT,Event:EVENT
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
In this example, Pick and StationAmplitude objects are sent to the
|
||||
receiving system\(aqs IMPORT group to avoid interfering with the receiving system\(aqs
|
||||
picking.
|
||||
.sp
|
||||
On the sending system, only those events with a high enough magnitude
|
||||
and enough arrivals, and with the AgencyID \(dqGFZ\(dq are exported:
|
||||
scimex_export.cfg
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
connection.username=\(dqscimexEx\(dq
|
||||
connection.server = localhost
|
||||
|
||||
mode = EXPORT
|
||||
|
||||
cleanupinterval = 7200
|
||||
exportHosts = exp1, exp2
|
||||
|
||||
# Match everything with magnitude above or equal 5
|
||||
# and with more than 25 phases which comes from
|
||||
# agency GFZ.
|
||||
criteria.globalM5.latitude = \-90:90
|
||||
criteria.globalM5.longitude = \-180:180
|
||||
criteria.globalM5.magnitude = 5:10
|
||||
criteria.globalM5.arrivalcount = 25
|
||||
criteria.globalM5.agencyID = GFZ
|
||||
|
||||
# Export to a system which still runs a very old version. The
|
||||
# messages need to be converted.
|
||||
hosts.exp1.address = 192.168.0.3
|
||||
hosts.exp1.criteria = globalM5
|
||||
hosts.exp1.conversion = imexscdm0.51
|
||||
|
||||
hosts.exp2.address = 192.168.0.4
|
||||
hosts.exp2.criteria = globalM5
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scimex.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scimex.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scimex.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scimex inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B mode
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Mode of operation. Options are IMPORT or EXPORT.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B cleanupinterval
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Cache lifetime for objects.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B subscriptions
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Only used in export mode. A list of message groups to subscribe.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B conversion
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Used only in import mode. It defines the source format of the
|
||||
messages that need to be converted. Currently the import of
|
||||
SeisComP datamodel version 0.51 (imexscdm0.51)
|
||||
is supported which was used in release Barcelona (2008).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B exportHosts
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
A list of hosts profiles to be considered for exporting.
|
||||
These are used in hosts.$name directives
|
||||
(see below) to define addresses, filter criteria, etc.
|
||||
applicable to each recipient.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B importHosts
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
A list of hosts profiles to be considered for importing.
|
||||
These are used with hosts.$name directives similarly to
|
||||
exportHosts.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBcriteria.$name.*\fP
|
||||
\fIA definition of an event filter.\fP
|
||||
$name is a placeholder for the name to be used.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B criteria.$name.latitude
|
||||
Type: \fItuple:double\fP
|
||||
.sp
|
||||
Pair of doubles that defines the latitude range.
|
||||
Example: \-90:90.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B criteria.$name.longitude
|
||||
Type: \fItuple:double\fP
|
||||
.sp
|
||||
Pair of doubles that defines the longitude range.
|
||||
Example: \-180:180.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B criteria.$name.magnitude
|
||||
Type: \fItuple:double\fP
|
||||
.sp
|
||||
Pair of doubles that defines the magnitude range.
|
||||
Example: 3:10.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B criteria.$name.arrivalcount
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Number of minimum arrivals.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B criteria.$name.agencyID
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
White list of AgencyIDs (the agency identifier which
|
||||
appears in the objects sent over the export\-import link).
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBhosts.$name.*\fP
|
||||
\fIA sink definition used for either import or export.\fP
|
||||
$name is a placeholder for the name to be used.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B hosts.$name.address
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Address of a sink, as a host name with an optional port
|
||||
number e.g. \(aqaddress = 192.168.1.1\(aq or
|
||||
\(aqaddress = somewhere.com:4803\(aq
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B hosts.$name.criteria
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Defining filter criteria name for sink, e.g. criteria =
|
||||
world\-xxl. The criteria must be defined in the criteria.
|
||||
* configuration lines.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B hosts.$name.filter
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enable/disable filtering based on defined criteria.
|
||||
If set to false, all events will pass, even if one
|
||||
or more criteria are defined.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B hosts.$name.conversion
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Optional target format for export.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B hosts.$name.useDefinedRoutingTable
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enable/disable defined routing tables.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B hosts.$name.routingTable
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Defining routing tables in the meaning of mapping
|
||||
objects to message groups. Example: Pick:NULL,
|
||||
StationAmplitude:NULL, Origin:LOCATION,
|
||||
StationMagnitude: MAGNITUDE, NetworkMagnitude:MAGNITUDE,
|
||||
MagnitudeReference:MAGNITUDE, OriginReference:EVENT,
|
||||
Event:EVENT. Specifying NULL for the message group causes
|
||||
messages to be thrown away/dropped/discarded.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscimex [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 SCIMEX
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-print\-default\-routingtable
|
||||
Print the default object routing table.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
618
share/man/man1/scimport.1
Normal file
618
share/man/man1/scimport.1
Normal file
@ -0,0 +1,618 @@
|
||||
.\" 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 "SCIMPORT" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scimport \- SeisComP Documentation
|
||||
.sp
|
||||
\fBForward messages across two SeisComP systems.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scimport is responsible to forward messages from one system to another. The
|
||||
difference to \fI\%scimex\fP is that scimport does not handle the messages
|
||||
event based. scimport supports two different modes. The relay mode does a
|
||||
simple mapping from GROUP:SYSTEM_A to GROUP:SYSTEM_B. This mode is default.
|
||||
.sp
|
||||
In case GROUP is not defined in the second system the message is forwarded to
|
||||
IMPORT_GROUP. The import mode supports custom mapping and filter functionality.
|
||||
It is possible to forward GROUP1:SYSTEM_A to GROUP2:SYSTEM_B. In addition the
|
||||
forwarded objects can be filtered by:
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B Pick
|
||||
.INDENT 7.0
|
||||
.IP \(bu 2
|
||||
Status
|
||||
.IP \(bu 2
|
||||
Mode
|
||||
.IP \(bu 2
|
||||
Phase
|
||||
.IP \(bu 2
|
||||
AgencyID
|
||||
.UNINDENT
|
||||
.TP
|
||||
.B Amplitude
|
||||
.INDENT 7.0
|
||||
.IP \(bu 2
|
||||
Amplitude
|
||||
.UNINDENT
|
||||
.TP
|
||||
.B Origin
|
||||
.INDENT 7.0
|
||||
.IP \(bu 2
|
||||
Location
|
||||
.IP \(bu 2
|
||||
Depth
|
||||
.IP \(bu 2
|
||||
AgencyID
|
||||
.IP \(bu 2
|
||||
Status
|
||||
.IP \(bu 2
|
||||
Mode
|
||||
.UNINDENT
|
||||
.TP
|
||||
.B Event
|
||||
.INDENT 7.0
|
||||
.IP \(bu 2
|
||||
Type
|
||||
.UNINDENT
|
||||
.TP
|
||||
.B StationMagnitude
|
||||
.INDENT 7.0
|
||||
.IP \(bu 2
|
||||
Type
|
||||
.UNINDENT
|
||||
.TP
|
||||
.B Magnitude
|
||||
.INDENT 7.0
|
||||
.IP \(bu 2
|
||||
Type
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.sp
|
||||
Example scimport.cfg
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
# The address of the importing system
|
||||
sink = sinkAddress
|
||||
|
||||
# This option has to be set if the application runs in import mode.
|
||||
# The routing table has to be defined in the form of source_group:sink_group
|
||||
routingtable = PICK:PICK
|
||||
|
||||
# List of sink groups to subscribe to. If this option is not set the message
|
||||
# groups will be determined automatically. If this option is set but not
|
||||
# needed for a setup it can be ignored with the option \-\-ignore\-groups
|
||||
msggroups = GROUP_ONE, GROUP_TWO
|
||||
|
||||
# Available filter options
|
||||
filter.pick.mode = manual
|
||||
filter.pick.status = confirmed
|
||||
filter.pick.phase = P
|
||||
filter.pick.agencyID = GFZ
|
||||
|
||||
# Values: eq (==), lt (<=) ,gt (>=), *
|
||||
filter.amplitude.operator = gt
|
||||
filter.amplitude.amplitude = 100
|
||||
|
||||
# Values: lat0:lat1 (range)
|
||||
filter.origin.latitude = \-90:90
|
||||
|
||||
# Values: lon0:lon1 (range)
|
||||
filter.origin.longitude = \-180:180
|
||||
filter.origin.depth = 0:100
|
||||
filter.origin.agencyID = GFZ
|
||||
|
||||
# Values: automatic, manual
|
||||
filter.origin.mode = manual
|
||||
filter.origin.status = confirmed
|
||||
|
||||
# Values: earthquake, explosion, quarry blast, chemical explosion,
|
||||
# nuclear explosion, landslide, debris avalanche, rockslide,
|
||||
# mine collapse, volcanic eruption, meteor impact, plane crash,
|
||||
# building collapse, sonic boom, other
|
||||
filter.event.type = earthquake
|
||||
|
||||
# Values: Whatever your magnitudes are named
|
||||
filter.stationMagnitude.type = MLv
|
||||
|
||||
# Values: Whatever your magnitudes are named
|
||||
filter.magnitude.type = MLv
|
||||
|
||||
# Values: latency, delay, timing quality, gaps interval, gaps length,
|
||||
# spikes interval, spikes amplitude, offset, rms
|
||||
filter.qc.type = latency
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scimport.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scimport.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scimport.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scimport inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B sink
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
URI of receiving host which runs scmaster. The URI contains
|
||||
the host name with an optional protocol and port.
|
||||
.sp
|
||||
Format: protocol://host:port
|
||||
.sp
|
||||
Examples:
|
||||
.sp
|
||||
\- proc
|
||||
.sp
|
||||
\- scmp://proc:18180
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B routingtable
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
This option has to be set if the application runs in import mode.
|
||||
The routing table has to be defined in the form of
|
||||
source_group:sink_group
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B msggroups
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Define a list of message groups of the source system
|
||||
(connection.server). If not specified, the source system is
|
||||
queried for a list of message groups which are then used to check
|
||||
each subscription extracted from the routing table.
|
||||
This parameter allows to override to source query result.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B useFilter
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
\fINo description available\fP
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.*\fP
|
||||
\fIDefine filter criteria before sending.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.pick.*\fP
|
||||
\fICriteria for filtering picks.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.pick.mode
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The mode of picks to filter for. Allowed values:
|
||||
\(dqautomatic\(dq and \(dqmanual\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.pick.status
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The status of picks to filter for. Allowed values:
|
||||
\(dqpreliminary\(dq, \(dqconfirmed\(dq,
|
||||
\(dqreviewed\(dq, \(dqfinal\(dq,
|
||||
\(dqrejected\(dq and \(dqreported\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.pick.phase
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The pick phase hint to filter for. Allowed values:
|
||||
all possible phase codes.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.pick.agencyIDs
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
The pick agencyIDs to filter for. Allowed values:
|
||||
all possible agency ids;
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.pick.networkCode
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The pick network code of the processed waveforms.
|
||||
Allowed values: all possible network codes.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.amplitude.*\fP
|
||||
\fICriteria for filtering amplitudes\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.amplitude.operator
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The amplitude comparison operator. Allowed values:
|
||||
\(dqeq\(dq, \(dqlt\(dq, \(dqgt\(dq and \(dq*\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.amplitude.amplitude
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
The amplitude threshold to filter for. The operator
|
||||
configured with \(dqoperator\(dq is used to compare this threshold with
|
||||
the incoming value. If \(dqoperator\(dq is \(dq*\(dq then
|
||||
values will pass.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.amplitude.agencyIDs
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
The amplitude agencyIDs to filter for. Allowed values:
|
||||
all possible agency ids.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.origin.*\fP
|
||||
\fICriteria for filtering origins\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.origin.latitude
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The latitude range in format [min]:[max].
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.origin.longitude
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The longitude range in format [min]:[max].
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.origin.depth
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The depth range in format [min]:[max].
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.origin.agencyIDs
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
The origin agencyIDs to filter for. Allowed values:
|
||||
all possible agency ids;
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.origin.mode
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The origin evaluation mode to filter for. Allowed values:
|
||||
\(dqautomatic\(dq and \(dqmanual\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.origin.status
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The origin status to filter for. Allowed values:
|
||||
\(dqpreliminary\(dq, \(dqconfirmed\(dq,
|
||||
\(dqreviewed\(dq, \(dqfinal\(dq,
|
||||
\(dqrejected\(dq and \(dqreported\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.origin.arrivalcount
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The minimum number of arrivals of an origin to pass
|
||||
the filter.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.event.*\fP
|
||||
\fICriteria for filtering events\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.event.type
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The event type to filter for, e.g. \(dqearthquake\(dq,
|
||||
\(dqexplosion\(dq ...
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.stationMagnitude.*\fP
|
||||
\fICriteria for filtering station magnitudes\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.stationMagnitude.type
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The station magnitude type. Allowed values: all possible
|
||||
magnitude types such as \(dqMLv\(dq.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.magnitude.*\fP
|
||||
\fICriteria for filtering network magnitudes\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.magnitude.type
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The magnitude type. Allowed values: all possible
|
||||
magnitude types such as \(dqMLv\(dq.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBfilter.qc.*\fP
|
||||
\fICriteria for filtering QC parameters\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filter.qc.type
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The QC parameter type. Allowed values: all possible
|
||||
types such as \(dqlatency\(dq, \(dqdelay\(dq ...
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscimport [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 Import
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-sink
|
||||
Overrides configuration parameter \fI\%sink\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-import
|
||||
Switch to import mode (default is relay). Im import mode the
|
||||
routing table has to be specified whereas in relay the
|
||||
routing table will be calculated automatically.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-no\-filter
|
||||
Disable message filtering and ignore all configured filters.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-routeunknowngroup
|
||||
Route unknown groups to the default group IMPORT_GROUP.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-ignore\-groups
|
||||
Ignore user specified groups.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-test
|
||||
Do not send any messages.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
1192
share/man/man1/scinv.1
Normal file
1192
share/man/man1/scinv.1
Normal file
File diff suppressed because it is too large
Load Diff
489
share/man/man1/scm.1
Normal file
489
share/man/man1/scm.1
Normal file
@ -0,0 +1,489 @@
|
||||
.\" 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 "SCM" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scm \- SeisComP Documentation
|
||||
.sp
|
||||
\fBProcess monitor.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scm monitors client activity. scm connects to a certain master and periodically
|
||||
processes the status messages sent by the clients.
|
||||
.sp
|
||||
Each client status if forwarded to the plugins loaded by scm. By default
|
||||
the \fI\%mncursesplugin\fP is loaded which presents an interface
|
||||
similar to the gnu program top.
|
||||
.SH FILTERS
|
||||
.sp
|
||||
Plugins might support filtering client status information. To configure filters
|
||||
each plugin supports a configuration value \fB$name.filter\fP\&. This filter
|
||||
is a string which can be constructed from available status info tags and logical
|
||||
and numerical operators.
|
||||
.sp
|
||||
List of tags:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
time
|
||||
privategroup
|
||||
hostname
|
||||
clientname
|
||||
ips
|
||||
programname
|
||||
pid
|
||||
cpuusage
|
||||
totalmemory
|
||||
clientmemoryusage
|
||||
memoryusage
|
||||
sentmessages
|
||||
receivedmessages
|
||||
messagequeuesize
|
||||
summedmessagequeuesize
|
||||
averagemessagequeuesize
|
||||
summedmessagesize
|
||||
averagemessagesize
|
||||
objectcount
|
||||
uptime
|
||||
responsetime
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
A filter might look like this:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
memailplugin.filter = \(dq(cpuusage>100 || totalmemory>1000) && hostname==proc\-machine\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Numerical operators
|
||||
.sp
|
||||
Numerical operators are applied to a tag name and a constant value.
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Operator
|
||||
T} T{
|
||||
Description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
==
|
||||
T} T{
|
||||
equal
|
||||
T}
|
||||
_
|
||||
T{
|
||||
!=
|
||||
T} T{
|
||||
not equal
|
||||
T}
|
||||
_
|
||||
T{
|
||||
<
|
||||
T} T{
|
||||
less than
|
||||
T}
|
||||
_
|
||||
T{
|
||||
>
|
||||
T} T{
|
||||
greater than
|
||||
T}
|
||||
_
|
||||
T{
|
||||
<=
|
||||
T} T{
|
||||
less or equal
|
||||
T}
|
||||
_
|
||||
T{
|
||||
>=
|
||||
T} T{
|
||||
greater or equal
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.SS Logical operators
|
||||
.sp
|
||||
Logical operators are applied to a group (might be enclosed in brackets) or
|
||||
numerical expressions.
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Operator
|
||||
T} T{
|
||||
Description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
!
|
||||
T} T{
|
||||
not
|
||||
T}
|
||||
_
|
||||
T{
|
||||
&&
|
||||
T} T{
|
||||
and
|
||||
T}
|
||||
_
|
||||
T{
|
||||
||
|
||||
T} T{
|
||||
or
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.SH MULTIPLE INSTANCES
|
||||
.sp
|
||||
To monitor different clients sets with different criteria and different plugins
|
||||
it is common practice to create aliases of scm and to configure each instance
|
||||
separately
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp alias create scm_level1 scm
|
||||
seiscomp alias create scm_level2 scm
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
where \fBscm_level1\fP could monitor all mandatory clients whereas
|
||||
\fBscm_level2\fP monitors all clients which are not crucial for operation.
|
||||
.SH PLUGINS
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%email\fP
|
||||
.sp
|
||||
Email plugin for scm which sends emails based on client status.
|
||||
.IP \(bu 2
|
||||
\fI\%text\fP
|
||||
.sp
|
||||
Text output plugin for scm.
|
||||
.IP \(bu 2
|
||||
\fI\%ncurses\fP
|
||||
.sp
|
||||
Ncurses output plugin for scm which presents an interactive table of processes.
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scm.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scm.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scm.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scm inherits \fI\%global options\fP\&.
|
||||
.SS email extension
|
||||
.sp
|
||||
Email plugin for scm which sends emails based on client status.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B memailplugin.recipients
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Defines a comma separated list of email addresses to send
|
||||
notifications to.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B memailplugin.template
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Configures a custom message text that is appended to each message
|
||||
when clients passed the filter.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B memailplugin.filter
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Defines the filter for each client status. A filter is an expression
|
||||
that can be constructed with all available status tags (scm \-\-print\-tags)
|
||||
and logical and numerical operators. See scm for more information.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B memailplugin.requiredClients
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
\fINo description available\fP
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B memailplugin.reportSilentClients
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
\fINo description available\fP
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B memailplugin.reportSilentClientsTimeSpan
|
||||
Default: \fB1\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fImin\fP
|
||||
.sp
|
||||
\fINo description available\fP
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B memailplugin.reportRequiredClients
|
||||
Default: \fB10\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fImin\fP
|
||||
.sp
|
||||
\fINo description available\fP
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B memailplugin.filterMeanInterval
|
||||
Default: \fB10\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fImin\fP
|
||||
.sp
|
||||
\fINo description available\fP
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B memailplugin.sendEmail
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enables sending of emails using mailx shell command.
|
||||
.UNINDENT
|
||||
.SS text extension
|
||||
.sp
|
||||
Text output plugin for scm.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B mtextplugin.outputDir
|
||||
Default: \fB@LOGDIR@/scm/\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
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.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscm [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 Monitor
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-c, \-\-clients list
|
||||
Comma separated list of clients to monitor.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-print\-tags
|
||||
Print available keys for accessing client info data and to
|
||||
build filter configurations.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-no\-output\-plugins
|
||||
Do not use output plugins such as mncursesplugin.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
679
share/man/man1/scmag.1
Normal file
679
share/man/man1/scmag.1
Normal file
@ -0,0 +1,679 @@
|
||||
.\" 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 "SCMAG" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scmag \- SeisComP Documentation
|
||||
.sp
|
||||
\fBCalculates magnitudes of different types.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
The purpose of scmag is to compute magnitudes from pre\-computed amplitudes.
|
||||
Instead it takes amplitudes and origins as input and produces StationMagnitudes
|
||||
and (network) Magnitudes as output. It does not access waveforms.
|
||||
The resulting magnitudes are sent to the \(dqMAGNITUDE\(dq group. scmag doesn’t access
|
||||
any waveforms. It only uses amplitudes previously calculated.
|
||||
.sp
|
||||
The purpose of scmag is the decoupling of magnitude computation from amplitude
|
||||
measurements. This allows several modules to generate amplitudes concurrently,
|
||||
like \fI\%scautopick\fP or \fI\%scamp\fP\&. As soon as an origin comes in, the amplitudes related
|
||||
to the picks are taken either from the memory buffer or the database to compute
|
||||
the magnitudes.
|
||||
.SS Relationship between amplitudes and origins
|
||||
.sp
|
||||
scmag makes use of the fact that origins sent by \fI\%scautoloc\fP, \fI\%scolv\fP
|
||||
or other modules include
|
||||
the complete set of arrivals, which reference picks used for origin computation.
|
||||
The picks in turn are referenced by a number of amplitudes, some of which are
|
||||
relevant for magnitude computation.
|
||||
.sp
|
||||
Read the \fI\%scamp\fP documentation for more details on amplitude measurements.
|
||||
.SS Primary magnitudes
|
||||
.sp
|
||||
Primary magnitudes are computed from amplitudes and station\-event distances.
|
||||
Currently the following primary magnitude types are implemented.
|
||||
.SS Local distances
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \fI\%Md\fP
|
||||
Duration magnitude as described in HYPOINVERSE (Klein [\fI\%50\fP]).
|
||||
.TP
|
||||
.B \fI\%Mjma\fP
|
||||
Mjma is computed on displacement data using body waves of period < 30s.
|
||||
.TP
|
||||
.B \fI\%ML\fP
|
||||
Local (Richter) magnitude calculated on the horizontal components using a
|
||||
correction term to fit with the standard ML (Richter [\fI\%57\fP]).
|
||||
.TP
|
||||
.B \fI\%MLc\fP
|
||||
Local custom magnitude calculated on the horizontal components according to
|
||||
Hessian Earthquake Service and Stange [\fI\%62\fP]
|
||||
.TP
|
||||
.B \fI\%MLh\fP
|
||||
Local magnitude calculated on the horizontal components according to SED
|
||||
specifications.
|
||||
.TP
|
||||
.B \fI\%MLv\fP
|
||||
Local magnitude calculated on the vertical component using a correction term
|
||||
to fit with the standard ML.
|
||||
.TP
|
||||
.B \fI\%MLr\fP
|
||||
Local magnitude calculated from MLv amplitudes based on GNS/GEONET specifications
|
||||
for New Zealand (Ristau \fIet al.\fP [\fI\%58\fP]).
|
||||
.TP
|
||||
.B \fI\%MN\fP
|
||||
Nuttli magnitude for Canada and other Cratonic regions (Nuttli [\fI\%53\fP]).
|
||||
.UNINDENT
|
||||
.SS Teleseismic distances
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \fI\%mb\fP
|
||||
Narrow band body wave magnitude measured on a WWSSN\-SP filtered trace
|
||||
.TP
|
||||
.B \fI\%mBc\fP
|
||||
Cumulative body wave magnitude
|
||||
.TP
|
||||
.B \fI\%mB\fP
|
||||
Broad band body wave magnitude after Bormann and Saul [\fI\%38\fP]
|
||||
.TP
|
||||
.B \fI\%Mwp\fP
|
||||
The body wave magnitude of Tsuboi \fIet al.\fP [\fI\%63\fP]
|
||||
.TP
|
||||
.B \fI\%Ms_20\fP
|
||||
Surface\-wave magnitude at 20 s period
|
||||
.TP
|
||||
.B \fI\%Ms(BB)\fP
|
||||
Broad band surface\-wave magnitude
|
||||
.UNINDENT
|
||||
.SS Derived magnitudes
|
||||
.sp
|
||||
Additionally, scmag derives the following magnitudes from primary magnitudes:
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \fI\%Mw(mB)\fP
|
||||
Estimation of the moment magnitude Mw based on mB using the Mw vs. mB
|
||||
regression of Bormann and Saul [\fI\%38\fP]
|
||||
.TP
|
||||
.B \fI\%Mw(Mwp)\fP
|
||||
Estimation of the moment magnitude Mw based on Mwp using the Mw vs. Mwp
|
||||
regression of Whitmore \fIet al.\fP [\fI\%65\fP]
|
||||
.TP
|
||||
.B \fI\%M\fP
|
||||
Summary magnitude, which consists of a weighted average of the individual
|
||||
magnitudes and attempts to be a best possible compromise between all magnitudes.
|
||||
See below for configuration and also scevent for how to add the summary magnitude
|
||||
to the list of possible preferred magnitudes or how to make it always preferred.
|
||||
.sp
|
||||
More details are given in the \fI\%section Summary magnitude\fP\&.
|
||||
.TP
|
||||
.B Mw(avg)
|
||||
Estimation of the moment magnitude Mw based on a weighted average of other
|
||||
magnitudes, currently MLv, mb and Mw(mB), in future possibly other magnitudes as
|
||||
well, especially those suitable for very large events. The purpose of Mw(avg) is
|
||||
to have, at any stage during the processing, a “best possible” estimation of the
|
||||
magnitude by combining all available magnitudes into a single, weighted average.
|
||||
Initially the average will consist of only MLv and/or mb measurements, but as soon
|
||||
as Mw(mB) measurements become available, these (and in future other large\-event
|
||||
magnitudes) become progressively more weight in the average.
|
||||
.UNINDENT
|
||||
.sp
|
||||
If an amplitude is updated, the corresponding magnitude is updated as well.
|
||||
This allows the computation of preliminary, real\-time magnitudes even before
|
||||
the full length of the P coda is available.
|
||||
.SH STATION MAGNITUDES
|
||||
.sp
|
||||
Station magnitudes of a \fI\%particular magnitude type\fP are
|
||||
calculated based on measured amplitudes considered by this magnitude type and
|
||||
the distance between the \fI\%origin\fP and the station at which the amplitude
|
||||
was measured. Typically, epicentral distance is used for distance. Magnitudes
|
||||
may support configurable distance measures, e.g.,
|
||||
\fI\%MLc\fP\&. The relation between measured
|
||||
amplitudes, distance and station magnitude is given by a calibration function
|
||||
which is specific to a magnitude type and configurable for some magnitudes.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Usually station magnitudes use amplitudes of the same type. However, some magnitude
|
||||
consider amplitudes of another type. E.g. \fI\%MLr\fP
|
||||
uses amplitudes computed for \fI\%MLv\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Regionalization
|
||||
.sp
|
||||
Depending on the geographic region in which events, stations or entire ray paths
|
||||
are located, different calibration functions and constraints may apply. This is
|
||||
called \(dqmagnitude regionalization\(dq. The region is defined by a polygon stored in
|
||||
a region file. For a particular magnitude, regionalization can be configured by
|
||||
global parameters, e.g., in \fB$SEISCOMP_ROOT/etc/global.cfg\fP\&.
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Add magnitude type profile to the magnitudes parameters. The name of the
|
||||
profile must be the name of the magnitude type.
|
||||
.IP 2. 3
|
||||
Add the profile\-specific parameters.
|
||||
.UNINDENT
|
||||
.sp
|
||||
Example for MLc in \fB$SEISCOMP_ROOT/etc/global.cfg\fP the polygon with name
|
||||
\fItest\fP defined in a \fI\%BNA file\fP:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
magnitudes.MLc.regionFile = @DATADIR@/spatial/vector/magnitudes/regions.bna
|
||||
magnitudes.MLc.region.test.enable = true
|
||||
magnitudes.MLc.region.test.A0.logA0 = 0:\-1.3, 60:\-2.8, 100:\-3.0, 400:\-4.5, 1000:\-5.85
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH NETWORK MAGNITUDES
|
||||
.sp
|
||||
The network magnitude is a magnitude value summarizing several
|
||||
\fI\%station magnitudes\fP values of one \fI\%origin\fP\&.
|
||||
Different methods are available for forming network magnitudes from station
|
||||
magnitudes:
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Method
|
||||
T} T{
|
||||
Description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
mean
|
||||
T} T{
|
||||
The usual mean value.
|
||||
T}
|
||||
_
|
||||
T{
|
||||
trimmed mean value
|
||||
T} T{
|
||||
To stabilize the network magnitudes the smallest and the largest 12.5% of the \fI\%station magnitude\fP values are removed before computing the mean.
|
||||
T}
|
||||
_
|
||||
T{
|
||||
median
|
||||
T} T{
|
||||
The usual median value.
|
||||
T}
|
||||
_
|
||||
T{
|
||||
median trimmed mean
|
||||
T} T{
|
||||
Removing all station magnitudes with a distance greater than 0.5 (default) from the median of all station magnitudes and computing the mean of all remaining station magnitudes.
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.sp
|
||||
Configure the method per magnitude type by \fI\%magnitudes.average\fP\&.
|
||||
Default values apply for each magnitude type which are defined by the magnitude
|
||||
itself.
|
||||
In the \fI\%scolv Magnitudes tab\fP the methods, the
|
||||
stations magnitudes and other parameters can be selected interactively.
|
||||
.SH SUMMARY MAGNITUDE
|
||||
.sp
|
||||
scmag can compute a summary magnitude as a weighted sum from all available
|
||||
\fI\%network magnitudes\fP\&.
|
||||
This magnitude is typically called \fBM\fP as configured in
|
||||
\fI\%summaryMagnitude.type\fP\&.
|
||||
.sp
|
||||
It is computed as a weighted average over the available magnitudes:
|
||||
.sp
|
||||
.ce
|
||||
M &= \efrac{\esum w_{i} * M_{i}}{\esum w_i} \e\e
|
||||
w_{i} &= a_i * stationCount(M_{i}) + b_i
|
||||
.ce 0
|
||||
.sp
|
||||
The coefficients a and b can be configured per magnitude type by
|
||||
\fI\%summaryMagnitude.coefficients.a\fP
|
||||
and \fI\%summaryMagnitude.coefficients.b\fP, respectively.
|
||||
Furthermore each magnitude type can be specifically added to or excluded from the
|
||||
summary magnitude calculation
|
||||
as defined in \fI\%summaryMagnitude.whitelist\fP or
|
||||
\fI\%summaryMagnitude.blacklist\fP, respectively.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
While the magnitudes are computed by scmag the decision about the preferred
|
||||
magnitude of an \fI\%event\fP is made by \fI\%scevent\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH PREFERRED MAGNITUDE
|
||||
.sp
|
||||
The preferred magnitude of an \fI\%event\fP is set automatically by \fI\%scevent\fP
|
||||
or interactively in \fI\%scolv\fP\&. It can be any network magnitude or the summary
|
||||
magnitude.
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scmag.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scmag.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scmag.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scmag inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B magnitudes
|
||||
Default: \fBMLv,mb,mB,Mwp\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
The magnitude types to be calculated. Station magnitudes are
|
||||
computed from their amplitudes, network magnitudes from their
|
||||
station magnitudes.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B minimumArrivalWeight
|
||||
Default: \fB0.5\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
The minimum weight of an arrival for an associated amplitude
|
||||
to be used for calculating a magnitude.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBmagnitudes.*\fP
|
||||
\fIGeneral parameters for computing magnitudes. Others are configured\fP
|
||||
\fIby global binding parameters for specific magnitude types.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B magnitudes.average
|
||||
Default: \fBdefault\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
The methods for computing the network magnitude
|
||||
from station magnitudes. Exactly one method per
|
||||
magnitude can be configured.
|
||||
To define the averaging method per magnitude type append
|
||||
the type after colon, e.g.:
|
||||
\(dqmagnitudes.average = default, MLv:median\(dq
|
||||
.sp
|
||||
default: Compute the mean if less than 4 contributed
|
||||
station magnitudes exist. Otherwise apply trimmedMean(25),
|
||||
trimmed mean with 25%.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B connection.sendInterval
|
||||
Default: \fB1\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Interval between 2 sending processes. The interval controls
|
||||
how often information is updated.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBsummaryMagnitude.*\fP
|
||||
\fIThe summary magnitude is the weighted average from all\fP
|
||||
\fIdefined network magnitude types: Single network magnitude values\fP
|
||||
\fIare multiplied with their magnitude\-type specific weight and\fP
|
||||
\fIsummed up. The resulting sum is divided by the sum of all weights.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B summaryMagnitude.enabled
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enables summary magnitude calculation.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B summaryMagnitude.type
|
||||
Default: \fBM\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Define the type/name of the summary magnitude.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B summaryMagnitude.minStationCount
|
||||
Default: \fB1\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
This is the minimum station magnitude required for any
|
||||
magnitude to contribute to the summary magnitude at all. If
|
||||
this is set to 4, then no magnitude with less than 4 station
|
||||
magnitudes is taken into consideration even if this results
|
||||
in no summary magnitude at all. For this reason, the default
|
||||
here is 1 but in a purely automatic system it should be
|
||||
higher, at least 4 is recommended.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B summaryMagnitude.singleton
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Allow computing the summary magnitude even if only one single
|
||||
network magnitude meeting the other criteria is available.
|
||||
Unselecting this parameter will suppress computing summary
|
||||
magnitudes if only one network magnitude is available.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B summaryMagnitude.blacklist
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Define the magnitude types to be excluded from the summary
|
||||
magnitude calculation.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B summaryMagnitude.whitelist
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Define the magnitude types to be included in the summary
|
||||
magnitude calculation.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBsummaryMagnitude.coefficients.*\fP
|
||||
\fIThe coefficients defining the weight of network magnitudes\fP
|
||||
\fIfor calculating the summary magnitude.\fP
|
||||
\fIWeight = a * magnitudeStationCount + b.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B summaryMagnitude.coefficients.a
|
||||
Default: \fB0, Mw(mB):0.4, Mw(Mwp):0.4\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Define the coefficients a. To define the value per magnitude
|
||||
type append the type after colon. A value without a
|
||||
type defines the default value.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B summaryMagnitude.coefficients.b
|
||||
Default: \fB1, MLv:2, Mw(mB):\-1, Mw(Mwp):\-1\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Define the coefficients b. To define the value per magnitude
|
||||
type append the type after colon. A value without a
|
||||
type defines the default value.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.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
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-x, \-\-expiry time
|
||||
Time span in hours after which objects expire.
|
||||
.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 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 Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-ep file
|
||||
Defines an event parameters XML file to be read and processed. This
|
||||
implies offline mode and only processes all origins contained
|
||||
in that file. It computes station magnitudes for all picks associated
|
||||
with an origin where amplitudes are available and the corresponding
|
||||
network magnitudes. Station and network magnitudes having the
|
||||
evaluation status set are ignored. Use \-\-reprocess to include those
|
||||
magnitudes. It outputs an XML text adding the station\-
|
||||
and network magnitudes to the input XML file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-reprocess
|
||||
Reprocess also station and network magnitudes with an evaluation
|
||||
status set but do not change original weights. New
|
||||
contributions are added with weight 0.
|
||||
.UNINDENT
|
||||
.SS Reprocess
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-static
|
||||
With that flag all existing station magnitudes are recomputed
|
||||
based on their associated amplitudes. If an amplitude cannot
|
||||
be accessed, no station magnitude is updated.
|
||||
Network magnitudes are recomputed based on their station
|
||||
magnitude contributions. No new objects will
|
||||
be created in this mode, it only updates values and weights.
|
||||
The method to accumulate the station magnitudes to form the network
|
||||
magnitude will be read from the existing object and replicated.
|
||||
If it cannot be interpreted, then the configured default for this
|
||||
magnitude type will be used instead. Weights of station magnitudes
|
||||
will be changed according to the accumulation method of the
|
||||
network magnitude.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-keep\-weights
|
||||
Keep the original weights in combination with \-\-static.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
279
share/man/man1/scmapcut.1
Normal file
279
share/man/man1/scmapcut.1
Normal file
@ -0,0 +1,279 @@
|
||||
.\" 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 "SCMAPCUT" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scmapcut \- SeisComP Documentation
|
||||
.sp
|
||||
\fBCreate image files containing maps of specific regions.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
\fIscmapcut\fP is a commandline tool to create image files containing maps of specific
|
||||
regions and for selected events. When plotting events given by their eventID, the
|
||||
event parameters must be provided in a SeisComP event XML file. The XML file can
|
||||
be retrieved from the database using \fI\%scxmldump\fP\&.
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Draw a map for the event with event ID <eventID>. Plot a region of at least
|
||||
3 degrees around the epicentre. The created image has 800x400 px.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scmapcut \-E <eventID> \-\-ep <eventID>.xml \-m 3 \-d 800x400 \-o <eventID>.png
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 3.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Image example..UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Draw a map for a generic event with magnitude 4. The size of the event shown
|
||||
on the map scales with magnitude. Plot a region of at least 3 degrees around
|
||||
the epicentre. The created image has 800x400 px.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scmapcut \-\-lat 44 \-\-lon 12 \-\-depth 10 \-\-mag 4 \-m 0.5 \-d 800x400 \-o generic.png
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 3.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Generic example..UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scmapcut.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scmapcut.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scmapcut.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scmapcut inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscmapcut [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 Cities
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-city\-xml arg
|
||||
Path to the cities.xml file. If undefined, the data is
|
||||
read from CONFIGDIR@/cities.xml or @DATADIR@/cities.xml.
|
||||
.UNINDENT
|
||||
.SS Options
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-r, \-\-region arg
|
||||
Cut region ([lat_dim]x[lon_dim]+lat0+lon0 or +lat0+lon+lat1+lon1).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-m, \-\-margin arg
|
||||
Margin in degrees around origin (margin|margin_latxmargin_lon).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-d, \-\-dimension arg
|
||||
Output image dimension (wxh).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output arg
|
||||
Output image, file name.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-lat arg
|
||||
Latitude of symbol.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-long arg
|
||||
Longitude of symbol.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-depth arg
|
||||
Depth of event.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-mag arg
|
||||
Magnitude of event.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-layers arg
|
||||
Draw polygonal layers.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-ep arg
|
||||
Name of XML file containing the event parameters to load.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E, \-\-event\-id arg
|
||||
Event ID of the event to plot on map.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-html\-area
|
||||
Print html/area section.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-without\-arrivals
|
||||
Do not render arrivals (stations).
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
624
share/man/man1/scmaster.1
Normal file
624
share/man/man1/scmaster.1
Normal file
@ -0,0 +1,624 @@
|
||||
.\" 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 "SCMASTER" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scmaster \- SeisComP Documentation
|
||||
.sp
|
||||
\fBThe messaging system\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scmaster is the implementation of the \fI\%messaging\fP
|
||||
mediator.
|
||||
.SH MESSAGE GROUPS
|
||||
.sp
|
||||
scmaster provides the \fI\%message groups\fP\&. Configure
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%defaultGroups\fP: Add the groups which can be used by all queues.
|
||||
.IP \(bu 2
|
||||
\fI\%queues.$name.groups\fP: Set all groups which are used by the given
|
||||
queue. You may inherit \fI\%defaultGroups\fP, e.g.:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
queues.production.groups = ${defaultGroups},L1PICK
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBWARNING:\fP
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
Setting any value without inheriting \fI\%defaultGroups\fP ignores all
|
||||
values of \fI\%defaultGroups\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH QUEUES
|
||||
.sp
|
||||
scmaster provides \fIqueues\fP for separating the processing.
|
||||
Typically, the default queue \fIproduction\fP is used. To add new queues
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Define a new queue by adding a new profile with some name,
|
||||
.IP 2. 3
|
||||
Configure the profile parameters \fBqueues.$name.*\fP,
|
||||
.IP 3. 3
|
||||
Register the queue in \fI\%queues\fP\&.
|
||||
.UNINDENT
|
||||
.SH SCHEME
|
||||
.sp
|
||||
scmaster provides unsecured and secured connection which is addressed by the
|
||||
scheme values \fIscmp\fP and \fIscmps\fP, respectively, in \fI\%connection.server\fP
|
||||
when connecting to the messaging.
|
||||
Read the \fI\%concepts section\fP for more details. \fIscmps\fP
|
||||
is in use when configuring \fI\%interface.ssl.bind\fP\&.
|
||||
.SH DATABASE ACCESS
|
||||
.sp
|
||||
scmaster reads from and writes to the database and reports the database connection
|
||||
to the clients of the messaging system (compare with the \fI\%concepts section\fP).
|
||||
.sp
|
||||
The database is configured per queue.
|
||||
.SS Single Machine
|
||||
.sp
|
||||
When running all \fISeisComP\fP modules on a single machine, the read and write
|
||||
parameters are typically configured with \fIlocalhost\fP as a \fIhost name\fP\&.
|
||||
.sp
|
||||
Example:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
queues.production.processors.messages.dbstore.read = sysop:sysop@localhost/seiscomp
|
||||
queues.production.processors.messages.dbstore.write = sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Multiple Machines
|
||||
.sp
|
||||
If the clients are located on machines different from the messaging, the
|
||||
\fIhost name\fP of the read parameter
|
||||
must be available on the client machine and the client machine must be able to
|
||||
connect to the host with its name. If the database is on the same machine as the
|
||||
messaging, the \fIhost name\fP of the write connection typically remains \fIlocalhost\fP\&.
|
||||
.sp
|
||||
Example for connecting clients on computerB to the messaging on computerA (compare
|
||||
with the \fI\%concepts section\fP).
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Configuration of scmaster on computerA:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
queues.production.processors.messages.dbstore.read = sysop:sysop@computerA/seiscomp
|
||||
queues.production.processors.messages.dbstore.write = sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Global configuration of client on computerB:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
connection.server = computerA/production
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Database Proxy
|
||||
.sp
|
||||
scmaster can accept database requests and forward results to clients without
|
||||
exposing the underlying database. That allows clients to connect to the database
|
||||
of a particular queue via the Websocket HTTP protocol. No specific database
|
||||
plugin is required at the client which reduces the complexity of configuration.
|
||||
.sp
|
||||
Be aware that due to the nature of a proxy which is another layer on top of the
|
||||
actual database connection the performance is not as high as direct database
|
||||
access.
|
||||
.sp
|
||||
To let scmaster return the proxy address of the database connection, set
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
queues.production.processors.messages.dbstore.proxy = true
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
in the configuration file.
|
||||
.SH ACCESS CONTROL
|
||||
.sp
|
||||
scmaster does not provide any built\-in access control to connecting clients.
|
||||
The only exception is the possibility to verify client certificates against
|
||||
the server certificate if SSL is enabled.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
interface.ssl.verifyPeer = true
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
It is required that the client certificate is signed by the server certificate
|
||||
otherwise the client connection will be rejected.
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scmaster.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scmaster.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scmaster.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scmaster inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B defaultGroups
|
||||
Default: \fBAMPLITUDE, PICK, LOCATION, MAGNITUDE, FOCMECH, EVENT, QC, PUBLICATION, GUI, INVENTORY, CONFIG, LOGGING, SERVICE_REQUEST, SERVICE_PROVIDE, STATUS_GROUP\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
The default set of message groups for each queue. Only used
|
||||
if a queues group list is unset (note: empty is not unset).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues
|
||||
Default: \fBproduction, playback\fP
|
||||
.sp
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Enable messaging queues defined as profile in queues. The profile
|
||||
names are the final queue names.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBinterface.*\fP
|
||||
\fIControl the messaging interface. The default protocol is\fP
|
||||
\fI\(dqscmp\(dq but \(dqscmps\(dq (secure protocol) is\fP
|
||||
\fIused when valid SSL certificate and key are configured.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B interface.bind
|
||||
Default: \fB0.0.0.0:18180\fP
|
||||
.sp
|
||||
Type: \fIipbind\fP
|
||||
.sp
|
||||
Local bind address and port of the messaging system.
|
||||
0.0.0.0:18180 accepts connections from all clients,
|
||||
127.0.0.1:18180 only from localhost.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B interface.acl
|
||||
Type: \fIlist:ipmask\fP
|
||||
.sp
|
||||
The IP access control list for clients which are allowed
|
||||
to connect to the interface. Separate each IP with a space
|
||||
and put the entire list in double quotes, e.g.
|
||||
\(dq127.0.0.1 192.168.1.2 192.168.0.0/16\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B interface.socketPortReuse
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
SO_REUSEADDR socket option for the TCP listening socket.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBinterface.ssl.*\fP
|
||||
\fISSL encryption is used if key and certificate are configured.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B interface.ssl.bind
|
||||
Default: \fB0.0.0.0:\-1\fP
|
||||
.sp
|
||||
Type: \fIipbind\fP
|
||||
.sp
|
||||
Additional local bind address and port of the messaging
|
||||
system in case SSL encryption is active.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B interface.ssl.acl
|
||||
Type: \fIlist:ipmask\fP
|
||||
.sp
|
||||
The IP access control list for clients which are allowed
|
||||
to connect to the interface. See interface.acl for
|
||||
further details.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B interface.ssl.socketPortReuse
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
SO_REUSEADDR socket option for the TCP listening socket.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B interface.ssl.key
|
||||
Type: \fIpath\fP
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B interface.ssl.certificate
|
||||
Type: \fIpath\fP
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B interface.ssl.verifyPeer
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled then the certificate of a connecting client
|
||||
is verified against the servers certificate. It is
|
||||
required that the client certificate is signed by the
|
||||
server certificate otherwise the connection is refused.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBqueues.*\fP
|
||||
\fISet the parameters for each messaging queue. The queues are used\fP
|
||||
\fIwhen listed in the \(dqqueues\(dq parameter. Several queues\fP
|
||||
\fIcan be used in parallel. For queues with without databases leave\fP
|
||||
\fIthe processor parameters empty.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBqueues.$name.*\fP
|
||||
$name is a placeholder for the name to be used and needs to be added to \fI\%queues\fP to become active.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
queues = a,b
|
||||
queues.a.value1 = ...
|
||||
queues.b.value1 = ...
|
||||
# c is not active because it has not been added
|
||||
# to the list of queues
|
||||
queues.c.value1 = ...
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.groups
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Define the list of message groups added to the queue.
|
||||
If unset, then the defaultGroups will be used.
|
||||
A queue will always add the default group \(dqSTATUS_GROUP\(dq.
|
||||
This parameter overrides defaultGroups.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.acl
|
||||
Default: \fB0.0.0.0/0\fP
|
||||
.sp
|
||||
Type: \fIlist:ipmask\fP
|
||||
.sp
|
||||
The IP access control list for clients which are allowed
|
||||
to join the queue. See interface.acl for further details.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.maximumPayloadSize
|
||||
Default: \fB1048576\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIB\fP
|
||||
.sp
|
||||
The maximum size in bytes of a message to be accepted.
|
||||
Clients which send larger messages will be disconnected.
|
||||
The default is 1MB.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.plugins
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
List of plugins required by this queue. This is just a
|
||||
convenience parameter to improve configurations
|
||||
readability. The plugins can also be added to the
|
||||
global list of module plugins.
|
||||
.sp
|
||||
Example: dbstore
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.processors.messages
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Interface name. For now, use \(dqdbstore\(dqto
|
||||
use a database.
|
||||
.sp
|
||||
Use empty for testing or playbacks without a database.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBqueues.$name.processors.messages.dbstore.*\fP
|
||||
\fIDefine the database connection parameters.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.processors.messages.dbstore.driver
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Selected the database driver to use.
|
||||
Database drivers are available through plugins.
|
||||
The default plugin is dbmysql which supports
|
||||
the MYSQL database server. It is activated
|
||||
with the core.plugins parameter.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.processors.messages.dbstore.read
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Set the database read connection which is
|
||||
reported to clients that connect to this server.
|
||||
If a remote setup should be implemented,
|
||||
ensure that the hostname is reachable from
|
||||
the remote computer.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.processors.messages.dbstore.write
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Set the database write connection which is
|
||||
private to scmaster.
|
||||
A separate write connection enables different
|
||||
permissions on the database level for scmaster
|
||||
and clients.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.processors.messages.dbstore.proxy
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled then the database connection as configured
|
||||
in \(aqread\(aq is not being returned to the client
|
||||
but the URL \(dqproxy://\(dq. This URL
|
||||
tells the client to open the database via the
|
||||
websocket proxy at the messaging address,
|
||||
e.g. http://localhost/production/db. The same
|
||||
hostname and queue must be used as for the
|
||||
initial messaging connection.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B queues.$name.processors.messages.dbstore.strictVersionMatch
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled, the plugin will check the database
|
||||
schema version and refuse to start if the
|
||||
version doesn\(aqt match the latest version.
|
||||
If disabled and the an object needs to be
|
||||
stored, which is incompatible with the
|
||||
database schema, this object is lost.
|
||||
Leave this option enabled unless you know
|
||||
exactly what are you doing and what the
|
||||
consequences are.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B http.filebase
|
||||
Default: \fB@DATADIR@/scmaster/http/\fP
|
||||
.sp
|
||||
Type: \fIpath\fP
|
||||
.sp
|
||||
The directory served by the http server at staticPath.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B http.staticPath
|
||||
Default: \fB/\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The URL path at which html files and assets are available.
|
||||
All files under filebase will be served at this URL path.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B http.brokerPath
|
||||
Default: \fB/\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The URL path at which the broker websocket is available.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscmaster [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
|
||||
.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 Wired
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-bind arg
|
||||
The non\-encrypted bind address. Format [ip:]port
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-sbind arg
|
||||
The encrypted bind address. Format: [ip:]port
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
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.
|
||||
.
|
||||
197
share/man/man1/scmssort.1
Normal file
197
share/man/man1/scmssort.1
Normal file
@ -0,0 +1,197 @@
|
||||
.\" 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 "SCMSSORT" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scmssort \- SeisComP Documentation
|
||||
.sp
|
||||
\fBRead and manipulate miniSEED records\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scmssort reads unsorted (and possibly multiplexed) MiniSEED files and sorts
|
||||
the individual records by time. This is useful e.g. for simulating data
|
||||
acquisition and playbacks. Removing of duplicate data and trimming of time
|
||||
window is available.
|
||||
.sp
|
||||
scmssort reads single files and output to the command line. Cat many files
|
||||
to read them at the same time. In this way huge amount of data can be processed
|
||||
efficiently.
|
||||
.sp
|
||||
Applications to miniSEED records:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Sort records by time, e.g., for playbacks.
|
||||
.IP \(bu 2
|
||||
Remove duplicate records from files and clean waveform archives.
|
||||
.IP \(bu 2
|
||||
Filter data records, i.e. keep or remove them, based on
|
||||
.INDENT 2.0
|
||||
.IP \(bu 2
|
||||
time windows,
|
||||
.IP \(bu 2
|
||||
stream lists where each line has the format NET.STA.LOC.CHA including regular
|
||||
expressions. Such stream lists can be generated, e.g., using \fI\%scinv\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Combine with \fI\%scart\fP or \fI\%msrtsimul\fP to archive data or to make
|
||||
playbacks with real\-time simulations.
|
||||
.IP \(bu 2
|
||||
Filter data by stream IDs using NSLC lists which can be generated using
|
||||
\fI\%scinv\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Read a single miniSEED data file. The records are sorted by endtime and
|
||||
duplicates are removed.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scmssort \-vuE unsorted.mseed > sorted.mseed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Read all files ending with \(dq.mseed\(dq at the same time. The data are trimmed
|
||||
to a time window and duplicated or empty records are ignored.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
cat *.mseed | scmssort \-vuiE \-t 2020\-03\-28T15:48~2020\-03\-28T16:18 > sorted.mseed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Remove streams listed by stream code and sort records by end time. Also ignore
|
||||
duplicated or empty records. Stream lists can be generated, e.g., by \fI\%scinv\fP\&.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scmssort \-vuiE \-\-rm \-l stream\-list.txt test.mseed > sorted.mseed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 4. 3
|
||||
Extract streams by time and stream code and sort records by end time. Also ignore
|
||||
duplicated or empty records.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
echo CX.PB01..BH? | scmssort \-vuE \-t 2007\-03\-28T15:48~2007\-03\-28T16:18 \-l \- test.mseed > sorted.mseed
|
||||
scmssort \-vuiE \-t 2007\-03\-28T15:48~2007\-03\-28T16:18 \-l stream\-list.txt test.mseed > sorted.mseed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscmssort [options] input\fP
|
||||
.SS Options
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h, \-\-help
|
||||
Show the command\-line help and exit.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E, \-\-sort\-by\-end\-time
|
||||
Sort by end time.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-ignore
|
||||
Ignore all records which have no data samples.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-l, \-\-list
|
||||
File with streams to filter the records. One stream per
|
||||
line. Instead of a file read the from stdin (\-). Line
|
||||
format: NET.STA.LOC.CHA \- wildcards and regular expressions
|
||||
are considered. Example: CX.*..BH? .
|
||||
.sp
|
||||
NSLC lists may be generated, e.g., using scinv.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output
|
||||
Name of output file for miniSEED data (default is stdout).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-r, \-\-rm
|
||||
Remove all traces in stream list given by \-\-list
|
||||
instead of keeping them.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-t, \-\-time\-window
|
||||
Specify time window (as one \-properly quoted\- string).
|
||||
Times are of course UTC and separated by a tilde ~
|
||||
.sp
|
||||
Example:
|
||||
.sp
|
||||
2020\-03\-28T15:48~2020\-03\-28T16:18
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-u, \-\-uniqueness
|
||||
Ensure uniqueness of output, i.e. skip duplicate records.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-v, \-\-verbose
|
||||
Run in verbose mode.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
733
share/man/man1/scmv.1
Normal file
733
share/man/man1/scmv.1
Normal file
@ -0,0 +1,733 @@
|
||||
.\" 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 "SCMV" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scmv \- SeisComP Documentation
|
||||
.sp
|
||||
\fBMap view\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scmv visualizes the actual information regarding earthquakes, trigger status,
|
||||
ground motion and station quality. This information is visualized in a map
|
||||
showing also the topography of the region including bathymetry, state borders
|
||||
and geologic faults. scmv provides two different tabs with maps showing the
|
||||
ground motion and the network status.
|
||||
.SS Ground motion status
|
||||
.sp
|
||||
The ground motion tab (fig. \fI\%Ground motion tab\fP) shows the actual groundmotion
|
||||
in nm/s at each station color\-coded. Furthermore the trigger status (new picks)
|
||||
of the stations are announced by blinking triangles (the same in all
|
||||
other tabs). In case a new pick is associated to an event, the blinking color
|
||||
changes from red to green (default). Events are represented by open circles
|
||||
and the depth is color\-coded. By right mouse click on the symbol of a station
|
||||
more detailed information are shown in an information widget (fig. \fI\%Station information widget\fP).
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Ground motion tab
|
||||
Tab 1\-2 = Ground Motion, Network Status tab; Station A = station with ground
|
||||
motion between 0 and 200 nm/s; Station B = triggering (red blinking) station;
|
||||
Station C = station of undefined status; Station D = triggering and associated
|
||||
station (green blinking); EQ = location of the earthquake/event; P = spreading
|
||||
of the P\-wave; S = spreading of the S\-wave; Legend = ground motion scale.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Network status
|
||||
.sp
|
||||
The network status tab (fig. \fI\%Network status tab\fP) visualizes the quality control
|
||||
parameters of all shown stations. The colors of the triangles represent the data
|
||||
the selected parameters of a station, e.g. latency or delay. More detailed information about station quality
|
||||
can be derived by opening an information widget (fig. \fI\%Station information widget\fP left)
|
||||
with a right mouse click on the symbol.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Network status tab
|
||||
Station A = station with up to 20 sec data latency/delay;
|
||||
Station B = station with up to 10 min data latency/delay and a warning;
|
||||
Station C = disabled station;
|
||||
EQ = location of a recent or historic earthquake/event;
|
||||
Legend = scale of the delay;
|
||||
Status = connection status.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The visualized QC parameters can be selected in the QC parameters widget of scmv.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
QC parameters selection widget.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The station information widget opens by right mouse click on a station symbol
|
||||
in one of the scmv maps. The widget gives a more detailed list of parameters.
|
||||
For a station general information (coordinates, network code etc.), quality
|
||||
parameter (latency, gaps etc.), amplitude information and the actual waveform
|
||||
data are provided. For an event information like the location, the number of
|
||||
stations and the azimuthal gap are shown.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Station information widget.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The info widget of a station shows station information like network code
|
||||
and location. The quality of the station can be checked here. The lower
|
||||
part shows the last 15 minutes of waveforms including picks (if available).
|
||||
.SS Event information
|
||||
.sp
|
||||
In addition to the current event scmv also shows all events it has currently
|
||||
saved in its session as circles. This depends on the configured time span it remembers
|
||||
events. Showing the events can give a convenient overview of the network activity.
|
||||
If available focal mechanisms are displayed with dashed lines connecting to their location.
|
||||
The circles and focal mechanisms are again colored by their depth and sized by
|
||||
magnitude.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Show historic origins
|
||||
All historic origins currently saved in scmv are shown as circles.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The events shown an the map can be confined by selecting the mode and the status
|
||||
of preferred origins in the event selection widget.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Event selection widget.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The event information widget opens by right mouse click on an event symbol.
|
||||
It shows event details.
|
||||
Clicking on the \(dqShow Details\(dq button allows to open the preferred origin of
|
||||
the event in other GUIs such as in scolv.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Event information widget.UNINDENT
|
||||
.UNINDENT
|
||||
.SH HOTKEYS
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Hotkey
|
||||
T} T{
|
||||
Description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF2\fP
|
||||
T} T{
|
||||
Setup connection dialog
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF3\fP
|
||||
T} T{
|
||||
Toggle ray paths and associated stations
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF6\fP
|
||||
T} T{
|
||||
Hide propagation of P and S waves
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF7\fP
|
||||
T} T{
|
||||
Toggle legend
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF8\fP
|
||||
T} T{
|
||||
Toggle historic origins
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF9\fP
|
||||
T} T{
|
||||
Toggle station annotation
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF10\fP
|
||||
T} T{
|
||||
Toggle event list (event tab)
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBF11\fP
|
||||
T} T{
|
||||
Toggle full screen mode
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBCTRL + f\fP
|
||||
T} T{
|
||||
Seach station
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\fBArrows\fP
|
||||
T} T{
|
||||
Move focus
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Mouse wheel
|
||||
T} T{
|
||||
Zoom in or out
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Double click
|
||||
T} T{
|
||||
Center map
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Right mouse button
|
||||
T} T{
|
||||
Open info widget
|
||||
T}
|
||||
_
|
||||
T{
|
||||
Mid mouse button
|
||||
T} T{
|
||||
Set preliminary origin
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.SH USE CASES
|
||||
.SS Get station information
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Position the mouse above a triangle representing a station.
|
||||
.IP \(bu 2
|
||||
Click the right mouse button for opening the station info widget.
|
||||
.IP \(bu 2
|
||||
Choose one station in case several stations are in the selection range.
|
||||
.UNINDENT
|
||||
.SS Get event information
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Position the mouse above a circle representing a location of an event.
|
||||
.IP \(bu 2
|
||||
Click the right mouse button for opening the event info widget.
|
||||
.IP \(bu 2
|
||||
Choose one event in case several events are in the selection range.
|
||||
.UNINDENT
|
||||
.SS Set preliminary origin
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Position the mouse in the map
|
||||
.IP \(bu 2
|
||||
Press the middle mouse button
|
||||
.IP \(bu 2
|
||||
Set date & time and latitude, longitude & depth
|
||||
.IP \(bu 2
|
||||
Press \(dqCreate\(dq to open the origin in another GUI, e.g. scolv.
|
||||
[image]
|
||||
.UNINDENT
|
||||
.SS Search station/network
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Press \fBCTRL + f\fP
|
||||
.IP \(bu 2
|
||||
Type station/network name
|
||||
.IP \(bu 2
|
||||
Double click in a station in the list to center the map at this location
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scmv.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scmv.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scmv.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scmv inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B displaymode
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Start scmv in one of the available display modes:
|
||||
.sp
|
||||
groundmotion or qualitycontrol
|
||||
.sp
|
||||
and without tabs and menus as walldisplay.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B groundMotionRecordLifeSpan
|
||||
Default: \fB300\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Set the maximum latency in seconds of the ground motion records
|
||||
to be valid.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B removeEventDataOlderThan
|
||||
Default: \fB43200\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Set the time span in seconds to keep events.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B readEventsNotOlderThan
|
||||
Default: \fB0\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Set the time span in seconds to read events initially from
|
||||
database.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B centerOrigins
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If a new origin/event is set/selected this option defines if the
|
||||
map is centered or not at the origin location.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B eventActivityLifeSpan
|
||||
Default: \fB900\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Time span of which an event is active after origin time to
|
||||
show blinking associated stations.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B expiredEventsInterval
|
||||
Default: \fB0\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
A positive value (greater than zero) defines the interval to check
|
||||
for expired events. A negative or zero value disables the interval
|
||||
check and expired events are only removed when a new event is declared
|
||||
or an existing event is updated.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B annotations
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enable/disable drawing of station annotations at startup.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B annotationsWithChannels
|
||||
Default: \fBtrue\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Enable/disable drawing of station annotations with
|
||||
location/channel codes.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B mapLegendPosition
|
||||
Default: \fBtopleft\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Set the location of the map symbol legend (QC, ground motion).
|
||||
Use either: topleft, topright, bottomright or bottomleft.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B eventLegendPosition
|
||||
Default: \fBbottomleft\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Set the location of the event symbol legend. Use either:
|
||||
topleft, topright, bottomright or bottomleft.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B eventTable.visible
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Whether to show the event table initially or not.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B eventTable.columns
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
The columns that are visible in the table. If nothing
|
||||
is specified then all columns are visible. Valid column names are:
|
||||
\(dqEvent\(dq, \(dqOrigin Time\(dq, \(dqMagnitude\(dq,
|
||||
\(dqMagnitude Type\(dq, \(dqRegion\(dq, \(dqLatitude\(dq,
|
||||
\(dqLongitude\(dq, \(dqDepth\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B stations.groundMotionFilter
|
||||
Default: \fB\(dqRMHP(50)>>ITAPER(20)>>BW(2,0.04,2)\(dq\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The filter applied to waveforms for measuring ground motion.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBdisplay.*\fP
|
||||
\fIAllow to define an initial rectangular region for the map.\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.latmin
|
||||
Default: \fB\-90\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
Minimum latitude in degrees.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.lonmin
|
||||
Default: \fB\-180\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
Minimum longitude in degrees.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.latmax
|
||||
Default: \fB90\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
Maximum latitude in degrees.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B display.lonmax
|
||||
Default: \fB180\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
Maximum longitude in degrees.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscmv [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 Cities
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-city\-xml arg
|
||||
The path to the cities XML file. This overrides the default
|
||||
paths. Compare with the global parameter \(dqcitiesXML\(dq.
|
||||
.UNINDENT
|
||||
.SS User interface
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-F, \-\-full\-screen
|
||||
Start the application filling the entire screen.
|
||||
This only works with GUI applications.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-N, \-\-non\-interactive
|
||||
Use non\-interactive presentation mode. This only works with
|
||||
GUI applications.
|
||||
.UNINDENT
|
||||
.SS Mapview
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-displaymode arg
|
||||
Start scmv as walldisplay.
|
||||
Modes: groundmotion, qualitycontrol
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-with\-legend
|
||||
Show the map legend if started as walldisplay.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
4148
share/man/man1/scolv.1
Normal file
4148
share/man/man1/scolv.1
Normal file
File diff suppressed because it is too large
Load Diff
253
share/man/man1/scorgls.1
Normal file
253
share/man/man1/scorgls.1
Normal file
@ -0,0 +1,253 @@
|
||||
.\" 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 "SCORGLS" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scorgls \- SeisComP Documentation
|
||||
.sp
|
||||
\fBList origin IDs from database.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
\fIscorgls\fP lists all available origin IDs within a given time range to stdout.
|
||||
Origins are fetched from database or read from a \fI\%SCML\fP file.
|
||||
.sp
|
||||
Similarly, use \fI\%scevtls\fP for listing all event IDs. In extension to
|
||||
\fIscorgls\fP and \fI\%scevtls\fP \fI\%scquery\fP can search for parameters based on
|
||||
complex custom queries.
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Print all origin IDs for the complete year 2012.
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scorgls \-d mysql://sysop:sysop@localhost/seiscomp \e
|
||||
\-\-begin \(dq2012\-01\-01 00:00:00\(dq \e
|
||||
\-\-end \(dq2013\-01\-01 00:00:00\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Print the IDs of all origins provided with the XML file:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scevtls \-i origins.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scorgls.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scorgls.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scorgls.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scorgls inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscorgls [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 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 Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-input arg
|
||||
Name of input XML file. Read from stdin if \(aq\-\(aq is given.
|
||||
Deactivates reading origins from database.
|
||||
.UNINDENT
|
||||
.SS Origins
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-begin time
|
||||
The lower bound of the time interval. Format:
|
||||
012\-01\-01T00:00:00.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-end time
|
||||
The upper bound of the time interval. Format:
|
||||
2012\-01\-01T00:00:00.
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-D, \-\-delimiter string
|
||||
The delimiter of the resulting origin IDs.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
2188
share/man/man1/scqc.1
Normal file
2188
share/man/man1/scqc.1
Normal file
File diff suppressed because it is too large
Load Diff
3247
share/man/man1/scqcv.1
Normal file
3247
share/man/man1/scqcv.1
Normal file
File diff suppressed because it is too large
Load Diff
399
share/man/man1/scquery.1
Normal file
399
share/man/man1/scquery.1
Normal file
@ -0,0 +1,399 @@
|
||||
.\" 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 "SCQUERY" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scquery \- SeisComP Documentation
|
||||
.sp
|
||||
\fBRead database objects and writes them to the command line.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
\fIscquery\fP reads objects such as event information from a
|
||||
\fI\%SeisComP database\fP using custom queries. The results
|
||||
are written to stdout. The module extends \fI\%scevtls\fP and \fI\%scorgls\fP
|
||||
which are limited to searching event and origin IDs, respectively, by time.
|
||||
.sp
|
||||
scquery takes into account and requires \fI\%query profiles\fP
|
||||
for querying the database. The profiles are defined in
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fB@SYSTEMCONFIGDIR@/queries.cfg\fP or
|
||||
.IP \(bu 2
|
||||
\fB@CONFIGDIR@/queries.cfg\fP
|
||||
.UNINDENT
|
||||
.sp
|
||||
while parameters in the latter take priority. The are no default query profile,
|
||||
hence they must be created first.
|
||||
.SH MODULE SETUP
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Create the query profiles in \fBqueries.cfg\fP in \fB@SYSTEMCONFIGDIR@\fP
|
||||
or \fB@CONFIGDIR@\fP\&. The file contains your database queries. Examples for
|
||||
MariaDB/MySQL and PostgreSQL are found in the section \fI\%Queries\fP\&.
|
||||
.IP 2. 3
|
||||
\fBOptional:\fP Add the database connection parameter to the configuration file
|
||||
\fBscquery.cfg\fP or \fBglobal.cfg\fP in @CONFIGDIR@ or to @SYSTEMCONFIGDIR@:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
database = mysql://sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
If the database connection is configured, the database option
|
||||
\fI\%\-d\fP in the section \fI\%Examples\fP
|
||||
can be omitted or used to override the configuration.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.sp
|
||||
Choose any query profile defined in the \fI\%queries.cfg\fP\&.
|
||||
Provide the required parameters in the same order as in the database request.
|
||||
The required parameters are indicated by hashes, e.g. ##latMin##.
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
List all available query profiles using the command\-line option
|
||||
\fBshowqueries\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scquery \-\-showqueries
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Profile \fBevent_filter\fP: Fetch all event IDs and event parameters for events
|
||||
with magnitude ranging from 2.5 to 5 in central Germany between 2014 and 2017:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scquery \-d localhost/seiscomp eventFilter 50 52 11.5 12.5 2.5 5 2014\-01\-01 2018\-01\-01 > events_vogtland.txt
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Profile \fBeventByAuthor\fP: Fetch all event IDs where the preferred origin was
|
||||
provided by a specific author for events 2.5 to 5 with 6 to 20 phases in central
|
||||
Germany between 2014 and 2017:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scquery \-d localhost/seiscomp eventByAuthor 50 52 11.5 12.5 6 20 2.5 5 2014\-01\-01 2018\-01\-01 scautoloc > events_vogtland.txt
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 4. 3
|
||||
Profile \fBeventType\fP: Fetch all event IDs and event times from events
|
||||
with the given event type and within the provided time interval:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scquery \-d localhost/seiscomp eventType explosion \(aq2017\-11\-01 00:00:00\(aq \(aq2018\-11\-01 00:00:00\(aq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH QUERIES
|
||||
.sp
|
||||
Example queries for \fI\%MariaDB/MySQL\fP and \fI\%PostgreSQL\fP are given
|
||||
below.
|
||||
.SS MariaDB/MySQL
|
||||
.sp
|
||||
\fBGeneral event/origin queries\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
queries = eventFilter, eventUncertainty, eventByAuthor, eventWithStationCount, eventType, originByAuthor
|
||||
|
||||
query.eventFilter.description = \(dqReturns all events (lat, lon, mag, time) that fall into a certain region and a magnitude range\(dq
|
||||
query.eventFilter = \(dqSELECT PEvent.publicID, Origin.time_value AS OT, Origin.latitude_value,Origin.longitude_value, Origin.depth_value, Magnitude.magnitude_value, Magnitude.type FROM Origin,PublicObject as POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject as PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID=Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.eventUncertainty.description = \(dqReturns all events (eventsIDs, time, lat, lat error, lon, lon error, depth, depth error, magnitude, region name) in the form of an event catalog\(dq
|
||||
query.eventUncertainty = \(dqSELECT PEvent.publicID, Origin.time_value AS OT, ROUND(Origin.latitude_value, 3), ROUND(Origin.latitude_uncertainty, 3), ROUND(Origin.longitude_value, 3), ROUND(Origin.longitude_uncertainty, 3), ROUND(Origin.depth_value, 3), ROUND(Origin.depth_uncertainty, 3), ROUND(Magnitude.magnitude_value, 1), EventDescription.text FROM Event, PublicObject AS PEvent, EventDescription, Origin, PublicObject AS POrigin, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND Event.preferredOriginID = POrigin.publicID AND Event.preferredMagnitudeID = PMagnitude.publicID AND Event._oid = EventDescription._parent_oid AND EventDescription.type = \(aqregion name\(aq AND Event.type = \(aq##type##\(aq AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.eventByAuthor.description = \(dqGet events by preferred origin author etc\(dq
|
||||
query.eventByAuthor = \(dqSELECT PEvent.publicID, Origin.time_value AS OT, Origin.latitude_value AS lat,Origin.longitude_value AS lon, Origin.depth_value AS dep, Magnitude.magnitude_value AS mag, Magnitude.type AS mtype, Origin.quality_usedPhaseCount AS phases, Event.type AS type, Event.typeCertainty AS certainty, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Origin.quality_usedPhaseCount >= ##minPhases## AND Origin.quality_usedPhaseCount <= ##maxPhases## AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq AND Origin.creationInfo_author like \(aq##author##\(aq;\(dq
|
||||
|
||||
query.eventWithStationCount.description = \(dqGet events by preferred origin author etc\(dq
|
||||
query.eventWithStationCount = \(dqSELECT PEvent.publicID, Origin.time_value AS OT, Origin.latitude_value AS lat, Origin.longitude_value AS lon, Origin.depth_value AS dep, Magnitude.magnitude_value AS mag, Magnitude.type AS mtype, Origin.quality_usedStationCount AS stations, Event.type AS type, Event.typeCertainty AS certainty, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.eventType.description = \(dqReturns all eventIDs FROM event WHERE the type is flagged AS \(aqevent type\(aq\(dq
|
||||
query.eventType = \(dqSELECT pe.publicID, o.time_value AS OT FROM PublicObject pe, PublicObject po, Event e, Origin o WHERE pe._oid = e._oid AND po._oid = o._oid AND e.preferredOriginID = po.publicID AND e.type = \(aq##type##\(aq AND o.time_value >= \(aq##startTime##\(aq AND o.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.originByAuthor.description = \(dqGet origins by author\(dq
|
||||
query.originByAuthor = \(dqSELECT po.publicID, o.time_value AS OT, o.creationInfo_author FROM PublicObject po JOIN Origin o ON po._oid = o._oid WHERE o.creationInfo_author like \(aq##author##\(aq AND o.time_value >= \(aq##startTime##\(aq AND o.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBMore examples and statistics\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
queries = phaseCountPerAuthor, time, mag_time, space_time, all, space_mag_time, event, fm_space_time, picks, stationPicks, assoc_picks, pref_assoc_picks, sta_net_mag, sta_net_mag_type, delta_sta_net_mag, delta_sta_net_mag_type
|
||||
|
||||
query.phaseCountPerAuthor.description = \(dqGet phase count per origin author FROM event #EventID#\(dq
|
||||
query.phaseCountPerAuthor = \(dqSELECT PEvent.publicID, Origin.creationInfo_author, MAX(Origin.quality_usedPhaseCount) FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, OriginReference WHERE Origin._oid = POrigin._oid AND Event._oid = PEvent._oid AND OriginReference._parent_oid = Event._oid AND OriginReference.originID = POrigin.publicID AND PEvent.publicID = \(aq##EventID##\(aq group by Origin.creationInfo_author;\(dq
|
||||
|
||||
query.time.description = \(dqEvents in time range\(dq
|
||||
query.time = \(dqSELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.mag_time.description = \(dqEvents in magnitude\-time range\(dq
|
||||
query.mag_time = \(dqSELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.space_time.description = \(dqEvents in space\-time range\(dq
|
||||
query.space_time = \(dqSELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.all.description = \(dqEvents in space\-magnitude\-time\-quality range by author\(dq
|
||||
query.all = \(dqSELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Origin.quality_usedPhaseCount >= ##minPhases## AND Origin.quality_usedPhaseCount <= ##maxPhases## AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq AND Origin.creationInfo_author like \(aq##author##%\(aq;\(dq
|
||||
|
||||
query.space_mag_time.description = \(dqEvents in space\-magnitude\-time range\(dq
|
||||
query.space_mag_time = \(dqSELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, Origin.quality_usedPhaseCount, Origin.quality_usedStationCount, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Magnitude.magnitude_value >= ##minMag## AND Magnitude.magnitude_value <= ##maxMag## AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.fm_space_time.description = \(dqEvents with focal mechanisms in space\-time range\(dq
|
||||
query.fm_space_time = \(dqSELECT PEvent.publicID, Origin.time_value, ROUND(Origin.latitude_value, 4), ROUND(Origin.longitude_value, 4), ROUND(Origin.depth_value, 1), ROUND(Magnitude.magnitude_value, 1), Magnitude.type, MomentTensor.doubleCouple, MomentTensor.variance, Event.typeCertainty, Event.type, Origin.creationInfo_author FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude, FocalMechanism, PublicObject AS PFocalMechanism, MomentTensor WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.publicID = Event.preferredMagnitudeID AND FocalMechanism._oid = PFocalMechanism._oid AND PFocalMechanism.publicID = Event.preferredFocalMechanismID AND MomentTensor._parent_oid = FocalMechanism._oid AND POrigin.publicID = Event.preferredOriginID AND Origin.latitude_value >= ##latMin## AND Origin.latitude_value <= ##latMax## AND Origin.longitude_value >= ##lonMin## AND Origin.longitude_value <= ##lonMax## AND Origin.time_value >= \(aq##startTime##\(aq AND Origin.time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.event.description = \(dqList authors and number of origins for event\(dq
|
||||
query.event = \(dqSELECT PEvent.publicID, Origin.creationInfo_author, MAX(Origin.quality_usedPhaseCount) FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, OriginReference WHERE Origin._oid = POrigin._oid AND Event._oid = PEvent._oid AND OriginReference._parent_oid = Event._oid AND OriginReference.originID = POrigin.publicID AND PEvent.publicID = \(aq##EventID##\(aq group by Origin.creationInfo_author;\(dq
|
||||
|
||||
query.picks.description = \(dqList number of picks per station in a certain timespan\(dq
|
||||
query.picks = \(dqSELECT waveformID_networkCode AS Network, waveformID_stationCode AS Station, COUNT(_oid) AS Picks, MIN(time_value) AS Start, MAX(time_value) AS End FROM Pick WHERE time_value >= \(aq##startTime##\(aq AND time_value <= \(aq##endTime##\(aq GROUP BY waveformID_networkCode, waveformID_stationCode;\(dq
|
||||
|
||||
query.stationPicks.description = \(dqList the picks and phase hints per station in a certain timespan\(dq
|
||||
query.stationPicks = \(dqSELECT PPick.publicID, Pick.phaseHint_code FROM Pick, PublicObject AS PPick WHERE Pick._oid = PPick._oid AND waveformID_networkCode = \(aq##netCode##\(aq AND waveformID_stationCode = \(aq##staCode##\(aq AND time_value >= \(aq##startTime##\(aq AND time_value <= \(aq##endTime##\(aq;\(dq
|
||||
|
||||
query.assoc_picks.description = \(dqList number of associated picks per station in a certain time span\(dq
|
||||
query.assoc_picks = \(dqSELECT Pick.waveformID_networkCode AS Network, Pick.waveformID_stationCode AS Station, COUNT(DISTINCT(Pick._oid)) AS Picks, MIN(Pick.time_value) AS Start, MAX(Pick.time_value) AS End FROM Pick, PublicObject PPick, Arrival WHERE Pick._oid = PPick._oid AND PPick.publicID = Arrival.pickID AND Pick.time_value >= \(aq##startTime##\(aq AND Pick.time_value <= \(aq##endTime##\(aq GROUP BY Pick.waveformID_networkCode, Pick.waveformID_stationCode;\(dq
|
||||
|
||||
query.pref_assoc_picks.description = \(dqList number of associated picks of preferred origins per station for certain time span\(dq
|
||||
query.pref_assoc_picks = \(dqSELECT Pick.waveformID_networkCode AS Network, Pick.waveformID_stationCode AS Station, COUNT(DISTINCT(Pick._oid)) AS Picks, MIN(Pick.time_value) AS Start, MAX(Pick.time_value) AS End FROM Pick, PublicObject PPick, Arrival, Origin, PublicObject POrigin, Event WHERE Event.preferredOriginID = POrigin.publicID AND Origin._oid = POrigin._oid AND Origin._oid = Arrival._parent_oid AND Pick._oid = PPick._oid AND PPick.publicID = Arrival.pickID AND Pick.time_value >= \(aq##startTime##\(aq AND Pick.time_value <= \(aq##endTime##\(aq GROUP BY Pick.waveformID_networkCode, Pick.waveformID_stationCode;\(dq
|
||||
|
||||
query.sta_net_mag.description = \(dqCompares station magnitudes of a particular station with the network magnitude in a certain time span\(dq
|
||||
query.sta_net_mag = \(dqSELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, StationMagnitude.magnitude_value AS StaMag, Magnitude.magnitude_value AS NetMag, Magnitude.type AS NetMagType, StationMagnitude.creationInfo_creationTime AS CreationTime FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oid AND StationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicID AND StationMagnitudeContribution._parent_oid = Magnitude._oid AND StationMagnitude.waveformID_networkCode = \(aq##netCode##\(aq AND StationMagnitude.waveformID_stationCode = \(aq##staCode##\(aq AND StationMagnitude.creationInfo_creationTime >= \(aq##startTime##\(aq AND StationMagnitude.creationInfo_creationTime <= \(aq##endTime##\(aq ORDER BY StationMagnitude.creationInfo_creationTime;\(dq
|
||||
|
||||
query.sta_net_mag_type.description = \(dqCompares station magnitudes of a particular station with the network magnitude of specific type in a certain time span\(dq
|
||||
query.sta_net_mag_type = \(dqSELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, StationMagnitude.magnitude_value AS StaMag, Magnitude.magnitude_value AS NetMag, Magnitude.type AS NetMagType, StationMagnitude.creationInfo_creationTime AS CreationTime FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oid AND StationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicID AND StationMagnitudeContribution._parent_oid = Magnitude._oid AND StationMagnitude.waveformID_networkCode = \(aq##netCode##\(aq AND StationMagnitude.waveformID_stationCode = \(aq##staCode##\(aq AND StationMagnitude.creationInfo_creationTime >= \(aq##startTime##\(aq AND StationMagnitude.creationInfo_creationTime <= \(aq##endTime##\(aq AND Magnitude.type = \(aq##magType##\(aq ORDER BY StationMagnitude.creationInfo_creationTime;\(dq
|
||||
|
||||
query.delta_sta_net_mag.description = \(dqCalculates delta values of station and network magnitudes for all stations in a certain time span\(dq
|
||||
query.delta_sta_net_mag = \(dqSELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, AVG(StationMagnitude.magnitude_value \- Magnitude.magnitude_value) AS DeltaAvg, MIN(StationMagnitude.magnitude_value \- Magnitude.magnitude_value) AS DeltaMin, MAX(StationMagnitude.magnitude_value \- Magnitude.magnitude_value) AS DeltaMax, MIN(StationMagnitude.creationInfo_creationTime) AS Start, MAX(StationMagnitude.creationInfo_creationTime) AS End FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oidStationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicIDStationMagnitudeContribution._parent_oid = Magnitude._oidStationMagnitude.creationInfo_creationTime >= \(aq##startTime##\(aqStationMagnitude.creationInfo_creationTime <= \(aq##endTime##\(aq GROUP BY StationMagnitude.waveformID_networkCode, StationMagnitude.waveformID_stationCode;\(dq
|
||||
|
||||
query.delta_sta_net_mag_type.description = \(dqCalculates delta values of station and network magnitudes for all stations and all magnitude types in a certain time span\(dq
|
||||
query.delta_sta_net_mag_type = \(dqSELECT StationMagnitude.waveformID_networkCode AS Network, StationMagnitude.waveformID_stationCode AS Station, AVG(StationMagnitude.magnitude_value \- Magnitude.magnitude_value) AS DeltaAvg, MIN(StationMagnitude.magnitude_value \- Magnitude.magnitude_value) AS DeltaMin, MAX(StationMagnitude.magnitude_value \- Magnitude.magnitude_value) AS DeltaMax, Magnitude.type AS NetMagType, MIN(StationMagnitude.creationInfo_creationTime) AS Start, MAX(StationMagnitude.creationInfo_creationTime) AS End FROM StationMagnitude, PublicObject PStationMagnitude, StationMagnitudeContribution, Magnitude WHERE StationMagnitude._oid = PStationMagnitude._oid AND StationMagnitudeContribution.stationMagnitudeID = PStationMagnitude.publicID AND StationMagnitudeContribution._parent_oid = Magnitude._oid AND StationMagnitude.creationInfo_creationTime >= \(aq##startTime##\(aq AND StationMagnitude.creationInfo_creationTime <= \(aq##endTime##\(aq GROUP BY StationMagnitude.waveformID_networkCode, StationMagnitude.waveformID_stationCode, Magnitude.type;\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS PostgreSQL
|
||||
.sp
|
||||
In contrast to queries for objects in \fI\%MariaDB/MySQL\fP the
|
||||
string \fBm_\fP must be added to the value and publicID database columns as shown
|
||||
below for the query \(dqeventFilter\(dq.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
queries = eventFilter
|
||||
|
||||
query.eventFilter.description = \(dqReturns all events (lat, lon, mag, time) that fall into a certain region and a magnitude range\(dq
|
||||
query.eventFilter = \(dqSELECT PEvent.m_publicID, Origin.m_time_value AS OT, Origin.m_latitude_value, Origin.m_longitude_value, Origin.m_depth_value, Magnitude.m_magnitude_value, Magnitude.m_type FROM Origin, PublicObject AS POrigin, Event, PublicObject AS PEvent, Magnitude, PublicObject AS PMagnitude WHERE Event._oid = PEvent._oid AND Origin._oid = POrigin._oid AND Magnitude._oid = PMagnitude._oid AND PMagnitude.m_publicID = Event.m_preferredMagnitudeID AND POrigin.m_publicID = Event.m_preferredOriginID AND Origin.m_latitude_value >= ##latMin## AND Origin.m_latitude_value <= ##latMax## AND Origin.m_longitude_value >= ##lonMin## AND Origin.m_longitude_value <= ##lonMax## AND Magnitude.m_magnitude_value >= ##minMag## AND Magnitude.m_magnitude_value <= ##maxMag## AND Origin.m_time_value >= \(aq##startTime##\(aq AND Origin.m_time_value <= \(aq##endTime##\(aq;\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scquery.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scquery.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scquery.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scquery inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscquery [OPTIONS] [query name] [query parameters]\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
|
||||
.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 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
|
||||
.SS Commands
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-showqueries
|
||||
Show the queries defined in queries.cfg.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-delimiter arg
|
||||
Column delimiter. If found, this character will be escaped
|
||||
in output values. Default: \(aq|\(aq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-print\-column\-name
|
||||
Print the name of each output column in a header.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-print\-header
|
||||
Print the query parameters and the query filter description
|
||||
as a header of the query output.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-print\-query\-only
|
||||
Only print the full query to stdout and then quit.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-Q, \-\-query arg
|
||||
Execute the given query instead of applying queries
|
||||
pre\-defined by configuration.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
315
share/man/man1/scqueryqc.1
Normal file
315
share/man/man1/scqueryqc.1
Normal file
@ -0,0 +1,315 @@
|
||||
.\" 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 "SCQUERYQC" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scqueryqc \- SeisComP Documentation
|
||||
.sp
|
||||
\fBQuery waveform quality control (QC) parameters from database.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scqueryqc queries a database for waveform quality control (QC) parameters. The
|
||||
QC parameters can be provided and written to the database, e.g., by \fI\%scqc\fP\&.
|
||||
.sp
|
||||
\fBWARNING:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Writing QC parameters to the database by \fI\%scqc\fP will result in a rapidly
|
||||
growing database and is therefore not recommended in permanent application without
|
||||
regularly stripping these parameters from the database!
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The database query is done for
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
One or multiple streams,
|
||||
.IP \(bu 2
|
||||
One or multiple QC parameters. All QC parameters can be requested. Defaults
|
||||
apply. For reading the defaults use
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scqueryqc \-h
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
A single time window where the begin time must be provided. Current time is
|
||||
considered if the end is not give.
|
||||
.UNINDENT
|
||||
.SS Workflow
|
||||
.sp
|
||||
You should minimize the impact of stored waveform QC parameters on the size of the
|
||||
database.
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Compute the QC parameters in real time using \fI\%scqc\fP and save them in the
|
||||
\fISeisComP\fP database. Saving the QC parameters in the database requires to
|
||||
adjust the scqc module configuration parameters
|
||||
\fBplugins.$name.archive.interval\fP for each plugin.
|
||||
.IP 2. 3
|
||||
Regularly use scqueryqc for some time span to read the QC parameters from the
|
||||
database. Save them in a XML files.
|
||||
.sp
|
||||
Example for all QC parameters found for all streams in the inventory before
|
||||
end time:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scqueryqc \-d [host] \-e \(aq[end time]\(aq \-\-streams\-from\-inventory \-o [XML file]
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Clean the database from QC parameters.
|
||||
.INDENT 3.0
|
||||
.IP \(bu 2
|
||||
Either use \fI\%scdispatch\fP with the parameters saved in XML. You may need
|
||||
to set the routing table for sending the QualityControl parameters to the
|
||||
right message group, e.g., QC:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdispatch \-H [host] \-O remove \-\-routingtable QualityControl:QC \-i [XML file]
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Alternatively, use \fI\%scdbstrip\fP with the command\-line option
|
||||
\fB\-\-qc\-only\fP and remove \fBall\fP QC parameters in the time span. Use the same
|
||||
period for which the QC parameters were retrieved:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scdbstrip \-d [database] \-Q \-\-date\-time \(aq[end time]\(aq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
Considering an end time by \fB\-\-date\-time\fP has the advantage that no QC
|
||||
parameters are removed which were measured after scqueryqc was applied with the
|
||||
same end time value.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Examples
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Query rms and delay values for the stream AU.AS18..SHZ,AU.AS19..SHZ before
|
||||
\(aq2021\-11\-20 00:00:00\(aq. Write the XML to stdout
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scqueryqc \-d localhost \-e \(aq2021\-11\-20 00:00:00\(aq \-p rms,delay \-i AU.AS18..SHZ,AU.AS19..SHZ
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Query all default QC parameter values for all streams found in the inventory
|
||||
from \(aq2021\-11\-20 00:00:00\(aq until current. Write the formatted XML output to
|
||||
\fB/tmp/query.xml\fP
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scqueryqc \-d localhost \-b \(aq2021\-11\-20 00:00:00\(aq \-\-streams\-from\-inventory \-f \-o /tmp/query.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scqueryqc.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scqueryqc.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scqueryqc.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scqueryqc inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscqueryqc [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
|
||||
.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 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 \-\-inventory\-db arg
|
||||
Load the inventory from the given database or file, format:
|
||||
[\fI\%service://]location\fP .
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output filename
|
||||
Name of output XML file. Objects are sent to stderr if none
|
||||
is given.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-formatted
|
||||
Write formatted XML.
|
||||
.UNINDENT
|
||||
.SS Query
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-b, \-\-begin time
|
||||
Begin time of query. Format: \(aqYYYY\-MM\-DD hh:mm:ss\(aq.
|
||||
\(aq1900\-01\-01T00:00:00Z\(aq is considered if undefined.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-e, \-\-end time
|
||||
End time of query. Format: \(aqYYYY\-MM\-DD hh:mm:ss\(aq.
|
||||
Current time is considered if undefined.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-stream\-id string
|
||||
Waveform stream ID to search for QC parameters: net.sta.loc.cha \-
|
||||
[networkCode].[stationCode].[sensorLocationCode].[channelCode].
|
||||
Provide a single ID or a comma\-separated list. Overrides
|
||||
\(aq\-\-streams\-from\-inventory\(aq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-p, \-\-parameter string
|
||||
QC parameter to output: (e.g. delay,rms,\(aqgaps count\(aq ...).
|
||||
Use quotes if QC parameter has more than 1 word.
|
||||
Provide a single parameter or a comma\-separated list.
|
||||
Defaults are used if parameter is undefined.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-streams\-from\-inventory
|
||||
Read streams from inventory. Superseded by \(aq\-\-stream\-id\(aq.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
528
share/man/man1/screloc.1
Normal file
528
share/man/man1/screloc.1
Normal file
@ -0,0 +1,528 @@
|
||||
.\" 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 "SCRELOC" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
screloc \- SeisComP Documentation
|
||||
.sp
|
||||
\fBAutomatic relocator.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
screloc is an automatic relocator that receives origins from realtime
|
||||
locators such as scautoloc and relocates them with a configurable locator.
|
||||
screloc can be conveniently used to test different locators and velocity models
|
||||
or to relocate events with updated velocity models. Check the
|
||||
\fI\%Example applications\fP for screloc.
|
||||
.sp
|
||||
screloc processes any incoming automatic origin but does not yet listen to event
|
||||
information nor does it skip origins for that a more recent one exists.
|
||||
.sp
|
||||
To run screloc along with all processing modules add it to the list of
|
||||
clients in the seiscomp configuration frontend.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp enable screloc
|
||||
seiscomp start screloc
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Descriptions of parameters for screloc:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp exec screloc \-h
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Test the performance of screloc and learn from debug output:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp exec screloc \-\-debug
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SETUP
|
||||
.sp
|
||||
The following example configuration shows a setup of screloc for
|
||||
\fI\%NonLinLoc\fP:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
plugins = ${plugins}, locnll
|
||||
|
||||
# Define the locator algorithm to use
|
||||
reloc.locator = NonLinLoc
|
||||
|
||||
# Define a suffix appended to the publicID of the origin to be relocated
|
||||
# to form the new publicID.
|
||||
# This helps to identify pairs of origins before and after relocation.
|
||||
# However, new publicIDs are unrelated to the time of creation.
|
||||
# If not defined, a new publicID will be generated automatically.
|
||||
reloc.originIDSuffix = \(dq#relocated\(dq
|
||||
|
||||
########################################################
|
||||
################ NonLinLoc configuration################
|
||||
########################################################
|
||||
NLLROOT = ${HOME}/nll/data
|
||||
|
||||
NonLinLoc.outputPath = ${NLLROOT}/output/
|
||||
|
||||
# Define the default control file if no profile specific
|
||||
# control file is defined.
|
||||
NonLinLoc.controlFile = ${NLLROOT}/NLL.default.conf
|
||||
|
||||
# Set the default pick error in seconds passed to NonLinLoc
|
||||
# if no SeisComP pick uncertainty is available.
|
||||
NonLinLoc.defaultPickError = 0.1
|
||||
|
||||
# Define the available NonLinLoc location profiles. The order
|
||||
# implicitly defines the priority for overlapping regions
|
||||
#NonLinLoc.profiles = swiss_3d, swiss_1d, global
|
||||
NonLinLoc.profiles = swiss_3d, global
|
||||
|
||||
# The earthModelID is copied to earthModelID attribute of the
|
||||
# resulting origin
|
||||
NonLinLoc.profile.swiss_1d.earthModelID = \(dqswiss regional 1D\(dq
|
||||
|
||||
# Specify the velocity model table path as used by NonLinLoc
|
||||
NonLinLoc.profile.swiss_1d.tablePath = ${NLLROOT}/time_1d_regio/regio
|
||||
|
||||
# Specify the region valid for this profile
|
||||
NonLinLoc.profile.swiss_1d.region = 41.2, 3.8, 50.1, 16.8
|
||||
|
||||
# The NonLinLoc default control file to use for this profile
|
||||
NonLinLoc.profile.swiss_1d.controlFile = ${NLLROOT}/NLL.swiss_1d.conf
|
||||
|
||||
# Configure the swiss_3d profile
|
||||
NonLinLoc.profile.swiss_3d.earthModelID = \(dqswiss regional 3D\(dq
|
||||
NonLinLoc.profile.swiss_3d.tablePath = ${NLLROOT}/time_3d/ch
|
||||
NonLinLoc.profile.swiss_3d.region = 45.15, 5.7, 48.3, 11.0
|
||||
NonLinLoc.profile.swiss_3d.controlFile = ${NLLROOT}/NLL.swiss_3d.conf
|
||||
|
||||
# And the global profile
|
||||
NonLinLoc.profile.global.earthModelID = iaspei91
|
||||
NonLinLoc.profile.global.tablePath = ${NLLROOT}/iasp91/iasp91
|
||||
NonLinLoc.profile.global.controlFile = ${NLLROOT}/NLL.global.conf
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Run screloc to with a specific velocity model given in a profile by \fI\%NonLinLoc\fP\&.
|
||||
Use a specific userID and authorID for uniquely recognizing the relocation.
|
||||
Changing the priority in \fI\%scevent\fP before running the example, e.g. to
|
||||
TIME_AUTOMATIC, sets the latest origin (which will be created by screloc) to preferred.
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
# set specific velocity profile defined for NonLinLoc
|
||||
profile=<your_profile>
|
||||
# set userID
|
||||
userID=\(dq<your_user>\(dq
|
||||
# set authorID
|
||||
authorID=\(dq<screloc>\(dq
|
||||
|
||||
for i in \(gascevtls \-d mysql://sysop:sysop@localhost/seiscomp \-\-begin \(aq2015\-01\-01 00:00:00\(aq \-\-end \(aq2015\-02\-01 00:00:00\(aq\(ga; do
|
||||
|
||||
orgID=\(gaecho \(dqselect preferredOriginID from Event,PublicObject where Event._oid=PublicObject._oid and PublicObject.publicID=\(aq$i\(aq\(dq |\e
|
||||
mysql \-u sysop \-p sysop \-D seiscomp \-h localhost \-N\(ga
|
||||
|
||||
screloc \-O $orgID \-d localhost \-\-locator NonLinLoc \-\-profile $profile \-u $userID \-\-debug \-\-author=$authorID
|
||||
|
||||
done
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/screloc.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/screloc.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/screloc.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
screloc inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.locator
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Defines the locator to be used such as NonLinLoc.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.profile
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The locator profile to use.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.ignoreRejectedOrigins
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Ignores origins with status REJECTED.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.allowAnyStatus
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Triggers processing on origins with any evaluation status.
|
||||
Overrides \(dqallowPreliminaryOrigins\(dq but not
|
||||
\(dqignoreRejectedOrigins\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.allowPreliminaryOrigins
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Triggers processing also on origins with status PRELIMINARY.
|
||||
Origins with any other status is ignored anyway. The parameter
|
||||
is overridden by \(dqallowAnyStatus\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.allowManualOrigins
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Triggers processing also on origins with evaluatuion mode
|
||||
MANUAL. Otherwise only origins with mode AUTOMATIC are
|
||||
considered. The triggering may be limited due to an evaluation
|
||||
status, see \(dqallowPreliminaryOrigins\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.useWeight
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Whether to use the weight of the picks associated with the
|
||||
input origin as defined in the input origin as input for
|
||||
the locator or not. If false then all picks associated with
|
||||
the input origin will be forwarded to the locator with full
|
||||
weight.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.adoptFixedDepth
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If the input origin\(aqs depth is fixed then it will be fixed
|
||||
during the relocation process as well.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.storeSourceOriginID
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Whether to store the ID of the input origin as comment in the
|
||||
relocated origin or not.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B reloc.originIDSuffix
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Suffix appended to the publicID of the origin to be relocated
|
||||
to form the new publicID. This
|
||||
helps to identify pairs of origins before and after relocation.
|
||||
However, new publicIDs are unrelated to the time of creation.
|
||||
If not defined, a new publicID will be generated automatically.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.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 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 Mode
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-test
|
||||
Test mode, do not send any message
|
||||
.UNINDENT
|
||||
.SS Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-O, \-\-origin\-id arg
|
||||
Reprocess the origin and send a message unless test mode is activated
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-locator arg
|
||||
The locator type to use
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-use\-weight arg
|
||||
Use current picks weight
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-evaluation\-mode arg
|
||||
set origin evaluation mode: \(dqAUTOMATIC\(dq or \(dqMANUAL\(dq
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-ep file
|
||||
Defines an event parameters XML file to be read and processed. This
|
||||
implies offline mode and only processes all origins contained
|
||||
in that file. Each relocated origin is appended to the list
|
||||
of origins unless \-\-replace is given.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-replace
|
||||
Used in combination with \-\-ep. If given then each origin for
|
||||
that an output has been generated is replaced by the result
|
||||
of relocation. In other words: two LocSAT origins in, two
|
||||
NonLinLoc origins out. All other objects are passed through.
|
||||
.UNINDENT
|
||||
.SS Profiling
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-measure\-relocation\-time
|
||||
Measure the time spent in a single relocation
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-repeated\-relocations arg
|
||||
improve measurement of relocation time by running each relocation multiple times. Specify the number of relocations, e.g. 100.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
251
share/man/man1/screpick.1
Normal file
251
share/man/man1/screpick.1
Normal file
@ -0,0 +1,251 @@
|
||||
.\" 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 "SCREPICK" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
screpick \- SeisComP Documentation
|
||||
.sp
|
||||
\fBReads an XML file of picks and repicks them using a post picker. The
|
||||
picks will be modified in place and written to another XML file.\fP
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/screpick.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/screpick.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/screpick.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
screpick inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B picker
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Picker interface to be used for repicking.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B anyPhase
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
If enabled then all picks will be processed. Otherwise only
|
||||
P phases or picks without a phase hint will be considered.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.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 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 Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-ep file
|
||||
Name of input XML file (SCML) with all picks for offline
|
||||
processing.
|
||||
.UNINDENT
|
||||
.SS Picker
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-P, \-\-picker interface
|
||||
Defines the picker interface to be used. It must be part of
|
||||
the common libraries or loaded as plugin.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-A, \-\-any\-phase
|
||||
Accept any pick regardless of its phase hint.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
1945
share/man/man1/scrttv.1
Normal file
1945
share/man/man1/scrttv.1
Normal file
File diff suppressed because it is too large
Load Diff
317
share/man/man1/scsendjournal.1
Normal file
317
share/man/man1/scsendjournal.1
Normal file
@ -0,0 +1,317 @@
|
||||
.\" 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 "SCSENDJOURNAL" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scsendjournal \- SeisComP Documentation
|
||||
.sp
|
||||
\fBSend journaling information to the messaging to manipulate event parameter objects.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scsendjournal sends journals to the \fIscname\fP messaging system.
|
||||
Currently, journals can be used to command \fI\%scevent\fP\&.
|
||||
The journals command \fI\%scevent\fP to manipulate event parameters according to
|
||||
the \fI\%journal actions\fP which must be known to
|
||||
\fI\%scevent\fP\&.
|
||||
.sp
|
||||
The actions allow to:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Create new events,
|
||||
.IP \(bu 2
|
||||
Modify event parameters,
|
||||
.IP \(bu 2
|
||||
Control the association of origins to events.
|
||||
.UNINDENT
|
||||
.SH ACTIONS
|
||||
.sp
|
||||
There are specific journal actions for handling non\-events and events. The documentation
|
||||
of \fI\%scevent\fP contains a \fI\%complete list of journals known to scevent\fP\&.
|
||||
Parameters used on the command line can also be passed from file using the option
|
||||
\fB\-i\fP\&.
|
||||
.SS None\-event specific actions
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBEvNewEvent\fP: Create a new event from origin with the provided origin ID.
|
||||
The origin must be known to \fI\%scevent\fP\&.
|
||||
.sp
|
||||
Example: Create a new event from the
|
||||
origin with given originID. Apply the action in the message system on \fIlocalhost\fP:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H localhost Origin#20170505130954.736019.318 EvNewEvent
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Origin association
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBEvGrabOrg\fP: 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.
|
||||
.IP \(bu 2
|
||||
\fBEvMerge\fP: Merge events into one event.
|
||||
.sp
|
||||
Example: Merge all origins from the source event with eventID \fIeventS\fP into the
|
||||
target event with eventID \fIeventT\fP\&. Remove event \fIeventS\fP\&. Apply the action in
|
||||
the message system on \fIhost\fP:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H {host} {eventT} EvMerge {eventS}
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBEvSplitOrg\fP: Split origins to 2 events.
|
||||
.UNINDENT
|
||||
.SS Event parameters
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fBEvName\fP: Set \fIEventDescription\fP of type \fIearthquake name\fP\&.
|
||||
.sp
|
||||
Example, setting the name of the event with
|
||||
eventID \fIgempa2021abcd\fP to \fIPetrinja\fP
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H localhost gempa2020abcd EvName \(dqPetrinja\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBEvOpComment\fP: Set event operator\(aqs comment.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefFocMecID\fP: Set event preferred focal mechanism.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefMagTypev:\fP Set preferred magnitude type.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefMw\fP: Set Mw from focal mechanism as preferred magnitude.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefOrgAutomatic\fP: Set the preferred mode to \fIautomatic\fP corresponding to \fIunfix\fP in scolv.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefOrgEvalMode\fP: Set preferred origin by evaluation mode.
|
||||
.IP \(bu 2
|
||||
\fBEvPrefOrgID\fP: Set preferred origin by ID.
|
||||
.IP \(bu 2
|
||||
\fBEvRefresh\fP: Select the preferred origin, the preferred magnitude, update
|
||||
the region. Call processors loaded with plugins, e.g. the
|
||||
\fI\%evrc\fP plugin for scevent.
|
||||
.sp
|
||||
Example:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H localhost gempa2021abcd EvRefresh
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBEvType\fP: Set event type.
|
||||
.sp
|
||||
Example: Set the type of the event with eventID \fIgempa2021abcd\fP to \fInuclear explosion\fP\&.
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scsendjournal \-H localhost gempa2021abcd EvType \(dqnuclear explosion\(dq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
\fBEvTypeCertainty\fP: set event type certainty.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscsendjournal [opts] {objectID} {action} [parameters]\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 \-\-start\-stop\-msg arg
|
||||
Set sending of a start and a stop message.
|
||||
.UNINDENT
|
||||
.SS Input
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-input arg
|
||||
Read parameters from given file instead from command line.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
191
share/man/man1/scsendorigin.1
Normal file
191
share/man/man1/scsendorigin.1
Normal file
@ -0,0 +1,191 @@
|
||||
.\" 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 "SCSENDORIGIN" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scsendorigin \- SeisComP Documentation
|
||||
.sp
|
||||
\fBCreate an artificial origin and send to the messaging.\fP
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscsendorigin [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 \-\-start\-stop\-msg arg
|
||||
Set sending of a start and a stop message.
|
||||
.UNINDENT
|
||||
.SS Parameters
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-time
|
||||
Time of origin. Use quotes to encapsulate date and time.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-coord
|
||||
Latitude,longitude,depth of origin.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
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.
|
||||
.
|
||||
493
share/man/man1/scvoice.1
Normal file
493
share/man/man1/scvoice.1
Normal file
@ -0,0 +1,493 @@
|
||||
.\" 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 "SCVOICE" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scvoice \- SeisComP Documentation
|
||||
.sp
|
||||
\fBReal time voice alert.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
This tool runs an external script whenever an event has been created or updated.
|
||||
It can also run a script in case an amplitude of a particular type or a
|
||||
preliminary origin (heads\-up message) has been sent. The common purpose for
|
||||
this tool is to play a sound or to convert a message to speech using external
|
||||
tools like festival or espeak.
|
||||
There are three possible trigger mechanisms for calling scripts:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Event creation/update
|
||||
.IP \(bu 2
|
||||
Amplitude creation
|
||||
.IP \(bu 2
|
||||
Origin creation (with status = preliminary)
|
||||
.UNINDENT
|
||||
.sp
|
||||
Although this tool was designed to alert the user acoustically it can also be
|
||||
used to send e\-mails, sms or to do any other kind of alert. scvoice can only
|
||||
run one script per call type at a time! A template (\fI\%scalert\fP) Python script with
|
||||
more options has been added to \fISeisComP\fP to be used as source for custom notifications.
|
||||
.SH EXAMPLES
|
||||
.SS Event script
|
||||
.sp
|
||||
The following script is used as event script. It requires
|
||||
\fI\%festival\fP which should be
|
||||
available in almost any Linux distribution.
|
||||
.sp
|
||||
\fBIMPORTANT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
When saving the scripts given below do not forget to set the executable
|
||||
bit otherwise scvoice cannot call the scripts. In Linux just run:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
chmod +x /path/to/file
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Save an executable script file, e.g., under, e.g. \fB~/.seiscomp/event.sh\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
#!/bin/sh
|
||||
if [ \(dq$2\(dq = \(dq1\(dq ]; then
|
||||
echo \(dq $1\(dq | sed \(aqs/,/, ,/g\(aq | festival \-\-tts;
|
||||
else
|
||||
echo \(dqEvent updated, $1\(dq | sed \(aqs/,/, ,/g\(aq | festival \-\-tts;
|
||||
fi
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Add the file to the configuration of \fI\%scripts.event\fP in the file
|
||||
\fBSEISCOMP_ROOT/etc/scvoice.cfg\fP or \fB~/.seiscomp/scvoice.cfg\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scripts.event = /home/sysop/.seiscomp/event.sh
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Amplitude script
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Save an executable script file, e.g., under \fB~/.seiscomp/amplitude.sh\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
#!/bin/sh
|
||||
# Play a wav file with a particular volume
|
||||
# derived from the amplitude itself.
|
||||
playwave ~/.seiscomp/beep.wav \-v $3
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Add the file to the configuration of \fI\%scripts.amplitude\fP in the
|
||||
file \fBSEISCOMP_ROOT/etc/scvoice.cfg\fP or \fB~/.seiscomp/scvoice.cfg\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scripts.amplitude = /home/sysop/.seiscomp/amplitude.sh
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Alert script
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Create a sound file \fBsiren.wav\fP for accoustic alerts.
|
||||
.IP 2. 3
|
||||
Save an executable script file under, e.g., \fB~/.seiscomp/alert.sh\fP:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
#!/bin/sh
|
||||
playwave /home/sysop/.seiscomp/siren.wav
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 3. 3
|
||||
Add the script filename to the configuration of \fI\%scripts.alert\fP in
|
||||
the file \fBSEISCOMP_ROOT/etc/scvoice.cfg\fP or \fB~/.seiscomp/scvoice.cfg\fP\&.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scripts.alert = /home/sysop/.seiscomp/alert.sh
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scvoice.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scvoice.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scvoice.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scvoice inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B firstNew
|
||||
Default: \fBfalse\fP
|
||||
.sp
|
||||
Type: \fIboolean\fP
|
||||
.sp
|
||||
Treat an event as new event when it is seen the first time.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B agencyIDs
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
Define a white list of agencyIDs to alert an event. The
|
||||
agencyID is extracted from the preferred origin of the event.
|
||||
If this list is empty, all agencies are allowed.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B poi.message
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The default message string for the event\-script is
|
||||
\(dqearthquake, [HOURS] hours [MINS] minutes ago, [DESC],
|
||||
magnitude [MAG], depth [DEP] kilometers\(dq whereas [DESC]
|
||||
is the string given in the event.description attribute.
|
||||
This string can be overwritten using one of the following
|
||||
options. There are three placeholders that can be used:
|
||||
@region@, @dist@ and @poi@.
|
||||
Example: \(dq@region@, @dist@ kilometers from @poi@ away\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B poi.maxDist
|
||||
Default: \fB20\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIdeg\fP
|
||||
.sp
|
||||
When using the nearest point of interest (city) as part of the
|
||||
message string, specify the maximum distance in degrees from the
|
||||
event. Any point of interest farther away will be ignored.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B poi.minPopulation
|
||||
Default: \fB50000\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Minimum population for a city to become a point of interest.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.amplitude
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Specify the script to be called if an amplitude
|
||||
arrives, network\-, stationcode and amplitude are passed
|
||||
as parameters $1, $2 and $3.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.alert
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Specify the script to be called if a preliminary
|
||||
origin arrives, latitude and longitude are passed as
|
||||
parameters $1 and $2.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B scripts.event
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Specify the script to be called when an event has been
|
||||
declared; the message string, a flag (1=new event,
|
||||
0=update event), the EventID, the arrival count and the
|
||||
magnitude (optional when set) are passed as parameter
|
||||
$1, $2, $3, $4 and $5.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscvoice [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
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-first\-new
|
||||
Overrides configuration parameter \fI\%firstNew\fP\&.
|
||||
.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 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 Alert
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-amp\-type arg
|
||||
Specify the amplitude type to listen to.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-amp\-script arg
|
||||
Overrides configuration parameter \fI\%scripts.amplitude\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-alert\-script arg
|
||||
Overrides configuration parameter \fI\%scripts.alert\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-event\-script arg
|
||||
Overrides configuration parameter \fI\%scripts.event\fP\&.
|
||||
.UNINDENT
|
||||
.SS Cities
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-max\-dist arg
|
||||
Overrides configuration parameter \fI\%poi.maxDist\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-min\-population arg
|
||||
Overrides configuration parameter \fI\%poi.minPopulation\fP\&.
|
||||
.UNINDENT
|
||||
.SS Debug
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E, \-\-eventid arg
|
||||
Specify event ID that is used for testing.
|
||||
After running the alert scripts scvoice will exit.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
256
share/man/man1/scwfas.1
Normal file
256
share/man/man1/scwfas.1
Normal file
@ -0,0 +1,256 @@
|
||||
.\" 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 "SCWFAS" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scwfas \- SeisComP Documentation
|
||||
.sp
|
||||
\fBWaveform archive server\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
The waveform archive server is a small application that serves a local
|
||||
SDS archive via different protocols. Currently there are two implementations:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%fdsnws dataselect\fP
|
||||
.INDENT 2.0
|
||||
.IP \(bu 2
|
||||
dataselect/1/query
|
||||
.IP \(bu 2
|
||||
dataselect/1/version
|
||||
.IP \(bu 2
|
||||
dataselect/1/application.wadl
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Arclink (deprecated)
|
||||
.UNINDENT
|
||||
.sp
|
||||
This application is meant to share data with trusted computers in a fast and
|
||||
efficient way. It does not require inventory information and supports wildcards
|
||||
on each level.
|
||||
.sp
|
||||
All data are forwarded unrestricted. There are no options to add restriction
|
||||
checks or user authentication.
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scwfas.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scwfas.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scwfas.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scwfas inherits \fI\%global options\fP\&.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B handlerSDS
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Defines an alternative SDS archive handler. This is the name
|
||||
of an RecordStream interface that can be loaded via a plugin.
|
||||
If not given, an internal implementation will be used.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B filebase
|
||||
Default: \fB@ROOTDIR@/var/lib/archive\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The filebase of the SDS archive. If an alternative archive
|
||||
handler is defined by \(dqhandlerSDS\(dq, this value serves
|
||||
as input to setSource().
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B arclink.port
|
||||
Default: \fB\-1\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
The server port for Arclink connections. \-1
|
||||
deactivates the Arclink server. The standard Arclink port is
|
||||
18001.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B fdsnws.port
|
||||
Default: \fB8080\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
The server port for FDSNWS connections. \-1
|
||||
deactivates the FDSN Web server.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B fdsnws.baseURL
|
||||
Default: \fBhttp://localhost:8080/fdsnws\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
The base URL of the FDSN Web service that is
|
||||
given in the WADL document.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B fdsnws.maxTimeWindow
|
||||
Default: \fB0\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
The aggregated maximum time window (seconds)
|
||||
for all requested streams. A value of 0 will deactive
|
||||
any restriction.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscwfas [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
|
||||
.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 \-\-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 \-\-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 \-\-trace
|
||||
Execute in trace mode.
|
||||
Equivalent to \-\-verbosity=4 \-\-console=1 \-\-print\-component=1
|
||||
\-\-print\-context=1 .
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-log\-file arg
|
||||
Use alternative log file.
|
||||
.UNINDENT
|
||||
.SS Server
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-arclink\-port int
|
||||
Overrides configuration parameter \fI\%arclink.port\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-fdsnws\-port int
|
||||
Overrides configuration parameter \fI\%fdsnws.port\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-fdsnws\-baseurl string
|
||||
Overrides configuration parameter \fI\%fdsnws.baseURL\fP\&.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
1553
share/man/man1/scwfparam.1
Normal file
1553
share/man/man1/scwfparam.1
Normal file
File diff suppressed because it is too large
Load Diff
503
share/man/man1/scxmldump.1
Normal file
503
share/man/man1/scxmldump.1
Normal file
@ -0,0 +1,503 @@
|
||||
.\" 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 "SCXMLDUMP" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scxmldump \- SeisComP Documentation
|
||||
.sp
|
||||
\fBDump database objects to XML files.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scxmldump reads various parameters from a SeisComP database:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Availability,
|
||||
.IP \(bu 2
|
||||
Config (bindings parameters),
|
||||
.IP \(bu 2
|
||||
Event parameters,
|
||||
.IP \(bu 2
|
||||
Inventory,
|
||||
.IP \(bu 2
|
||||
Journal,
|
||||
.IP \(bu 2
|
||||
Routing.
|
||||
.UNINDENT
|
||||
.sp
|
||||
The parameters are sent to stdout or written into an XML (\fI\%SCML\fP) file.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Waveform quality control (QC) parameters can be read from databases using
|
||||
scqcquery\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Event parameters
|
||||
.sp
|
||||
To get event, origin or pick information from the database without using SQL
|
||||
commands is an important task for the user. \fI\%scxmldump\fP queries the
|
||||
database and transforms that information into XML. Events and origins can be
|
||||
treated further by \fI\%scbulletin\fP for generating bulletins or conversion
|
||||
into KML.
|
||||
.sp
|
||||
Many processing modules, e.g., \fI\%scevent\fP support the on\-demand processing
|
||||
of dumped event parameters by the command\-line option \fB\-\-ep\fP\&.
|
||||
Importing event parameters into another database is possible with \fI\%scdb\fP
|
||||
and sending to a SeisComP messaging is provided by \fI\%scdispatch\fP\&.
|
||||
.sp
|
||||
\fBHINT:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Events, origins and picks are referred to by their public IDs. IDs of events
|
||||
and origins can be provided by \fI\%scevtls\fP and \fI\%scorgls\fP,
|
||||
respectively. Event, origin and pick IDs can also be read from graphical
|
||||
tools like \fI\%scolv\fP or used database queries assisted by \fI\%scquery\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Format conversion
|
||||
.sp
|
||||
Conversion of \fI\%SCML\fP into other formats is supported by \fI\%sccnv\fP\&.
|
||||
An XSD schema of the XML output can be found under
|
||||
\fB$SEISCOMP_ROOT/share/xml/\fP\&.
|
||||
.SS Examples
|
||||
.sp
|
||||
Dump inventory
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scxmldump \-fI \-o inventory.xml \-d mysql://sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Dump config (bindings parameters)
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scxmldump \-fC \-o config.xml \-d mysql://sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Dump full event data incl. the relevant journal entries
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scxmldump \-fPAMFJ \-E test2012abcd \-o test2012abcd.xml \e
|
||||
\-d mysql://sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Dump summary event data
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scxmldump \-fap \-E test2012abcd \-o test2012abcd.xml \e
|
||||
\-d mysql://sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Create bulletin from an event
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scxmldump \-fPAMF \-E test2012abcd
|
||||
\-d mysql://sysop:sysop@localhost/seiscomp | \e
|
||||
scbulletin
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Copy event parameters to another database
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scxmldump \-fPAMF \-E test2012abcd \e
|
||||
\-d mysql://sysop:sysop@localhost/seiscomp | \e
|
||||
scdb \-i \- \-d mysql://sysop:sysop@archive\-db/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Export the entire journal:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scxmldump \-fJ \-o journal.xml \e
|
||||
\-d mysql://sysop:sysop@localhost/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scxmldump.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scxmldump.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scxmldump.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scxmldump inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscxmldump [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 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 \-\-config\-db arg
|
||||
Load the configuration from the given database or file,
|
||||
format: [\fI\%service://]location\fP .
|
||||
.UNINDENT
|
||||
.SS Dump
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-listen
|
||||
Enable server mode which listens to the message server for
|
||||
incoming events and dumps each received add/update.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-I, \-\-inventory
|
||||
Dump the inventory.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-without\-station\-groups
|
||||
Remove all station groups from inventory.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-stations sta\-list
|
||||
If inventory is exported, filter the stations to export.
|
||||
Wildcards are supported. Format of each item: net[.{sta|*}].
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-C, \-\-config
|
||||
Dump the configuration (bindings).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-J, \-\-journal
|
||||
Dump the journal. In combination with \-E only corresponding
|
||||
journal entries are included.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-R, \-\-routing
|
||||
Dump the routing.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-Y, \-\-availability
|
||||
Dump data availability information.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-with\-segments
|
||||
Dump individual data segments.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-pick ID
|
||||
Pick public ID(s) to dump. Multiple IDs may be specified
|
||||
as a comma\-separated list.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-O, \-\-origin ID
|
||||
Origin public ID(s) to dump. Multiple origins may be specified
|
||||
as a comma\-separated list.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E, \-\-event ID
|
||||
Event public ID(s) to dump. Multiple events may be specified
|
||||
as a comma\-separated list.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-P, \-\-with\-picks
|
||||
Add picks associated to origins.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-A, \-\-with\-amplitudes
|
||||
Add amplitudes associated to magnitudes.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-M, \-\-with\-magnitudes
|
||||
Add station magnitudes associated to origins.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-F, \-\-with\-focal\-mechanism
|
||||
Add focal mechanisms associated to events.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-a, \-\-ignore\-arrivals
|
||||
Do not dump arrivals part of origins.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-ignore\-magnitudes
|
||||
Do not export (network) magnitudes of origins. This
|
||||
option is most useful in combination with \-O to only
|
||||
export the location information.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-p, \-\-preferred\-only
|
||||
When exporting events only the preferred origin, the preferred
|
||||
magnitude and the preferred focal mechanism will be dumped.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-m, \-\-all\-magnitudes
|
||||
If only the preferred origin is exported, all magnitudes for
|
||||
this origin will be dumped.
|
||||
.UNINDENT
|
||||
.SS Output
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-formatted
|
||||
Use formatted XML output. Otherwise all XML is printed
|
||||
on one line.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output
|
||||
Name of output file. If not given, output is sent to
|
||||
stdout.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-prepend\-datasize
|
||||
Prepend a line with the length of the XML data.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
245
share/man/man1/scxmlmerge.1
Normal file
245
share/man/man1/scxmlmerge.1
Normal file
@ -0,0 +1,245 @@
|
||||
.\" 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 "SCXMLMERGE" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
scxmlmerge \- SeisComP Documentation
|
||||
.sp
|
||||
\fBMerge the content of multiple XML files in SCML format.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
scxmlmerge reads all \fISeisComP\fP elements from one or more XML files in \fI\%SCML\fP
|
||||
format. It merges the content and prints the result to standard output. The
|
||||
input can contain and \fI\%SeisComP element\fP and the
|
||||
content can be filtered to print only some elements such as EventParameters.
|
||||
The output can be redirected into one single file and used by other applications.
|
||||
.sp
|
||||
The supported \fI\%SeisComP elements\fP are:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Config
|
||||
.IP \(bu 2
|
||||
DataAvailability
|
||||
.IP \(bu 2
|
||||
EventParameters
|
||||
.IP \(bu 2
|
||||
Inventory
|
||||
.IP \(bu 2
|
||||
Journaling
|
||||
.IP \(bu 2
|
||||
QualityControl
|
||||
.IP \(bu 2
|
||||
Routing
|
||||
.UNINDENT
|
||||
.sp
|
||||
By default all supported elements will be parsed and merged. Duplicates are
|
||||
removed. Use options to restrict the element types.
|
||||
.sp
|
||||
There are alternative modules for processing inventory XML files:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%scinv\fP: Merge inventory XML files, extract inventory information.
|
||||
.IP \(bu 2
|
||||
\fI\%invextr\fP: Extract and filter inventory information.
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Merge the all SeisComP elements from 2 XML files into a single XML file:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scxmlmerge file1.xml file2.xml > file.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Merge the all EventParameters and all Config elements from 2 XML files into a
|
||||
single XML file. Other element types will be ignored:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scxmlmerge \-E \-C file1.xml file2.xml > file.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/scxmlmerge.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/scxmlmerge.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/scxmlmerge.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
scxmlmerge inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBscxmlmerge [options] inputFiles\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
|
||||
.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 \-\-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 \-\-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 \-\-trace
|
||||
Execute in trace mode.
|
||||
Equivalent to \-\-verbosity=4 \-\-console=1 \-\-print\-component=1
|
||||
\-\-print\-context=1 .
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-log\-file arg
|
||||
Use alternative log file.
|
||||
.UNINDENT
|
||||
.SS Dump
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-Y, \-\-availability
|
||||
Include DataAvailability specifically. If no specfic object
|
||||
type is given, all supported objects are included.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-E, \-\-event
|
||||
Include EventParameters specifically. If no specfic object
|
||||
type is given, all supported objects are included.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-I, \-\-inventory
|
||||
Include Inventory specifically. If no specfic object
|
||||
type is given, all supported objects are included.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-J, \-\-journaling
|
||||
Include QualityControl specifically. If no specfic object
|
||||
type is given, all supported objects are included.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-C, \-\-config
|
||||
Include Config specifically. If no specfic object
|
||||
type is given, all supported objects are included.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-Q, \-\-quality
|
||||
Include QualityControl specifically. If no specfic object
|
||||
type is given, all supported objects are included.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-R, \-\-routing
|
||||
Include Routing specifically. If no specfic object
|
||||
type is given, all supported objects are included.
|
||||
.UNINDENT
|
||||
.SS Options
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-ignore\-bad\-files
|
||||
Tolerate empty or corrupted input files and continue without
|
||||
interruption. Otherwise, the application stops if corrupt
|
||||
or empty files are processed.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
225
share/man/man1/sczip.1
Normal file
225
share/man/man1/sczip.1
Normal file
@ -0,0 +1,225 @@
|
||||
.\" 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 "SCZIP" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
sczip \- SeisComP Documentation
|
||||
.sp
|
||||
\fBCompress or expand files with ZIP algorithm\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
sczip can compress and decompress data using the ZIP algorithm (PKZIP). It
|
||||
is not meant to supersede any available packagers but a little helper to
|
||||
decompress zipped SeisComPML formats. Like GZip, sczip can only handle one file
|
||||
and does not support archives. It compresses a byte stream and outputs a byte
|
||||
stream.
|
||||
.SH EXAMPLES
|
||||
.sp
|
||||
Decompress a file
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
sczip \-d file.xml.zip \-o file.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
sczip \-d file.xml.zip \-o file.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Compress a file
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
sczip file.xml \-o file.xml.zip
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
sczip < file.xml > file.xml.zip
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/sczip.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/sczip.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/sczip.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
sczip inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBsczip file.dat \-o file.zip\fP
|
||||
.sp
|
||||
\fBsczip file.dat \-d \-o file.zip\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 Mode
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-d, \-\-decompress
|
||||
Decompress.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output file
|
||||
Output file name. Default is stdout.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
3498
share/man/man1/seedlink.1
Normal file
3498
share/man/man1/seedlink.1
Normal file
File diff suppressed because it is too large
Load Diff
661
share/man/man1/seiscomp.1
Normal file
661
share/man/man1/seiscomp.1
Normal file
@ -0,0 +1,661 @@
|
||||
.\" 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 "SEISCOMP" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
seiscomp \- SeisComP Documentation
|
||||
.sp
|
||||
\fBSeisComP system control utility\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
The tool \fBseiscomp\fP allows controlling your \fISeisComP\fP system on the
|
||||
command line. As other \fISeisComP\fP modules it provides
|
||||
options and commands, e.g., the command \fBhelp\fP\&. Apply
|
||||
\fBseiscomp\fP to
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Install software dependencies,
|
||||
.IP \(bu 2
|
||||
Print
|
||||
.INDENT 2.0
|
||||
.IP \(bu 2
|
||||
environment variables of the installed \fISeisComP\fP system,
|
||||
.IP \(bu 2
|
||||
internal \fISeisComP\fP variables which can be used in configurations,
|
||||
.IP \(bu 2
|
||||
suggestions for timed automatic actions, i.e. \(dq\fIconjobs\fP\(dq,
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Make a basic setup including the \fISeisComP\fP database,
|
||||
.IP \(bu 2
|
||||
List daemon modules by categories,
|
||||
.IP \(bu 2
|
||||
Enable or disable modules in order to start them by default,
|
||||
.IP \(bu 2
|
||||
Start, stop, restart or reload single or multiple modules or all default
|
||||
modules,
|
||||
.IP \(bu 2
|
||||
Check the status of module,
|
||||
.IP \(bu 2
|
||||
Execute single or multiple modules or all default modules
|
||||
.IP \(bu 2
|
||||
Print the run status of modules,
|
||||
.IP \(bu 2
|
||||
Manage modules aliases,
|
||||
.IP \(bu 2
|
||||
Update inventory or bindings configurations,
|
||||
.IP \(bu 2
|
||||
Manage bindings by a specific shell.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
When executing \fBseiscomp\fP, all actions refer to the \fISeisComP\fP
|
||||
installation from within which \fBseiscomp\fP is called. This allows
|
||||
to refer to a default but also to any other installed \fISeisComP\fP system and to
|
||||
operate multiple \fISeisComP\fP systems in parallel, e.g., for testing different
|
||||
versions or for running different projects. Then give the full path to the
|
||||
\fBseiscomp\fP tools. Example:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$HOME/seiscomp\-test/bin/seiscomp
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Many of these actions are used by \fI\%scconfig\fP\&.
|
||||
.SH HELP
|
||||
.sp
|
||||
Use the command \fBhelp\fP for learning about the full set of options and
|
||||
other commands including examples:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp help
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
For basic help you may also use the option \fB\-h\fP:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp \-h
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH APPLICATIONS
|
||||
.SS Software dependencies
|
||||
.sp
|
||||
Software dependencies should be installed after installation or updates of
|
||||
\fISeisComP\fP\&. You may install dependencies on different levels, e.g., \fIbase\fP,
|
||||
\fIgui\fP, \fIfdswnws\fP, \fI[database]\-server\fP\&. Examples:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp install\-deps base
|
||||
seiscomp install\-deps base gui mariadb\-server
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Alternatively run the shell scripts for your Linux flavor and version located in
|
||||
\fBseiscomp/share/deps/\fP\&.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
For making a full installation and setup follow the instructions starting
|
||||
with section \fI\%SeisComP Installation\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Print
|
||||
.sp
|
||||
You may print the environment variables related to your considered \fISeisComP\fP
|
||||
installation, internal \fISeisComP\fP variables or suggestions for timed automatic
|
||||
procedures. Examples:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp print env
|
||||
$HOME/seiscomp\-test/bin/seiscomp print env
|
||||
seiscomp print variables
|
||||
seiscomp print crontab
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Add the environment variables to your shell configuration for making them known
|
||||
user wide. Internal variables are resolved when applying them in user
|
||||
configurations. For adjusting, adding or removing \fBcrontab\fP listings
|
||||
execute:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
man crontab
|
||||
crontab \-e
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Basic setup
|
||||
.sp
|
||||
Make a basic setup of your \fISeisComP\fP system interactively after installation.
|
||||
This will also allow you to generate a database or to configure the connection
|
||||
to an existing one. Run, e.g.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp setup
|
||||
$HOME/seiscomp\-test/bin/seiscomp setup
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS List
|
||||
.sp
|
||||
List modules which can be started to run as background daemon modules by
|
||||
categories. Examples:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp list modules
|
||||
seiscomp list enabled
|
||||
seiscomp list started
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Enable/disable [*]
|
||||
.sp
|
||||
Enabled modules will be started to run as a background daemon module.
|
||||
You may enable or disable one or multiple modules. Examples:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp enable scautopick
|
||||
seiscomp enable scautopick scautoloc
|
||||
seiscomp disable scautopick scautoloc
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Start/stop/restart/reload
|
||||
.nf
|
||||
[*]_
|
||||
.fi
|
||||
|
||||
.sp
|
||||
Start all enabled modules:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp start
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Stop all modules and start all enabled modules:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp restart
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Start/stop/restart specific modules
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp start scautopick scautoloc
|
||||
seiscomp stop scautopick scautoloc
|
||||
seiscomp restart scautopick scautoloc
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
In order to apply configurations, a module must be (re)started since it reads
|
||||
any configuration only during startup. Restarts will create downtimes and should
|
||||
be avoided as much as possible. In order to minimize downtimes, some modules
|
||||
may apply changes in configuration by reloading during runtime without
|
||||
restarting. For reloading you may use the command \fBseiscomp reload\fP\&.
|
||||
The application of reloading is therefore restricted to a limited range of
|
||||
modules and parameters.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Graphical modules such as \fI\%scolv\fP cannot be operated as background
|
||||
daemon modules. Therefore, they cannot be started but they can
|
||||
be \fI\%executed\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Check
|
||||
.nf
|
||||
[*]_
|
||||
.fi
|
||||
|
||||
.sp
|
||||
When modules stop unexpectedly, they are not stopped in a clean way. Such
|
||||
stopped modules may be detected and started again in order to minimize
|
||||
downtimes. Apply the \fBcheck\fP command to all or specific modules.
|
||||
Examples:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp check
|
||||
seiscomp check scautopick
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Execute
|
||||
.sp
|
||||
Instead of running daemon modules you may execute modules in a terminal and
|
||||
observe the output, e.g., for debugging or for applying command\-line options.
|
||||
Examples:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp exec scolv \-\-debug
|
||||
seiscomp exec scautopick \-\-debug
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
When all relevant system environment variables point to the same \fISeisComP\fP
|
||||
installation from where seiscomp is executed, then it is enough to execute
|
||||
modules by their names replacing the above:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
scolv \-\-debug
|
||||
scautopick \-\-debug
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Status
|
||||
.nf
|
||||
[*]_
|
||||
.fi
|
||||
|
||||
.sp
|
||||
List the status of all, enabled, disabled, started, or specific modules.
|
||||
Examples:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp status
|
||||
seiscomp status enabled
|
||||
seiscomp status disabled
|
||||
seiscomp status started
|
||||
seiscomp status scautopick
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
:command:status\(ga will report modules which terminated due to errors.
|
||||
.SS Module Aliases
|
||||
.sp
|
||||
For some \fISeisComP\fP modules aliases can be generated allowing the separate
|
||||
execution with specific configurations in parallel the original module
|
||||
and even in separate pipeline with specific message groups.
|
||||
Using the \fBalias\fP command aliases modules can be created or removed.
|
||||
Examples for creating or removing the alias \fBl1autopick\fP to
|
||||
\fI\%scautopick\fP:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp alias create l1autopick scautopick
|
||||
seiscomp alias remove l1autopick
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
When creating aliases, soft links to the original module executable files, the
|
||||
default configuration and the init files are created. The alias itself is
|
||||
registered in \fBSEISCOMP_ROOT/etc/descriptions/aliases\fP\&. If a module does
|
||||
not allow creating aliases a notification is printed. Example:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp alias create scolv1 scolv
|
||||
error: module \(aqscolv\(aq not found
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
After creating aliases, they may be configured and operated in the same way as
|
||||
the original module.
|
||||
.sp
|
||||
\fBWARNING:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
The length of alias names for modules considering
|
||||
\fI\%bindings\fP is strictly limited to 20 characters.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
When removing aliases, all links and the alias registration are removed but
|
||||
possibly existing module or binding configurations remained unchanged. The
|
||||
option \fB\-\-interactive\fP allows removing these configurations
|
||||
interactively.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp \-\-interactive alias remove l1autopick
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Update configuration
|
||||
.nf
|
||||
[*]_
|
||||
.fi
|
||||
|
||||
.sp
|
||||
The command \fBupdate\-config\fP allows reading bindings configurations from
|
||||
the standard \fB@KEYDIR@\fP directory as well as inventory from
|
||||
\fB@SYSTEMCONFIGDIR@/inventory\fP and sending them to the messaging for
|
||||
storing in the database or for generating the configuration of
|
||||
\fI\%standalone modules\fP:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp update\-config
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Executing \fBseiscomp update\-config\fP involves:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Merging inventory,
|
||||
.IP \(bu 2
|
||||
Sending inventory updates to the messaging,
|
||||
.IP \(bu 2
|
||||
Synchronisation of inventory, key files and bindings,
|
||||
.IP \(bu 2
|
||||
Sending any updates of bindings to the messaging,
|
||||
.IP \(bu 2
|
||||
Generation of configuration for \fI\%standalone modules\fP\&.
|
||||
.UNINDENT
|
||||
.sp
|
||||
The command can therefore be rater time consuming. For speeding up you may be
|
||||
more specific:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Only update global bindings and all \fI\%trunk\fP modules without inventory
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp update\-config trunk
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Update only inventory
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp update\-config inventory
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Update bindings of \fI\%scautopick\fP only
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp update\-config scautopick
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The command may be similarly applied to any other module considering
|
||||
bindings.
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Instead of reading bindings configurations from the standard @KEYDIR@
|
||||
directory, the module \fI\%bindings2cfg\fP can read bindings from any key
|
||||
directory and write the Config parameters to \fI\%SCML\fP or send them to
|
||||
the messaging.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SEISCOMP SHELL
|
||||
.sp
|
||||
The seiscomp shell is a special environment, e.g., allowing to control
|
||||
\fI\%bindings\fP of \fI\%modules\fP to stations.
|
||||
.sp
|
||||
Applications are:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Create or remove station bindings,
|
||||
.IP \(bu 2
|
||||
Create or remove binding profiles,
|
||||
.IP \(bu 2
|
||||
Remove binding profiles.
|
||||
.UNINDENT
|
||||
.sp
|
||||
Invoke \fBseiscomp\fP along with the \fBshell\fP command to start the
|
||||
shell:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp shell
|
||||
|
||||
|
||||
================================================================================
|
||||
SeisComP shell
|
||||
================================================================================
|
||||
|
||||
Welcome to the SeisComP interactive shell. You can get help about
|
||||
available commands with \(aqhelp\(aq. \(aqexit\(aq leaves the shell.
|
||||
|
||||
$
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The full list of shell control commands are printed along with the help of the
|
||||
seiscomp shell:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
================================================================================
|
||||
SeisComP shell
|
||||
================================================================================
|
||||
|
||||
Welcome to the SeisComP interactive shell. You can get help about
|
||||
available commands with \(aqhelp\(aq. \(aqexit\(aq leaves the shell.
|
||||
|
||||
$ help
|
||||
Commands:
|
||||
list stations
|
||||
Lists all available stations keys.
|
||||
|
||||
list profiles {mod}
|
||||
Lists all available profiles of a module.
|
||||
|
||||
\&...
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.IP [*] 5
|
||||
With this command, the flag \fB\-\-invert\fP can be used
|
||||
in order to invert the application to the specific modules. You may provide
|
||||
one or more module names. A major application is to
|
||||
restart most \fISeisComP\fP modules after a change in global bindings. However,
|
||||
\fI\%seedlink\fP and \fI\%slarchive\fP are not affected by global
|
||||
bindings and any downtime of these modules shall be avoided. Example:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp \-\-invert restart seedlink slarchive
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The same procedure could be achieved without \fB\-\-invert\fP by
|
||||
explicitly stating all other modules which, however, may result in a
|
||||
long list of module names.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBseiscomp [flags] command(s) [argument(s)]\fP
|
||||
.SS Flags
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-asroot
|
||||
Allow running a command as root.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-csv
|
||||
Print output as CSV in machine\-readable format.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h, \-\-help
|
||||
Produce this help message.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-interactive
|
||||
Interactive mode: Allow deleting configurations interactively when
|
||||
removing aliases.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-invert
|
||||
Invert the selection of the specified module names when using any of the
|
||||
commands: start, stop, check, status, reload, or restart.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-wait arg
|
||||
Define a timeout in seconds for acquiring the seiscomp lock
|
||||
file, e.g., \fIseiscomp \-\-wait 10 update\-config\fP\&.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
494
share/man/man1/sh2proc.1
Normal file
494
share/man/man1/sh2proc.1
Normal file
@ -0,0 +1,494 @@
|
||||
.\" 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 "SH2PROC" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
sh2proc \- SeisComP Documentation
|
||||
.sp
|
||||
\fBConvert SeismicHandler event files to SCML.\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
sh2proc converts \fI\%Seismic Handler\fP event data to
|
||||
SeisComP XML format. Data is read from input file or \fIstdin\fP if no input file is
|
||||
specified. The result is available on \fIstdout\fP\&.
|
||||
.SH CODE MAPPING
|
||||
.sp
|
||||
Since Seismic Handler only specifies station and component codes, a mapping to
|
||||
SeisComP network, location and channel codes is necessary. The script assumes
|
||||
that the same station code is not used in different networks. In case an
|
||||
ambiguous id is found a warning is printed and the first network code is used.
|
||||
The channel and stream code is extracted from the dectecStream and detecLocid
|
||||
configured in the global bindings. In case no configuration module is available
|
||||
the first location and stream is used.
|
||||
.SH EVENT PARAMETERS
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Event types given in Seismic Handler files are mapped to SeisComP event types:
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Seismic Handler
|
||||
T} T{
|
||||
SeisComP
|
||||
T}
|
||||
_
|
||||
T{
|
||||
teleseismic quake
|
||||
T} T{
|
||||
earthquake
|
||||
T}
|
||||
_
|
||||
T{
|
||||
regional quake
|
||||
T} T{
|
||||
earthquake
|
||||
T}
|
||||
_
|
||||
T{
|
||||
local quake
|
||||
T} T{
|
||||
earthquake
|
||||
T}
|
||||
_
|
||||
T{
|
||||
quarry blast
|
||||
T} T{
|
||||
quarry blast
|
||||
T}
|
||||
_
|
||||
T{
|
||||
nuclear explosion
|
||||
T} T{
|
||||
nuclear explosion
|
||||
T}
|
||||
_
|
||||
T{
|
||||
mining event
|
||||
T} T{
|
||||
mining explosion
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.IP \(bu 2
|
||||
The EventID given in Seismic Handler files is mapped as a comment to the event.
|
||||
.UNINDENT
|
||||
.SH MAGNITUDES
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Magnitude types given in Seismic Handler files are mapped to SeisComP magnitudes:
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Seismic Handler
|
||||
T} T{
|
||||
SeisComP
|
||||
T}
|
||||
_
|
||||
T{
|
||||
m
|
||||
T} T{
|
||||
M
|
||||
T}
|
||||
_
|
||||
T{
|
||||
ml
|
||||
T} T{
|
||||
ML
|
||||
T}
|
||||
_
|
||||
T{
|
||||
mb
|
||||
T} T{
|
||||
mb
|
||||
T}
|
||||
_
|
||||
T{
|
||||
ms
|
||||
T} T{
|
||||
Ms(BB)
|
||||
T}
|
||||
_
|
||||
T{
|
||||
mw
|
||||
T} T{
|
||||
Mw
|
||||
T}
|
||||
_
|
||||
T{
|
||||
bb
|
||||
T} T{
|
||||
mB
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.IP \(bu 2
|
||||
ML magnitudes in Seismic Handler files have no corresponding measured amplitudes.
|
||||
Therefore the ML station magnitudes are converted without referencing the amplitude.
|
||||
.IP \(bu 2
|
||||
Seismic Handler uses the phase name \(dqL\(dq for referring to surface waves without
|
||||
further specification. The phase name is kept unchanged.
|
||||
.UNINDENT
|
||||
.SH DISTANCE CALCULATIONS
|
||||
.sp
|
||||
In Seismic Handler files distances can be given in units of km or degree but in
|
||||
SeisComP only degree is used. Both representations are considered for conversion.
|
||||
In case of double posting preference is given to the Seismic Handler values given in km
|
||||
due to their higher precision.
|
||||
.SH BEAM PARAMETERS
|
||||
.sp
|
||||
Seismic Handler files provide the phase picks with theoretical, measured and corrected
|
||||
slowness and (back) azimuth but the pick in SeisComP knows only one value.
|
||||
During conversion highest preference is given to corrected values.
|
||||
The theoretical values are ignored.
|
||||
.SH LIMITATIONS
|
||||
.sp
|
||||
The following parameters from Seismic Handler files are not considered:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Phase Flag
|
||||
.IP \(bu 2
|
||||
Location Input Params
|
||||
.IP \(bu 2
|
||||
Reference Location Name
|
||||
.IP \(bu 2
|
||||
Quality Number
|
||||
.IP \(bu 2
|
||||
Ampl&Period Source
|
||||
.IP \(bu 2
|
||||
Location Quality
|
||||
.IP \(bu 2
|
||||
Reference Latitude
|
||||
.IP \(bu 2
|
||||
Reference Longitude
|
||||
.IP \(bu 2
|
||||
Amplitude Time
|
||||
.UNINDENT
|
||||
.SH FURTHER PROCESSING IN SEISCOMP
|
||||
.sp
|
||||
The created XML files can be used in multiple ways, e.g.:
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
By other modules in an XML\-base playback
|
||||
.IP 2. 3
|
||||
Inject into the messaging system by \fI\%scdispatch\fP
|
||||
.IP 3. 3
|
||||
Integrate into the database by \fI\%scdb\fP
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Convert the Seismic Handler file \fIshm.evt\fP and writes SCML into the file
|
||||
\fIsc.xml\fP\&. The database connection to read inventory and configuration
|
||||
information is fetched from the default messaging connection.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
sh2proc shm.evt > sc.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 2. 3
|
||||
Read Seismic Handler data from \fIstdin\fP\&. Inventory and configuration information
|
||||
is provided through files.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
cat shm.evt | sh2proc \-\-inventory\-db=inventory.xml \-\-config\-db=config.xml > sc.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SHM.EVT FILE FORMAT
|
||||
.sp
|
||||
The list of parameters supported by sh2proc may be incomplete.
|
||||
Read the original \fI\%format and parameter description\fP
|
||||
of the SeismicHandler .evt files for providing correct input files.
|
||||
.sp
|
||||
Example of a SeismicHandler \fIshm.evt\fP file with supported parameters:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
Event ID : 1170102002
|
||||
Station code : VITZ
|
||||
Onset time : 2\-JAN\-2017_12:25:40.415
|
||||
Onset type : emergent
|
||||
Phase name : Pg
|
||||
Event Type : mining event
|
||||
Applied filter : SHM_BP_1HZ_25HZ_3
|
||||
Component : Z
|
||||
Quality number : 2
|
||||
Pick Type : manual
|
||||
Weight : 4
|
||||
Theo. Azimuth (deg) : 27.29
|
||||
Theo. Backazimuth (deg): 207.36
|
||||
Distance (deg) : 0.122
|
||||
Distance (km) : 13.572
|
||||
Magnitude ml : 1.0
|
||||
Phase Flags : L
|
||||
\-\-\- End of Phase \-\-\-
|
||||
|
||||
|
||||
Event ID : 1170102002
|
||||
Station code : WESF
|
||||
Onset time : 2\-JAN\-2017_12:25:53.714
|
||||
Onset type : emergent
|
||||
Phase name : Pg
|
||||
Event Type : mining event
|
||||
Applied filter : SHM_BP_1HZ_25HZ_3
|
||||
Component : Z
|
||||
Quality number : 2
|
||||
Pick Type : manual
|
||||
Weight : 4
|
||||
Theo. Azimuth (deg) : 106.98
|
||||
Theo. Backazimuth (deg): 287.91
|
||||
Distance (deg) : 0.807
|
||||
Distance (km) : 89.708
|
||||
Magnitude ml : 1.8
|
||||
Mean Magnitude ml : 1.1
|
||||
Latitude : +50.779
|
||||
Longitude : +10.003
|
||||
Depth (km) : 0.0
|
||||
Depth type : (g) estimated
|
||||
Origin time : 2\-JAN\-2017_12:25:38.273
|
||||
Region Table : GEO_REG
|
||||
Region ID : 5326
|
||||
Source region : Tann, E of Fulda
|
||||
Velocity Model : deu
|
||||
Location Input Params : 20
|
||||
Reference Location Name: CENTRE
|
||||
\-\-\- End of Phase \-\-\-
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.nf
|
||||
\fBetc/defaults/global.cfg\fP
|
||||
\fBetc/defaults/sh2proc.cfg\fP
|
||||
\fBetc/global.cfg\fP
|
||||
\fBetc/sh2proc.cfg\fP
|
||||
\fB~/.seiscomp/global.cfg\fP
|
||||
\fB~/.seiscomp/sh2proc.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.sp
|
||||
sh2proc inherits \fI\%global options\fP\&.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBsh2proc [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 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
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
592
share/man/man1/slarchive.1
Normal file
592
share/man/man1/slarchive.1
Normal file
@ -0,0 +1,592 @@
|
||||
.\" 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 "SLARCHIVE" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
slarchive \- SeisComP Documentation
|
||||
.sp
|
||||
\fBSeedLink client for data stream archiving\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
slarchive connects to a SeedLink server, requests data streams and writes received
|
||||
packets into directory/file structures (archives). The precise layout
|
||||
of the directories and files is defined in a format string.
|
||||
.sp
|
||||
The implemented layouts are:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
\fI\%SDS\fP: The SeisComP Data Structure, default in \fISeisComP\fP
|
||||
.IP \(bu 2
|
||||
BUD: Buffer of Uniform Data structure
|
||||
.IP \(bu 2
|
||||
DLOG: The old SeisComP/datalog structure for backwards compatibility
|
||||
.UNINDENT
|
||||
.sp
|
||||
The duration for which the data are kept in archive is controlled by the bindings
|
||||
parameter \fI\%keep\fP\&. slarchive itself does not clean the archive. For removing
|
||||
old data execute \fB$SEISCOMP_ROOT/var/lib/slarchive/purge_datafiles\fP\&. A
|
||||
regular clean\-up is suggested by
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp print crontab
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The resulting line, e.g.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
20 3 * * * /home/sysop/seiscomp/var/lib/slarchive/purge_datafiles >/dev/null 2>&1
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
can be adjusted and added to crontab.
|
||||
.SH BACKGROUND EXECUTION
|
||||
.sp
|
||||
When starting slarchive in \fISeisComP\fP as a daemon module in the background SDS is
|
||||
considered and the packets are written without modification:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ seiscomp start slarchive
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE EXECUTION
|
||||
.sp
|
||||
Writing to \fBother layouts\fP or to \fBmultiple archives\fP and other options are
|
||||
supported when executing slarchive on the command line.
|
||||
E.g. to write to more than one archive simply specify multiple format definitions
|
||||
(or presets).
|
||||
.sp
|
||||
For more command\-line option read the help:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ slarchive \-h
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH MULTIPLE INSTANCES
|
||||
.sp
|
||||
slarchive allows generating aliases, e.g. for running in multiple instances with
|
||||
different module and bindings configurations. For creating/removing aliases use the
|
||||
\fI\%seiscomp script\fP, e.g.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
$ seiscomp alias create slarchive2 slarchive
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SDS DEFINITION
|
||||
.sp
|
||||
SDS is the basic directory and file layout in \fISeisComP\fP for waveform archives. The
|
||||
archive base directory is defined by \fI\%archive\fP\&. The SDS layout is defined
|
||||
as:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
<SDSdir>
|
||||
+ year
|
||||
+ network code
|
||||
+ station code
|
||||
+ channel code
|
||||
+ one file per day and location, e.g. NET.STA.LOC.CHAN.D.YEAR.DOY
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
File example: \fB<SDSdir>/Year/NET/STA/CHAN.TYPE/NET.STA.LOC.CHAN.TYPE.YEAR.DAY\fP\&.
|
||||
.TS
|
||||
center;
|
||||
|l|l|.
|
||||
_
|
||||
T{
|
||||
Field
|
||||
T} T{
|
||||
Description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
SDSdir
|
||||
T} T{
|
||||
Arbitrary base directory
|
||||
T}
|
||||
_
|
||||
T{
|
||||
YEAR
|
||||
T} T{
|
||||
4 digit YEAR
|
||||
T}
|
||||
_
|
||||
T{
|
||||
NET
|
||||
T} T{
|
||||
Network code/identifier, 1\-8 characters,
|
||||
no spaces
|
||||
T}
|
||||
_
|
||||
T{
|
||||
STA
|
||||
T} T{
|
||||
Station code/identifier, 1\-8 characters,
|
||||
no spaces
|
||||
T}
|
||||
_
|
||||
T{
|
||||
CHAN
|
||||
T} T{
|
||||
Channel code/identifier, 1\-8 characters,
|
||||
no spaces
|
||||
T}
|
||||
_
|
||||
T{
|
||||
TYPE
|
||||
T} T{
|
||||
1 character, indicating the data type,
|
||||
provided types are:
|
||||
.nf
|
||||
\fBD\fP Waveform data
|
||||
\fBE\fP Detection data
|
||||
\fBL\fP Log data
|
||||
\fBT\fP Timing data
|
||||
\fBC\fP Calibration data
|
||||
\fBR\fP Response data
|
||||
\fBO\fP Opaque data
|
||||
.fi
|
||||
T}
|
||||
_
|
||||
T{
|
||||
LOC
|
||||
T} T{
|
||||
Location identifier, 1\-8 characters,
|
||||
no spaces
|
||||
T}
|
||||
_
|
||||
T{
|
||||
DAY
|
||||
T} T{
|
||||
3 digit day of year, padded with zeros
|
||||
T}
|
||||
_
|
||||
.TE
|
||||
.SH MODULE CONFIGURATION
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
slarchive is a \fI\%standalone module\fP and does not inherit \fI\%global options\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.nf
|
||||
\fBetc/defaults/slarchive.cfg\fP
|
||||
\fBetc/slarchive.cfg\fP
|
||||
\fB~/.seiscomp/slarchive.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B address
|
||||
Default: \fB127.0.0.1\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Host of the Seedlink server to connect to. If the acquisition
|
||||
is running on one system nothing needs to be changed.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B port
|
||||
Default: \fB18000\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
The port of the Seedlink server to connect to. If the acquisition
|
||||
is running on one system this port must match the configured
|
||||
local Seedlink port.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B archive
|
||||
Default: \fBvar/lib/archive\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Path to waveform archive where all data is stored. Relative paths
|
||||
(as the default) are treated relative to the installation
|
||||
directory ($SEISCOMP_ROOT).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B buffer
|
||||
Default: \fB1000\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Number of records (512 byte units) to buffer before flushing to
|
||||
disk.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B delay
|
||||
Default: \fB30\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
The network reconnect delay (in seconds) for the connection
|
||||
to the SeedLink server. If the connection breaks for any
|
||||
reason this will govern how soon a reconnection should be
|
||||
attempted. The default value is 30 seconds.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B networkTimeout
|
||||
Default: \fB900\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
The network timeout (in seconds) for the connection to the
|
||||
SeedLink server. If no data [or keep alive packets?] are received
|
||||
in this time range the connection is closed and re\-established
|
||||
(after the reconnect delay has expired). The default value is
|
||||
600 seconds. A value of 0 disables the timeout.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B idleTimeout
|
||||
Default: \fB300\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Timeout for closing idle data stream files in seconds. The idle
|
||||
time of the data streams is only checked when some packets has
|
||||
arrived. If no packets arrived no idle stream files will be
|
||||
closed. There is no reason to change this parameter except for
|
||||
the unusual cases where the process is running against an open
|
||||
file number limit. Default is 300 seconds.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B keepalive
|
||||
Default: \fB0\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Interval (in seconds) at which keepalive (heartbeat) packets
|
||||
are sent to the server. Keepalive packets are only sent if
|
||||
nothing is received within the interval. This requires a
|
||||
Seedlink version >= 3.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B validation.certs
|
||||
Default: \fBvar/lib/certs\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Path to cerificate store where all certificates and CRLs are stored. Relative
|
||||
paths(as the default) are treated relative to the installation
|
||||
directory ($SEISCOMP_ROOT).
|
||||
If the signature check is enabled slarchive loads all files at start. The store
|
||||
uses the OpenSSl store format. From the offical OpenSSL documentation:
|
||||
\(dqThe directory should contain one certificate or CRL per file in PEM format,
|
||||
with a file name of the form hash.N for a certificate, or hash.rN for a CRL.
|
||||
The .N or .rN suffix is a sequence number that starts at zero, and is incremented
|
||||
consecutively for each certificate or CRL with the same hash value. Gaps in the
|
||||
sequence numbers are not supported, it is assumed that there are no more objects
|
||||
with the same hash beyond the first missing number in the sequence.The .N or .rN suffix
|
||||
is a sequence number that starts at zero, and is incremented consecutively for
|
||||
each certificate or CRL with the same hash value. Gaps in the sequence numbers
|
||||
are not supported, it is assumed that there are no more objects with the same
|
||||
hash beyond the first missing number in the sequence.\(dq
|
||||
The hash value can be obtained as follows:
|
||||
.sp
|
||||
openssl x509 \-hash \-noout \-in <file>
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B validation.mode
|
||||
Default: \fBignore\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Signatures are expected to be carried in blockette 2000
|
||||
as opaque data. Modes:
|
||||
.sp
|
||||
ignore : Signatures will be ignored and no further actions
|
||||
will be taken.
|
||||
warning: Signatures will be checked and all received records
|
||||
which do not carry a valid signature or no signature
|
||||
at all will be logged with at warning level.
|
||||
skip : All received records without a valid signature
|
||||
will be ignored and will not be processed.
|
||||
.UNINDENT
|
||||
.SH BINDINGS PARAMETERS
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B selectors
|
||||
Type: \fIlist:string\fP
|
||||
.sp
|
||||
List of stream selectors. If left empty all available
|
||||
streams will be requested. See slarchive manpage for
|
||||
more information.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B keep
|
||||
Default: \fB30\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
Unit: \fIday\fP
|
||||
.sp
|
||||
Number of days the data is kept in the archive. This
|
||||
requires purge_datafile to be run as cronjob.
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBslarchive [OPTION]... [host][:][port]\fP
|
||||
.sp
|
||||
Address ([host][:][port]) is a required argument. It specifies the address
|
||||
of the SeedLink server in host:port format. Either the host, port or both
|
||||
can be omitted. If host is omitted then localhost is assumed,
|
||||
i.e. \(aq:18000\(aq implies \(aqlocalhost:18000\(aq. If the port is omitted
|
||||
then 18000 is assumed, i.e. \(aqlocalhost\(aq implies \(aqlocalhost:18000\(aq.
|
||||
If only \(aq:\(aq is specified \(aqlocalhost:18000\(aq is assumed.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-V
|
||||
Print program version and exit.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h
|
||||
Print program usage and exit.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-v
|
||||
Be more verbose. This flag can be used multiple times (\(dq\-v \-v\(dq or \(dq\-vv\(dq)
|
||||
for more verbosity. One flag: report basic handshaking (link configuration) details and
|
||||
briefly report each packet received. Two flags: report the details of the handshaking,
|
||||
each packet received and detailed connection diagnostics.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-p
|
||||
Print details of received Mini\-SEED data records. This flag can be used multiple times
|
||||
(\(dq\-p \-p\(dq or \(dq\-pp\(dq) for more detail. One flag: a single summary line
|
||||
for each data packet received. Two flags: details of the Mini\-SEED data records received,
|
||||
including information from fixed header and 100/1000/1001 blockettes.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-nd delay
|
||||
The network reconnect delay (in seconds) for the connection to the SeedLink server.
|
||||
If the connection breaks for any reason this will govern how soon a reconnection should
|
||||
be attempted. The default value is 30 seconds.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-nt timeout
|
||||
The network timeout (in seconds) for the connection to the SeedLink server. If no data
|
||||
[or keep alive packets?] are received in this time range the connection is closed and
|
||||
re\-established (after the reconnect delay has expired). The default value is 600 seconds.
|
||||
A value of 0 disables the timeout.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-k keepalive
|
||||
Interval (in seconds) at which keepalive (heartbeat) packets are sent to the server.
|
||||
Keepalive packets are only sent if nothing is received within the interval. Requires SeedLink
|
||||
version >= 3.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-x statefile[:interval]
|
||||
During client shutdown the last received sequence numbers and time stamps (start times)
|
||||
for each data stream will be saved in this file. If this file exists upon startup the information
|
||||
will be used to resume the data streams from the point at which they were stopped. In this way the
|
||||
client can be stopped and started without data loss, assuming the data are still available on the
|
||||
server. If an interval is specified the state will be saved every interval in that packets are
|
||||
received. Otherwise the state will be saved only on normal program termination.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i timeout
|
||||
Timeout for closing idle data stream files in seconds. The idle time of the data streams is
|
||||
only checked when some packets has arrived. If no packets arrived no idle stream files will be
|
||||
closed. There is no reason to change this parameter except for the unusual cases where the
|
||||
process is running against an open file number limit. Default is 300 seconds.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-d
|
||||
Configure the connection in \(dqdial\-up\(dq mode. The remote server will close the connection when
|
||||
it has sent all of the data in its buffers for the selected data streams. This is opposed to
|
||||
the normal behavior of waiting indefinitely for data.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-b
|
||||
Configure the connection in \(dqbatch\(dq mode.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-Fi[:overlap]
|
||||
Future check initially. Check the last Mini\-SEED data record in an existing archive file
|
||||
and do not write new data to that file if it is older than a certain overlap. The default
|
||||
overlap limit is 2 seconds; the overlap can be specified by appending a colon and the desired
|
||||
overlap limit in seconds to the option. If the overlap is exceeded an error message will be
|
||||
logged once for each time the file is opened. This option makes sense only for archive formats
|
||||
where each unique data stream is written to a unique file (e.g. SDS format). If a data stream
|
||||
is closed due to timeout (see option \-i) the initial future check will be preformed when the
|
||||
file is re\-opened.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-Fc[:overlap]
|
||||
Future check continuously. Available only for archive Mini\-SEED data records. Check if the
|
||||
first sample of the record is older than the last sample of the previous record for a given
|
||||
archive file, within a certain overlap. The default overlap limit is 2 seconds; the overlap
|
||||
can be specified by appending a colon and the desired overlap limit in seconds to the option.
|
||||
If the overlap is exceeded an error message will be logged once until either a non\-overlapping
|
||||
packet is received or a new archive file is used. This option only makes sense for archive
|
||||
formats where each unique data stream is written to a unique file (e.g. SDS format).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-A format
|
||||
If specified, all received packets (Mini\-SEED records) will be appended to a directory/file
|
||||
structure defined by format. All directories implied in the format string will be created if
|
||||
necessary. The option may be used multiple times to write received packets to multiple archives.
|
||||
See the section \(dqarchiving data\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-SDS path
|
||||
If specified, all received packets (Mini\-SEED records) will be saved into a Simple Data
|
||||
Structure (SDS) dir/file structure starting at the specified directory. This directory and
|
||||
all subdirectories will be created if necessary. This option is a preset of the \(aq\-A\(aq option.
|
||||
The SDS dir/file structure is:
|
||||
.sp
|
||||
<SDSdir>/<YEAR>/<NET>/<STA>/<CHAN.TYPE>/NET.STA.LOC.CHAN.TYPE.YEAR.DAY
|
||||
.sp
|
||||
Details are mentioned later on.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-BUD path
|
||||
If specified, all received waveform data packets (Mini\-SEED data records) will be saved into
|
||||
a Buffer of Uniform Data (BUD) dir/file structure starting at the specified directory.
|
||||
This directory and all subdirectories will be created if necessary. This option is a preset
|
||||
of the \(aq\-A\(aq option. The BUD dir/file structure is:
|
||||
.sp
|
||||
<BUDdir>/<NET>/<STA>/STA.NET.LOC.CHAN.YEAR.DAY
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-DLOG DLOGdir
|
||||
If specified, all received packets (Mini\-SEED data records) will be saved into an old style
|
||||
SeisComP/datalog dir/file structure starting at the specified directory. This directory and
|
||||
all subdirectories will be created if necessary. This option is a preset of the \(aq\-A\(aq option.
|
||||
The DLOG dir/file structure is:
|
||||
.sp
|
||||
<DLOGdir>/<STA>/[LOC.]<CHAN>.<TYPE>/STA.NET.CHAN.TYPE.YEAR.DAY.HHMM
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-l streamfile
|
||||
The given file contains a list of streams. This option implies multi\-station mode.
|
||||
The format of the stream list file is given below in the section \(dqstream list file\(dq.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-s selectors
|
||||
Defining default selectors. If no multi\-station data streams are configured these selectors
|
||||
will be used for uni\-station mode. Otherwise these selectors will be used when no selectors
|
||||
are specified for a given stream with the \(aq\-S\(aq or \(aq\-l\(aq options.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-S stream[:selectors]
|
||||
The connection will be configured in multi\-station mode with optional SeedLink selectors
|
||||
for each station, see examples below. Stream should be provided in NET_STA format. If no
|
||||
selectors are provided for a given stream, the default selectors will be used, if defined.
|
||||
.sp
|
||||
Requires SeedLink >= 2.5.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-tw start:[end]
|
||||
Specifying a time window for the data streams that is applied by the server. The format
|
||||
for both times is year,month,day,hour,min,sec; for example: \(dq2002,08,05,14,00:2002,08,05,14,15,00\(dq.
|
||||
The end time is optional but the colon must be present. If no end time is specified the
|
||||
server will send data indefinitely. This option will override any saved state information.
|
||||
.sp
|
||||
Warning: time windowing might be disabled on the remote server.
|
||||
.sp
|
||||
Requires SeedLink >= 3.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
521
share/man/man1/slinktool.1
Normal file
521
share/man/man1/slinktool.1
Normal file
@ -0,0 +1,521 @@
|
||||
.\" 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 "SLINKTOOL" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
slinktool \- SeisComP Documentation
|
||||
.sp
|
||||
\fBSeedLink query interface module\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
slinktool connects to a \fI\%seedlink\fP server and queries the server for information
|
||||
or requests data using uni\-station or multi\-station mode and prints information
|
||||
about the packets received. All received packets can optionally be dumped to a
|
||||
single file or saved in custom directory and file layouts.
|
||||
.SH EXAMPLES
|
||||
.SS All\-station/Uni\-station mode
|
||||
.sp
|
||||
The following would connect to a SeedLink server at slink.host.com port 18000 and
|
||||
configure the link in all\-station/uni\-station mode, exactly which data are received
|
||||
depends on the data being served by the SeedLink server on that particular port.
|
||||
Additionally, all of the received packets are appended to the file \(aqdata.mseed\(aq
|
||||
and each packet received is reported on the standard output.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
slinktool \-v \-o data.mseed slink.host.com:18000
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The \(aq\-s\(aq argument could be used to indicate selectors to limit the type of packets
|
||||
sent by the SeedLink server (without selectors all packet types are sent). The
|
||||
following would limit this connection to BHZ channel waveform data with a location
|
||||
code of 10 (see an explanation of SeedLink selectors below). Additionally another
|
||||
verbose flag is given, causing slinktool to report detailed header information
|
||||
from data records.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
slinktool \-vv \-s 10BHZ.D \-o data.mseed slink.host.com:18000
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Multi\-station mode
|
||||
.sp
|
||||
The following example would connect to a SeedLink server on localhost port 18010
|
||||
and configure the link in multi\-station mode. Each station specified with the \(aq\-S\(aq
|
||||
argument will be requested, optionally specifying selectors for each station.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
slinktool \-v \-S GE\e_WLF,MN\e_AQU:00???,IU\e_KONO:BHZ.D :18010
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
This would request all data from the GEOFON station WLF as no selectors were indicated,
|
||||
MedNet station AQU with location code 00 and all streams and waveform data from the
|
||||
IU network station KONO from stream BHZ.
|
||||
A variety of different data selections can be made simultaneously.
|
||||
.sp
|
||||
Examples:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Horizontal BH channels, data only:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
\-s \(aqBHE.D BHN.D\(aq \-S \(aqGE\e_STU,GE\e_MALT,GE\e_WLF\(aq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP \(bu 2
|
||||
Vertical channels only:
|
||||
.INDENT 2.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
\-s BHZ \-S GE\e_STU,GE\e_WLF,GE\e_RUE,GE\e_EIL
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Wildcarding network and station codes
|
||||
.sp
|
||||
Some SeedLink implementations support wildcarding of the network and station codes.
|
||||
If this is the case, the only two wildcard characters recognized are \(aq*\(aq for
|
||||
one or more characters and \(aq?\(aq for any single character.
|
||||
.sp
|
||||
As an example, all US network data can be requested using the following syntax
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
\-S \(aqUS\e_\e*\(aq
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SEEDLINK SELECTORS
|
||||
.sp
|
||||
SeedLink selectors are used to request specific types of data within a given data
|
||||
stream, in effect limiting the default action of sending all data types.
|
||||
A data packet is sent to the client if it matches any positive selector
|
||||
(without leading \(dq!\(dq) and doesn\(aqt match any negative selectors (with a leading \(dq!\(dq).
|
||||
The general format of selectors is LLSSS.T, where LL is location, SSS is channel
|
||||
and T is type (one of [DECOTL] for Data, Event, Calibration, Blockette, Timing,
|
||||
and Log records). \(dqLL\(dq, \(dq.T\(dq, and \(dqLLSSS.\(dq can be omitted, implying anything in
|
||||
that field. It is also possible to use \(dq?\(dq in place of L and S as a single character
|
||||
wildcard. Multiple selectors are separated by space(s).
|
||||
.sp
|
||||
Examples:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
BH? \- BHZ, BHN, BHE (all record types)
|
||||
00BH?.D \- BHZ, BHN, BHE with location code \(aq00\(aq (data records)
|
||||
BH? !E \- BHZ, BHN, BHE (excluding detection records)
|
||||
BH? E \- BHZ, BHN, BHE & detection records of all channels
|
||||
!LCQ !LEP \- exclude LCQ and LEP channels
|
||||
!L !T \- exclude log and timing records
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH ARCHIVING DATA
|
||||
.sp
|
||||
Using the \(aq\-A format\(aq option received data can be saved in a custom directory and
|
||||
file structure. The archive format argument is expanded for each packet processed
|
||||
using the following flags:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
n : network code, white space removed
|
||||
s : station code, white space removed
|
||||
l : location code, white space removed
|
||||
c : channel code, white space removed
|
||||
Y : year, 4 digits
|
||||
y : year, 2 digits zero padded
|
||||
j : day of year, 3 digits zero padded
|
||||
H : hour, 2 digits zero padded
|
||||
M : minute, 2 digits zero padded
|
||||
S : second, 2 digits zero padded
|
||||
F : fractional seconds, 4 digits zero padded
|
||||
% : the percent (%) character
|
||||
# : the number (#) character
|
||||
t : single character type code:
|
||||
D \- waveform data packet
|
||||
E \- detection packet
|
||||
C \- calibration packet
|
||||
T \- timing packet
|
||||
L \- log packet
|
||||
O \- opaque data packet
|
||||
U \- unknown/general packet
|
||||
I \- INFO packet
|
||||
? \- unidentifiable packet
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The flags are prefaced with either the % or # modifier. The % modifier indicates
|
||||
a defining flag while the # indicates a non\-defining flag. All received packets
|
||||
with the same set of defining flags will be saved to the same file. Non\-defining
|
||||
flags will be expanded using the values in the first packet received for the
|
||||
resulting file name.
|
||||
.sp
|
||||
Time flags are based on the start time of the given packet.
|
||||
.sp
|
||||
For example, the format string:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
/archive/%n/%s/%n.%s.%l.%c.%Y.%j
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
would be expanded to day length files named something like:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
/archive/NL/HGN/NL.HGN..BHE.2003.055
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Using non\-defining flags the format string:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
/data/%n.%s.%Y.%j.%H:#M:#S.miniseed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
would be expanded to:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
/data/NL.HGN.2003.044.14:17:54.miniseed
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
resulting in hour length files because the minute and second are specified with the non\-defining modifier. The minute and second fields are from the first packet in the file.
|
||||
.SH STREAM LIST FILE
|
||||
.sp
|
||||
The stream list file used with the \(aq\-l\(aq option is expected to define a data stream
|
||||
on each line. The format of each line is:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
Network Station [selectors]
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The selectors are optional. If default selectors are also specified (with the \(aq\-s\(aq option),
|
||||
they they will be used when no selectors are specified for a given stream.
|
||||
.sp
|
||||
Example:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
\-\-\-\- Begin example file \-\-\-\-\-
|
||||
# Comment lines begin with a \(aq#\(aq or \(aq\e*\(aq
|
||||
# Example stream list file for use with the \-l argument of slclient or
|
||||
# with the sl\e_read\e_streamlist() libslink function.
|
||||
GE ISP BH?.D
|
||||
NL HGN
|
||||
MN AQU BH? HH?
|
||||
\-\-\-\- End example file \-\-\-\-\-
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
All diagnostic output from slinktool is printed to standard error (stderr).
|
||||
Exceptions are when
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Printing miniSEED packet details with the \fI\-p\fP option.
|
||||
.IP \(bu 2
|
||||
Printing unpacked samples with the \fI\-u\fP option.
|
||||
.IP \(bu 2
|
||||
Printing the raw or formatted responses to INFO requests.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH AUTHOR OF SLINKTOOL
|
||||
.sp
|
||||
Chad Trabant
|
||||
.sp
|
||||
ORFEUS Data Center/EC\-Project MEREDIAN
|
||||
.sp
|
||||
IRIS Data Management Center
|
||||
.sp
|
||||
Original source code: \fI\%https://github.com/iris\-edu/slinktool/tree/master/doc\fP
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBslinktool [OPTION]... [host][:][port]\fP
|
||||
.sp
|
||||
Address ([host][:][port]) is a required argument. It specifies the address
|
||||
of the SeedLink server in host:port format. Either the host, port or both
|
||||
can be omitted. If host is omitted then localhost is assumed,
|
||||
i.e. \(aq:18000\(aq implies \(aqlocalhost:18000\(aq. If the port is omitted,
|
||||
then 18000 is assumed, i.e. \(aqlocalhost\(aq implies \(aqlocalhost:18000\(aq.
|
||||
If only \(aq:\(aq is specified, \(aqlocalhost:18000\(aq is assumed.
|
||||
.SS General program options
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-V
|
||||
Print program version and exit.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h
|
||||
Print program usage and exit.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-v
|
||||
Be more verbose. This flag can be used multiple times (\(dq\-v \-v\(dq or \(dq\-vv\(dq)
|
||||
for more verbosity. One flag: report basic handshaking (link configuration) details and
|
||||
briefly report each packet received. Two flags: report the details of the handshaking,
|
||||
each packet received and detailed connection diagnostics.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-P
|
||||
Ping the server, report the server ID and exit.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-p
|
||||
Print details of received Mini\-SEED data records. This flag can be used multiple times
|
||||
(\(dq\-p \-p\(dq or \(dq\-pp\(dq) for more detail. One flag: a single summary line
|
||||
for each data packet received. Two flags: details of the Mini\-SEED data records received,
|
||||
including information from fixed header and 100/1000/1001 blockettes.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-u
|
||||
Print unpacked samples of data packets.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-nd delay
|
||||
The network reconnect delay for the connection to the SeedLink server.
|
||||
If the connection breaks for any reason this will govern how soon a reconnection should
|
||||
be attempted.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-nt timeout
|
||||
The network timeout (in seconds) for the connection to the SeedLink server. If no data
|
||||
[or keep alive packets?] are received in this time range the connection is closed and
|
||||
re\-established (after the reconnect delay has expired). The default value is 600 seconds.
|
||||
A value of 0 disables the timeout.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-k interval
|
||||
Interval at which keepalive (heartbeat) packets are sent to the server.
|
||||
Keepalive packets are only sent if nothing is received within the interval.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-x sfile[:interval]
|
||||
Save/restore stream state information to this file.
|
||||
.sp
|
||||
During client shutdown the last received sequence numbers and time stamps (start times)
|
||||
for each data stream will be saved in this file. If this file exists upon startup the information
|
||||
will be used to resume the data streams from the point at which they were stopped. In this way the
|
||||
client can be stopped and started without data loss, assuming the data are still available on the
|
||||
server. If an interval is specified the state will be saved every interval in that packets are
|
||||
received. Otherwise the state will be saved only on normal program termination.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-d
|
||||
Configure the connection in \(dqdial\-up\(dq mode. The remote server will close the connection when
|
||||
it has sent all of the data in its buffers for the selected data streams. This is opposed to
|
||||
the normal behavior of waiting indefinitely for data.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-b
|
||||
Configure the connection in \(dqbatch\(dq mode.
|
||||
.UNINDENT
|
||||
.SS Data stream selection
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-s selector
|
||||
Selectors for uni\-station or default for multi\-station mode
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-l listfile
|
||||
Read a stream list from this file for multi\-station mode
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-S streams
|
||||
Define a stream list for multi\-station mode.
|
||||
.sp
|
||||
\(aqstreams\(aq = \(aqstream1[:selectors1],stream2[:selectors2],...\(aq
|
||||
.sp
|
||||
\(aqstream\(aq is in NET_STA format, for example:
|
||||
.sp
|
||||
\-S \(dqIU_KONO:BHE BHN,GE_WLF,MN_AQU:HH?.D\(dq
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-tw begin:[end]
|
||||
Specify a time window in year,month,day,hour,min,sec format.
|
||||
.sp
|
||||
Example: \-tw 2002,08,05,14,00,00:2002,08,05,14,15,00
|
||||
.sp
|
||||
The end time is optional, but the colon must be present.
|
||||
.UNINDENT
|
||||
.SS Data saving options
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o dumpfile
|
||||
Write all received records to this file
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-A format
|
||||
If specified, all received packets (Mini\-SEED records) will be appended to a directory/file
|
||||
structure defined by format. All directories implied in the format string will be created if
|
||||
necessary.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-SDS SDSdir
|
||||
If specified, all received packets (Mini\-SEED records) will be saved into a Simple Data
|
||||
Structure (SDS) dir/file structure starting at the specified directory. This directory and
|
||||
all subdirectories will be created if necessary. This option is a preset of the \(aq\-A\(aq option.
|
||||
The SDS dir/file structure is:
|
||||
.sp
|
||||
<SDSdir>/<YEAR>/<NET>/<STA>/<CHAN.TYPE>/NET.STA.LOC.CHAN.TYPE.YEAR.DAY
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-BUD BUDdir
|
||||
If specified, all received waveform data packets (Mini\-SEED data records) will be saved into
|
||||
a Buffer of Uniform Data (BUD) dir/file structure starting at the specified directory.
|
||||
This directory and all subdirectories will be created if necessary. This option is a preset
|
||||
of the \(aq\-A\(aq option. The BUD dir/file structure is:
|
||||
.sp
|
||||
<BUDdir>/<NET>/<STA>/STA.NET.LOC.CHAN.YEAR.DAY
|
||||
.UNINDENT
|
||||
.SS Data server
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i type
|
||||
Send info request, type is one of the following:
|
||||
.sp
|
||||
ID, CAPABILITIES, STATIONS, STREAMS, GAPS, CONNECTIONS, ALL
|
||||
.sp
|
||||
The returned raw XML is displayed when using this option.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-I
|
||||
Print formatted server id and version
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-L
|
||||
Print formatted station list (if supported by server)
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-Q
|
||||
Print formatted stream list (if supported by server)
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-G
|
||||
Print formatted gap list (if supported by server)
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-C
|
||||
Print formatted connection list (if supported by server)
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
240
share/man/man1/slmon.1
Normal file
240
share/man/man1/slmon.1
Normal file
@ -0,0 +1,240 @@
|
||||
.\" 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 "SLMON" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
slmon \- SeisComP Documentation
|
||||
.sp
|
||||
\fBSeedLink monitor creating web pages\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
\fIslmon\fP collects waveform QC parameters from a configured \fI\%seedlink\fP Server
|
||||
and creates static HTML websites for their visualization. \fI\%Station summeries\fP and
|
||||
\fI\%per\-station channels views\fP are available.
|
||||
.SH SETUP
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Adjust the module configuration parameters of \fIslmon\fP to set the seedlink Server,
|
||||
the output directory for the created webpages and other parameters.
|
||||
.IP 2. 3
|
||||
Create and adjust binding profiles and station bindings for \fIslmon\fP to activate
|
||||
the monitoring of the desired networks and stations.
|
||||
.IP 3. 3
|
||||
Update the configuration of \fIslmon\fP
|
||||
.IP 4. 3
|
||||
Start \fIslmon\fP\&. This step reads the QC parameters and creates the static webpage.
|
||||
The webpage is not automatically updated.
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp update\-config
|
||||
seiscomp start slmon
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.IP 5. 3
|
||||
Restart \fIslmon\fP in order to upate the webpage. The restart can be
|
||||
performed by a the regular system check scheduled by a crontab entry.
|
||||
.sp
|
||||
The example below shows a crontab entry to update the webpage
|
||||
generated by \fIslmon\fP every 3 minutes:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
*/3 * * * * /home/sysop/seiscomp/bin/seiscomp check slmon >/dev/null 2>&1
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
The crontab entry can be generated and added automatically
|
||||
using the seiscomp script:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
seiscomp print crontab | crontab \-
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
A comprehensive example for monitoring many stations of a large number of networks
|
||||
is provided by \fI\%GEOFON\fP at
|
||||
\fI\%GFZ Potsdam\fP, Germany. A simple example of a website
|
||||
create by \fIslmon\fP is given in the \fI\%figures below\fP\&.
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Example of a website with the station summary created by \fIslmon\fP\&..UNINDENT
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.INDENT 2.5
|
||||
[image]
|
||||
Example of a website with a per\-station channel view created by \fIslmon\fP\&..UNINDENT
|
||||
.UNINDENT
|
||||
.SH MODULE CONFIGURATION
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
slmon is a \fI\%standalone module\fP and does not inherit \fI\%global options\fP\&.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.nf
|
||||
\fBetc/defaults/slmon.cfg\fP
|
||||
\fBetc/slmon.cfg\fP
|
||||
\fB~/.seiscomp/slmon.cfg\fP
|
||||
.fi
|
||||
.sp
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B title
|
||||
Default: \fB\(dqSeedLink Monitor\(dq\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Title of the web page used as heading.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B refresh
|
||||
Default: \fB180\fP
|
||||
.sp
|
||||
Type: \fIdouble\fP
|
||||
.sp
|
||||
Unit: \fIs\fP
|
||||
.sp
|
||||
Refresh interval of the generated web page used by the browser.
|
||||
The interval should be similar to the interval for starting slmon.
|
||||
If empty, the web page must be manually refreshed from within
|
||||
the browser.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B address
|
||||
Default: \fB127.0.0.1\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Host of the Seedlink server to connect to. If the acquisition
|
||||
is running on one system nothing needs to be changed.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B port
|
||||
Default: \fB18000\fP
|
||||
.sp
|
||||
Type: \fIint\fP
|
||||
.sp
|
||||
The port of the Seedlink server to connect to. If the acquisition
|
||||
is running on one system this port must match the configured
|
||||
local Seedlink port.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B email
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
e\-mail address added to web pages.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B wwwdir
|
||||
Default: \fB@ROOTDIR@/var/run/@NAME@\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Output directory of the web pages.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B icon
|
||||
Default: \fBhttp://www.gfz\-potsdam.de/favicon.ico\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Favicon URL of the web pages. Not mandatory.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B linkname
|
||||
Default: \fBGEOFON\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Name of Link shown in footer of web pages.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B linkurl
|
||||
Default: \fBhttp://www.gfz\-potsdam.de/geofon/\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
URL referred to by linkname in footer of web pages.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B liveurl
|
||||
Default: \fBhttp://geofon.gfz\-potsdam.de/waveform/liveseis.php?station=%s\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
URL to live seismograms. %s will be replaced by station name.
|
||||
Not mandatory.
|
||||
.UNINDENT
|
||||
.SH BINDINGS PARAMETERS
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B group
|
||||
Default: \fBlocal\fP
|
||||
.sp
|
||||
Type: \fIstring\fP
|
||||
.sp
|
||||
Defines the group of the station that is monitored.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
104
share/man/man1/tab2inv.1
Normal file
104
share/man/man1/tab2inv.1
Normal file
@ -0,0 +1,104 @@
|
||||
.\" 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 "TAB2INV" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
tab2inv \- SeisComP Documentation
|
||||
.sp
|
||||
\fBtab to SeisComp3 inventory converter\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
The tab2inv program is part of the nettab package distributed together with the
|
||||
\fISeisComP\fP package. The nettab is a text\-based format developed inside the
|
||||
GEOFON data center to describe seismological instruments responses information.
|
||||
The tab2inv program can generate \fISeisComP\fP inventory files by parsing
|
||||
\'\'tab files\'\' as described by in the nettab format.
|
||||
.sp
|
||||
This program can read a set of tab files in the nettab format,
|
||||
verify their contents and generate inventory for the stations
|
||||
described in them.
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBtab2inv [options] tab\-file [more\-tab\-file]\fP
|
||||
.SS Options
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h, \-\-help
|
||||
Prints a small help message and exits.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-f, \-\-filterf
|
||||
Indicate the filter folder. The filter folder is where the program will search for the files indicated by the Ff and If lines.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-x, \-\-xmlf
|
||||
Indicate a folder containing a set of XML files that contains the SeisComp3 inventory files that will be used to resolve the station groups. Normally this folder is seiscomp/etc/inventory.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-D, \-\-database
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-force
|
||||
Don\(aqt stop on errors of individual files. Try to perform the requested task even if some files contain formatting errors.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-g, \-\-generate
|
||||
This option instruct the program to generate the XML document in the end of processing. When you don\(aqt supply this option the file is just parsed and loaded into objects in the memory.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-c, \-\-check
|
||||
Perform some tests after the files can be loaded. The tests include testing that the instruments all can be resolved and has no unused instruments supplied.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-d, \-\-default
|
||||
Use this option to indicate a default file. A default file is a file containing normally a set of rules for Network (Na), Stations (Sa) and Instruments (Ia) that are applied for every object created before the attributes specified in the file are applied. This option help sto set parameters that you want to be set on all objects.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output
|
||||
Use this option to indicate the output filename for the XML file. If not indicated the program will write the output file to STDOUT.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-i, \-\-ip
|
||||
Allow prefixing of the instrument (Datalogger or Sensor) name attribute on the inventory generated by a prefix. This option is normally used when you want to convert many networks that share the same instrumentation in different calls of the program. In each call of the program you can supply the network code and year as padding to guarantee that the instruments generated in both runs of the program will have different name values that are used as Key on the SeisComp3 inventory.
|
||||
.UNINDENT
|
||||
.SH AUTHOR
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.SH COPYRIGHT
|
||||
gempa GmbH, GFZ Potsdam
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
184
share/man/man1/tabinvmodifier.1
Normal file
184
share/man/man1/tabinvmodifier.1
Normal file
@ -0,0 +1,184 @@
|
||||
.\" 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 "TABINVMODIFIER" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
|
||||
.SH NAME
|
||||
tabinvmodifier \- SeisComP Documentation
|
||||
.sp
|
||||
\fBtab\-based inventory modifier\fP
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
Sometimes small tweaks need to be made to inventory.
|
||||
The tabinvmodifier program reads a \fIrules file\fP (a network tab file without any station lines) and applies network and station attributes to existing inventory. This method can be used to modify attributes in inventory that originate from dataless SEED or other sources. It can change inventory at the network, station, location, and channel level; it can also change sensor and datalogger attributes (Ia lines).
|
||||
Currently (2016) changes to station groups (virtual networks) aren\(aqt supported.
|
||||
.sp
|
||||
For details of what can go in a tab file, see
|
||||
\fI\%NETTAB File Format Description\fP\&.
|
||||
.sp
|
||||
tabinvmodifier can either write directly to the inventory in an SC3 database, or dump its output as an XML file.
|
||||
If output is as an XML file, typically this would then be moved to ~/seiscomp/etc/inventory, and then loaded into the database with \fIseiscomp update\-config\fP\&.
|
||||
.SH EXAMPLES
|
||||
.INDENT 0.0
|
||||
.IP 1. 3
|
||||
Set network\-level attributes. Suppose the file \fIge.rules\fP contains
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
Nw: GE 1993/001
|
||||
Na: Description=\(dqGEOFON Program, GFZ Potsdam, Germany\(dq
|
||||
Na: Remark=\(dqAccess to Libyan stations and Spanish HH streams limited\(dq
|
||||
Na: Type=VBB
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The first line (Nw:) specifies the network, including its start date, that these rules apply to.
|
||||
The following lines starting with Na: provide values for the description, remark, and type attributes to be written into the new inventory.
|
||||
Note the capital letter on the attributes Description, Remark, Type, etc.
|
||||
.sp
|
||||
We can use this rules file to change attributes of the GE network:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
# Apply changes to database directly
|
||||
$ tabinvmodifier \-r ge.rules
|
||||
|
||||
# Apply changes to XML file
|
||||
$ tabinvmodifier \-r ge.rules \-\-inventory\-db ge.xml \-o ge\-mod.xml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The resulting inventory now contains:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
<network publicID=\(dqNetwork#20130513163612.389203.2\(dq code=\(dqGE\(dq>
|
||||
<start>1993\-01\-01T00:00:00.0000Z</start>
|
||||
<description>GEOFON Program, GFZ Potsdam, Germany</description>
|
||||
<institutions>GFZ/partners</institutions>
|
||||
<region>euromed global</region>
|
||||
<type>VBB</type>
|
||||
<netClass>p</netClass>
|
||||
<archive>GFZ</archive>
|
||||
<restricted>false</restricted>
|
||||
<shared>true</shared>
|
||||
<remark>access to Libyan stations and Spanish HH streams limited</remark>
|
||||
<station publicID=\(dqStation#20130620185450.488952.190\(dq code=\(dqMSBI\(dq archiveNetworkCode=\(dqGE\(dq>
|
||||
<start>2013\-06\-16T00:00:00.0000Z</start>
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Other attributes present in inventory are left unchanged.
|
||||
.IP 2. 3
|
||||
Changing location codes. (Thanks to Andres H. for this example.)
|
||||
To replace an empty location code for station \(dqKP.UPNV\(dq with location code \(dq00\(dq, together with its description and place.
|
||||
The rules file is:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
Nw: KP 1980/001
|
||||
Sa: Description=\(dqGLISN Station Upernavik, Greenland\(dq UPNV
|
||||
Sa: Place=\(dqUpernavik, Greenland\(dq UPNV
|
||||
Sa: Code=\(dq00\(dq UPNV,
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The resulting inventory now contains:
|
||||
.INDENT 3.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
<network publicID=\(dqNetwork#20140603153203.17936.2\(dq code=\(dqKP\(dq>
|
||||
<start>1980\-01\-01T00:00:00.0000Z</start>
|
||||
...
|
||||
<station publicID=\(dqStation#20140603153203.179738.3\(dq code=\(dqUPNV\(dq>
|
||||
<start>2013\-08\-01T00:00:00.0000Z</start>
|
||||
<description>GLISN Station Upernavik, Greenland</description>
|
||||
<latitude>72.7829</latitude>
|
||||
<longitude>\-56.1395</longitude>
|
||||
<elevation>38</elevation>
|
||||
<place>Upernavik, Greenland</place>
|
||||
<affiliation>GLISN</affiliation>
|
||||
...
|
||||
<sensorLocation publicID=\(dqSensorLocation#20140603153203.181119.4\(dq code=\(dq00\(dq>
|
||||
<start>2013\-08\-01T00:00:00.0000Z</start>
|
||||
...
|
||||
</station>
|
||||
</network>
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH COMMAND-LINE OPTIONS
|
||||
.sp
|
||||
\fBtabinvmodifier { \-r | \-\-rules } {rules file} [options]\fP
|
||||
.SS Options
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-r, \-\-rules
|
||||
Input filename of the rules file. A rules file is mandatory.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-e, \-\-relaxed
|
||||
Relax rules for matching NSLC items
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-o, \-\-output
|
||||
Output XML filename. Without an output file, tabinvmodifier will attempt to write to the local SeisComp3 database.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-inventory\-db
|
||||
Input file containing inventory. If this option is given, an output file must be provided with \fI\-\-output\fP\&.
|
||||
.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