DOKK / manpages / debian 12 / tirex / tirex-send.1.en
TIREX-SEND(1) User Contributed Perl Documentation TIREX-SEND(1)

tirex-send - send messages to a tirex daemon

tirex-send [OPTIONS] TYPE [KEY=VALUE ...]

Display help message.
Run in debug mode. You'll see the actual messages sent and received.
Use the config directory DIR instead of /etc/tirex.
Talk to DESTINATION, which can be 'master' (default), 'syncd', or a port number.
Wait SECONDS for the answer after sending the message. Default is 5 seconds. If set to 0, don't wait for an answer at all. This is the default when the destination is set to syncd.

tirex-send sends a message through a UDP socket to a tirex daemon running on the local machine and waits for the answer. It can be used to check whether a daemon is running, activate debugging in the daemon, send a render request, etc.

Messages are normally sent to the tirex-master daemon, but can also be sent to a sync daemon or one of the rendering backends.

You have to give the TYPE of the message on the command line and optionally some fields in the format KEY=VALUE.

The following messages can be send to a master daemon:

Check whether server is alive.
Activate debugging in the daemon.
Deactivate debugging in the daemon.
Quit server now (unclean!).
Clean shutdown (no yet implemented XXX)
Reload renderer and map config.
Reset max queue size indicator in shared memory.
Stop feeding jobs from a bucket to the renderer. Currently rendering jobs are unaffected. Give the name of the bucket as "bucket=NAME".
Continue rendering jobs from this bucket. Give the name of the bucket as "bucket=NAME".
Add metatile to job queue.
Remove job from queue.

The following messages can be send to a syncd server:

Syncs the metatile file.

The following messages can be send to a rendering backend:

Renders the metatile requested.

/etc/tirex/tirex.conf
The configuration file.

tirex-send returns

0 if the message was answered with 'ok',
1 if the message was answered with an error,
2 if the error was 'unknown_message_type',
3 if the message could not be sent or if there was a timeout waiting for the answer,
4 if there was an error parsing the command line.

<http://wiki.openstreetmap.org/wiki/Tirex>

Frederik Ramm <frederik.ramm@geofabrik.de>, Jochen Topf <jochen.topf@geofabrik.de> and possibly others.

2023-04-11 perl v5.36.0