TIREX-R...-CONTROL(1)

πŸ’– TIREX-RENDERING-CONTROL(1) πŸ’–

okay bestie, so this page lives in the User Contributed Perl Documentation section of the manual (that's the manual name, iykyk), and it's literally the "hey tirex, chill for a sec" remote control you've been looking for. no cap. πŸŽ€


✨ NAME ✨

tirex-rendering-control β€” send messages to control rendering πŸ¦‹


🫢 SYNOPSIS 🫢

tirex-rendering-control [OPTIONS] [BUCKET...]

literally that's it. options first, then a list of buckets if you're feeling specific. πŸ’…


πŸ‘‘ OPTIONS πŸ‘‘

  • -h, --help β€” shows you the help message. your basic "what does this thing do" button. πŸ₯°
  • -d, --debug β€” run in debug mode. extra chatter, extra clues. πŸ”
  • -c, --config=DIR β€” use the config DIR instead of the default /etc/tirex. main character move if your config lives somewhere else. πŸ’…
  • --stop β€” sends stop_rendering_bucket commands to tirex-master for each bucket you listed on the command line. and if you didn't list any? it sends the command for all buckets except the one containing the priority 1 β€” which is usually the bucket getting live requests from the web server, so yeah, we're protecting that one. πŸ›‘οΈ and if you really want every single one, use the special bucket name ALL.
  • --continue β€” sends continue_rendering_bucket commands to tirex-master for each bucket you listed on the command line. no buckets specified (or you said ALL)? then it's sent for all buckets. we're so back. πŸ”₯

🌸 DESCRIPTION 🌸

sometimes you just need rendering tiles to, like, take a little nap. not forever. just for a minute. maybe you're updating the database, maybe you're re-starting the rendering daemon, maybe you're running some resource-intensive job on the machine that would straight-up conflict with rendering. it's giving "sorry bestie, not right now." 😭

this command sends the running tirex-master commands to stop (or continue) rendering for the buckets you specify. simple as. ✨

and here's the part you need to know: when you use --stop, this command blocks and waits for the currently rendering tiles to be finished. so when the command returns (with return code 0) you can be absolutely sure you can do whatever you want to do without the rendering interfering. periodt. πŸ’–


πŸŽ€ FILES πŸŽ€

  • /etc/tirex/tirex.conf β€” the configuration file. that's the one. πŸ—‚οΈ

🧚 DIAGNOSTICS 🧚

tirex-rendering-control returns:

  1. 0 if everything was alright πŸŽ‰
  2. 3 if the server could not be reached πŸ’€
  3. 4 if there was an error parsing the command line πŸ™ˆ

🌈 SEE ALSO 🌈

<http://wiki.openstreetmap.org/wiki/Tirex> β€” go read the wiki, bestie, it's iconic. ⭐


πŸ’œ AUTHORS πŸ’œ

Frederik Ramm <frederik.ramm@geofabrik.de>, Jochen Topf <jochen.topf@geofabrik.de> and possibly others. legends, all of them. πŸ‘‘


ngl, if any of this is confusing, just remember: --stop blocks until tiles are done, --continue un-blocks, and the priority 1 bucket is lowkey the VIP you don't wanna freeze. got it? slay. πŸ’…

okay that's the whole page!! this was perl v5.40.1, dated 2026-08-09 β€” mwah, stay rendering responsibly, ily bye 🫢✨

πŸ“¦ where this page comes from