### Start required SeisComP modules

Source: https://docs.gempa.de/quakelink/current/_sources/apps/qlplayback.rst.txt

Command to start the necessary QuakeLink and ql2sc modules.

```sh
seiscomp start quakelink ql2sc
```

--------------------------------

### Define station-specific configuration

Source: https://docs.gempa.de/quakelink/current/base/glossary.html

Example of standard station-specific configuration references.

```text
seedlink
scautopick
```

--------------------------------

### Configure Minimum Depth

Source: https://docs.gempa.de/quakelink/current/_sources/apps/global.rst.txt

Example of setting a minimum depth constraint using a specific unit.

```text
minDepth = 500km
```

--------------------------------

### Configure Maximum Depth

Source: https://docs.gempa.de/quakelink/current/_sources/apps/global.rst.txt

Example of setting a maximum depth constraint using a specific unit.

```text
maxDepth = 500km
```

--------------------------------

### Define profile-based configuration

Source: https://docs.gempa.de/quakelink/current/base/glossary.html

Example of using profiles to reference shared configuration sets instead of individual station settings.

```text
seedlink:geofon
scautopick:teleseismic
```

--------------------------------

### Display help message

Source: https://docs.gempa.de/quakelink/current/_sources/apps/qlplayback.rst.txt

View the command-line help and available options for qlplayback.

```sh
qlplayback -h
```

--------------------------------

### Display sc2ql help

Source: https://docs.gempa.de/quakelink/current/_sources/apps/sc2ql.rst.txt

View the command-line help and available options for the sc2ql application.

```sh
sc2ql -h
```

--------------------------------

### Display qlpush help

Source: https://docs.gempa.de/quakelink/current/_sources/apps/qlpush.rst.txt

View the command-line help and available options for the qlpush application.

```sh
qlpush -h
```

--------------------------------

### Display ql2ql help

Source: https://docs.gempa.de/quakelink/current/_sources/apps/ql2ql.rst.txt

View available command-line options for the ql2ql module.

```sh
ql2ql -h
```

--------------------------------

### Configure Maximum Distance

Source: https://docs.gempa.de/quakelink/current/_sources/apps/global.rst.txt

Example of setting a maximum distance constraint using a specific unit.

```text
maxDist = 500km
```

--------------------------------

### Configure Station Bindings and Profiles

Source: https://docs.gempa.de/quakelink/current/_sources/base/glossary.rst.txt

Demonstrates the difference between standard station-specific configuration and using a profile to manage multiple stations.

```sh
seedlink
scautopick
```

```sh
seedlink:geofon
scautopick:teleseismic
```

--------------------------------

### Configure Minimum Distance

Source: https://docs.gempa.de/quakelink/current/_sources/apps/global.rst.txt

Example of setting a minimum distance constraint using a specific unit.

```text
minDist = 500km
```

--------------------------------

### Display qltool help

Source: https://docs.gempa.de/quakelink/current/_sources/apps/qltool.rst.txt

Displays the command-line help and available options for qltool.

```sh
qltool -h
```

--------------------------------

### Example event filter

Source: https://docs.gempa.de/quakelink/current/_sources/apps/ql2ql.rst.txt

Filter events with magnitude >= 6.0, at least 10 phases, and depth < 100km.

```sql
MAG >= 6.0 AND PHASES >= 10 AND DEPTH < 100
```

--------------------------------

### Configure QuakeLink Ports and SSL

Source: https://docs.gempa.de/quakelink/current/_sources/base/examples.rst.txt

Set network ports and SSL security parameters in quakelink.cfg.

```sh
QL.port = 18010
QL.pluginPort = 18011
QL.http.port = 18080
```

```sh
QL.https.port = 22
QL.SSL.port = 22

QL.SSL.certificate = ...
QL.SSL.key = ...
QL.SSL.users =...
```

--------------------------------

### Define Magnitude Aliases

Source: https://docs.gempa.de/quakelink/current/_sources/apps/global.rst.txt

Examples for deriving a new magnitude type ABC from an existing MLv magnitude type.

```text
ABC:MLv:MLv
```

```text
ABC:MLv
```

--------------------------------

### Push events to QuakeLink

Source: https://docs.gempa.de/quakelink/current/_sources/base/examples.rst.txt

Use the qlpush command to send an events.xml file to a local QuakeLink server.

```bash
qlpush -H localhost:18011 events.xml
```

