.. highlight:: rst

.. _scwfas:

######
scwfas
######

**Waveform archive server**


Description
===========

The waveform archive server is a small application that serves a local
SDS archive via different protocols. Currently there are two implementations:

* :ref:`fdsnws dataselect <sec-dataSelect>`

  * dataselect/1/query
  * dataselect/1/version
  * dataselect/1/application.wadl

* Arclink (deprecated)

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.

All data are forwarded unrestricted. There are no options to add restriction
checks or user authentication.


.. _scwfas_configuration:

Configuration
=============

| :file:`etc/defaults/global.cfg`
| :file:`etc/defaults/scwfas.cfg`
| :file:`etc/global.cfg`
| :file:`etc/scwfas.cfg`
| :file:`~/.seiscomp/global.cfg`
| :file:`~/.seiscomp/scwfas.cfg`

scwfas inherits :ref:`global options<global-configuration>`.



.. confval:: handlerSDS

   Type: *string*

   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.


.. confval:: filebase

   Type: *string*

   The filebase of the SDS archive. If an alternative archive
   handler is defined by \"handlerSDS\", this value serves
   as input to setSource\(\).
   Default is ``@ROOTDIR@/var/lib/archive``.

.. confval:: arclink.port

   Type: *int*

   The server port for Arclink connections. \-1
   deactivates the Arclink server. The standard Arclink port is
   18001.
   Default is ``-1``.

.. confval:: fdsnws.port

   Type: *int*

   The server port for FDSNWS connections. \-1
   deactivates the FDSN Web server.
   Default is ``8080``.

.. confval:: fdsnws.baseURL

   Type: *string*

   The base URL of the FDSN Web service that is
   given in the WADL document.
   Default is ``http://localhost:8080/fdsnws``.

.. confval:: fdsnws.maxTimeWindow

   Type: *int*

   Unit: *s*

   The aggregated maximum time window \(seconds\)
   for all requested streams. A value of 0 will deactive
   any restriction.
   Default is ``0``.


Command-line
============

.. program:: scwfas

:program:`scwfas [options]`


Generic
-------

.. option:: -h, --help

   show help message.

.. option:: -V, --version

   show version information

.. option:: --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, eg scautopick \-> scautopick2.

.. option:: --plugins arg

   Load given plugins.

.. option:: -D, --daemon

   Run as daemon. This means the application will fork itself and
   doesn't need to be started with \&.


Verbosity
---------

.. option:: --verbosity arg

   Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug

.. option:: -v, --v

   Increase verbosity level \(may be repeated, eg. \-vv\)

.. option:: -q, --quiet

   Quiet mode: no logging output

.. option:: --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.

.. option:: --component arg

   Limits the logging to a certain component. This option can be given more than once.

.. option:: -s, --syslog

   Use syslog logging back end. The output usually goes to \/var\/lib\/messages.

.. option:: -l, --lockfile arg

   Path to lock file.

.. option:: --console arg

   Send log output to stdout.

.. option:: --debug

   Debug mode: \-\-verbosity\=4 \-\-console\=1

.. option:: --trace

   Trace mode: \-\-verbosity\=4 \-\-console\=1 \-\-print\-component\=1 \-\-print\-context\=1

.. option:: --log-file arg

   Use alternative log file.


Server
------

.. option:: --arclink-port int

   Overrides configuration parameter :confval:`arclink.port`.

.. option:: --fdsnws-port int

   Overrides configuration parameter :confval:`fdsnws.port`.

.. option:: --fdsnws-baseurl string

   Overrides configuration parameter :confval:`fdsnws.baseURL`.