TIREX-STATUS(1)

📦
version 0.8.0 · 8 versions
, in ubuntu stonking

✨ NAME ✨

tirex-status — the girl whose whole job is telling you what's going on with the tirex master 💅 it's giving "status check" but make it a whole command, fr fr.

It's a User Contributed Perl thing btw, so it lives in section 1 of the manual, and honestly? iconic of it.

🦋 SYNOPSIS 🦋

tirex-status [OPTIONS]

That's it bestie. That's the whole vibe. You give it some OPTIONS (or don't, it's chill like that) and it does its thing. No <file> arguments, no weird pipes, nothing. Just vibes and shared memory. 🌸

💖 OPTIONS 💖

Okay so here's the menu, pick your fave:

  • -h, --help — 🫶 the "bestie explain" button. Displays a help message. No cap, it's right there if you forget everything below.
  • -o, --once — shows the status one single time and then dips. ✋ The default behaviour is to keep showing it once per second like a lil heartbeat monitor, so -o is your "I just want a screenshot, not a livestream" option.
  • -t, --times — gives you a whole table of rendering times by style and zoom level. So you can be nosy about which style/zoom combo is being dramatic. 👑 Heads up: this implies --once — you get your table and it leaves.
  • -n, --numbers — the counting cousin: a table of rendering counts by style and zoom level. Numbers, not seconds. Which zoom levels are getting the most attention, basically. 💀 Also implies --once.
  • -r, --raw — the "I'm a script and I have no eyes" mode. Returns the status in raw JSON format instead of the ANSI coloured human readable form. Perfect for piping into something else. It also implies --once.
  • -e, --extended — the nosy girl option 🔍 shows the renderer and map config, too. Like, the status and the backstory.
Not me pointing out that --times, --numbers and --raw all imply --once… so if you were hoping for a fresh table every second, bestie, no. They snapshot and go. 🧚

🌈 DESCRIPTION 🌈

Here's the tea, tirex-status reads out the status of the running tirex-master process through shared memory and then displays it. That's the whole plot. 🎀

The display is formatted for human consumption on a terminal and it uses ANSI control codes for colour — so it's pretty, it's pink-adjacent, it slays — unless you specify the --raw option, in which case you get the JSON and zero sparkle. Pick your fighter. ✨

iykyk: no --raw = colour. --raw = no colour, just data. 💅

💀 DIAGNOSTICS 💀

Listen carefully because this is the part where things get real:

  • tirex-status returns 1 if there was an error
  • it returns 0 otherwise

That's it. Zero means we ate. One means something is lowkey wrong. 😭

🎀 SEE ALSO 🎀

Wanna go down the rabbit hole? The wiki is right here:

👑 AUTHORS 👑

These are the main characters who built this:

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

Periodt. Thank you for your service, legends. 🫶

and that's the whole page bestie, no gatekeeping 🌸 this was tirex-status out of the User Contributed Perl Documentation, living its life as perl v5.40.1, dated 2026-08-09, filed under TIREX-STATUS(1). go check your master, mwah 💖

📦 where this page comes from