Tirex/Commands

From OpenStreetMap Wiki
Jump to: navigation, search

The Tirex system has many commands. This an overview.

Command line options

Most Tirex commands have at least the following command line options:

-h, --help
Display help message.
-d, --debug
Run in debug mode. Commands that normally run in the background will keep running in the foreground. Verbose logging is enabled and the command will log to STDERR (see Logging).
-c, --config=DIR
Use the config directory DIR instead of the default /etc/tirex (see Config).

See the man pages for other options.

Commands

Output of the tirex-status command
tirex-master
This is the heart of the Tirex system. The master keeps track of all tile requests queuing them as necessary and sending them on to the renderers.
tirex-backend-manager
Manages the rendering backends, it starts the processes and re-starts them when they fail.
tirex-batch
Used to send requests for tiles to be rendered from the command line. Used for instance for re-rendering old tiles.
tirex-status
Shows statistics and current status of master program, ie. queue sizes, tiles currently rendering, etc.
tirex-check-config
Checks configuration at outputs errors and warnings.
tirex-send
Low level program to send messages to master or other daemons.
tirex-syncd
Can be used to keep tile directories in sync on several machines.
tirex-tiledir-check
Checks tile directories for corrupt files and creates statistics.
tirex-tiledir-stat
Display statistics created by tirex-tiledir-check.
tirex-rendering-control
Used to temporarily halt/continue rendering.

There are some other commands that don't work out of the box and that are not installed by default. You can find them in the utils directory. See Utils.