TIREX-T...IR-CHECK(1)

📦
version 0.8.0 · 8 versions
, in ubuntu stonking

🌸 tirex-tiledir-check(1) — bestie edition 💖

okay so picture this: a Perl-contributed user manual, the User Contributed Perl Documentation shelf, and it's all about tirex-tiledir-check. she's a little utility that walks your tile dir and tells you if anything's sus. let's get into it 🫶

✨ NAME ✨

tirex-tiledir-check — check tile dir, literally that's the whole job 💅

🎀 SYNOPSIS 🎀

tirex-tiledir-check [OPTIONS] MAP

one command, one MAP, a whole lot of options. let's go.

⭐ OPTIONS ⭐

  • -h, --help — pops up the help message, no thoughts head empty, just usage ✨
  • -c, --config=DIR — use the config directory DIR instead of /etc/tirex. she can live anywhere you want her to 🏠
  • -l, --list=FILE — write a list of tiles to FILE. format deets below, keep scrolling bestie 💖
  • -s, --stats=FILE — write stats about the tiles to FILE. format deets below too 😌
  • -z, --minz=i — start processing at min zoom level i (default=0) 🦋
  • -Z, --maxz=i — stop processing at max zoom level i (default=19). note the capital Z, she's a different girlie than -z 👑
  • -c, --config=DIR — wait no, already said that one. moving on, we stay accurate here 😭

💜 DESCRIPTION 💜

so what does she actually do? she walks recursively through the tiles directory for the MAP you gave her and checks for:

  • wrong directory names
  • wrong file names
  • files that just can't be accessed 😭

if she finds problems, the messages go to STDERR. dramatic but useful.

when you hand her the --list and/or --stats options, she outputs info about each tile and/or generates statistics, respectively. the list and the stats get written to the filenames you gave — and if you pass - as the filename, STDOUT is used instead ✨

🚨 important: you can only use STDOUT for either the list file or the stats file. not both. pick a lane bestie.
⚠️ caution, and she means it: this command will go through all metatiles on your disk and stat each file. on a lightly loaded machine with lots of RAM this can go pretty quick, but under high IO loads it might take a long time. take this into account if you want to run it regularly from cron or similar. don't be the girlie who fills the crontab and then wonders why everything is slow 💀

🌈 LIST FILE FORMAT 🌈

the list file is in CSV format, with one line per metatile. the fields are:

  • age — age of metatile in seconds ⏳
  • size — size in bytes of the metatile 📏
  • blocks — number of blocks used for this metatile 🧱
  • metatile — description of metatile. format: map=foo x=8 y=0 z=10

this data can be read with other programs to create statistics etc. go off, data queen 📊

🦋 STATS FILE FORMAT 🦋

the stats file is in JSON format. it contains a hash with the names of all maps as keys and a list of zoom levels as their values. for each zoom level there's a nested hash containing the statistics:

  • count — number of tiles
  • maxage — maximum age in seconds
  • maxblocks — maximum number of blocks
  • maxsize — maximum file size in bytes
  • minage — minimum age in seconds
  • minblocks — minimum number of blocks
  • minsize — minimum file size in bytes
  • sumage — sum of ages in seconds
  • sumblocks — sum of number of blocks
  • sumsize — sum of file size in bytes

the sumage, sumblocks, and sumsize values can be divided by count to get the average. math girlie math 📐✨

this file can be displayed in a human readable format with the program tirex-tiledir-stat. it's also read by several Munin plugins 👀

🍓 FILES 🍓

  • /etc/tirex/tirex.conf — the configuration file. that's her home base 🏡

💀 DIAGNOSTICS 💀

  • returns 0 if no errors were found ✅
  • returns 1 if there were errors 😭
  • if there were errors parsing the command line, 2 is returned 🚩

exit codes are exit codes, we respect them in this house.

🔥 SEE ALSO 🔥

👑 AUTHORS 👑

Frederik Ramm <frederik.ramm@geofabrik.de>, Jochen Topf <jochen.topf@geofabrik.de> and possibly others. icons, all of them 💅

and that's the whole page bestie, no cap. this was perl v5.40.1, dated 2026-08-09 — mwah, periodt 🎀💖✨

📦 where this page comes from