[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
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.
|
||||
.
|
Reference in New Issue
Block a user