[installation] Init with inital config for global

share/doc/caps/html/_sources/apps/test2caps.rst.txt

@@ -0,0 +1,224 @@
+.. highlight:: rst
+
+.. _test2caps:
+
+#########
+test2caps
+#########
+
+**Recordstream data acquisition plugin**
+
+
+Description
+===========
+
+:program:`test2caps` allows to generate test signals which are send to a CAPS
+server. This plugin is useful for testing and developing data acquisition or
+processing modules.
+
+
+
+Module Configuration
+====================
+
+| :file:`etc/defaults/global.cfg`
+| :file:`etc/defaults/test2caps.cfg`
+| :file:`etc/global.cfg`
+| :file:`etc/test2caps.cfg`
+| :file:`~/.seiscomp/global.cfg`
+| :file:`~/.seiscomp/test2caps.cfg`
+
+test2caps inherits :ref:`global options<global-configuration>`.
+
+.. note::
+
+   Modules/plugins may require a license file. The default path to license
+   files is :file:`@DATADIR@/licenses/` which can be overridden by global
+   configuration of the parameter :confval:`gempa.licensePath`. Example: ::
+
+      gempa.licensePath = @CONFIGDIR@/licenses
+
+
+
+
+Command-Line Options
+====================
+
+
+.. _General:
+
+
+General
+-------
+
+.. option:: -h, --help
+
+   Print help message
+
+.. option:: --config file
+
+   File to read configuration from
+
+.. option:: -h, --help
+
+   Print help message
+
+.. option:: --verbosity arg
+
+   Verbosity level [0..4]
+
+
+.. _Stream:
+
+
+Stream
+------
+
+.. option:: --id arg
+
+   Comma separated list of stream IDs [net.sta.loc.cha] to use
+
+.. option:: --id-file arg
+
+   File to read stream IDs from
+
+.. option:: --begin arg
+
+   Start date and time of data stream
+
+.. option:: --interval arg
+
+   Sampling interval to use, format is numerator\/denominator
+
+
+.. _Mode:
+
+
+Mode
+----
+
+.. option:: --read-from arg
+
+   File to read data from
+
+.. option:: --random arg
+
+   Generate n random samples
+
+.. option:: --stream
+
+   Generate continuous sinus data
+
+.. option:: --amplitude arg
+
+   Amplitude of sinus data
+
+.. option:: --period arg
+
+   Period of sinus data in seconds
+
+
+.. _Packets:
+
+
+Packets
+-------
+
+.. option:: --data-type arg
+
+   
+
+.. option::  arg
+
+   Data type to use. Available are: INT8, INT32, FLOAT, DOUBLE
+
+.. option:: --fill arg
+
+   Number of seconds of data to send before\/after start time
+
+.. option:: --format arg
+
+   Format description 4 characters, e.g. 'JPEG'
+
+.. option:: --mseed
+
+   Enable Steim2 encoding for RAW packets
+
+.. option:: --recsize arg
+
+   Record size in samples in stream mode
+
+.. option:: -q, --quality arg
+
+   Record timing quality
+
+.. option:: --type arg
+
+   Packet type to use, e.g. ANY, RAW
+
+
+.. _Output:
+
+
+Output
+------
+
+.. option:: -H, --Host arg
+
+   Data output host
+
+.. option:: -p, --port arg
+
+   Data output port
+
+
+.. _Verbosity:
+
+
+Verbosity
+---------
+
+.. option:: --verbosity arg
+
+   Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
+   4:debug.
+
+
+.. _Output:
+
+
+Output
+------
+
+.. option:: -H, --host arg
+
+   Data output host
+
+.. option:: -p, --port arg
+
+   Data output port
+
+
+.. _Journal:
+
+
+Journal
+-------
+
+.. option:: -j, --journal arg
+
+   File to store stream states. Use an empty string to log to standard out.
+
+.. option:: -f, --flush arg
+
+   Flush stream states to disk every n seconds
+
+.. option:: --waitForAck arg
+
+   Wait when a sync has been forced, up to n seconds
+
+.. option:: -w, --waitForLastAck arg
+
+   Wait on shutdown to receive acknownledgement messages, up to n seconds
+
+