TIREX-CHECK-CONFIG(1)

📦
version 0.8.0 · 8 versions
, in ubuntu stonking

💖 tirex-check-config(1) 💖

User Contributed Perl Documentation ✨ (yes bestie, it's a Perl situation, we love that for us)

🌸 NAME 🌸

tirex-check-config — check Tirex config files 🎀

✨ SYNOPSIS ✨

tirex-check-config [OPTIONS]

That's it. That's the whole vibe. No positional args, just vibes and options 🦋

💅 OPTIONS 💅

  • -h, --help — shows you the help message 🫶 like a little friend handing you a map
  • -c, --config=DIR — use the config directory DIR instead of /etc/tirex 🗂️ yes you can point it somewhere else, it's flexible like that

👑 DESCRIPTION 👑

okay so here's the tea ☕ — this little icon goes through your Tirex config files and spits out errors and warnings for you. And the way it tells them apart:

  • every line starting with X is an error 💀
  • every line starting with ! is a warning ⚠️
real talk though: this program is here to help the admin out, it is NOT a magic all-seeing oracle. It can't detect all errors. So don't be out here acting brand new when something slips past it 🙈

And a lil confession moment: right now only the main config file gets checked. Checking of renderer and map config should be added at some point (it's on the to-do list, we swear). So if you've got the skills — patches welcome! 🫶✨

🍓 FILES 🍓

  • /etc/tirex/tirex.conf — the configuration file 📄 (the main character, honestly)

🌈 DIAGNOSTICS 🌈

tirex-check-config exits with these numbers, bestie — memorize them, iykyk 👑

  1. 0 — the config looks ok ✅ slay
  2. 1 — warnings were found ⚠️ not a crisis but like… look at it
  3. 2 — errors were found 🔥 okay now we have a problem

🦋 SEE ALSO 🦋

💜 AUTHORS 💜

Frederik Ramm <frederik.ramm@geofabrik.de>, Jochen Topf <jochen.topf@geofabrik.de> — and possibly others 👯‍♀️ (shoutout to the mystery contributors, we see you, we appreciate you 🫶)

<divider>---

and that's the whole page, periodt 💅 this was perl v5.40.1, dated 2026-08-09 — TIREX-CHECK-CONFIG(1) out 🎀✨💖

📦 where this page comes from