faxwatch.8c man page

faxwatch — monitor low-level HylaFAX server actions

Synopsis

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

Description

faxwatch registers interest in one or more events on a HylaFAX server and then prints subsequent event messages to the standard output. The faxwatch program is intended mainly for testing the event distribution mechanism used by the HylaFAX servers.

The trigger-expression is supplied as an argument to a “SITE TRIGGER” command passed to the hfaxd(8C) The syntax for this expression is:

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

where <class> defines a class of events and is one of:

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 (see the table below). If “*” is specified then all events in the class are matched.

An <id> can be used to restrict matches to a specific job or modem.  Eventually this will need to be generalized for job groups.

Thus an example 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. faxwatch runs until it is interrupted.

Options

-g

Display times and dates in  Greenwich Mean Time (GMT). NB: this is the default.

-h host

Report the status of the server on a specific host. The host may be either a symbolic name or a network address. IPv6 addresses are given in “[xx:xx::x]:port” format. 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.

-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.

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.

EventClassMaskDescription
JOB_CREATEJ0x0001job created
JOB_SUSPENDJ0x0002job suspended
JOB_READYJ0x0004job ready to send
JOB_SLEEPJ0x0008job sleeping awaiting time-to-send
JOB_DEADJ0x0010job marked dead
JOB_PROCESSJ0x0020job processed by scheduler
JOB_REAPJ0x0040job corpus reaped
JOB_ACTIVEJ0x0080job activated
JOB_REJECTJ0x0100job rejected
JOB_KILLJ0x0200job killed
JOB_BLOCKEDJ0x0400job blocked by other job
JOB_DELAYEDJ0x0800job delayed by tod restriction or similar
JOB_ALTERED¹J0x1000job parameters altered
JOB_TIMEDOUTJ0x2000job kill timer expired
JOB_PREP_BEGINJ0x4000job preparation started
JOB_PREP_ENDJ0x8000job preparation finished
SEND_BEGINS0x0001fax, send attempt started
SEND_CALLS0x0002fax, call placed
SEND_CONNECTEDS0x0004fax, call answered by fax
SEND_PAGES0x0008fax, page transmit done
SEND_DOCS0x0010fax, document transmit done
SEND_POLLRCVDS0x0020fax, document retrieved by poll operation
SEND_POLLDONES0x0040fax, poll operation completed
SEND_ENDS0x0080fax, send attempt finished
SEND_REFORMATS0x0100fax, job being reformatted
SEND_REQUEUES0x0200fax, job requeued
SEND_DONES0x0400fax, send job done
RECV_BEGINR0x0001fax, inbound call started
RECV_STARTR0x0002fax, session started
RECV_PAGER0x0004fax, page receive done
RECV_DOCR0x0008fax, document receive done
RECV_ENDR0x0010fax, inbound call finished
MODEM_ASSIGNM0x0001modem assigned to job
MODEM_RELEASEM0x0002modem released by job
MODEM_DOWNM0x0004modem marked down
MODEM_READYM0x0008modem marked ready
MODEM_BUSYM0x0010modem marked busy
MODEM_WEDGEDM0x0020modem considered wedged
MODEM_INUSEM0x0040modem in use for outbound work
MODEM_DATA_BEGINM0x0080inbound data call begun
MODEM_DATA_ENDM0x0100inbound data call finished
MODEM_VOICE_BEGINM0x0200inbound voice call begun
MODEM_VOICE_ENDM0x0400inbound voice call finished
MODEM_CIDM0x0800inbound caller-ID information

¹ Event to be removed soon.

See Also

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

Info

January 18, 1996