ST_SNAPSHOT.HOURLY(1)

💖 st_snapshot.hourly 💖

okay so bestie, welcome to the st_snapshot.hourly user manual (that's the manual-name part, iykyk) ✨ it's a lil page from the st_snapshot.hourly User Manual, and honestly? it's giving "small script, big responsibilities."

---

✨ NAME ✨

st_snapshot.hourly — a wrapper for st_snapshot 🎀

---

🦋 SYNOPSIS 🦋

st_snapshot.hourly

no arguments, no drama, she just runs 💅

---

🌸 DESCRIPTION 🌸

st_snapshot.hourly is a wrapper for st_snapshot. and like, she is meant to be run from cron — that's her whole moment, that's her purpose, periodt ⏰

so here's the vibe check she does first: she checks whether these two files exist:

• /etc/systraq/i_want_a_broken_systraq
• /etc/systraq/systraq_is_unconfigured

about that first one — i_want_a_broken_systraq is typically empty, bestie. if it exists, st_snapshot.hourly exits immediately. and the way that this file "breaks" systraq? yeah so systraq will no longer warn when system configuration files changes, but will remain silent 💀 that's the whole deal, that's the tradeoff.

now for the second one — if systraq_is_unconfigured exists, its contents are displayed and st_snapshot.hourly exits. that file typically holds instructions on how to configure systraq, and an example systraq_is_unconfigured file is shipped with the systraq tarball 🫶 so it's like a lil note-to-self for future you.

and if both files are missing? iconic. then st_snapshot is called with appropriate arguments, either in "root" or in "public"-mode, depending on the ST_MODE environment variable 👑

so, context: since the systraq tarball behaves sanely on a fresh default install, systraq_is_unconfigured is not installed by default. however, people preparing systraq binary packages typically can make good use of this file. not me judging, that's just the lore 📦

also important: when systraq is installed from tarball the systraq cronjobs are not enabled. one typically enables them after having configured systraq, especially after the st_snapshot listfiles snapshot_pub.list, snapshot_pub.homelist, snapshot_root.list and snapshot_root.homelist in /etc/systraq are created. however — and this is the plot twist — binary systraq packages typically enable the cronjobs without enforcing one-fits-all listfiles on the user. slay for flexibility, honestly 🌈

---

💜 ENVIRONMENT 💜

• ST_MODE — if set to "root", run st_snapshot in root-mode. that's it, that's the whole job, main character energy 👑
• ST_SUM — the command for calculating file checksums. e.g. sha256sum, sha512sum, sha384sum, sha224sum or sha1sum. if unset, sha256sum is used. if unset and sha256sum is not found on the system while md5sum is found, md5sum is used and a warning is printed. else, the script prints an error message and exits. ST_SUM is passed to and used by st_snapshot 🧚

bestie listen: that fallback chain is real. no ST_SUM, no sha256sum, and no md5sum either? that's an error message and an exit, fr fr. plan accordingly 💀

---

🎀 FILES 🎀

• /etc/systraq/i_want_a_broken_systraq
• /etc/systraq/systraq_is_unconfigured

---

⭐ SEE ALSO ⭐

• st_snapshot (1)
• The systraq Manual.

---

💖 VERSION 💖

20201231 ✨

---

👑 AUTHOR 👑

Joost van Baal-Ilić <joostvb-systraq-20151105@mdcc.cx> — Author. 🫶

---

🌈 COPYRIGHT 🌈

Copyright © 2001-2020 Joost van Baal-Ilić

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.

---

okay that's the whole page, bestie, you ate 💅 this was st_snapshot.hourly from the st_snapshot.hourly User Manual, dated Uku 31 2020, and that's a wrap — go configure your systraq, mwah 🎀💖✨