TIREX-BATCH(1)

📦
version 0.8.0 · 8 versions
, in ubuntu stonking

💖 TIREX-BATCH — bestie edition 💖

okay so real quick, this is tirex-batch from the User Contributed Perl Documentation, and it's literally the queen of sending rendering requests to the tirex master. she's giving main character energy and she's here to help you fill that queue. periodt. 👑

✨ NAME ✨

tirex-batch — send rendering requests to tirex master 🎀

✨ SYNOPSIS ✨

tirex-batch [OPTIONS] [INIT]

✨ OPTIONS ✨

  • -h, --help — shows you the help message. that's it, that's the vibe. 💅
  • -d, --debug — runs in debug mode, so you literally see the actual messages sent and received. no cap, full transparency. 🔍
  • -c, --config=DIR — use the config directory DIR instead of /etc/tirex. your directory, your rules. 💖
  • -n, --num=NUM — tries to keep the number of jobs in the queue below this number. lowkey only checked once per second tho. disable it with NUM=0. ✨
  • -q, --quit — quit if the number of jobs in the queue is higher than the number you gave with -n. without -q, tirex-batch would wait and continue to fill the queue once it's gone below the threshold. she's patient, but -q says no bestie, we're leaving. 😤
  • -p, --prio=PRIO — priority for requests. 👑
  • -e, --expire=TIME — expire time for jobs, in seconds since epoch. if it starts with '+', that's a number of seconds added to the current time. cute and relative. 🕐
  • -f, --filter — adds filters to metatile selection, go read the FILTERS section below, iykyk. 🧚
  • --remove — sends a remove request instead of a rendering request. the jobs get removed from the queue. bye bestie 💀
  • --count-only — only counts how many metatiles would be rendered, doesn't actually send the requests. it DOES take the filters into account, so heads up: it will possibly check the disk for thousands of files! 😭

✨ DESCRIPTION ✨

so INIT is a string describing a range of tiles. if no INIT string is given on the command line, tirex-batch reads init strings from STDIN, one per line. very chill, very stdin-core. 🩷

there are several different ways of describing the tiles, and all of them are allowed, so pick your fighter:

  • Single metatile:
map=foo x=4 y=7 z=15

(coordinates will be rounded to metatile numbers, she's not gonna be weird about it)

  • Multiple metatiles:
map=foo x=0-32 y=16-32 z=15
  • Using longitude and latitude ranges (8 to 9 degrees longitude, 48 to 49 degrees latitude):
map=foo lon=8,9 lat=48,49 z=15-17
  • Using a bounding box (8 to 9 degrees longitude, 48 to 49 degrees latitude):
map=foo bbox=8,48,9,49 z=15-17
  • Multiple maps are allowed, too:
map=foo,bar

you can use a z range (z=10-15). this does not work together with x and y ranges, but it does work with lon/lat ranges. okay bestie, noted. 📝

ranges of x, y, and z numbers are written as "MIN,MAX" or "MIN-MAX". ranges of lon and lat are written as "MIN,MAX" (because lon and lat can be negative, so ranging with "-" is problematic — yeah, exactly, awkward). 😬

you can also just give a pathname of a metatile file as the INIT string. it has to start with './' or '/'. the first directory component must be the name of the map. slay. ✨

✨ FILTERS ✨

FILTER is a ;-separated list of filter options. metatiles that don't match the filter get skipped. sorry babes, not your turn. 💅

Filter Options:

  • exists — matches if the meta tile exists on disk. 🦋
  • not-exists — matches if the meta tile does not exist on disk. 🙈
  • older(time) — matches if the meta tile's last modification time is before the given Unix time stamp (seconds since the epoch, 1970-01-01 00:00:00). it also matches if the meta tile does not exist on disk. if you want to match only files older than the given date which do actually exist, add the exists filter. 🌸
  • older(filename) — instead of the time in seconds since the epoch you can also enter a filename here. the mtime (last modified) of this file will be used. tirex-batch will exit with return code 2 if the file does not exist. ⚠️
  • newer(time) — matches if the meta tile's last modification time is after the given Unix time stamp (seconds since the epoch, 1970-01-01 00:00:00). it also matches if the meta tile does not exist on disk. if you want to match only files newer than the given date which do actually exist, add the exists filter. 🌈
  • newer(filename) — instead of the time in seconds since the epoch you can also enter a filename here. the mtime (last modified) of this file will be used. tirex-batch will exit with return code 2 if the file does not exist. ⚠️
  • multi(count,num) — a ✨magic✨ filter that divides all meta tiles up in count classes, and matches only if the current meta tile is in class num of these. hence the allowed range for num is always 0..count-1. currently only count=2 is supported. this filter can be used to distribute rendering requests among different tile servers (which may or may not then use tirex-syncd to share resulting tiles). literally load balancing, we love to see it. 🔥

✨ FILES ✨

  • /etc/tirex/tirex.conf — the configuration file. the blueprint, the lore, the source. 📜

✨ DIAGNOSTICS ✨

returns 0 on success, 1 if there was a problem sending the request, and 2 if there was a problem parsing the command line or init string. so like, 0 is the slay, 1 and 2 are not the slay. 💀

✨ SEE ALSO ✨

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

✨ AUTHORS ✨

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

and that's the whole page bestie, no crumbs left 💖 this was perl v5.40.1, dated 2026-08-09, and it's the TIREX-BATCH(1) manual page — go forth and batch those requests, you absolute icon 👑✨

📦 where this page comes from