FAXQCLEAN(8)

💖 FAXQCLEAN 💖

okay so bestie, let me introduce you to faxqclean — the HylaFAX queue cleaner process, aka the little gremlin that comes through and takes out the trash 🗑️✨ She's a manual page 8 situation (system manager's manual, so yeah, she's root-coded 👑).

✨ SYNOPSIS ✨

/usr/sbin/faxqclean [ options ]

🌸 DESCRIPTION 🌸

So like, faxqclean is the program that goes through your completed HylaFAX jobs and yeets the unreferenced document files. She's not a "run her whenever you feel like it" girl — she's designed to be invoked by cron(8) on behalf of the super user (that's root, the actual main character 💅) one or more times a day.

For example, this crontab entry might be set up for root so faxqclean runs every single hour, no cap:

0   *    *    *    *   /usr/sbin/faxqclean

When faxqclean runs, she scans the doneq subdirectory in the HylaFAX spooling area and processes each job according to the doneop field specified in the job description file — c.f. sendq(5) bestie, go read it, I'll wait 🫶. Jobs that are marked for removal get purged and references to documents get removed too. Jobs marked for archival may be archived, depending on what options you handed her on the command line.

Then, after she's done scanning for completed jobs, she scans 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? Gone. Removed. Blocked. Unfollowed. 💀

🎀 OPTIONS 🎀

• -a — Enable job archiving support. She can archive now, she's ready, she's prepared ✨
• -A — This one forces archiving even if doneop in the queue file is not archive — i.e. even if the user submitted the job without specifying the -A flag to sendfax. Yeah, we're doing it anyway, no permission needed 💅
• -j secs — Set the job age threshold (in seconds) that controls how long jobs may reside in the doneq directory before being processed. Default is 15 minutes (15*60 = 900 seconds).
• -d secs — Set the document age threshold (in seconds) that controls how long unreferenced files may reside in the docq directory before being removed. Default is 1 hour (60*60 = 3600 seconds).
• -n — Do not carry out any work; just show what would be done 👀. Super useful together with the -t option for debugging, fr fr.
• -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.
• -t — Trace in great detail exactly what faxqclean is doing. Messages get sent to the standard output. She's narrating her whole life, we love a transparent queen 🔥
• -v — Print messages on the standard output about jobs removed or archived, and about document files removed. The receipts, basically 🧾

🦋 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

Consult hylafax-server(5) for a complete discussion of the structure and content of the spooling area. Like, the whole lore. The deep cut. iykyk 📚

🌈 SEE ALSO 🌈

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

and that's the whole page bestie!! this icon dropped way back on March 14, 1996, it's part of the System Manager's Manual, and it lives at section FAXQCLEAN(8). periodt. 💖✨🦋