1HYLAFAX-INFO(5F) HYLAFAX-INFO(5F)
2
6 info - remote device capability database
7
9 The info subdirectory in the HylaFAX spooling area holds information
10 about the capabilities and status of devices that have been called.
11 One file exists for each device, with the filename created from the
12 remote device's fully-qualified phone number. Files have a simple
13 ASCII format. Each line is of the form
14 [&]tag: value
15 where a tag identifies a capability and a value is either a string,
16 number, or boolean value. An optional ``&'' at the front of the line
17 indicates that the tag's value is locked down and should not be updated
18 by the server. This facility is useful for restricting the capabili‐
19 ties used with a particular machine.
20 The following items are recorded:
22 Tag Type Description
23 calledBefore boolean device has previously answered at this number
24 dialFailures number count of consecutive failed dial operations
25 hasV34Trouble boolean there is difficulty sending to this destination with V.34
26 hasV17Trouble boolean there is difficulty sending to this destination with V.17
27 lastDialFailure string reason for last failed dial operation
28 lastSendFailure string reason for last failed send attempt
29 maxPageWidth number maximum page width in pixels in normal resolution
30 maxPageLength number maximum page length in millimeters
31 maxSignallingRate string maximum signalling rate (bits/sec) to use
32 minScanlineTime string minimum scanline time
33 pagerMaxMsgLength number length of longest allowed text message
34 pagerPassword string password string send to service provider
35 pagerSetupCmds string commands for setting up modem for a specific service provider
36 pagerTTYParity string parity & # bits configuration for IXO/TAP communication
37 pageSource string parameter to tell the paging central who we are
38 pagingProtocol string protocol (IXO or UCP) for this provider
39 remoteCSI string remote device Called Subscriber Identification
40 remoteNSF string remote equipment Non-Standard Facilities information
41 remoteDIS string remote Digital Identification Signal: capabilities
42 sendFailures number count of consecutive failed send attempts
43 dataSent number units of data sent to the destination in the last session
44 dataSent1 number units of data sent to the destination in the session previous to the last
45 dataSent2 number units of data sent to the destination in the session previous, previous to the last
46 dataMissed number units of data sent to the destination which were missed or corrupt in the last session
47 dataMissed1 number units of data sent to the destination which were missed or corrupt in session previous to the last
48 dataMissed2 number units of data sent to the destination which were missed or corrupt in session previous, previous to the last
49 senderConfusesPIN boolean this caller does not return to Phase B and resend the same page after PIN
50 senderConfusesRTN boolean this caller does not return to Phase B and resend the same page after RTN
51 senderDataSent number units of data sent by the sender in the last session
52 senderDataSent1 number units of data sent by the sender in the session previous to the last
53 senderDataSent2 number units of data sent by the sender in the session previous, previous to the last
54 senderDataMissed number units of data sent by the sender which were missed or corrupt in the last session
55 senderDataMissed1 number units of data sent by the sender which were missed or corrupt in session previous to the last
56 senderDataMissed2 number units of data sent by the sender which were missed or corrupt in session previous, previous to the last
57 senderHasV17Trouble boolean there is difficulty receiving from this caller with V.17
58 senderSkipsV29 boolean this caller does not use V.29 in the presence of V.17
59 supportsBatching boolean accepts batching protocol
60 supportsHighRes boolean accepts 196 line/inch images (obsolete)
61 supportsVRes number vertical resolution support bitmask
62 supports2DEncoding boolean accepts Group 3 2D encoding
63 supportsMMR boolean accepts Group 4 encoding
64 supportsPostScript boolean accepts Adobe POSTSCRIPT transfer protocol
65 The HylaFAX scheduler, faxq(8C), uses the information stored in this
67 directory when deciding if a call should be placed and when preparing
68 documents for transmission. If a remote device's capabilities are
69 known, then document preparation is constrained and/or optimized
70 according to the capabilities. Otherwise, documents are prepared with‐
71 out regard for the remote device's capabilities and if a capability
72 mismatch is encountered the session is terminated and the documents are
73 reformatted using the newly discovered capabilities.
74 The calledBefore item is used by faxsend to decide whether or not to
76 redial a phone number when encountering certain errors. For example,
77 if a dialing command results in a ``NO CARRIER'' result, then the num‐
78 ber will not be retried unless the number has previously been dialed
79 successfully.
80 The minScanlineTime item indicates the minimum scanline time parameter
82 used for facsimile transmissions. Acceptable values are: ``0ms'',
83 ``5ms'', ``10ms/5ms'', ``10ms'', ``20ms/10ms'', ``20ms'',
84 ``40ms/20ms'', and ``40ms''. (Values of the form X/Y mean to use X for
85 98 lpi images and Y for 196 lpi images.)
86 The pagerTTYParity item specifies the communication parameters to use
88 when communicating with the IXO/TAP service provider. Acceptable val‐
89 ues are: ``even'' (7 bits, even parity), ``odd'' (7 bits, odd parity),
90 and ``none'' (8 bits, no parity). If nothing is specified then
91 ``even'' is used per the standard.
92 The pagerMaxMsgLength, pagerPassword, and pagerTTYParity items can be
94 setup according to the requirements of a pager service provider; they
95 typically are locked down so that their values are not lost during
96 updates.
97 The pagerSetupCmds can be used to define AT commands for setting up the
99 modem for a specific service provider. This value overwrites the set‐
100 tings defined in hylafax-config(5F).
101 The pageSource parameter can be used to tell the paging central who we
103 are. It usually contains a SMS answerable mobile number. It is only
104 used for the UCP part of sendpage(8C). Note: This parameter should be
105 used from user-land sendpage(1) and will be removed later.
106 The pagingProtocol defines which protocol, UCP or IXO, should be used
108 to send the message to the service provider. It defaults to ``ixo'';
109 for UCP set ``ucp''.
110
112 faxsend, pagesend, and faxq automatically create and update entries in
113 the info directory, as required.
114 The data in this directory is simply a cache of remote capabilities
116 and, except for locked down items, can be safely purged at any time.
117 The faxcron(8C) script, for example, periodically purges unlocked
118 entries in this directory that have not been accessed in 30 days.
119 When the first batching attempt fails then supportsBatching is set to
121 false. It must be manually altered in order to re-enable batching to
122 the destination.
123 Restricting the capabilities used with a particular machine to a value
125 other than those that are mandatory can cause documents to be sent out‐
126 side of an acceptable range for the receiver.
127
129 faxcron(8C), faxq(8C), faxsend(8C), pagesend(8C), hylafax-config(5F)
130 February 10, 1996 HYLAFAX-INFO(5F)