FAXWATCH(8)

💖 FAXWATCH(8) — System Manager's Manual 💖

okay bestie, welcome to faxwatch(8), aka the little snitch that watches your HylaFAX server do its thing. System manager vibes only. ✨

---

🌸 NAME 🌸

faxwatch — monitor low-level HylaFAX server actions

Like, it's literally in the name. It watches. It faxes. It's that girl. 🎀

---

🦋 SYNOPSIS 🦋

/usr/sbin/faxwatch [ -g ] [ -l ] [ -h host ] trigger-expression

---

✨ DESCRIPTION ✨

So here's the tea 🍵: faxwatch signs you up for one or more events on a HylaFAX server, and then it just prints every subsequent event message straight to standard output. That's the whole job. No cap.

Real talk though: faxwatch is intended mainly for testing the event distribution mechanism used by the HylaFAX servers. So like, it's a dev tool, not a production bestie. iykyk.

The trigger-expression gets handed over as an argument to a SITE TRIGGER command passed to the hfaxd(8). The syntax for this expression is:

[<class>['<'id'>'][<mask>|'*']]*

where <class> defines a class of events, and it's one of these four icons 💅:

• J — for job-related events,
• S — for fax send-related events,
• R — for fax receive-related events, and
• M — for modem-related events.

A <mask> is a 4-hex-digit mask of trigger events (the table's down below, don't worry 👇). And if you write *, then all the events in that class get matched. slay.

An <id> can be used to restrict matches to a specific job or modem. Eventually this will need to be generalized for job groups — that's the original note, not me being shady, fr fr.

So, for example, a specification that would catch any event for the modem on ttyf2 would be:

M<ttyf2>*

and to be notified when job 1932 is requeued or completes, one would use:

J<1932>4c60

The output from faxwatch is ASCII text that describes each event. And faxwatch runs until it is interrupted. It does not stop. It does not sleep. It is committed. 👑

---

💅 OPTIONS 💅

• -g — Display times and dates in Greenwich Mean Time (GMT). NB: this is the default. so yeah, it's giving "I was already doing this" 🙈
• -h host — Report the status of the server on a specific host. The host may be either a symbolic name or a network address. If no -h option is supplied, faxwatch uses the FAXSERVER environment variable to identify the HylaFAX server to contact. If this variable is not set, then faxwatch checks for a setting in the configuration files (first in the per-user file and then in the system-wide file). If all of the above fails, then faxwatch attempts to contact a server on the machine where it is run. it's giving "I'll find it myself, bestie" 🔍
• -l — Display times and dates in the local timezone of the server.
• -v — Trace the protocol exchanges between faxwatch and the hfaxd processes on the standard output. messy, chatty, iconic. 🗣️

---

🌈 EVENTS 🌈

The following table specifies the current set of events that may be monitored. This information is subject to change; consult the source code for reference. (translation: don't come for me if it moves, it moves 💀)

👑 Job events — class J

• JOB_CREATE — class J, mask 0x0001 — job created
• JOB_SUSPEND — class J, mask 0x0002 — job suspended
• JOB_READY — class J, mask 0x0004 — job ready to send
• JOB_SLEEP — class J, mask 0x0008 — job sleeping awaiting time-to-send
• JOB_DEAD — class J, mask 0x0010 — job marked dead
• JOB_PROCESS — class J, mask 0x0020 — job processed by scheduler
• JOB_REAP — class J, mask 0x0040 — job corpus reaped
• JOB_ACTIVE — class J, mask 0x0080 — job activated
• JOB_REJECT — class J, mask 0x0100 — job rejected
• JOB_KILL — class J, mask 0x0200 — job killed
• JOB_BLOCKED — class J, mask 0x0400 — job blocked by other job
• JOB_DELAYED — class J, mask 0x0800 — job delayed by tod restriction or similar
• JOB_ALTERED¹ — class J, mask 0x1000 — job parameters altered
• JOB_TIMEDOUT — class J, mask 0x2000 — job kill timer expired
• JOB_PREP_BEGIN — class J, mask 0x4000 — job preparation started
• JOB_PREP_END — class J, mask 0x8000 — job preparation finished

🦋 Send events — class S

• SEND_BEGIN — class S, mask 0x0001 — fax, send attempt started
• SEND_CALL — class S, mask 0x0002 — fax, call placed
• SEND_CONNECTED — class S, mask 0x0004 — fax, call answered by fax
• SEND_PAGE — class S, mask 0x0008 — fax, page transmit done
• SEND_DOC — class S, mask 0x0010 — fax, document transmit done
• SEND_POLLRCVD — class S, mask 0x0020 — fax, document retrieved by poll operation
• SEND_POLLDONE — class S, mask 0x0040 — fax, poll operation completed
• SEND_END — class S, mask 0x0080 — fax, send attempt finished
• SEND_REFORMAT — class S, mask 0x0100 — fax, job being reformatted
• SEND_REQUEUE — class S, mask 0x0200 — fax, job requeued
• SEND_DONE — class S, mask 0x0400 — fax, send job done

🎀 Receive events — class R

• RECV_BEGIN — class R, mask 0x0001 — fax, inbound call started
• RECV_START — class R, mask 0x0002 — fax, session started
• RECV_PAGE — class R, mask 0x0004 — fax, page receive done
• RECV_DOC — class R, mask 0x0008 — fax, document receive done
• RECV_END — class R, mask 0x0010 — fax, inbound call finished

💜 Modem events — class M

• MODEM_ASSIGN — class M, mask 0x0001 — modem assigned to job
• MODEM_RELEASE — class M, mask 0x0002 — modem released by job
• MODEM_DOWN — class M, mask 0x0004 — modem marked down
• MODEM_READY — class M, mask 0x0008 — modem marked ready
• MODEM_BUSY — class M, mask 0x0010 — modem marked busy
• MODEM_WEDGED — class M, mask 0x0020 — modem considered wedged
• MODEM_INUSE — class M, mask 0x0040 — modem in use for outbound work
• MODEM_DATA_BEGIN — class M, mask 0x0080 — inbound data call begun
• MODEM_DATA_END — class M, mask 0x0100 — inbound data call finished
• MODEM_VOICE_BEGIN — class M, mask 0x0200 — inbound voice call begun
• MODEM_VOICE_END — class M, mask 0x0400 — inbound voice call finished
• MODEM_CID — class M, mask 0x0800 — inbound caller-ID information

¹ Event to be removed soon. 🪦 don't get attached, bestie.

---

🔥 SEE ALSO 🔥

hylafax-server(5), hfaxd(8).

---

and that's the whole page, periodt 💅✨

signed off from the System Manager's Manual, dated January 18, 1996 — yeah, she's vintage, she's iconic, she's still watching your faxes. FAXWATCH(8), out. 🫶🎀