.. highlight:: rst

.. _qlpush:

######
qlpush
######

**Module to send XML files to a QuakeLink server.**


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

qlpush is an application to populate the QuakeLink database with event
parameters read from a |scname| XML file. qlpush is part of the QuakeLink
package.

Please read the command-line help for the options:

.. code-block:: sh

   qlpush -h


Examples
========

* Populate the QuakeLink database with the preferred event parameters from an
  existing SeisComP database of a particular type and on a particular host
  <type://user:password@host/database>.

  **Code example** involving :cite:t:`scevtls` and :cite:t:`scxmldump`. The
  retrieved event paramters are re-directed to *qlpush* for sending to the
  QuakeLink server running on localhost:

  .. code-block:: sh

     scevtls --begin '2016-04-13 00:00:00' -d [database] | while read event; do
         echo "processing event $event"
         scxmldump -PAMFp -E $event -d [database] | qlpush
     done

* Remove one event with ID *gempa2022abcd* from QuakeLink running on localhost:

  .. code-block:: sh

     qlpush -r gempa2022abcd



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

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

qlpush 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
====================

:program:`qlpush [options]`

Options
-------

.. option:: -H, --host arg

   host and optional port to connect to, e.g. localhost:18011

.. option:: -h, --help

   display this help message

.. option:: -s, --ssl

   use secure socket layer \(SSL\)

.. option:: -p, --print-env

   echo event id and revision of successfully sent files

.. option:: -r, --rm

   remove the event