seiscomp-training/share/man/man1/scwfas.1

.\" Man page generated from reStructuredText.
.
.TH "SCWFAS" "1" "Jan 10, 2023" "5.3.0" "SeisComP"
.SH NAME
scwfas \- SeisComP Documentation
.
.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
..
.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
fdsnws dataselect
.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 global options\&.
.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 "handlerSDS", 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.
.