faxstat.1
上传用户:weiyuanprp
上传日期:2020-05-20
资源大小:1169k
文件大小:15k
源码类别:

传真(Fax)编程

开发平台:

C/C++

  1. ." $Id: faxstat.1,v 1.10 2009/09/29 11:46:01 faxguy Exp $
  2. ."
  3. ." HylaFAX Facsimile Software
  4. ."
  5. ." Copyright (c) 1990-1996 Sam Leffler
  6. ." Copyright (c) 1991-1996 Silicon Graphics, Inc.
  7. ." HylaFAX is a trademark of Silicon Graphics
  8. ." 
  9. ." Permission to use, copy, modify, distribute, and sell this software and 
  10. ." its documentation for any purpose is hereby granted without fee, provided
  11. ." that (i) the above copyright notices and this permission notice appear in
  12. ." all copies of the software and related documentation, and (ii) the names of
  13. ." Sam Leffler and Silicon Graphics may not be used in any advertising or
  14. ." publicity relating to the software without the specific, prior written
  15. ." permission of Sam Leffler and Silicon Graphics.
  16. ." 
  17. ." THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
  18. ." EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
  19. ." WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
  20. ." 
  21. ." IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  22. ." ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  23. ." OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  24. ." WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
  25. ." LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
  26. ." OF THIS SOFTWARE.
  27. ."
  28. .if n .po 0
  29. .ds Fx fIHylas-1FAXs+1fP
  30. .TH FAXSTAT 1 "July 9, 1996"
  31. .SH NAME
  32. faxstat - display *(Fx status
  33. .SH SYNOPSIS
  34. .B faxstat
  35. [
  36. .B -O
  37. .I config
  38. ] [
  39. .I options
  40. ]
  41. .SH DESCRIPTION
  42. .I faxstat
  43. reports the status of *(Fx servers, including (potentially)
  44. the status of the send, receive, done, document, and archive directories.
  45. When invoked without options
  46. .I faxstat
  47. reports only the status of the server; the options
  48. described below can be used to override this behavior.
  49. .PP
  50. Server status information indicates the state of the
  51. server (idle, sending, receiving, etc.)
  52. and the phone number that is associated with the fax modem.
  53. .PP
  54. The job queue report give the status of facsimile jobs
  55. queued for transmission; by default:
  56. .IP (bu 3
  57. the job identifier,
  58. .IP (bu 3
  59. the job state (see below for the description of the
  60. .B a
  61. format in the
  62. .B JobFmt
  63. string),
  64. .IP (bu 3
  65. the modem or modem class the job is bound to (``any'' if the job
  66. can be sent though any modem),
  67. .IP (bu 3
  68. the destination (phone number) of the job,
  69. .IP (bu 3
  70. the time to send the job, or a blank field if the job is being
  71. processed or is to be sent immediately,
  72. .IP (bu 3
  73. the job's owner,
  74. .IP (bu 3
  75. and status information about the job (typically the reason why
  76. a previous attempt failed).
  77. .PP
  78. The receive queue report lists the facsimile documents
  79. that have been received and are awaiting delivery; by default it
  80. includes:
  81. .IP (bu 3
  82. the document protection mode,
  83. .IP (bu 3
  84. the number of pages,
  85. .IP (bu 3
  86. the document's owner,
  87. .IP (bu 3
  88. the phone number of the sender (if supplied),
  89. .IP (bu 3
  90. the date and time at which the job was received, and
  91. .IP (bu 3
  92. the filename of the document in the fBrecvqfP
  93. directory on the server machine.
  94. .SH OPTIONS
  95. .TP 10
  96. .B -a
  97. Display the contents of the
  98. .B archive
  99. directory on the server machine
  100. .TP 10
  101. .B -d
  102. Display the status of all jobs that have completed; i.e. those
  103. jobs located in the
  104. .B doneq
  105. directory on the server machine.
  106. The
  107. .B JobFmt
  108. string defines the content and format of information reported with
  109. this option.
  110. .TP 10
  111. .B -f
  112. Display the status of document files located in the
  113. .B docq
  114. directory on the server machine.
  115. The
  116. .B FileFmt
  117. string defines the content and format of information reported with
  118. this option (see below).
  119. .TP 10
  120. .B -g
  121. Display times and dates in 
  122. Greenwich Mean Time (s-1GMTs+1).
  123. NB: fIthis is the defaultfP.
  124. .TP 10
  125. .BI -h " host"
  126. Report the status of the server on a specific
  127. .IR host .
  128. The
  129. .I host
  130. may be either a symbolic name or a network address.
  131. IPv6 addresses are given in ``[xx:xx::x]:port'' format.
  132. If no
  133. .B -h
  134. option is supplied,
  135. .I faxstat
  136. uses the
  137. .SM FAXSERVER
  138. environment variable to identify the *(Fx server to contact.
  139. If this variable is not set, then
  140. .I faxstat
  141. checks for a setting in the configuration files (first in the
  142. per-user file and then in the system-wide file).
  143. If all of the above fails, then
  144. .I faxstat
  145. attempts to contact a server on the machine where it is run.
  146. .TP 10
  147. .B -i
  148. Display additional status information for the server
  149. as given by
  150. .B ${SPOOL}/status/any.info.
  151. This status typically has information such as the *(Fx
  152. version, the physical location of the server machine, and
  153. an administrative contact for the server.  See fIstatusfP|(${MANNUM4_5}).
  154. .TP 10
  155. .B -l
  156. Display times and dates in the local timezone of the server.
  157. .TP 10
  158. .B -n
  159. Supress the display of server and modem status.
  160. .TP 10
  161. .BI -o " login"
  162. Specify the fax owner login name.  If unspecified, the user's
  163. current login name is used.  The login password may also
  164. be provided by separating it from the owner login name with
  165. a colon, like ``owner:pass''.
  166. .TP 10
  167. .B -q
  168. Display the sequence numbers of the *(Fx queues.
  169. .TP 10
  170. .B -r
  171. Display the receive queue status for each server.
  172. The
  173. .B RcvFmt
  174. string defines the content and format of information reported with
  175. this option (see below).
  176. .TP 10
  177. .BI -O " config"
  178. Treat
  179. .I config
  180. as a configuration parameter specification that is interpreted
  181. after reading the configuration file.
  182. For example, ``-O Host:fax.example.com'' would set the
  183. .B Host
  184. configuration parameter to ``fax.example.com'', overriding any setting in
  185. the configuration file.
  186. .TP 10
  187. .B -s
  188. Display the status of jobs in the send queue on the server machine.
  189. The
  190. .B JobFmt
  191. string defines the content and format of information reported with
  192. this option (see below).
  193. .TP 10
  194. .B -v
  195. Trace the protocol exchanges between
  196. .I faxstat
  197. and the
  198. .I hfaxd
  199. processes on the standard output.
  200. .SH "CONFIGURATION PARAMETERS"
  201. .I faxstat
  202. reads configuration information from the file
  203. .B ${LIBDATA}/hyla.conf
  204. and then from the file
  205. .BR ~/.hylarc .
  206. Configuration files follow the conventions described in
  207. .IR hylafax-client (1).
  208. The following configuration parameters are recognized:
  209. .sp .5
  210. .nf
  211. .ta w'AutoCoverPage    'u +w'boolean    'u +w's-1fIsee belowfPs+1    'u
  212. fBTag Type Default DescriptionfP
  213. FileFmt string s-1fIsee belowfPs+1 format string for file status results
  214. Host string s-1localhosts+1 host to contact for service
  215. JobFmt string s-1fIsee belowfPs+1 format string for job status results
  216. ModemFmt string s-1fIsee belowfPs+1 format string for modem status results
  217. PassiveMode boolean s-1falses+1 whether or not to use passive mode
  218. Port integer s-14559s+1 port to use in contacting server
  219. Protocol string s-1tcps+1 protocol to use in contacting server
  220. RcvFmt string s-1fIsee belowfPs+1 format string for received facsimile status results
  221. TimeZone string s-1GMTs+1 timezone to use for reporting dates and times
  222. Verbose boolean s-1Nos+1 whether or not to enable protocol tracing
  223. .fi
  224. .PP
  225. The configuration parameters are explained below:
  226. .TP 14
  227. .B FileFmt
  228. The format string to use when returning file status information with the
  229. .B -f
  230. option.
  231. Formats are specified using 
  232. .IR printf (3S)-c
  233. style conventions but using the field identifiers listed below.
  234. Each item can include field width, precision, left-justification,
  235. 0-filling, etc. just as for 
  236. .IR printf ;
  237. e.g. %-8p for an 8-character wide, left-justified, blank-padded
  238. field containing the file protection flags.
  239. .IP
  240. .nf
  241. .ta w'Format    'u +w'Description    'u
  242. fBFormat DescriptionfP
  243. a Last access time
  244. c Creation time
  245. d Device number (octal)
  246. f Filename
  247. g Group identifier (decimal)
  248. i Inode number (decimal)
  249. l Link count (decimal)
  250. m Last modification time
  251. o Owner (based on file s-1GIDs+1)
  252. p Fax-style protection flags (no group bits)
  253. q s-1UNIXs+1-style protection flags
  254. r Root device number (octal)
  255. s File size in bytes (decimal)
  256. u User identifier (decimal)
  257. .fi
  258. .TP 14
  259. .B Host
  260. The host to contact for service.
  261. (Equivalent to the
  262. .B -h
  263. option.)
  264. .TP 14
  265. .B JobFmt
  266. The format string to use when returning job status information for
  267. the
  268. .B -s
  269. and
  270. .B -d
  271. options.
  272. Formats are specified using 
  273. .IR printf (3S)-c
  274. style conventions but using the field identifiers listed below.
  275. Each item can include field width, precision, left-justification,
  276. 0-filling, etc. just as for 
  277. .IR printf ;
  278. e.g. %-3j for a 3-character wide, left-justified, blank-padded
  279. field containing the job state.
  280. .IP
  281. .nf
  282. .ta w'Format    'u +w'Description    'u
  283. fBFormat DescriptionfP
  284. A Destination SubAddress
  285. B Destination Password
  286. C Destination company name
  287. D Total # dials/maximum # dials
  288. E Desired signalling rate
  289. F Client-specific tagline format string
  290. G Desired min-scanline time
  291. H Desired data format
  292. I Client-specified scheduling priority
  293. J Client-specified job tag string
  294. K Desired use of ECM (one-character symbol)
  295. L Destination geographic location
  296. M Notification e-mail address
  297. N Desired use of private tagline (one-character symbol)
  298. O Whether to use continuation cover page (one-character symbol)
  299. P # pages transmitted/total # pages to transmit
  300. Q Client-specified minimum acceptable signalling rate
  301. R Destination person (receiver)
  302. S Sender's identity
  303. T Total # tries/maximum # tries
  304. U Page chopping threshold (inches)
  305. V Job done operation
  306. W Communication identifier
  307. X Job type (one-character symbol)
  308. Y Scheduled date and time
  309. Z Scheduled time in seconds since the UNIX epoch
  310. a Job state (one-character symbol)
  311. b # consecutive failed tries
  312. c Client machine name
  313. d Total # dials
  314. e Public (external) format of dialstring
  315. f # consecutive failed dials
  316. g Group identifier
  317. h Page chop handling (one-character symbol)
  318. i Current scheduling priority
  319. j Job identifier
  320. k Job kill time
  321. l Page length in mm
  322. m Assigned modem
  323. n E-mail notification handling (one-character symbol)
  324. o Job owner
  325. p # pages transmitted
  326. q Job retry time (MM::SS)
  327. r Document resolution in lines/inch
  328. s Job status information from last failure
  329. t Total # tries attempted
  330. u Maximum # tries
  331. v Client-specified dialstring
  332. w Page width in mm
  333. x Maximum # dials
  334. y Total # pages to transmit
  335. z Time to send job
  336. .fi
  337. .IP
  338. The
  339. .B K
  340. format produces:
  341. ``D'' if ECM is to be disabled,
  342. `` '' (space) if ECM use is enabled,
  343. ``H'' if T.30 Annex C half duplex is enabled,
  344. or
  345. ``F'' if T.30 Annex C full duplex is enabled.
  346. .IP
  347. The
  348. .B N
  349. format produces:
  350. `` '' (space) if the system-wide tagline format is to be used
  351. or
  352. ``P'' if a private tagline format is to be used.
  353. .IP
  354. The
  355. .B O
  356. format produces:
  357. ``N'' if no continuation cover page is to be used
  358. or
  359. `` '' (space) if the system default handling for continuation cover pages
  360. is to be used.
  361. .IP
  362. The
  363. .B X
  364. format produces:
  365. ``F'' for a facsimile job
  366. or
  367. ``P'' for a pager job.
  368. .IP
  369. The
  370. .B a
  371. format produces:
  372. ``?'' for a job in an undefined state,
  373. ``T'' for a suspended job (not being scheduled),
  374. ``P'' for a pending job (waiting for its time to send to arrive),
  375. ``S'' for a sleeping job (waiting for a scheduled timeout such as a delay between attempts to send),
  376. ``B'' for a job blocked by concurrent activity to the same destination,
  377. ``W'' for a job waiting for resources such as a free modem,
  378. ``R'' for a job that is actively running,
  379. and
  380. ``D'' for a job that is done and was a success.
  381. ``F'' for a job that failed to complete.
  382. .IP
  383. The
  384. .B h
  385. format produces:
  386. ``D'' if page chopping is disabled,
  387. `` '' (space) for the system default page chop handling,
  388. ``A'' when all pages are to be chopped,
  389. or
  390. ``L'' if only the last page is to be chopped.
  391. .IP
  392. The
  393. .B n
  394. format produces:
  395. `` '' (space) when no notification messages are to be delivered,
  396. ``D'' when notification is to be sent when the job is done,
  397. ``Q'' when notification is to be sent each time the job is requeued,
  398. or
  399. ``A'' when notification is to be sent for either the job completing
  400. or being requeued.
  401. .IP
  402. It is recommended that all items include a field width so that
  403. the width of column title strings can be constrained
  404. when constructing headers from the format string.
  405. .TP 14
  406. .B ModemFmt
  407. The format string to use when returning modem status information.
  408. Formats are specified using 
  409. .IR printf (3S)-c
  410. style conventions but using the field identifiers listed below.
  411. Each item can include field width, precision, left-justification,
  412. 0-filling, etc. just as for 
  413. .IR printf ;
  414. e.g. %-8h for an 8-character wide, left-justified, blank-padded
  415. field containing the name of the host the server is running on.
  416. .IP
  417. .nf
  418. .ta w'Format    'u +w'Description    'u
  419. fBFormat DescriptionfP
  420. h Server hostname
  421. l Local identifier string
  422. m Canonical modem name
  423. n FAX phone number
  424. r Maximum pages that can be received in a single call
  425. s Status information string
  426. t Server and session tracing levels (xxxxx:yyyyy)
  427. v Modem speaker volume as one-character symbol
  428. z A ``*'' if a fIfaxgettyfP|(${MANNUM1_8}) process is running; otherwise `` '' (space)
  429. .fi
  430. .TP 10
  431. .B PassiveMode
  432. Whether or not to use passive mode in communication with the server.
  433. .TP 14
  434. .B Port
  435. The network port to contact for service.
  436. (Equivalent to the
  437. .B -h
  438. option.)
  439. .TP 14
  440. .B Protocol
  441. The name of the communication protocol to use when contacting a server.
  442. (Equivalent to the
  443. .B FAXSERVICE
  444. environment variable.)
  445. .TP 14
  446. .B RcvFmt
  447. The format string to use when returning status information for the
  448. .B -r
  449. option.
  450. Formats are specified using 
  451. .IR printf (3S)-c
  452. style conventions but using the field identifiers listed below.
  453. Each item can include field width, precision, left-justification,
  454. 0-filling, etc. just as for 
  455. .IR printf ;
  456. e.g. %-3b for a 3-character wide, left-justified, blank-padded
  457. field containing the signalling rate.
  458. .IP
  459. .nf
  460. .ta w'Format    'u +w'Description    'u
  461. fBFormat DescriptionfP
  462. Y Extended representation of the time when the receive happened
  463. a SubAddress received from sender (if any)
  464. b Signalling rate used during receive
  465. d Data format used during receive
  466. e Error description if an error occurred during receive
  467. f Document filename (relative to the fBrecvqfP directory)
  468. h Time spent receiving document (HH:MM:SS)
  469. i CIDName value for received fax
  470. j CIDNumber value for received fax
  471. l Page length in mm
  472. m Fax-style protection mode string (``-rwxrwx'')
  473. n File size (number of bytes)
  474. o File owner
  475. p Number of pages in document
  476. q s-1UNIXs+1-style protection flags
  477. r Resolution of received data
  478. s Sender identity (s-1TSIs+1)
  479. t Compact representation of the time when the receive happened
  480. w Page width in mm
  481. z A ``*'' if receive is going on; otherwise `` '' (space)
  482. .fi
  483. .IP
  484. It is recommended that all items include a field width so that
  485. the width of column title strings can be constrained
  486. when constructing headers from the format string.
  487. .TP 14
  488. .B TimeZone
  489. Control whether times and dates are reported in the local
  490. timezone of the server (``local'') or in GMT (``gmt'').
  491. By default times are reported in GMT.
  492. .TP 14
  493. .B Verbose
  494. Control protocol tracing.
  495. (Equivalent to the
  496. .B -v
  497. option.)
  498. .SH NOTES
  499. The server login user name may be specified by the
  500. .B FAXUSER
  501. environment variable.
  502. .SH BUGS
  503. There is no way to suppress the server status report.
  504. There is no way to control the printing of headers.
  505. .SH FILES
  506. .ta w'${LIBDATA}/hyla.conf    'u
  507. .nf
  508. ${LIBDATA}/hyla.conf system-wide configuration file
  509. ~/.hylarc per-user configuration file
  510. .fi
  511. .SH "SEE ALSO"
  512. .IR hylafax-client (1),
  513. .IR sendfax (1),
  514. .IR faxalter (1),
  515. .IR faxrm (1),
  516. .IR hfaxd (${MANNUM1_8})