FAXQCLEAN(8C)

💖 FAXQCLEAN — the HylaFAX queue cleaner, bestie edition ✨

okay so real talk: faxqclean is literally the little cleanup gremlin of the HylaFAX world (it's section 8C of the manual, iykyk), and it's the one that makes sure your spooling area doesn't turn into a hoarder situation. she's out here processing finished HylaFAX jobs and yeeting unreferenced document files. no cap.

---

🌸 SYNOPSIS 🌸

/usr/bin/faxqclean [ options ]

---

🦋 DESCRIPTION 🦋

so faxqclean is the program that processes completed HylaFAX jobs and expunges unreferenced document files. 💅

she's designed to be run by cron(8C) on behalf of the super user (that's root, the main character), one or more times a day. like, here's the vibe — you could set up a crontab entry for root that runs faxqclean every single hour:

  0   *    *    *    *   /usr/bin/faxqclean

when faxqclean runs, here's the whole ritual, step by step:

1. she scans the doneq subdirectory in the HylaFAX spooling area 👀
2. she processes each job according to the doneop field specified in the job description file — c.f. sendq(5F)
3. jobs that are marked for removal get purged, and references to documents get removed too
4. jobs that are marked for archival may be archived, depending on the options you handed her on the command line

and after she's done scanning for completed jobs? she moves on to the docq subdirectory and builds up a table of document files. files that aren't referenced by any job and that are older than a specified threshold get removed. bye bestie 🫶

---

✨ OPTIONS ✨

• -a — Enable job archiving support. 🎀
• -A — this one forces archiving even if 'doneop' in the queue file is not 'archive'. like, even if the user submitted the job without specifying the -A flag to sendfax. she's not asking, she's archiving. 💅
• -j secs — sets the job age threshold (in seconds) that controls how long jobs may reside in the doneq directory before being processed. by default this value is 15 minutes (15*60 = 900 seconds). ⏰
• -d secs — sets the document age threshold (in seconds) that controls how long unreferenced files may reside in the docq directory before being removed. by default this value is 1 hour (60*60 = 3600 seconds). 🕐
• -n — do not carry out any work; just show what would be done. this option is useful together with the -t option for debugging. she's manifesting, not acting. 🙈
• -q dir — the specified directory is treated as the spooling area. the default spooling area, /var/spool/hylafax, is defined at the time the software is built. 🏠
• -s script — specifies a custom program to be used for archiving. this is given relative to the spooling area, /var/spool/hylafax. the default program is bin/archive found in the spooling area. 🧚
• -t — trace in great detail exactly what faxqclean is doing. messages are sent to the standard output. she's telling you everything, no filter. 🗣️
• -v — print messages on the standard output about jobs removed or archived and about document files removed. receipts only. 🧾

---

🎀 FILES 🎀

• /var/spool/hylafax/doneq — directory to scan for completed jobs
• /var/spool/hylafax/docq — directory to scan for unreferenced documents
• /var/spool/hylafax/archive — directory where archived jobs are placed

also, go consult hylafax-server(5F) for a complete discussion of the structure and content of the spooling area. it's giving required reading. 📚

---

👑 SEE ALSO 👑

faxq(8C), hylafax-server(5F), sendq(5F), doneq(5F), archive(5F).

---

and that's the whole page, bestie ✨ this one is dated March 14, 1996, and yeah, it's the FAXQCLEAN(8C) manual — a certified classic, lowkey iconic, fr fr. go forth and clean that queue 💖🦋🌸