1FAXWATCH(8C)                                                      FAXWATCH(8C)


6       faxwatch - monitor low-level HylaFAX server actions


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


12       faxwatch  registers  interest in one or more events on a HylaFAX server
13       and then prints subsequent event messages to the standard output.   The
14       faxwatch  program is intended mainly for testing the event distribution
15       mechanism used by the HylaFAX servers.
17       The trigger-expression is supplied as an argument to a ``SITE TRIGGER''
18       command passed to the hfaxd(8C) The syntax for this expression is:
20              [<class>['<'id'>'][<mask>|'*']]*
22       where <class> defines a class of events and is one of:
24       J      for job-related events,
26       S      for fax send-related events,
28       R      for fax receive-related events, and
30       M      for modem-related events.
32       A <mask> is a 4-hex-digit mask of trigger events (see the table below).
33       If ``*'' is specified then all events in the class are matched.
35       An <id> can be used to restrict matches to a  specific  job  or  modem.
36       Eventually this will need to be generalized for job groups.
38       Thus  an example specification that would catch any event for the modem
39       on ttyf2 would be ``M<ttyf2>*'', and to be notified when  job  1932  is
40       requeued or completes one would use ``J<1932>4c60''.
42       The  output  from  faxwatch  is  ASCII  text that describes each event.
43       faxwatch runs until it is interrupted.


46       -g        Display times and dates in Greenwich Mean  Time  (GMT).   NB:
47                 this is the default.
49       -h host   Report the status of the server on a specific host.  The host
50                 may be either a symbolic name or  a  network  address.   IPv6
51                 addresses  are given in ``[xx:xx::x]:port'' format.  If no -h
52                 option is supplied, faxwatch uses the  FAXSERVER  environment
53                 variable  to identify the HylaFAX server to contact.  If this
54                 variable is not set, then faxwatch checks for  a  setting  in
55                 the  configuration files (first in the per-user file and then
56                 in the system-wide file).  If all of the  above  fails,  then
57                 faxwatch attempts to contact a server on the machine where it
58                 is run.
60       -l        Display times and dates in the local timezone of the server.
62       -v        Trace the protocol exchanges between faxwatch and  the  hfaxd
63                 processes on the standard output.


66       The  following  table  specifies  the current set of events that may be
67       monitored.  This information is subject to change; consult  the  source
68       code for reference.
70       Event                Class  Mask       Description
71       JOB_CREATE           J      0x0001     job created
72       JOB_SUSPEND          J      0x0002     job suspended
73       JOB_READY            J      0x0004     job ready to send
74       JOB_SLEEP            J      0x0008     job sleeping awaiting time-to-send
75       JOB_DEAD             J      0x0010     job marked dead
76       JOB_PROCESS          J      0x0020     job processed by scheduler
77       JOB_REAP             J      0x0040     job corpus reaped
78       JOB_ACTIVE           J      0x0080     job activated
79       JOB_REJECT           J      0x0100     job rejected
80       JOB_KILL             J      0x0200     job killed
81       JOB_BLOCKED          J      0x0400     job blocked by other job
82       JOB_DELAYED          J      0x0800     job delayed by tod restriction or similar
83       JOB_ALTERED┬╣         J      0x1000     job parameters altered
84       JOB_TIMEDOUT         J      0x2000     job kill timer expired
85       JOB_PREP_BEGIN       J      0x4000     job preparation started
86       JOB_PREP_END         J      0x8000     job preparation finished
87       SEND_BEGIN           S      0x0001     fax, send attempt started
88       SEND_CALL            S      0x0002     fax, call placed
89       SEND_CONNECTED       S      0x0004     fax, call answered by fax
90       SEND_PAGE            S      0x0008     fax, page transmit done
91       SEND_DOC             S      0x0010     fax, document transmit done
92       SEND_POLLRCVD        S      0x0020     fax, document retrieved by poll operation
93       SEND_POLLDONE        S      0x0040     fax, poll operation completed
94       SEND_END             S      0x0080     fax, send attempt finished
95       SEND_REFORMAT        S      0x0100     fax, job being reformatted
96       SEND_REQUEUE         S      0x0200     fax, job requeued
97       SEND_DONE            S      0x0400     fax, send job done
98       RECV_BEGIN           R      0x0001     fax, inbound call started
99       RECV_START           R      0x0002     fax, session started
100       RECV_PAGE            R      0x0004     fax, page receive done
101       RECV_DOC             R      0x0008     fax, document receive done
102       RECV_END             R      0x0010     fax, inbound call finished
103       MODEM_ASSIGN         M      0x0001     modem assigned to job
104       MODEM_RELEASE        M      0x0002     modem released by job
105       MODEM_DOWN           M      0x0004     modem marked down
106       MODEM_READY          M      0x0008     modem marked ready
107       MODEM_BUSY           M      0x0010     modem marked busy
108       MODEM_WEDGED         M      0x0020     modem considered wedged
109       MODEM_INUSE          M      0x0040     modem in use for outbound work
110       MODEM_DATA_BEGIN     M      0x0080     inbound data call begun
111       MODEM_DATA_END       M      0x0100     inbound data call finished
112       MODEM_VOICE_BEGIN    M      0x0200     inbound voice call begun
113       MODEM_VOICE_END      M      0x0400     inbound voice call finished
114       MODEM_CID            M      0x0800     inbound caller-ID information
116       ┬╣ Event to be removed soon.


119       hylafax-server(5F), hfaxd(8C).
123                               January 18, 1996                   FAXWATCH(8C)