hylafax-info.4f
上传用户:weiyuanprp
上传日期:2020-05-20
资源大小:1169k
文件大小:7k
源码类别:

传真(Fax)编程

开发平台:

C/C++

  1. ." $Id: hylafax-info.4f,v 1.2 2007/08/17 14:54:27 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. .ds Ps Ps-2OSTs+2Ss-2CRIPTs+2
  31. .TH HYLAFAX-INFO ${MANNUM4_5} "February 10, 1996"
  32. .SH NAME
  33. info - remote device capability database
  34. .SH DESCRIPTION
  35. The
  36. .B info
  37. subdirectory in the *(Fx
  38. spooling area holds information about the capabilities
  39. and status of devices that have been called.
  40. One file exists for each device, with the filename
  41. created from the remote device's fully-qualified
  42. phone number.
  43. Files have a simple
  44. .SM ASCII
  45. format.
  46. Each line is of the form
  47. .sp .5
  48. .ti +0.5i
  49. [fB&fP]fBtagfP: fIvaluefP
  50. .br
  51. .sp .5
  52. where a fItagfP identifies a capability and a fIvaluefP
  53. is either a string, number, or boolean value.
  54. An optional ``&'' at the front of the line indicates that the
  55. tag's value is
  56. .I "locked down"
  57. and should not be updated by the server.
  58. This facility is useful for restricting the capabilities used
  59. with a particular machine.
  60. .PP
  61. The following items are recorded:
  62. .RS
  63. .sp .5
  64. .ta w'supports2DEncoding    'u +w'boolean    'u
  65. .nf
  66. fBTag Type DescriptionfP
  67. calledBefore boolean device has previously answered at this number
  68. dialFailures number count of consecutive failed dial operations
  69. hasV34Trouble boolean there is difficulty sending to this destination with V.34
  70. hasV17Trouble boolean there is difficulty sending to this destination with V.17
  71. senderHasV17Trouble boolean there is difficulty receiving from this caller with V.17
  72. senderSkipsV29 boolean this caller does not use V.29 in the presence of V.17
  73. lastDialFailure string reason for last failed dial operation
  74. lastSendFailure string reason for last failed send attempt
  75. maxPageWidth number maximum page width in pixels in normal resolution
  76. maxPageLength number maximum page length in millimeters
  77. maxSignallingRate string maximum signalling rate (bits/sec) to use
  78. minScanlineTime string minimum scanline time
  79. pagerMaxMsgLength number length of longest allowed text message
  80. pagerPassword string password string send to service provider
  81. pagerSetupCmds string commands for setting up modem for a specific service provider
  82. pagerTTYParity string parity & # bits configuration for IXO/TAP communication
  83. pageSource string parameter to tell the paging central who we are
  84. pagingProtocol string protocol (IXO or UCP) for this provider
  85. remoteCSI string remote device Called Subscriber Identification
  86. remoteNSF string remote equipment Non-Standard Facilities information
  87. remoteDIS string remote Digital Identification Signal: capabilities
  88. sendFailures number count of consecutive failed send attempts
  89. supportsBatching boolean accepts batching protocol
  90. supportsHighRes boolean accepts 196 line/inch images (obsolete)
  91. supportsVRes number vertical resolution support bitmask
  92. supports2DEncoding boolean accepts Group 3 2D encoding
  93. supportsMMR boolean accepts Group 4 encoding
  94. supportsPostScript boolean accepts Adobe *(Ps transfer protocol
  95. .fi
  96. .RE
  97. .PP
  98. The *(Fx scheduler,
  99. .IR faxq (${MANNUM1_8}),
  100. uses the information stored in this directory when
  101. deciding if a call should be placed and when
  102. preparing documents for transmission.
  103. If a remote device's capabilities are known, then
  104. document preparation is constrained and/or optimized
  105. according to the capabilities.
  106. Otherwise, documents are prepared without regard for
  107. the remote device's capabilities and if a capability mismatch
  108. is encountered the session is terminated and the documents
  109. are reformatted using the newly discovered capabilities.
  110. .PP
  111. The
  112. .I calledBefore
  113. item is used by 
  114. .I faxsend
  115. to decide whether or not to redial a phone number
  116. when encountering certain errors.
  117. For example, if a dialing command results in a ``s-1NO CARRIERs+1''
  118. result, then the number will not be retried unless
  119. the number has previously been dialed successfully.
  120. .PP
  121. The
  122. .I minScanlineTime
  123. item indicates the minimum scanline time parameter
  124. used for facsimile transmissions.
  125. Acceptable values are:
  126. ``0ms'',
  127. ``5ms'',
  128. ``10ms/5ms'',
  129. ``10ms'',
  130. ``20ms/10ms'',
  131. ``20ms'',
  132. ``40ms/20ms'',
  133. and
  134. ``40ms''.
  135. (Values of the form 
  136. .I X/Y
  137. mean to use 
  138. .I X
  139. for 98 lpi images and 
  140. .I Y
  141. for 196 lpi images.)
  142. .PP
  143. The
  144. .I pagerTTYParity
  145. item specifies the communication parameters to use when communicating
  146. with the
  147. .SM IXO/TAP
  148. service provider.
  149. Acceptable values are:
  150. ``even'' (7 bits, even parity),
  151. ``odd'' (7 bits, odd parity),
  152. and
  153. ``none'' (8 bits, no parity).
  154. If nothing is specified then ``even'' is used per the standard.
  155. .PP
  156. The
  157. .IR pagerMaxMsgLength ,
  158. .IR pagerPassword ,
  159. and
  160. .I pagerTTYParity
  161. items can be setup according to the requirements of a pager
  162. service provider; they typically are locked down so that their
  163. values are not lost during updates.
  164. .PP
  165. The
  166. .IR pagerSetupCmds
  167. can be used to define AT commands for setting up the modem
  168. for a specific service provider.
  169. This value overwrites the settings defined in
  170. .IR hylafax-config (${MANNUM4_5}).
  171. .PP
  172. The
  173. .IR pageSource
  174. parameter can be used to tell the paging central who we are.
  175. It usually contains a SMS answerable mobile number. It is only
  176. used for the s-1UCPs+1 part of
  177. .IR sendpage (${MANNUM1_8}).
  178. fBNote: fR This parameter should be used from user-land
  179. .IR sendpage (1)
  180. and will be removed later.
  181. .PP
  182. The
  183. .IR pagingProtocol
  184. defines which protocol, s-1UCPs+1 or s-1IXOs+1, should
  185. be used to send the message to the service provider. It
  186. defaults to ``ixo''; for s-1UCPs+1 set ``ucp''.
  187. .SH NOTES
  188. .IR faxsend ,
  189. .IR pagesend ,
  190. and
  191. .I faxq
  192. automatically create and update entries in the
  193. .B info
  194. directory, as required.
  195. .PP
  196. The data in this directory is simply a
  197. .I cache
  198. of remote capabilities and, except for locked down items, can be
  199. safely purged at any time.
  200. The
  201. .IR faxcron (${MANNUM1_8})
  202. script, for example, periodically purges unlocked entries in this
  203. directory that have not been accessed in 30 days.
  204. .PP
  205. When the first batching attempt fails then
  206. .IR supportsBatching
  207. is set to false.  It must be manually altered in order to re-enable
  208. batching to the destination.
  209. .PP
  210. Restricting the capabilities used with a particular machine to a value
  211. other than those that are mandatory can cause documents to be sent
  212. outside of an acceptable range for the receiver.
  213. .SH "SEE ALSO"
  214. .IR faxcron (${MANNUM1_8}),
  215. .IR faxq (${MANNUM1_8}),
  216. .IR faxsend (${MANNUM1_8}),
  217. .IR pagesend (${MANNUM1_8}),
  218. .IR hylafax-config (${MANNUM4_5})