1FAXSTAT(1) General Commands Manual FAXSTAT(1)
2
6 faxstat - display HylaFAX status
7
9 faxstat [ -O config ] [ options ]
10
12 faxstat reports the status of HylaFAX servers, including (potentially)
13 the status of the send, receive, done, document, and archive directo‐
14 ries. When invoked without options faxstat reports only the status of
15 the server; the options described below can be used to override this
16 behavior.
17 Server status information indicates the state of the server (idle,
19 sending, receiving, etc.) and the phone number that is associated with
20 the fax modem.
21 The job queue report give the status of facsimile jobs queued for
23 transmission; by default:
24 · the job identifier,
26 · the job state (see below for the description of the a format in the
28 JobFmt string),
29 · the modem or modem class the job is bound to (``any'' if the job can
31 be sent though any modem),
32 · the destination (phone number) of the job,
34 · the time to send the job, or a blank field if the job is being pro‐
36 cessed or is to be sent immediately,
37 · the job's owner,
39 · and status information about the job (typically the reason why a
41 previous attempt failed).
42 The receive queue report lists the facsimile documents that have been
44 received and are awaiting delivery; by default it includes:
45 · the document protection mode,
47 · the number of pages,
49 · the document's owner,
51 · the phone number of the sender (if supplied),
53 · the date and time at which the job was received, and
55 · the filename of the document in the recvq directory on the server
57 machine.
58
60 -A Login with administrative privileges.
61 -a Display the contents of the archive directory on the server
63 machine
64 -d Display the status of all jobs that have completed; i.e.
66 those jobs located in the doneq directory on the server
67 machine. The JobFmt string defines the content and format of
68 information reported with this option.
69 -f Display the status of document files located in the docq
71 directory on the server machine. The FileFmt string defines
72 the content and format of information reported with this
73 option (see below).
74 -g Display times and dates in Greenwich Mean Time (GMT). NB:
76 this is the default.
77 -h host Report the status of the server on a specific host. The host
79 may be either a symbolic name or a network address. IPv6
80 addresses are given in ``[xx:xx::x]:port'' format. If no -h
81 option is supplied, faxstat uses the FAXSERVER environment
82 variable to identify the HylaFAX server to contact. If this
83 variable is not set, then faxstat checks for a setting in the
84 configuration files (first in the per-user file and then in
85 the system-wide file). If all of the above fails, then faxs‐
86 tat attempts to contact a server on the machine where it is
87 run.
88 -i Display additional status information for the server as given
90 by /var/spool/hylafax/status/any.info. This status typically
91 has information such as the HylaFAX version, the physical
92 location of the server machine, and an administrative contact
93 for the server. See status(5F).
94 -l Display times and dates in the local timezone of the server.
96 -n Supress the display of server and modem status.
98 -o login Specify the fax owner login name. If unspecified, the user's
100 current login name is used. The login password and admin
101 password may also be provided by separating them from the
102 owner login name with colons, like ``owner:pass:adminpass''.
103 -q Display the sequence numbers of the HylaFAX queues.
105 -r Display the receive queue status for each server. The RcvFmt
107 string defines the content and format of information reported
108 with this option (see below).
109 -O config Treat config as a configuration parameter specification that
111 is interpreted after reading the configuration file. For
112 example, ``-O Host:fax.example.com'' would set the Host con‐
113 figuration parameter to ``fax.example.com'', overriding any
114 setting in the configuration file.
115 -s Display the status of jobs in the send queue on the server
117 machine. The JobFmt string defines the content and format of
118 information reported with this option (see below).
119 -v Trace the protocol exchanges between faxstat and the hfaxd
121 processes on the standard output.
122
124 faxstat reads configuration information from the file
125 /etc/hylafax/hyla.conf and then from the file ~/.hylarc. Configuration
126 files follow the conventions described in hylafax-client(1). The fol‐
127 lowing configuration parameters are recognized:
128 Tag Type Default Description
129 FileFmt string see below format string for file status results
130 Host string localhost host to contact for service
131 JobFmt string see below format string for job status results
132 ModemFmt string see below format string for modem status results
133 PassiveMode boolean false whether or not to use passive mode
134 Port integer 4559 port to use in contacting server
135 Protocol string tcp protocol to use in contacting server
136 RcvFmt string see below format string for received facsimile status results
137 TimeZone string GMT timezone to use for reporting dates and times
138 Verbose boolean No whether or not to enable protocol tracing
139 The configuration parameters are explained below:
141 FileFmt The format string to use when returning file status
143 information with the -f option. Formats are specified
144 using printf(3S)-style conventions but using the field
145 identifiers listed below. Each item can include field
146 width, precision, left-justification, 0-filling, etc.
147 just as for printf; e.g. %-8p for an 8-character wide,
148 left-justified, blank-padded field containing the file
149 protection flags.
150 Format Description
152 a Last access time
153 c Creation time
154 d Device number (octal)
155 f Filename
156 g Group identifier (decimal)
157 i Inode number (decimal)
158 l Link count (decimal)
159 m Last modification time
160 o Owner (based on file GID)
161 p Fax-style protection flags (no group bits)
162 q UNIX-style protection flags
163 r Root device number (octal)
164 s File size in bytes (decimal)
165 u User identifier (decimal)
166 Host The host to contact for service. (Equivalent to the -h
168 option.)
169 JobFmt The format string to use when returning job status infor‐
171 mation for the -s and -d options. Formats are specified
172 using printf(3S)-style conventions but using the field
173 identifiers listed below. Each item can include field
174 width, precision, left-justification, 0-filling, etc.
175 just as for printf; e.g. %-3j for a 3-character wide,
176 left-justified, blank-padded field containing the job
177 state.
178 Format Description
180 A Destination SubAddress
181 B Destination Password
182 C Destination company name
183 D Total # dials/maximum # dials
184 E Desired signalling rate
185 F Client-specific tagline format string
186 G Desired min-scanline time
187 H Desired data format
188 I Client-specified scheduling priority
189 J Client-specified job tag string
190 K Desired use of ECM (one-character symbol)
191 L Destination geographic location
192 M Notification e-mail address
193 N Desired use of private tagline (one-character symbol)
194 O Whether to use continuation cover page (one-character symbol)
195 P # pages transmitted/total # pages to transmit
196 Q Client-specified minimum acceptable signalling rate
197 R Destination person (receiver)
198 S Sender's identity
199 T Total # tries/maximum # tries
200 U Page chopping threshold (inches)
201 V Job done operation
202 W Communication identifier
203 X Job type (one-character symbol)
204 Y Scheduled date and time
205 Z Scheduled time in seconds since the UNIX epoch
206 a Job state (one-character symbol)
207 b # consecutive failed tries
208 c Client machine name
209 d Total # dials
210 e Public (external) format of dialstring
211 f # consecutive failed dials
212 g Group identifier
213 h Page chop handling (one-character symbol)
214 i Current scheduling priority
215 j Job identifier
216 k Job kill time
217 l Page length in mm
218 m Assigned modem
219 n E-mail notification handling (one-character symbol)
220 o Job owner
221 p # pages transmitted
222 q Job retry time (MM::SS)
223 r Document resolution in lines/inch
224 s Job status information from last failure
225 t Total # tries attempted
226 u Maximum # tries
227 v Client-specified dialstring
228 w Page width in mm
229 x Maximum # dials
230 y Total # pages to transmit
231 z Time to send job
232 The K format produces: ``D'' if ECM is to be disabled, ``
234 '' (space) if ECM use is enabled, ``H'' if T.30 Annex C
235 half duplex is enabled, or ``F'' if T.30 Annex C full
236 duplex is enabled.
237 The N format produces: `` '' (space) if the system-wide
239 tagline format is to be used or ``P'' if a private
240 tagline format is to be used.
241 The O format produces: ``N'' if no continuation cover
243 page is to be used or `` '' (space) if the system default
244 handling for continuation cover pages is to be used.
245 The X format produces: ``F'' for a facsimile job or ``P''
247 for a pager job.
248 The a format produces: ``?'' for a job in an undefined
250 state, ``T'' for a suspended job (not being scheduled),
251 ``P'' for a pending job (waiting for its time to send to
252 arrive), ``S'' for a sleeping job (waiting for a sched‐
253 uled timeout such as a delay between attempts to send),
254 ``B'' for a job blocked by concurrent activity to the
255 same destination, ``W'' for a job waiting for resources
256 such as a free modem, ``R'' for a job that is actively
257 running, and ``D'' for a job that is done and was a suc‐
258 cess. ``F'' for a job that failed to complete.
259 The h format produces: ``D'' if page chopping is dis‐
261 abled, `` '' (space) for the system default page chop
262 handling, ``A'' when all pages are to be chopped, or
263 ``L'' if only the last page is to be chopped.
264 The n format produces: `` '' (space) when no notification
266 messages are to be delivered, ``D'' when notification is
267 to be sent when the job is done, ``Q'' when notification
268 is to be sent each time the job is requeued, or ``A''
269 when notification is to be sent for either the job com‐
270 pleting or being requeued.
271 It is recommended that all items include a field width so
273 that the width of column title strings can be constrained
274 when constructing headers from the format string.
275 ModemFmt The format string to use when returning modem status
277 information. Formats are specified using
278 printf(3S)-style conventions but using the field identi‐
279 fiers listed below. Each item can include field width,
280 precision, left-justification, 0-filling, etc. just as
281 for printf; e.g. %-8h for an 8-character wide, left-jus‐
282 tified, blank-padded field containing the name of the
283 host the server is running on.
284 Format Description
286 h Server hostname
287 l Local identifier string
288 m Canonical modem name
289 n FAX phone number
290 r Maximum pages that can be received in a single call
291 s Status information string
292 t Server and session tracing levels (xxxxx:yyyyy)
293 v Modem speaker volume as one-character symbol
294 z A ``*'' if a faxgetty(8C) process is running; otherwise `` '' (space)
295 PassiveMode
297 Whether or not to use passive mode in communication with the
298 server.
299 Port The network port to contact for service. (Equivalent to
301 the -h option.)
302 Protocol The name of the communication protocol to use when con‐
304 tacting a server. (Equivalent to the FAXSERVICE environ‐
305 ment variable.)
306 RcvFmt The format string to use when returning status informa‐
308 tion for the -r option. Formats are specified using
309 printf(3S)-style conventions but using the field identi‐
310 fiers listed below. Each item can include field width,
311 precision, left-justification, 0-filling, etc. just as
312 for printf; e.g. %-3b for a 3-character wide, left-justi‐
313 fied, blank-padded field containing the signalling rate.
314 Format Description
316 Y Extended representation of the time when the receive happened
317 a SubAddress received from sender (if any)
318 b Signalling rate used during receive
319 d Data format used during receive
320 e Error description if an error occurred during receive
321 f Document filename (relative to the recvq directory)
322 h Time spent receiving document (HH:MM:SS)
323 i CIDName value for received fax
324 j CIDNumber value for received fax
325 l Page length in mm
326 m Fax-style protection mode string (``-rwxrwx'')
327 n File size (number of bytes)
328 o File owner
329 p Number of pages in document
330 q UNIX-style protection flags
331 r Resolution of received data
332 s Sender identity (TSI)
333 t Compact representation of the time when the receive happened
334 w Page width in mm
335 z A ``*'' if receive is going on; otherwise `` '' (space)
336 It is recommended that all items include a field width so
338 that the width of column title strings can be constrained
339 when constructing headers from the format string.
340 TimeZone Control whether times and dates are reported in the local
342 timezone of the server (``local'') or in GMT (``gmt'').
343 By default times are reported in GMT.
344 Verbose Control protocol tracing. (Equivalent to the -v option.)
346
348 The server login user name may be specified by the FAXUSER environment
349 variable.
350
352 There is no way to suppress the server status report. There is no way
353 to control the printing of headers.
354
356 /etc/hylafax/hyla.conf system-wide configuration file
357 ~/.hylarc per-user configuration file
358
360 hylafax-client(1), sendfax(1), faxalter(1), faxrm(1), hfaxd(8C)
361 July 9, 1996 FAXSTAT(1)