DIRVISH-EXPIRE(8)

💖 DIRVISH-EXPIRE 💖

okay bestie, sit down, hydrate, and let me tell you about dirvish-expire from the System Manager's Manual section (section 8, for the sysadmin girlies ✨). this is the little tool that goes through your dirvish vaults and yeets the expired images. no cap.

---

🌸 NAME 🌸

dirvish-expire — delete expired dirvish images 🗑️✨

---

🎀 SYNOPSIS 🎀

dirvish-expire[OPTIONS]

---

🦋 DESCRIPTION 🦋

so what it does is delete dirvish image trees, or whole images, that have expired. like, their time is up, they had their moment, we love them, bye 💅

every image has a summary file, and dirvish-expire checks each one for the Expire: field. if that field says the image has expired, then dirvish-expire will delete that image out of the vault. periodt.

by default, all subdirectories of all banks get treated as vaults, and everything inside them — except the directory literally named dirvish — gets checked for summary files. so it's thorough. it's giving thorough.

the removal of one image will have no effect on the other images. they don't gossip, they don't take it personally. 🫶

here's the safety girlie behaviour though, and this part is important: dirvish-expire will NOT delete an image unless it finds at least one image in that branch that has an <strong>intact image tree</strong> and Status: success in the summary that is <strong>not expired</strong>. so it never leaves you with nothing. it checks the vibe first. 🔥

---

✨ OPTIONS ✨

general rules first, bestie, because they apply to everything below:

• each option on the command line may be specified <strong>any number of times</strong>.
• those options that support lists in the config files will <strong>accumulate</strong> all of their arguments — otherwise each specification will <strong>override</strong> the ones before it. (so sometimes it stacks, sometimes it replaces. iykyk.)
• each option may be <strong>unambiguously abbreviated</strong>. you can be lazy, just not ambiguous about it. 😌

now the actual options:

• --time time_expression — execute as though time_expression were the current time. ⏰

time_expression is processed by Time::Parsedate(3pm), so relative time and date strings are permitted. see Time::Parsedate(3pm) for more details.

• --tree — only delete the image tree. leave in place the rest of the image directory with summary, log and any other image administrative files. 🌳 so the tree goes, the paperwork stays.
• --vault vault — restrict expiration to the specified vault. 🏦 one vault only, main character energy.
• --no-run — don't actually do anything. just display what <strong>would have</strong> happened. 👀 the ultimate dry run, the "not me, I'm just watching" of flags.
• --quiet — run quietly, only report errors. 🤫

normally dirvish-expire will report the images deleted. with this, it won't. silence is golden.

---

💀 EXIT CODES 💀

to facilitate further automation and integration of dirvish-expire with other tools, dirvish-expire provides rationalised exit codes. the exit codes are <strong>range based</strong>. while the code for a specific error may change from one version to another, it will remain within the specified range. so don't test for specific exit codes — instead test for a <strong>range</strong> of values. to the degree possible, higher value ranges indicate more severe errors. 📈

• 0 — success 🎉
• 200-219 — an error was encountered in loading a configuration file. 😭
• 220-254 — an error was detected in the configuration. 🙈
• 255 — incorrect usage. 💀

---

🍓 FILES 🍓

• /etc/dirvish/master.conf — alternate master configuration file.
• /etc/dirvish.conf — master configuration file.
• bank/vault/image/summary — image creation summary.
• bank/vault/image/tree — actual image of source directory tree.

---

🌈 SEE ALSO 🌈

• dirvish.conf(5)
• Time::ParseDate(3pm)

---

🧚 BUGS 🧚

dirvish-expire will walk the file hierarchy of <strong>all banks</strong> or the <strong>specified vault</strong> looking for summary files. anything non-dirvish in there may cause excess file-walking. 🚶‍♀️🚶‍♀️🚶‍♀️ so like, keep your vaults clean, bestie. don't put your random stuff in there and then act surprised.

---

and that's the whole page, gorgeous 💜 that was DIRVISH-EXPIRE(8) from the System Manager's Manual, and yes, the footer says the exact same thing — DIRVISH-EXPIRE(8) — so we've come full circle, iconic, no notes. go forth and expire responsibly 🎀✨