.. highlight:: rst

.. _scsmdump:

########
scsmdump
########

**Strong motion parameters database dump.**


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

scsmdump ...


.. _scsmdump_configuration:

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

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

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




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

.. program:: scsmdump


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

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

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

.. option:: --shutdown-master-username arg

   Set the name of the master\-username of the messaging
   used for auto\-shutdown. If \"shutdown\-master\-module\" is
   given as well, this parameter is ignored.


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:: --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:: --log-file arg

   Use alternative log file.


Database
--------

.. option:: --db-driver-list

   List all supported database drivers.

.. option:: -d, --database arg

   The database connection string, format:
   service:\/\/user:pwd\@host\/database.
   \"service\" is the name of the database driver which
   can be queried with \"\-\-db\-driver\-list\".

.. option:: --config-module arg

   The config module to use.

.. option:: --inventory-db arg

   Load the inventory from the given database or file, format:
   [service:\/\/]location .

.. option:: --db-disable

   Do not use the database at all


Input
-----

.. option:: -O, --origin originID

   Origin public ID\(s\) to dump. Multiple origins may be specified
   as a comma\-separated list. Use \"\-\" for reading from stdin.

.. option:: -E, --event eventID

   Event public ID\(s\) to dump. Multiple events may be specified
   as a comma\-separated list. Use \"\-\" for reading from stdin.


Dump
----

.. option:: -r, --with-event-records

   Include event record references. This option is necessary in order to export the records itself.

.. option:: -S, --with-records

   Include records referred to from event records. This option depends on \-\-with\-event\-records.

.. option:: -R, --with-ruptures

   Include ruptures.

.. option:: -p, --preferred-only

   When dumping events, only the preferred origin will be dumped.


Output
------

.. option:: -f, --formatted

   Use formatted XML output.

.. option:: -o, --output file

   Name of output file. If not given or '\-', output
   is sent to stdout.