--------------------------------

### Configure QuakeLink Plugins

Source: https://docs.gempa.de/quakelink/current/apps/quakelink.html

Define active plugins by adding them to the QL.plugins list; inactive plugins are ignored.

```text
QL.plugins = a,b
QL.plugin.a.value1 = ...
QL.plugin.b.value1 = ...
# c is not active because it has not been added
# to the list of QL.plugins
QL.plugin.c.value1 = ...
```

--------------------------------

### Generic Options

Source: https://docs.gempa.de/quakelink/current/_sources/apps/global.rst.txt

Standard command-line options for help, versioning, configuration, and daemon mode.

```APIDOC
## Generic Options

- **-h, --help**: Show help message.
- **-V, --version**: Show version information.
- **--config-file file**: The alternative module configuration file.
- **--plugins arg**: Load given plugins.
- **-D, --daemon**: Run as daemon.
- **--auto-shutdown arg**: Enable/disable self-shutdown because a master module shutdown.
- **--shutdown-master-module arg**: Set the name of the master-module used for auto-shutdown.
- **--shutdown-master-username arg**: Set the name of the master-username of the messaging used for auto-shutdown.
```

--------------------------------

### Populate QuakeLink database with events

Source: https://docs.gempa.de/quakelink/current/_sources/apps/qlpush.rst.txt

Pipe event parameters from scevtls and scxmldump into qlpush to send them to a local QuakeLink server.

```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
```

--------------------------------

### Import events from remote SeisComP

Source: https://docs.gempa.de/quakelink/current/_sources/base/examples.rst.txt

Use ql2sc to fetch events from the past 10 days from a remote QuakeLink server into a SeisComP system.

```bash
ql2sc --backLog 864000 --debug
```

--------------------------------

### Define host profiles

Source: https://docs.gempa.de/quakelink/current/_sources/apps/ql2ql.rst.txt

Register and configure multiple QuakeLink host connections.

```sh
hosts = a,b
host.a.value1 = ...
host.b.value1 = ...
# c is not active because it has not been added
# to the list of hosts
host.c.value1 = ...
```

--------------------------------

### Configure ql2sc with scevent

Source: https://docs.gempa.de/quakelink/current/_sources/apps/qlplayback.rst.txt

Configuration for forwarding playback data to SeisComP when scevent is running for interactive analysis.

```sh
hosts = playback

# Request native data instead of XML format. Native data export may be disabled
# on some hosts.
host.playback {
    native = true
    url = ql://localhost:18010
    syncEventAttributes = true
    routingTable = Pick:IMPORT_GROUP,\
                   Amplitude:IMPORT_GROUP,\
                   Origin:EVENT,\
                   FocalMechanism::EVENT
}
```

--------------------------------

### Execute event playback

Source: https://docs.gempa.de/quakelink/current/_sources/apps/qlplayback.rst.txt

Run a playback for a specific event located in the QuakeLink archive.

```sh
qlplayback $SEISCOMP_ROOT/var/lib/quakelink/archive/2022/09/18/gempa2022shod
```

--------------------------------

### Configure ql2sc Host Profiles

Source: https://docs.gempa.de/quakelink/current/_sources/base/examples.rst.txt

Define remote host connections and routing tables for ql2sc.cfg.

```sh
hosts = hostB, hostC

host.hostB.url = qls://user:passwd@remotehostB:18010
host.hostB.native = false
host.hostB.syncEventAttributes = false
host.hostB.syncJournals = true
host.hostB.routingTable = Pick:IMPORT_GROUP, Amplitude:IMPORT_GROUP, FocalMechanism:EVENT, Origin:EVENT
```

--------------------------------

### Configure scevent for TB2

Source: https://docs.gempa.de/quakelink/current/base/examples.html

Initial configuration for the TB2 testbed system.

```text
eventAssociation.agencies = GEMPA_TB1
eventAssociation.priorities = MODE, AGENCY, STATUS, PHASES_AUTOMATIC, TIME_AUTOMATIC
```

--------------------------------

### Configure QuakeLink SSL/TLS

Source: https://docs.gempa.de/quakelink/current/base/examples.html

Defines ports and credentials for encrypted communication.

```ini
QL.https.port = 22
QL.SSL.port = 22

QL.SSL.certificate = ...
QL.SSL.key = ...
QL.SSL.users =...
```