.. highlight:: rst

.. _rgsm:

####
rgsm
####

**Report generator for Strong-Motion Incidents**


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

RGSM is a module to generate reports for the strong-motion modules |shard| and
|sigma|.



Module Configuration
====================

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

rgsm 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



.. confval:: smModule

   Default: ``shard``

   Type: *string*

   Values: ``shard,sigma``

   Choose the module to calculate the reports for: either 'shard' or 'sigma'. Modify files in
   the supportive directories, e.g. station \(design spectra\), templates and media, in
   share\/rgsm\/smModule\/.


.. confval:: templateFiles

   Default: ``template.tex``

   Type: *list:string*

   Comma separated list, without spaces, of templates found in share\/smModule\/templates\/.
   Can be a single file or multiple. If multiple files are given multiple reports are
   generated simultaneously.


.. confval:: archiveDir

   Type: *string*

   If set, the generated report is archived\/copied to the following location:
   ARCHIVEDIR\/YEAR\/MONTH\/EVENTID\/. If the eventID is not available, e.g., in case of incident
   reports, the last subdirectory of the inputPath is used instead.




Command-Line Options
====================


.. _Verbosity:


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

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

.. option:: -s, --syslog

   Use syslog logging backend. 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

   Execute in debug mode.
   Equivalent to \-\-verbosity\=4 \-\-console\=1 .

.. option:: --trace

   Execute in trace mode.
   Equivalent to \-\-verbosity\=4 \-\-console\=1 \-\-print\-component\=1
   \-\-print\-context\=1 .

.. option:: --log-file arg

   Use alternative log file.


.. _Generic:


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. Example:
   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 \&.


.. _Misc:


Misc
----

.. option:: --print-vars

   Print usable variables for current and first latex template.