1HYLAFAX-CONFIG(5F)                                          HYLAFAX-CONFIG(5F)
2
3
4

NAME

6       config - HylaFAX configuration database
7

DESCRIPTION

9       HylaFAX  uses  a  configuration file for the central queueing agent and
10       for each facsimile modem attached to a machine.   These  files  contain
11       information about the modems and about how the HylaFAX server processes
12       that service these  modem  should  operate.   Configuration  files  are
13       located  in  the  etc  subdirectory.   The  configuration  file for the
14       faxq(8C) program is named config.  The  per-modem  configuration  files
15       used  by  the faxgetty(8C), faxsend(8C), and pagesend(8C) programs have
16       names of the form config.devid, where devid is  an  identifier  derived
17       from  the  name  of  the  modem's  device  file;  for example ttym2 for
18       /dev/ttym2, term_10 for /dev/term/10.
19
20       Configuration files have a simple format and  are  entirely  ASCII.   A
21       configuration parameter is of the form
22            tag: value
23       where a tag identifies a parameter and a value is either a string, num‐
24       ber, or boolean value.  Comments are introduced by the ``#''  character
25       and  extend  to  the end of the line.  String values start at the first
26       non-blank character after the ``:'' and  continue  to  the  first  non-
27       whitespace  character  or,  if  whitespace  is  to  be included, may be
28       enclosed in quote marks (``"'').  String values enclosed in quote marks
29       may  also  use  the  standard  C programming conventions for specifying
30       escape codes; e.g. ``\n'' for a newline character and ``\xxx''  for  an
31       octal  value.  Numeric values are specified according to the C program‐
32       ming conventions (leading ``0x'' for hex, leading ``0'' for octal, oth‐
33       erwise  decimal),  except  for  a few parameters, such as RecvFileMode,
34       whose value is interpreted  strictly  as  an  octal  number  and  Page‐
35       ChopThreshold  whose  value is interpreted strictly as a floating point
36       number.  Boolean values are case insensitive.  For a true value, either
37       ``Yes''  or  ``On''  should  be used.  For a false value, use ``No'' or
38       ``Off''.
39
40       The following table itemizes the tags and the expected  type  of  their
41       value.   The  first  part lists items specific to the operation of each
42       server, while the second part has items related to the servicing of the
43       modem.   Parameters marked with a ¹ are used only by the HylaFAX sched‐
44       uler process and should appear only in the file named config.   Parame‐
45       ters  marked with a ² are used by both the scheduler and the per-device
46       applications and so should  appear  in  all  appropriate  configuration
47       files (i.e.  config and any per-device files that make sense).  Parame‐
48       ters not otherwise marked should appear only in  per-device  configura‐
49       tion files.  More detailed information about each item is given follow‐
50       ing the table.
51       Tag                           Type       Default          Description
52       AdaptiveAnswer                boolean    No               enable adaptive answer of inbound calls
53       AdminGroup                    string     faxadmin         System user group for administration (if PAM enabled)
54       AllowIgnoreModemBusy¹         boolean    No               honor job requests to ignore modem busy status
55       AnswerRotary                  string     Any              alternatives for answering calls
56       AnswerBias                    integer    -                bias to apply to successful rotary answer
57       AreaCode²                     string     -                local area code
58       AuditHook¹                    string     -                command to run for faxq event auditing
59       BadPageHandlingMethod         string     RTN-SAVE         bad page received handling method
60       BatchLogs¹                    boolean    Yes              keep all session logs of a batch in a single log
61       CallIDAnswerLength            integer    -                answer call when CallIDPattern received
62       CallIDDisplay                 boolean    No               display match in modem status
63       CallIDLabel                   string     -                label to use in presentation of the match
64       CallIDPattern                 string     -                call identification pattern string
65       CallIDRecord                  boolean    Yes              record match in recvq image file
66       CallIDType                    string     -                type identifier for the CallIDPattern match
67       CIDName                       string     -                equivalent to CallIDPattern (2)
68       CIDNameAnswerLength           integer    0                equivalent to CallIDAnswerLength (2)
69       CIDNumber                     string     -                equivalent to CallIDPattern (1)
70       CIDNumberAnswerLength         integer    0                equivalent to CallIDAnswerLength (1)
71       ClocalAsRoot                  boolean    No               set CLOCAL using root UID
72       ContCoverCmd¹                 string     bin/mkcover      continuation cover page generation program
73       ContCoverPage¹                string     -                continuation cover page template filename
74       CountryCode²                  string     -                local country code
75       DestControls¹                 obsolete   -                Obsoleted by JobControl
76       DeviceMode                    octal      0600             protection mode to use for modem device
77       DialStringRules²              string     -                dial string rules file
78       DistinctiveRings              string     -                configuration for distinctive ring cadences
79       DRingOff                      string     -                distinctive ring ``off'' cadence indicator
80       DRingOn                       string     -                distinctive ring ``on'' cadence indicator
81       DynamicConfig                 string     -                program for dynamic receive configuration
82       EGettyArgs                    string     -                arguments passed to external getty program
83       FAXNumber                     string     -                facsimile modem phone number
84       FaxRcvdCmd                    string     bin/faxrcvd      notification program for received facsimile
85       GettyArgs                     string     -                arguments passed to getty program
86       Include²                      string     -                include another config file
87       InternationalPrefix²          string     -                dialing prefix for international calls
88       JobControlCmd¹                string     -                job control command
89       JobReqBusy                    integer    180              requeue interval for BUSY dial result
90       JobReqDataConn                integer    300              requeue interval for data connection dial result
91       JobReqNoAnswer                integer    300              requeue interval for NO ANSWER dial result
92       JobReqNoCarrier               integer    300              requeue interval for NO CARRIER dial result
93       JobReqNoFCon                  integer    300              requeue interval for carrier without +FCON dial result
94       JobReqOther²                  integer    300              requeue interval for ``other'' problems
95       JobReqProto                   integer    60               requeue interval after fax protocol error
96       JobRetryBusy                  integer    -                number of retries for BUSY dial result
97       JobRetryDataConn              integer    -                number of retries for data connection dial result
98       JobRetryNoAnswer              integer    -                number of retries for NO ANSWER dial result
99       JobRetryNoCarrier             integer    1                number of retries for NO CARRIER dial result
100       JobRetryNoFCon                integer    -                number of retries for carrier without +FCON dial result
101       JobRetryOther                 integer    -                number of retries for ``other'' problems
102       LockDataCalls                 boolean    Yes              lock modem for the duration of an inbound data call
103       LockVoiceCalls                boolean    Yes              lock modem for the duration of an inbound voice call
104       LogCalls                      boolean    Yes              Log all incoming calls as CALL records in xferfaxlog
105       LogFacility²                  string     daemon           syslog facility name for ServerTracing messages
106       LogFileMode                   octal      0600             protection mode to use for session log files
107       LogRecv                       boolean    Yes              Log recieved faxes as RECV records in xferfaxlog
108       LogSend                       boolean    Yes              Log sent faxes as SEND records in xferfaxlog
109       LocalIdentifier               string     -                local station identification string
110       LongDistancePrefix            string     -                dialing prefix for long distance calls
111       MaxBatchJobs¹                 integer    64               max jobs in a batch
112       MaxConcurrentCalls¹           integer    1                max concurrent jobs to process for a destination
113       MaxConcurrentPreps¹           integer    1                maximum number of simultaneous job preparations
114       MaxConsecutiveBadLines        integer    5                max consecutive bad rows for OK page quality
115       MaxDials¹                     integer    12               max phone calls to make to transmit a job
116       MaxProxyJobs¹                 integer    64               max number of concurrent proxy jobs
117       MaxRecvPages                  integer    unlimited        max pages to permit in a receive
118       MaxSendPages¹                 integer    unlimited        max pages to permit in a send
119       MaxSetupAttempts              integer    2                max attempts to initialize a modem
120       MaxTraversal¹                 integer    256              max traversal into queue for batching
121       MaxTries¹                     integer    3                max attempts to transmit a job
122       MinAcceptedLineCount          integer    10               min number of rows for OK page quality
123       MissedPageHandlingMethod      string     RTN              missed page received handling method
124       ModemGroup¹                   string     -                define a name for a set of modems
125       ModemPriority                 integer    255              scheduling priority for outbound jobs
126       ModemReadyState               string     R                ``ready state'' sent by faxgetty
127       ModemRingResponse             string     -                command to respond after hearing RING
128       ModemRingsBeforeResponse      integer    0                the number of rings before ModemRingResponse
129       NoAnswerVoice                 boolean    false            disable the answering of voice-indicated calls
130       NoCarrierRetrys               integer    -                Deprecated - See JobRetryNoCarrier
131       NotifyCmd¹                    string     bin/notify       user notification program
132       PageChop¹                     string     last             control automatic truncation of trailing whitespace
133       PageChopThreshold¹            float      3.0              whitespace truncation threshold (inches)
134       PCL2FaxCmd¹                   string     bin/pcl2fax      PCL RIP command script
135       PercentGoodLines              integer    95               percentage of good rows for OK page quality
136       PollLockPokeModem             boolean    false            check on modem every time the lock is polled
137       PollLockWait²                 integer    30               polling interval for lockfile presence/removal (secs)
138       PollModemWait                 integer    30               polling interval when in ``modem wait'' state (secs)
139       PollRcvdCmd                   string     bin/pollrcvd     delivery program for facsimile received by polling
140       PostScriptTimeout¹            integer    300              timeout on POSTSCRIPT interpreter runs (secs)
141       PriorityScheduling            boolean    see below        use available priority job scheduling mechanism
142       PS2FaxCmd¹                    string     bin/ps2fax       POSTSCRIPT RIP command script
143       QualifyCID                    obsolete   -                See DynamicConfig and RejectCall for rejecting calls
144       QualifyPWD                    string     -                file of PWD patterns for qualifying senders
145       QualifyTSI                    string     -                file of TSI patterns for qualifying senders
146       RecvDataFormat                string     adaptive         format for received facsimile data
147       RecvFileMode                  octal      0600             protection mode to use for received facsimile files
148       RejectCall                    boolean    false            Reject the current call
149       RingData                      string     -                distinctive ring data call identifier
150       RingExtended                  string     -                extended ring message identifier
151       RingFax                       string     -                distinctive ring fax call identifier
152       RingsBeforeAnswer             integer    0                rings to wait before answering phone
153       RingTimeout                   integer    6000             timeout in ms after RING before reset
154       RingVoice                     string     -                distinctive ring voice call identifier
155       RTNHandlingMethod             string     Retransmit-IgnoreRTN signal handling method
156       SaveUnconfirmedPages          boolean    true             save or delete unconfirmed pages
157       SendFaxCmd¹                   string     bin/faxsend      fax transmit command script
158       SendPageCmd¹                  string     bin/pagesend     pager transmit command script
159       SendUUCPCmd¹                  string     bin/uucpsend     UUCP transmit command script
160       ServerTracing²                integer    1                non-session server tracing
161       SessionTracing²               integer    0xFFF            send and receive session tracing
162       ShareCallFailures²            string     none             which call failures should be shared
163       SpeakerVolume                 string     Quiet            volume level for modem speaker
164       StaggerCalls¹                 integer    0                time to delay between starting outbound calls
165       TagLineFont                   string     -                tag line font filename
166       TagLineFormat                 string     see below        tag line format string
167       TagLineLocale                 string     see below        tag line format locale
168       TIFF2FaxCmd²                  string     bin/tiff2fax     TIFF converter command script
169       TimeOfDay¹                    string     Any              default time-of-day restrictions
170       TSIRecvdCmd                   string     -                program executed after TSI receipt, can drop calls
171       Unblock¹                      string     -                force faxq to unblock specified destination
172       Use2D¹                        boolean    Yes              restrict/permit use of 2D-encoded fax data
173       UseJobTSI                     boolean    No               use job-specified TSI instead of LocalIdentifier
174       UseJobTagLine                 boolean    Yes              Allow use of job-specified Tagline instead of TagLineFormat
175       UUCPLockMode²                 octal      0600             protection mode for UUCP lock files
176       UUCPLockDir²                  string     see below        UUCP lockfile directory
177       UUCPLockTimeout²              integer    30               time before removing stale UUCP lockfile
178       UUCPLockType²                 string     see below        UUCP lockfile type
179       VGettyArgs                    string     -                arguments passed to voice getty program
180       WedgedCmd¹                    string     bin/wedged       program to run when modem is wedged
181       ModemAnswerCmd                string     ATA              command for answering phone
182       ModemAnswerAgainCmd           string     <delay:50>ATA    command for answer recovery
183       ModemAnswerDataBeginCmd       string     -                command for start of answered data call
184       ModemAnswerDataCmd            string     ATA              command for answering data call
185       ModemAnswerDialCmd            string     ATA              command for answering dialed call
186       ModemAnswerFaxBeginCmd        string     -                command for start of answered fax call
187       ModemAnswerFaxCmd             string     ATA              command for answering fax call
188       ModemAnswerResponseTimeout    integer    180000           answer command timeout (ms)
189       ModemAnswerVoiceBeginCmd      string     -                command for start of answered voice call
190       ModemAnswerVoiceCmd           string     ATA              command for answering voice call
191       ModemATCmdDelay               integer    0                delay before sending modem an AT cmd (ms)
192       ModemBaudRateDelay            integer    10               delay (ms) after setting baud rate
193       ModemCEDCmd                   string     ATA              command to signal CED and start V.21 HDLC transmit
194       ModemClassQueryCmd            string     AT+FCLASS=?      command for querying modem services
195       ModemCNGCmd                   string     ATD              command to signal CNG and listen for V.21 HDLC
196       ModemCommaPauseTimeCmd        string     ATS8=2           command for setting time to pause for ``,'' in dialing string
197       ModemDialCmd                  string     ATDT%s           command for dialing (%s for number to dial)
198       ModemDialResponseTimeout      integer    180000           dialing command timeout (ms)
199       ModemDoPhaseCDebug            boolean    No               query modem responses during Phase C transmit
200       ModemDTRDropDelay             integer    75               delay (ms) between DTR OFF and DTR ON
201       ModemEchoOffCmd               string     ATE0             command for disabling command echo
202       ModemFlowControl              string     XONXOFF          DTE-DCE flow control scheme
203       ModemFrameFillOrder           string     LSB2MSB          bit order for HDLC frames
204       ModemHardFlowCmd              string     -                command for setting hardware flow control between DTE and DCE
205       ModemMinSpeed                 string     2400             minimum acceptable transmit speed
206       ModemMfrQueryCmd              string     -                command for querying modem manufacturer
207       ModemModelQueryCmd            string     -                command for querying modem model
208       ModemNoAutoAnswerCmd          string     ATS0=0           command for disabling auto-answer
209       ModemNoAutoAnswerCmdDelay     integer    0                time, in ms, to pause after a disabling auto-answer
210       ModemNoFlowCmd                string     -                command for disabling hardware flow control between DTE and DCE
211       ModemOnHookCmd                string     ATH0             command for placing phone ``on hook''
212       ModemPageDoneTimeout          integer    180000           page send/receive timeout (ms)
213       ModemPageStartTimeout         integer    180000           page send/receive timeout (ms)
214       ModemRaiseATCommands          boolean    Yes              raise AT commands in configuration to upper-case
215       ModemRate                     integer    19200            baud rate to use for DCE-DTE communication
216       ModemReadyCmds                string     -                additional final commands when resetting modem
217       ModemRecvFillOrder            string     see below        bit order for received facsimile data
218       ModemRecvSuccessCmd           string     -                command to send after a successful reception
219       ModemResetCmds                string     -                additional commands when resetting modem
220       ModemResetDelay               integer    2600             delay (ms) after placing DTR ON
221       ModemResultCodesCmd           string     ATQ0             command for enabling result codes
222       ModemRevQueryCmd              string     see below        command for querying modem firmware revision
223       ModemSendBeginCmd             string     -                command to send on establishing carrier
224       ModemSendFillOrder            string     LSB2MSB          bit order for sending facsimile data
225       ModemSetOriginCmd             string     -                command to set call origin information
226       ModemSetVolumeCmd             string     see below        commands for setting modem speaker volume level
227       ModemSetupAACmd               string     -                command for setting up adaptive answer
228       ModemSetupDCDCmd              string     -                command for setting up DCD handling
229       ModemSetupDTRCmd              string     -                command for setting up DTR handling
230       ModemSoftFlowCmd              string     -                command for setting software flow control between DTE and DCE
231       ModemSoftResetCmd             string     ATZ              command for doing a soft reset
232       ModemSoftResetCmdDelay        integer    3000             time, in ms, to pause after a soft reset
233       ModemSoftRTFCC                boolean    Yes              enable software-driven real-time fax compression conversion
234       ModemType                     string     see below        modem type
235       ModemVerboseResultsCmd        string     ATV1             command for enabling verbose result codes
236       ModemWaitForConnect           boolean    No               force server to wait for ``CONNECT'' response on answer
237       ModemWaitTimeCmd              string     ATS7=60          command for setting time to wait for carrier when dialing
238       FaxT1Timer                    integer    35000            CCITT T.30 T1 timer (ms)
239       FaxT2Timer                    integer    7000             CCITT T.30 T2 timer (ms)
240       FaxT4Timer                    integer    3100             CCITT T.30 T4 timer (ms)
241       Class0Cmd                     string     AT+FCLASS=0      Class 0: command to enter class 0
242       Class1Cmd                     string     AT+FCLASS=1      Class 1: command to enter class 1
243       Class1Cmd                     string     AT+FCLASS=1.0    Class 1.0: command to enter class 1
244       Class1AdaptRecvCmd            string     -                Class 1/1.0: command for adaptive reception support
245       Class1ColorJPEGSupport        boolean    No               Class 1/1.0: to enable color JPEG fax support
246       Class1EnableV34Cmd            string     -                Class 1/1.0: command to enable V.34-fax support
247       Class1ECMCheckFrameLength     boolean    No               Class 1/1.0: require complete ECM frame lengths
248       Class1ECMSupport              boolean    Yes              Class 1/1.0: enable T.30-A ECM support
249       Class1PersistentECM           boolean    Yes              Class 1/1.0: to continue to correct while in ECM
250       Class1ECMFrameSize            integer    256              Class 1/1.0: image frame size in ECM protocol
251       Class1ExtendedRes             boolean    -                Class 1/1.0: enable extended resolution support
252       Class1HasRHConnectBug         boolean    No               Class 1/1.0: modem can report CONNECT incorrectly
253       Class1HFLOCmd                 string     -                Class 1/1.0: command to set hardware flow control
254       Class1FrameOverhead           integer    4                Class 1/1.0: extra bytes in a received HDLC frame
255       Class1GreyJPEGSupport         boolean    No               Class 1/1.0: to enable grey JPEG fax support
256       Class1HookSensitivity         integer    0                Class 1/1.0: times to ignore on-hook detection
257       Class1JBIGSupport             string     see below        Class 1/1.0: to enable monochrome JBIG fax support
258       Class1MRSupport               boolean    Yes              Class 1/1.0: enable 2-D MR support
259       Class1MMRSupport              boolean    Yes              Class 1/1.0: enable 2-D MMR support
260       Class1NFLOCmd                 string     -                Class 1/1.0: command to set no flow control
261       Class1PageLengthSupport       integer    7                Class 1/1.0: coded value for modem page length support
262       Class1PageWidthSupport        integer    7                Class 1/1.0: coded value for modem page width support
263       Class1RecvAbortOK             integer    200              Class 1/1.0: max wait (ms) for ``OK'' after recv abort
264       Class1RecvIdentTimer          integer    40000            Class 1/1.0: max wait (ms) for initial ident frame
265       Class1RestrictPoorDestinations¹          integer          0Class 1/1.0: restrict features for destinations with poor quality
266       Class1RestrictPoorSenders     integer    0                Class 1/1.0: restrict features for senders with poor quality
267       Class1RMPersistence           integer    2                Class 1/1.0: times to attempt high-speed carrier recv
268       Class1SFLOCmd                 string     -                Class 1/1.0: command to set software flow control
269       Class1PPMWaitCmd              string     AT+FTS=7         Class 1/1.0: command to stop and wait before PPM
270       Class1ResponseWaitCmd         string     -                Class 1/1.0: command to wait before TCF response
271       Class1Resolutions             integer    0x7F             Class 1/1.0: bitmap of supported resolutions
272       Class1RMQueryCmd              string     AT+FRM=?         Class 1/1.0: command to query modem data reception rates
273       Class1TCFWaitCmd              string     AT+FTS=7         Class 1/1.0: command to stop and wait before TCF
274       Class1TMQueryCmd              string     AT+FTM=?         Class 1/1.0: command to query modem data transmission rates
275       Class1EOPWaitCmd              string     AT+FTS=9         Class 1/1.0: command to stop and wait before EOP
276       Class1ModemHasDLEBug          boolean    No               Class 1/1.0: modem fails to double DLE in V.21
277       Class1MsgRecvHackCmd          string     ""               Class 1/1.0: command to avoid +FCERROR before image data
278       Class1SSLFaxCert              string     etc/ssl.pem      Class 1/1.0: PEM certificate file for SSL Fax
279       Class1SSLFaxClientTimeout     integer    5000             Class 1/1.0: timeout waiting for client connection
280       Class1SSLFaxInfo              string     -                Class 1/1.0: hostname and port number for SSL Fax
281       Class1SSLFaxSupport           boolean    Yes              Class 1/1.0: support for SSL Fax
282       Class1SSLFaxServerTimeout     integer    2000             Class 1/1.0: timeout waiting for server connection
283       Class1TCFRecvHackCmd          string     ""               Class 1/1.0: command to avoid +FCERROR before TCF
284       Class1TCFMaxNonZero           integer    10               Class 1/1.0: max% of non-zero data in good TCF
285       Class1TCFMinRun               integer    1000             Class 1/1.0: minimum zero run in good TCF
286       Class1TCFMinRunECMMod         integer    2                Class 1/1.0: modify minimum zero run in ECM by this factor
287       Class1TCFRecvTimeout          integer    4500             Class 1/1.0: max wait (ms) for TCF
288       Class1TMConnectDelay          integer    0                Class 1/1.0: delay between +FTM CONNECT and data transmission
289       Class1SwitchingCmd            string     AT+FRS=7         Class 1/1.0: command to ensure silence after HDLC reception
290       Class1ValidateV21Frames       boolean    No               Class 1/1.0: check FCS against received frames
291       Class2Cmd                     string     AT+FCLASS=2      Class 2: command to enter class 2/2.0
292       Class2AbortCmd                string     AT+FK            Class 2: command to abort active session
293       Class2APCmd                   string     AT+FAP           Class 2: enable support for sending and receiving SUB, SEP, and PWD frames
294       Class2APQueryCmd              string     AT+FAP=?         Class 2: query capabilities for sending and receiving SUB, SEP, and PWD frames
295       Class2BORCmd                  string     AT+FBOR=0        Class 2: command to setup bit order
296       Class2BUGCmd                  string     AT+FBUG=1        Class 2: command to enable HDLC frame tracing
297       Class2CIGCmd                  string     AT+FCIG          Class 2: command to set polling identifier
298       Class2CRCmd                   string     AT+FCR=1         Class 2: command to enable receive capability
299       Class2CQCmd                   string     -                Class 2: command to setup copy quality parameters
300       Class2CQQueryCmd              string     AT+FCQ=?         Class 2: command to query modem copy quality capabilities
301       Class2DCCCmd                  string     AT+FDCC          Class 2: command to set modem capabilities
302       Class2DCCQueryCmd             string     AT+FDCC=?        Class 2: command to query modem capabilities
303       Class2DisableV17Cmd           string -   Class 2: command to disable V.17 support
304       Class2DISCmd                  string     AT+FDIS          Class 2: command to set session parameters
305       Class2DDISCmd                 string     -                Class 2: command to set session parameters before dialing
306       Class2ECMType                 string     ``2''            Class 2: ECM specification type to follow
307       Class2HexNSF                  boolean    Yes              Class 2: parse NSF strings as hex values
308       Class2HFLOCmd                 string     -                Class 2: command to set hardware flow control
309       Class2LIDCmd                  string     AT+FLID          Class 2: command to set local identifier string
310       Class2MINSPCmd                string     AT+FMINSP        Class 2: command to set minimum transmit speed
311       Class2NFLOCmd                 string     -                Class 2: command to set no flow control
312       Class2PACmd                   string     AT+FPA           Class 2: set polling address string
313       Class2PHCTOCmd                string     AT+FPHCTO=30     Class 2: command to set Phase C timeout parameter
314       Class2PTSCmd                  string     AT+FPTS          Class 2: command to set received page status
315       Class2PWCmd                   string     AT+FPW           Class 2: set password string
316       Class2RecvDataTrigger         string     ``\21''          Class 2: character to send to trigger recv
317       Class2RELCmd                  string     -                Class 2: command to enable byte-aligned EOL codes
318       Class2SACmd                   string     AT+FSA           Class 2: set destination subaddress string
319       Class2SendRTC                 boolean    No               Class 2: append RTC to page data on transmit
320       Class2SFLOCmd                 string     -                Class 2: command to set software flow control
321       Class2SPLCmd                  string     AT+FSPL          Class 2: command to set polling request
322       Class2TBCCmd                  string     AT+FTBC=0        Class 2: command to enable stream mode
323       Class2UseLineCount            boolean    No               Class 2: use the line count from the firmware decoder
324       Class2UseHex                  boolean    No               Class 2: parse capabilities strings as hex values
325       Class2XmitWaitForXON          boolean    Yes              Class 2: wait for XON before sending facsimile data
326       Class2Cmd                     string     AT+FCLASS=2.0    Class 2.0: command to enter class 2/2.0
327       Class2AbortCmd                string     AT+FKS           Class 2.0: command to abort active session
328       Class2APCmd                   string     AT+FAP           Class 2.0: enable support for sending and receiving SUB, SEP, and PWD frames
329       Class2APQueryCmd              string     AT+FAP=?         Class 2.0: query capabilities for sending and receiving SUB, SEP, and PWD frames
330       Class2BORCmd                  string     AT+FBO=0         Class 2.0: command to setup bit order
331       Class2BUGCmd                  string     AT+FBU=1         Class 2.0: command to enable HDLC frame tracing
332       Class2CIGCmd                  string     AT+FPI           Class 2.0: command to set polling identifier
333       Class2CRCmd                   string     AT+FCR=1         Class 2.0: command to enable receive capability
334       Class2CQCmd                   string     -                Class 2.0: command to setup copy quality parameters
335       Class2CQQueryCmd              string     AT+FCQ=?         Class 2.0: command to query modem copy quality capabilities
336       Class2DCCCmd                  string     AT+FCC           Class 2.0: command to set modem capabilities
337       Class2DCCQueryCmd             string     AT+FCC=?         Class 2.0: command to query modem capabilities
338       Class2DisableV17Cmd           string -   Class 2.0: command to disable V.17 support
339       Class2DisableV34Cmd           string -   Class 2.0: command to disable V.34 support
340       Class2DISCmd                  string     AT+FIS           Class 2.0: command to set session parameters
341       Class2ECMType                 string     ``2.0''          Class 2.0: ECM specification type to follow
342       Class2HexNSF                  boolean    Yes              Class 2.0: parse NSF strings as hex values
343       Class2HFLOCmd                 string     AT+FLO=2         Class 2.0: command to set hardware flow control
344       Class2JBIGSupport             string     see below        Class 2.0: to enable monochrome JBIG fax support
345       Class2JPEGSupport             boolean    No               Class 2.0: use modem JPEG support
346       Class2LIDCmd                  string     AT+FLI           Class 2.0: command to set local identifier string
347       Class2MINSPCmd                string     AT+FMS           Class 2.0: command to set minimum transmit speed
348       Class2NFLOCmd                 string     AT+FLO=0         Class 2.0: command to set no flow control
349       Class2NRCmd                   string     AT+FNR=1,1,1,1   Class 2.0: command to set negotiation message reporting
350       Class2PACmd     string        AT+FPA     Class 2.0: set polling address string
351       Class2PHCTOCmd                string     AT+FCT=30        Class 2.0: command to set Phase C timeout parameter
352       Class2PIECmd                  string     AT+FIE=0         Class 2.0: command to set procedure interrupt handling
353       Class2PWCmd     string        AT+FPW     Class 2.0: set password string
354       Class2PTSCmd                  string     AT+FPS           Class 2.0: command to set received page status
355       Class2PTSQueryCmd             string     AT+FPS?          Class 2.0: command to query received page status
356       Class2RecvDataTrigger         string     ``\22''          Class 2.0: character to send to trigger recv
357       Class2RELCmd                  string     -                Class 2.0: command to enable byte-aligned EOL codes
358       Class2RTFCC                   boolean    No               Class 2.0: enable real-time fax compression conversion
359       Class2SACmd     string        AT+FSA     Class 2.0: set destination subaddress string
360       Class2SendRTC                 boolean    No               Class 2.0: append RTC to page data on transmit
361       Class2SFLOCmd                 string     AT+FLO=1         Class 2.0: command to set software flow control
362       Class2SPLCmd                  string     AT+FSP           Class 2.0: command to set polling request
363       Class2TBCCmd                  string     AT+FPP=0         Class 2.0: command to enable stream mode
364       Class2UseLineCount            boolean    No               Class 2.0: use the line count from the firmware decoder
365       Class2UseHex                  boolean    No               Class 2.0: parse capabilities strings as hex values
366       PagerSetupCmds                string     -                commands for setting up modem for a pager call
367       PagerMaxMsgLength             integer    128              max length of a text message
368       IXOService                    string     ``PG''           IXO: service identification string
369       IXODeviceID                   string     ``1''            IXO: device identification string
370       IXOMaxUnknown                 integer    3                IXO and UCP: max unknown responses before abort
371       IXOIDProbe                    integer    2                IXO: time between sending \r during ID sequence (secs)
372       IXOIDTimeout                  integer    20               IXO: max time to wait for ID= response (secs)
373       IXOLoginRetries               integer    3                IXO: max attempts to login
374       IXOLoginTimeout               integer    15               IXO: max time to complete login (secs)
375       IXOGATimeout                  integer    30               IXO: max time to wait for Go-Ahead response (secs)
376       IXOXmitRetries                integer    3                IXO and UCP: max retries to send text msg block
377       IXOXmitTimeout                integer    15               IXO and UCP: max time to transmit text msg block
378       IXOAckTimeout                 integer    30               IXO: max time to wait for msg block ack (secs)
379

SERVER-ORIENTED CONFIGURATION PARAMETERS

381       These configuration parameters affect the general operation of the  fax
382       server.
383
384       AdaptiveAnswer
385              Control  whether  or  not an adaptive answering strategy is used
386              whereby an incoming call is answered in multiple ways  according
387              to  the list specified in the AnswerRotary parameter.  For exam‐
388              ple, if adaptive answering is enabled and AnswerRotary specifies
389              ``fax  data'',  then  an incoming call will first be answered as
390              fax using ModemAnswerFaxCmd and then, if  that  fails,  as  data
391              using  ModemAnswerDataCmd.   If  the adaptive answer strategy is
392              not enabled, then calls are answered using the appropriate Mode‐
393              mAnswer*Cmd  parameter  (normally  ModemAnswerCmd for unattended
394              operation).  Note that the adaptive answer strategy  depends  on
395              many factors that limit its usefulness.  When calls are answered
396              first as fax, it typically only  works  with  a  Class  1  modem
397              because  it is important that the sequence of operations related
398              to answering as fax be completed in a short enough time  that  a
399              subsequent  answer  for data be done before the caller times out
400              and hangs up the telephone (for this reason Class1RecvIdentTimer
401              should  be  set  to  a  value  that is shorter than FaxT1Timer.)
402              Also, note that it is sometimes necessary to  arrange  that  the
403              phone  be  placed  on-hook  between successive answers; this can
404              typically be done by inserting the appropriate  command  at  the
405              start of the second and subsequent ModemAnswer*Cmds.
406
407       AdminGroup
408              Tells  PAM  what  user  group  is  allowed to administer the fax
409              server.  Only useful if the server is compiled with PAM enabled.
410
411       AllowIgnoreModemBusy¹
412              Whether or not to honor job requests to ignore modem busy status
413              when allocating jobs to a modem.  The intended use for this fea‐
414              ture is to allow configurations whereby a DynamicConfig  program
415              can  send a fax to an incoming caller (contrary to T.30 protocol
416              for sending or polling).
417
418       AnswerRotary
419              The sequence of answering techniques the server should  ``rotate
420              through'' when answer incoming calls.  Answering techniques are:
421              Name    Description
422              fax     answer a fax call
423              data    answer a data call
424              voice   answer a voice call
425              extern  use the vgetty application to answer a call
426              any     answer a call of any/unknown type
427              When  a  call  is not answered successfully, the server advances
428              the rotary to the next specified answering technique.  If  Adap‐
429              tiveAnswer  is  enabled,  the  server will try all the answering
430              techniques for each incoming call.   Otherwise,  the  rotary  is
431              advanced  between  unsuccessful  phone  calls.   For example, if
432              AdaptiveAnswer is disabled and  AnswerRotary  is  ``fax  data'',
433              then the calls will initially be answered as fax until the first
434              call is received that does not appear to be from a fax  machine;
435              after  that  calls  will be answered as if they were from a data
436              modem until the next unsuccessful call; after  which  they  will
437              one  again  be answered as fax.  Only the first three techniques
438              listed are used; any additional  ones  are  (silently)  ignored.
439              See also AnswerBias.
440
441       AnswerBias
442              The  index  into  the  AnswerRotary  list that the server should
443              rotate the list to after each successful  incoming  phone  call.
444              List  indices  are  numbered  starting at zero.  For example, if
445              AnswerRotary is ``fax data'' and AnswerBias  is  1,  then  after
446              each  successful inbound call, the next call will be answered as
447              data.
448
449       AreaCode²
450              The local area code in which the facsimile modem resides.   This
451              value  is  passed  to  the  dial string rules that are used, for
452              example, to formulate canonical phone numbers for  dialing  (see
453              DialStringRules below.)
454
455       AuditHook¹
456              Specifies  a program command and an interest specification indi‐
457              cating which events as described in faxwatch(8C) should  trigger
458              the execution of the program.  For example, this configuration:
459
460                  AuditHook: "bin/hook: J*S*M*R*"
461
462              would cause bin/hook to be executed upon every event.  The argu‐
463              ments passed to  the  hook  program  are  respectively  <class>,
464              <mask>, <id>, and optionally [info] where...
465
466                  <class> = JOB | SEND | MODEM | RECV
467                  <mask>  = the specific event
468                  <id>    = id of the job/modem with which the event is associated
469                  [info]  = additional information
470
471
472       BadPageHandlingMethod
473              (Class 1/1.0 only) Specifies how to react to a bad page received
474              from the remote sender:  one  of  ``RTN'',  ``DCN'',  or  ``RTN-
475              SAVE''.
476
477              If  a page is received in non-ECM mode with unacceptable quality
478              according to PercentGoodLines or MaxConseutiveBadLines  then  it
479              can  be  somewhat difficult to inform the sender of the problem.
480              Historically, HylaFAX has assumed that  signalling  RTN  to  the
481              sender  will  accomplish  this.  However, some senders are inca‐
482              pable of retransmitting pages, and to reduce burden  they  treat
483              an  RTN signal as a receipt confirmation and proceed to the next
484              page without notifying the sending user of the potential problem
485              in  readability on the receive-end.  (The assumption there being
486              that the receiving user will notify the sending  user  if  there
487              actually is a readability problem.)
488
489              A  setting  of ``RTN'' is the historic behavior and assumes that
490              an RTN signal will be enough to get the sender to retransmit  or
491              be  otherwise informed of a potential readability problem on the
492              receive-end.  The previously-received page data is marked to  be
493              overwritten by the next page data received from the sender.
494
495              A  setting  of ``DCN'' tells HylaFAX to transmit a DCN signal in
496              response to the post-page message  and  should  trigger  a  call
497              abortion  by the sender.  This should clearly indicate a problem
498              in page readability to the sender, although the receipt  of  any
499              following pages in a later call cannot be guaranteed.
500
501              A setting of ``RTN-SAVE'' more closely approximates the behavior
502              of other fax receivers (especially  fax  machines).   It  causes
503              HylaFAX  to  send  the  RTN  signal  but it saves the previously
504              received page data and places the next transmitted page data  in
505              another page.  This is the default setting.  However, this could
506              result in multiple copies of the same page image being saved  in
507              the  same  file - if the sender does indeed retransmit the unac‐
508              ceptable pages during the same call.
509
510       BatchLogs¹
511              When sending or receiving multiple documents (denoted  by  EOM),
512              this  value determines if the session logs span the entire batch
513              or, if set to no, only contain a single document.
514
515       CallIDPattern
516              A string that identifies the caller's identity in any call iden‐
517              tification  messages provided by the modem (such as Caller*ID or
518              DNIS/DID).  The specified string is compared against any  unrec‐
519              ognized  status messages received from the modem before ModemAn‐
520              swerCmd is sent to the modem.  If there is  a  match,  then  the
521              remainder  of  the message is returned as CallIDn where n corre‐
522              sponds to the n'th instance that this CallIDPattern is from  the
523              top in the modem configuration file.  For example, for the ZyXEL
524              U-1496 this parameter would be set to
525              CallIDPattern: ``CALLER NAME: '' (note the trailing space).
526              If more than one message matches  between  instances  of  "RING"
527              messages, then the message remainders are concatenated.
528
529              The  special CallID value of "SHIELDED_DTMF" is used in conjunc‐
530              tion with ModemRingResponse and CallIDAnswerLength.  After  exe‐
531              cuting ModemRingResponse, HylaFAX will expect DTMF data (usually
532              DLE-shielded) for CallIDn until CallIDAnswerLength  is  reached.
533              Note  that if the modem is in voice mode to hear these DTMF dig‐
534              its, then it must be returned to fax mode in the ModemAnswerCmd.
535              In order to prevent this feature from losing incoming fax calls,
536              if fax sender CNG is detected while waiting for DTMF or  if  ten
537              seconds  elapse  without  sufficient  DTMF  then  the  remaining
538              expected digits will be populated by whitespace, triggering  fax
539              answering.
540
541              For  example, the following settings will cause HylaFAX to enter
542              voice mode and go off-hook when a RING  is  detected.   It  will
543              then  expect four DTMF digits (presumably for routing), and then
544              it will pause for 100  ms  before  returning  to  fax  mode  and
545              answering the call.
546
547                ModemRingResponse:     AT+FCLASS=8;H1
548                CallIDPattern:         SHIELDED_DTMF
549                CallIDAnswerLength:    4
550                ModemAnswerCmd:        <delay:100>AT+FCLASS=1;A
551
552              For  modems  that  do  not support AT+FCLASS=8 (such as some USR
553              modems) this may be an appropriate equivalent:
554
555                ModemRingResponse:      "AT#CLS=8\nAT#VLS=4\nATA"
556                CallIDPattern:          SHIELDED_DTMF
557                CallIDAnswerLength:     4
558                ModemAnswerCmd:         "<delay:100>AT+FCLASS=1\nATA"
559
560              Multiple entries of CallIDPattern are used together in one modem
561              configuration   file   in   order  to  capture  multiple  CallID
562              responses.  For example, the following  settings  would  capture
563              "NDID"  responses  from  the  modem as CallID1, "NMBR" responses
564              from the modem as CallID2, "NAME" responses as CallID3,  and  it
565              would  trigger  ModemAnswerCmd  whenever CallID1 or CallID2 were
566              longer than 7 or 10 characters, respectively.
567
568                CallIDPattern:         "NDID="
569                CallIDAnswerLength:    7
570                CallIDPattern:         "NMBR="
571                CallIDAnswerLength:    10
572                CallIDPattern:         "NAME="
573
574              Note that this example is only given as an example, and probably
575              would  cause  unexpected results.  Because pattern-matching ends
576              when ModemAnswerCmd is sent to the modem, if "NDID", "NMBR", and
577              "NAME"  responses  came  from  the  modem in that order, and the
578              "NDID" response was at least 7 characters  long,  then  ModemAn‐
579              swerCmd  would  be  sent  to the modem immediately following the
580              "NDID" response, and the "NMBR" and "NAME"  responses  would  be
581              ignored.   Generally  only one CallIDAnswerLength item should be
582              in a modem configuration file.
583
584              Call identification data is usually only sent once by the  telco
585              or  PBX,  and the timing of its arrival varies upon the telco or
586              PBX and the type of line.  If HylaFAX is  configured  to  answer
587              via RingsBeforeAnswer prior to the arrival of the data, then all
588              CallID values will be null.  For example, on  US  analog  lines,
589              caller-ID  data  is usually sent between RINGs 1 and 2.  In this
590              situation, RingsBeforeAnswer should be set to ``2'' or greater.
591
592       CallIDAnswerLength
593              An integer indicating the minimum number of characters in a Cal‐
594              lID  matching  the  previous  CallIDPattern  to be received when
595              ModemAnswerCmd is sent to the modem irrespective of any RingsBe‐
596              foreAnswer  value  greater than zero.  This allows the answering
597              of calls which deliver CID/DID data but not RINGs.  For example,
598              CallIDAnswerLength: ``7''
599              would cause the call to  be  answered  when  CallID2  reached  a
600              length  of seven digits.  A value of zero for CallIDAnswerLength
601              disables this feature.
602
603       CallIDDisplay
604              Whether or not to display the CallIDPattern match in  the  modem
605              status line.
606
607       CallIDLabel
608              The label to use in the presentation of any CallIDPattern match.
609              (For example, when CallIDDisplay  or  CallIDRecord  indicate  to
610              diplay or record the match.)
611
612       CallIDRecord
613              Whether or not to record the CallIDPattern match in the received
614              image file.
615
616       CallIDType
617              Identifies the type of indicator in the associated CallIDPattern
618              match.  The special type ``calling-number'' enables the faxgetty
619              process to utilize an associated entry in the info database  for
620              items  such as senderDataSent, senderDataMissed, senderConfuses‐
621              RTN, senderConfusesPIN,  senderFumblesECM,  senderHasV17Trouble,
622              and senderSkipsV29.  See hylafax-info(5F).
623
624       ClocalAsRoot
625              Control  whether operations that set the CLOCAL bit on the modem
626              device special file are done with the effective user-ID  set  to
627              the  super-user or the ``fax'' user.  By default such operations
628              are done as the fax user, except under IRIX where they are  done
629              as the super-user (because IRIX disallows manipulation of CLOCAL
630              by anyone but the super-user).
631
632       ContCoverCmd¹
633              The program to invoke to generate a continuation cover page; see
634              ContCoverPage and mkcover(8C).
635
636       ContCoverPage¹
637              A template file to use in creating continuation cover pages.  If
638              this parameter is non-null, then the server will pass the  file‐
639              name  to the command specified by ContCoverCmd to generate cover
640              pages for  outbound  jobs  that  are  continued  after  protocol
641              errors.   These  cover  pages identify the receiver and indicate
642              that the document is a continued transmission.  If this  parame‐
643              ter is not specified or is null, then the server will not gener‐
644              ate continuation cover pages.  The specified  pathname  must  be
645              relative to the top of the fax server's spooling area.
646
647       CountryCode²
648              The local country code in which the facsimile modem resides.  As
649              for AreaCode, this value is passed to the dial string rules  for
650              use  in  formulating  canonical phone numbers for dialing (among
651              other things.)
652
653       DeviceMode
654              The file protection mode that the  server  should  set  for  the
655              modem device file.  Note that this value is given in octal.  The
656              default value of 0600 implies that only the facsimile user (usu‐
657              ally uucp) can access the modem.  See also chmod(2).
658
659       DialStringRules²
660              The  pathname  of  the  file that holds the rules for processing
661              user-specified dial strings; c.f.  dialrules(5F).  The specified
662              pathname  must be relative to the top of the fax server's spool‐
663              ing area; e.g.  etc/dialrules.
664
665       DistinctiveRings
666              Modern distinctive ring support on  most  modems  indicates  the
667              ring   cadence   rather  than  the  older  style  of  ``RING1'',
668              ``RING2'', etc.  To  indicate  the  ring  cadence,  DRingOn  and
669              DRingOff  values  are  presented  by  the  modem to the faxgetty
670              process.   The  modem  indicates  the  entire  cadence   between
671              ``RING'' indications Like this:
672
673                RING
674                DROF=40
675                DRON=8
676                DROF=4
677                DRON=8
678                RING
679
680              The  corresponding  DistinctiveRings  parameter  for  this  ring
681              cadence would be:
682
683                DistinctiveRings:  F-8-4-8
684
685              where ``F'' tells the faxgetty process that the ring cadence  is
686              for  a  facsimile  (``V'' for voice and ``D'' for data), and the
687              other values describe the ring cadence with leading  and  ending
688              DRingOff  values  ignored.  Multiple ring cadences are indicated
689              by delimiting them with commas in this fashion:
690
691                DistinctiveRings:  V-20,F-8-4-8,D-4-2-4-8
692
693
694       DRingOff
695              A string that identifies the ``off'' value  in  any  distinctive
696              ring  cadence, for example ``DROF=''.  See also DRingOn and Dis‐
697              tinctiveRings.
698
699       DRingOn
700              A string that identifies the ``on''  value  in  any  distinctive
701              ring cadence, for example ``DRON=''.  See also DRingOff and Dis‐
702              tinctiveRings.
703
704       DynamicConfig
705              The pathname of the optional program, e.g. ``etc/localid'', that
706              makes  dynamic  configuration changes, i.e., to LocalIdentifier,
707              based on device ID and  call  identification.   The  program  is
708              passed those values as the parameters ($1 = device id, $2 = Cal‐
709              lID1, $3 = CallID2, $4 = CallID3, ...), when answering an incom‐
710              ing  call.   The  program  can  then perform local processing as
711              desired to send on standard output the  configuration  items  to
712              change in a ``parameter:value'' format, i.e.  ``LocalIdentifier:
713              +1.800.555.1212''.  If  there  are  multiple  parameters  to  be
714              changed,  then  each item must be on its own line.  This is com‐
715              monly used to dynamically alter the local identification of sys‐
716              tems  which  use DID/DNIS, but it can also be used to allow dif‐
717              ferent modem configurations for different senders.  This program
718              can also set the RejectCall options to cause the current call to
719              be rejected instead of answered.  Note that this  file  must  be
720              marked as executable by the faxgetty process.
721
722       EGettyArgs
723              A  string that indicates whether or not the server should use an
724              an external getty application (egetty)  to  perhaps  deduce  and
725              possibly  handle  an  incoming call.  If the string value is not
726              null, then it is interpreted as a set of arguments  to  pass  to
727              egetty.   Before  supplying  the  arguments, the string is first
728              scanned for ``%''-escape sequences: any appearance of ``%l''  is
729              replaced  with  the  tty  name  and  any appearance of ``%s'' is
730              replaced with the serial port speed (in decimal).   Any  appear‐
731              ance  of escaped numbers 1 through 9 (``%1'' through ``%9'') are
732              replaced by the match to  the  corresponding  CallIDPattern,  if
733              present.   The ``%'' character can be specified with ``%%''.  If
734              the EGettyArgs parameter is not specified in  the  configuration
735              file or if the string value is null, then ``extern'' connections
736              will be rejected.  Note that in addition to the  specified  com‐
737              mand  line arguments, egetty is invoked with its standard input,
738              output, and error descriptors directed to  the  controlling  tty
739              device.
740
741              When  egetty  completes,  its  exit  status  is evaluated and is
742              interpreted to indicate what, if anything, should be  done  with
743              the  call.   An  exit  status of ``0'' indicates an unknown call
744              type and that the call should be handled as if  egetty  had  not
745              been  used.  An exit status of ``1'' indicates a data connection
746              and that the getty(8C) program should be used to handle the call
747              if configured (see GettyArgs), otherwise it will assume that the
748              call has been answered and that a data connection is established
749              and  that  it  should proceed by issuing ModemAnswerDataBeginCmd
750              (if configured) to the modem.  An exit status of ``2'' indicates
751              a  fax  connection  is established and that it should proceed by
752              issuing ModemAnswerFaxBeginCmd (if configured) to the modem.  An
753              exit  status of ``3'' indicates a voice call and that the vgetty
754              program should be used to handle the  call  if  configured  (see
755              VGettyArgs),  otherwise  it  will  assume that the call has been
756              answered and that a voice connection is established and that  it
757              should  proceed  by issuing ModemAnswerVoiceBeginCmd (if config‐
758              ured) to the modem.  An exit status of ``4'' is considered to be
759              an  error  condition.   The session will be terminated.  An exit
760              status of ``5'' is used to indicate that egetty handled the call
761              entirely,  is not an error condition, and that the session is to
762              be considered terminated.  Exit status values of ``11'', ``12'',
763              and  ``13'' correspond to values ``1'', ``2'', and ``3'' respec‐
764              tively except that values ``11'', ``12'',  and  ``13''  indicate
765              that  the  call  has  not been answered yet with a data, fax, or
766              voice connection.  So if GettyArgs is not configured then  Mode‐
767              mAnswerDataCmd  is  first issued to the modem for an exit status
768              of ``11'', ModemAnswerFaxCmd is first issued to the modem for an
769              exit  status of ``12'', and if VGettyArgs is not configured then
770              ModemAnswerVoiceCmd is first issued to the  modem  for  an  exit
771              status of ``13''.
772
773       FAXNumber
774              The  phone  number  associated  with  the facsimile modem.  This
775              string is used to generate the Transmitter Subscriber  Identifi‐
776              cation (TSI) and Caller Subscriber Identification (CSI) informa‐
777              tion passed to remote machines—unless the LocalIdentifier param‐
778              eter  is explicitly set.  The FAXNumber is also used to name the
779              session log file where information for incoming phone  calls  is
780              recorded;  see  hylafax-log(5F).   If this phone number is not a
781              fully qualified number the values of  AreaCode  and  CountryCode
782              are used to generate the transmitted CSI and TSI.
783
784       Include²
785              Include  the  specified  config  file as if it were part of this
786              config file.
787
788       InternationalPrefix²
789              The string to use to place an international phone call.  In  the
790              United  States,  this  is ``011''.  This string is passed to the
791              dial string rules.
792
793       JobControlCmd¹
794              The command to invoke to which provides Job Control  information
795              for a job. See jobcontrol(8C).
796
797       JobReqBusy
798              The delay in seconds to wait before retrying a job whose dialing
799              attempt failed with a ``BUSY'' status result.
800
801       JobReqDataConn
802              The delay in seconds to wait before  retrying  a  facsimile  job
803              whose  dialing  attempt failed because a data modem answered the
804              phone.
805
806       JobReqNoAnswer
807              The delay in seconds to wait before retrying a job whose dialing
808              attempt failed with a ``NO ANSWER'' status result.
809
810       JobReqNoCarrier
811              The delay in seconds to wait before retrying a job whose dialing
812              attempt failed with a ``NO CARRIER'' status result.
813
814       JobReqNoFCon
815              The delay in seconds to wait before  retrying  a  facsimile  job
816              whose  dialing attempt failed because the initial facsimile pro‐
817              tocol handshake failed (i.e. no ``+FCON:'' result  was  received
818              from a Class 2/2.0 modem).
819
820       JobReqOther²
821              The  delay  in seconds to wait before retrying a job that failed
822              for a reason not already covered by one of the  JobReq*  parame‐
823              ters.
824
825       JobReqProto
826              The  delay  in  seconds  to wait before retrying a facsimile job
827              that failed because of a fax protocol error.
828
829       JobRetryBusy
830              The number of times to redial a phone number after  receiving  a
831              ``BUSY''  result  code when the number has not been successfully
832              dialed before.
833
834       JobRetryDataConn
835              The number of times to redial a phone number after  the  dialing
836              attempt  failed because a data modem answered the phone when the
837              number has not been successfully dialed before.
838
839       JobRetryNoAnswer
840              The number of times to redial a phone number after  the  dialing
841              attempt failed because of NO ANSWER when the number has not been
842              successfully dialed before.
843
844       JobRetryNoCarrier
845              The number of times to redial a phone number after  the  dialing
846              attempt  failed  because  of  NO CARRIER when the number has not
847              been successfully dialed before.  In normal  operation  the  fax
848              server  will  treat  this  result  code to mean that a facsimile
849              modem/machine did not answer the phone and reject  the  transmit
850              job.   This is done to avoid repeatedly dialing wrong phone num‐
851              bers and depends on the modem distinguishing between no  carrier
852              and no answer.  However, some modems are not capable of reliably
853              distinguishing  between  no  carrier  and  no  answer,  or  when
854              instructed  to  do  so  do not identify a busy signal correctly.
855              For these modems one may find it necessary to increase the value
856              of  this  parameter  to compensate.  It is strongly recommended,
857              however, that this value not be set to a large number.
858
859       JobRetryOther
860              The number of times to redial a phone number after  the  dialing
861              attempt  failed  for  a reason not already covered by one of the
862              other JobRetry* parameters when the number has not been success‐
863              fully dialed before.
864
865       GettyArgs
866              A  string that indicates whether or not the server should invoke
867              the getty(8C) program in response to an  incoming  call  from  a
868              data  modem.  If the string value is not null, then it is inter‐
869              preted as a set of arguments  to  pass  to  the  getty  program.
870              Before  supplying the arguments, the string is first scanned for
871              ``%''-escape sequences: any appearance  of  ``%l''  is  replaced
872              with  the tty name and any appearance of ``%s'' is replaced with
873              the serial port speed (in decimal).  Any appearance  of  escaped
874              numbers  1 through 9 (``%1'' through ``%9'') are replaced by the
875              match to the corresponding CallIDPattern, if present.  The ``%''
876              character can be specified with ``%%''.  If the GettyArgs param‐
877              eter is not specified in the configuration file or if the string
878              value  is  null,  then  data connections will be rejected.  Note
879              that in addition to the specified command  line  arguments,  the
880              getty  program  is  invoked with its standard input, output, and
881              error descriptors directed to the controlling tty device.
882
883       LocalIdentifier
884              The local station identification string to use when transmitting
885              TSI  and  CSI  strings  (see  FAXNumber  above).  NB: while this
886              string may contain any printable ASCII characters;  beware  that
887              CCITT  T.30  specifies  a  restricted character set and some fax
888              modems and machines may reject or  not  display   non-conforming
889              strings.   If the local identifier is not specified, a canonical
890              form of the FAXNumber is used instead.
891
892       LockDataCalls
893              Hold the UUCP lockfile during the time an inbound data  call  is
894              processed  by  the  external getty program.  If this is disabled
895              then the lockfile will be removed just before the getty  program
896              is invoked.  Note however that doing this introduces a race con‐
897              dition whereby an outbound program may sneak in and take control
898              of  the  modem  after  the  inbound  call has been accepted, but
899              before the getty program has started up and installed  it's  own
900              lockfile.
901
902       LockVoiceCalls
903              Hold  the  UUCP lockfile during the time an inbound data call is
904              processed by the external voice getty program.  If this is  dis‐
905              abled  then  the  lockfile will be removed just before the voice
906              getty program is invoked.  Note however that doing  this  intro‐
907              duces  a race condition whereby an outbound program may sneak in
908              and take control of the modem after the inbound  call  has  been
909              accepted,  but before the voice getty program has started up and
910              installed it's own lockfile.
911
912       LogFacility²
913              The symbolic name for the syslog(3) facility to use when logging
914              error  messages  and  informational/debugging messages requested
915              through the ServerTracing parameter.  The list of facility names
916              is  standardized;  it  can  be  found in the system include file
917              <syslog.h>; comparisons are case-insensitive.
918
919       LogCalls
920              Log all incoming calls into xferfaxlog as  CALL  records.   This
921              allows  a  quick  check of all incoming calls, regardless of fax
922              completion or not in a unified manner with other fax logs.
923
924       LogFileMode
925              The file protection mode that should be used when creating files
926              to  hold  session logs.  Note that this value is given in octal.
927              The default value of 0600 implies that the  log  files  are  not
928              generally  accessible,  which is important if sensitive informa‐
929              tion such as calling card access codes are logged.  If log files
930              are  to be publicly accessible, this value may be set, for exam‐
931              ple, to 0644.  See also chmod(2).
932
933       LogRecv
934              Log all recieved faxes into xferfaxlog as RECV records.
935
936       LogSend
937              Log all sent faxes into xferfaxlog as SEND records.
938
939       LongDistancePrefix²
940              The string to use to place a long distance phone call.   In  the
941              United States, this is ``1''.
942
943       MaxConcurrentCalls¹
944              The  default value to use for the maximum number of jobs for the
945              same destination that are  processed  concurrently.   Thus  this
946              parameter  defines  the maximum number of concurrent phone calls
947              to the same destination.  Unless all of  your  fax  destinations
948              have  multiple  fax lines using the same fax number per destina‐
949              tion then  MaxConcurrentCalls  is  probably  best  left  as  the
950              default  of  1 and exceptions should be accommodated by the Job‐
951              Control mechanism.  However,  for  high-throughput  applications
952              the  special  value  of  ``0''  may  be used; this configuration
953              instructs the server to permit limitless concurrent calls to the
954              same destination provided that all existing calls to that desti‐
955              nation have connected.  In this configuration if a  busy  signal
956              is  encountered for a concurrent call then the various ``dials''
957              counters are not incremented, and further concurrent  calls  are
958              temporarily stalled.
959
960       MaxConcurrentPreps¹
961              The maximum number of jobs preparations that may be run simulta‐
962              neously.  This is designed to prevent the scheduler from  initi‐
963              ating  so many job preparations that the system resources become
964              constrained in the operations.
965
966       MaxBatchJobs¹
967              The maximum number of jobs to batch together in a single call.
968
969       MaxConsecutiveBadLines
970              The maximum number of consecutive erroneous rows of  image  data
971              that  the  server  will  receive  before it deems a page to have
972              unacceptable copy  quality.   Setting  this  parameter  to  zero
973              causes  the  server to not check the quality of received facsim‐
974              ile.  Facsimile received with error-correction do not have  copy
975              quality checking performed.  See also PercentGoodLines.
976
977       MaxDials¹
978              The  default  value  for  the maximum number of times the server
979              will place a call for an outbound job.  This value may be  over‐
980              ridden  by  rules  in the JobControl mechanism.  This feature is
981              completely distinct from the identically-named  feature  in  the
982              client-server  communication,  and  jobs triggering these limits
983              will be handled differently for each.  See also MaxTries.
984
985       MaxProxyJobs¹
986              The maximum number of jobs which can be  concurrently  delivered
987              to a proxy for transmission.  This limit is to prevent proxy use
988              from overwhelming available system processes.
989
990       MaxRecvPages
991              The maximum number of pages the server will accept in a received
992              facsimile before it aborts the session.
993
994       MaxSendPages¹
995              The  default  value  for  the maximum number of pages the server
996              will permit in a  transmitted  facsimile.   Outbound  jobs  that
997              exceed this limit are rejected.  This value may be overridden by
998              rules in the JobControl mechanism.
999
1000       MaxSetupAttempts
1001              The maximum number  of  times  a  HylaFAX  server  program  will
1002              attempt to initialize a modem before considering it ``wedged''.
1003
1004       MaxTraversal¹
1005              The  maximum  depth  into the job queues that the scheduler will
1006              traverse in attempts to batch jobs together in  a  single  call.
1007              This  is intended to prevent the scheduler from wasting a lot of
1008              CPU in batching attempts when  the  job  queues  get  very  long
1009              (where batching is unlikely to be useful anyway).
1010
1011       MaxTries¹
1012              The  default  value  for  the maximum number of times the server
1013              will attempt to communicate with a remote site.  Note that for a
1014              call  to  be  counted against this limit, carrier must be estab‐
1015              lished; this is in contrast to the value of MaxDials which  lim‐
1016              its  the number of calls that will be placed on behalf of a job.
1017              This value may be overridden by rules in the  JobControl  mecha‐
1018              nism.  This feature is completely distinct from the identically-
1019              named feature in the client-server communication, and jobs trig‐
1020              gering  these  limits will be handled differently for each.  See
1021              also MaxDials.
1022
1023       MinAcceptedLineCount
1024              The minimum number of received scanlines allowed  on  an  ``OK''
1025              page.   The use of this setting prevents confirmation from being
1026              sent for very short pages.
1027
1028       MissedPageHandlingMethod
1029              (Class 1/1.0 only) Specifies how  to  react  to  a  missed  page
1030              received  from  the  remote  sender:  one  of  ``RTN'', ``PIN'',
1031              ``DCN'', or ``CFR''.
1032
1033              If a page is missed (where the modem does not train on the Phase
1034              C  carrier) in non-ECM mode then, like BadPageHandlingMethod, it
1035              can be somewhat difficult to inform the sender of the problem.
1036
1037              A setting of ``RTN'' is the proper behavior  that  fax  protocol
1038              employs  to  request  that  the sender retransmit the page after
1039              retraining.  Unfortunately, however, some senders will  perceive
1040              this  as  a receipt confirmation and not retransmit the page. If
1041              senderConfusesRTN is set to ``yes'' in the  associated  hylafax-
1042              info(5F)  file  for  this  sender,  then this method will not be
1043              used.
1044
1045              A setting of ``PIN'' is the proper behavior  that  fax  protocol
1046              employs  to  request that the sender retransmit the page after a
1047              procedural interrupt.  However, procedural interrupts are rarely
1048              used  and  may  not  be  widely  supported  by other systems. If
1049              senderConfusesPIN is set to ``yes'' in the  associated  hylafax-
1050              info(5F)  file  for  this  sender,  then this method will not be
1051              used.
1052
1053              A setting of ``DCN'' should  trigger  a  call  abortion  by  the
1054              sender.   This  should clearly indicate a problem to the sender,
1055              although a retransmission attempt in  a  later  call  cannot  be
1056              guaranteed.
1057
1058              A  setting  of  ``CFR'' causes an out-of-spec behavior where the
1059              CFR signal is used in response to the post-page message.   While
1060              other  HylaFAX  senders  should  handle this signal to lead to a
1061              retransmision of the page without retraining, most senders  will
1062              disconnect  after receiving this signal as it is not a permitted
1063              response in Phase D, and the sender response will be  undefined.
1064              This method will only be used if it is explicitly configured for
1065              use.
1066
1067              Historically, HylaFAX has  employed  both  ``RTN''  and  ``DCN''
1068              behaviors  by default with complaints using either.  The ``PIN''
1069              and ``CFR'' behaviors were developed in  order  to  evaluate  if
1070              other systems besides HylaFAX would tolerate them.
1071
1072              MissedPageHandlingMethod  is designed to allow the administrator
1073              the opportunity to vary between these options through the Dynam‐
1074              icConfig feature to acheive a more nuanced approach.
1075
1076       ModemGroup¹
1077              Define  a logical name for a set of modem devices.  This parame‐
1078              ter can be used to define a name that clients can use  to  refer
1079              to  a  collection  of  modems.   The syntax is ``<name>:<defini‐
1080              tion>'' where <name> is the name for the group and  <definition>
1081              is  of  the  syntax  ``[<limit>:]<regex>''  where  <limit> is an
1082              optional formatted expression of the limits for this  ModemGroup
1083              and  <regex>  is  a  regular  expression  that  faxq(8C) matches
1084              against known modems.  Presently <limit> only refers to a number
1085              that  is  the minimum number of modems in the group that must be
1086              left to stay idle (for receiving) after assigning an active  job
1087              to  the  ModemGroup.   The  default  for <limit> is 0.  Thus for
1088              example, the default modem to use for a job, any, is defined  as
1089              ``any:0:.*''.  This parameter may be specified multiple times to
1090              define multiple modem classes.  Modem classes may overlap.   The
1091              actual  set  of  modems in a modem class that are considered for
1092              use may vary based on which modems are believed to be ready  for
1093              use.
1094
1095       ModemPriority
1096              The scheduling priority to use for a modem.  Priority values are
1097              in the range 0 to 255 with lesser values signifying higher (more
1098              desirable)  priority.  The HylaFAX scheduler process assigns the
1099              highest priority modem that is ready for use when scheduling  an
1100              outbound job.
1101
1102              If multiple available modems in a job's selected ModemGroup have
1103              the same ModemPriority value, then the HylaFAX scheduler assigns
1104              jobs to them in a round-robin fashion.
1105
1106       NoAnswerVoice
1107              Whether  or  not  to disable the answering of calls indicated as
1108              voice (e.g. by DistinctiveRings ).
1109
1110       NoCarrierRetrys
1111              This is mapped onto JobRetryNoCarrier
1112
1113       ModemReadyState
1114              Define the state transmitted to the  HylaFAX  scheduler  process
1115              each time a modem is made ready by a faxgetty process.  State is
1116              one of: ``R'' (ready for use), ``B'' (busy),  ``D''  (down),  or
1117              ``E''  (exempt).  The modem state can be used to control whether
1118              or not modems are assigned to outbound jobs.  A modem's state is
1119              initially  set to ``R'' (ready).  Modem state can be dynamically
1120              changed with the faxstate(8C) program or by setting this config‐
1121              uration  parameter  with the faxconfig(8C) program.  The HylaFAX
1122              scheduler process will not assign jobs to a modem with a  Modem‐
1123              ReadyState  of  anything  other  than  ``R''.   The  differences
1124              between ``B'', ``D'', and ``E'' are that ``B'' refers to a  tem‐
1125              porary condition that will automatically clear in the passing of
1126              time (as if the modem were in-use with receiving a  fax);  ``D''
1127              refers to a condition that will not automatically clear (such as
1128              a wedged condition); and ``E'' refers to a  permanent  condition
1129              as  configured  by  the  administrator  (as  for  a receive-only
1130              modem).  If a user submits a job to a specific modem that has  a
1131              ModemReadyState  of ``B'' or ``D'' then the job will wait in the
1132              queue until the modem is made available or until the  job  times
1133              out.   In  contrast,  jobs  submitted to a specific modem with a
1134              ModemReadyState of ``E''  will  be  rejected  outright.   Exempt
1135              modems  should  be  removed  from  any  ModemGroup to which they
1136              belong (i.e. ``any'').
1137
1138       ModemRingResponse
1139              This can be used to cause the command  defined  by  ModemRingRe‐
1140              sponse  to  be  sent  to the modem after hearing at least Modem‐
1141              RingsBeforeResponse RINGs in order to receive DID-DTMF data, for
1142              example.
1143
1144       ModemRingsBeforeResponse
1145              This  defines  the  minimum  number  of RINGs that must be heard
1146              before ModemRingResponse is first sent to the modem.
1147
1148       NotifyCmd²
1149              The program to invoke to notify a client of a job status change;
1150              see notify(8C).
1151
1152       PageChop¹
1153              Whether  or not to automatically truncate trailing whitespace on
1154              pages of outbound facsimile (when possible).  If  page  chopping
1155              is  enabled, then pages with at least PageChopThreshold trailing
1156              whitespace on a page will be transmitted as a ``short page''  if
1157              the receiver is capable of accepting variable-length pages.  The
1158              possible values are: ``last'' to enable  chopping  of  the  last
1159              page  of each document, ``all'' to enable chopping of all pages,
1160              or ``none'' to disable page chopping.
1161
1162       PageChopThreshold¹
1163              The minimum amount of trailing whitespace that must  be  present
1164              on  a page before page chopping will be attempted; see PageChop.
1165              Note that this value is specified in inches.
1166
1167       PCL2FaxCmd¹
1168              The command to invoke to convert a HP-PCL document submitted for
1169              transmission to TIFF/F, suitable for transmission.
1170
1171       PercentGoodLines
1172              The minimum percentage of good rows of image data required for a
1173              received facsimile page to be deemed  to  have  acceptable  copy
1174              quality.   Setting  this  parameter to zero causes the server to
1175              not check the quality of received facsimile.  Facsimile received
1176              with  error-correction  do  not  have copy quality checking per‐
1177              formed.  See also MaxConsecutiveBadLines.
1178
1179       PollLockPokeModem
1180              When polling for the presence/removal of a UUCP  lockfile,  also
1181              test  to make sure the modem is still reachable.  This is useful
1182              for scenarios where the modem  is  apt  to  become  disconnected
1183              while the modem is idle, such as an external modem that may lose
1184              power, where the administrator wants notification of this (as  a
1185              ``wedged'' condition).
1186
1187       PollLockWait
1188              When  polling  for  the presence/removal of a UUCP lockfile, the
1189              time (in seconds) to  wait  between  checks.   Lockfile  polling
1190              occurs  to  ensure  the  fax server doesn't collide with another
1191              process using the modem.
1192
1193       PollModemWait
1194              The time (in seconds) to wait between  checks  for  a  modem  to
1195              become  ready  for use.  Modem polling occurs when a modem fails
1196              to reset cleanly.
1197
1198       PriorityScheduling
1199              Indicates whether the HylaFAX scheduler should utilize available
1200              priority  job  scheduling  mechanisms to enhance realtime execu‐
1201              tion, particularly with  Class  1  configurations  on  older  or
1202              slower systems.
1203
1204              Currently  PriorityScheduling  is available for IRIX, SVR/4, HP-
1205              UX, and POSIX-compliant (i.e.  Linux)  operating  systems.   The
1206              default  value  varies to maintain traditional HylaFAX behavior.
1207              On IRIX, SVR/4, and HP-UX systems  where  the  configure  script
1208              detects  one of the functions schedctl(), priocntl() or rtprio()
1209              the default is true.  The only other supported  priority  mecha‐
1210              nism  is  POSIX  sched_setscheduler(),  which  is used on Linux,
1211              OpenServer and possibly other systems.  On such systems, as well
1212              as on systems where no priority scheduling mechanism exists, the
1213              default is false."
1214
1215       PS2FaxCmd¹
1216              The command to invoke to convert a POSTSCRIPT document submitted
1217              for  transmission  to  TIFF/F,  suitable  for  transmission; see
1218              ps2fax(8C).
1219
1220       QualifyPWD
1221              A string that specifies whether or not the identity  of  calling
1222              facsimile  machines  should be checked against an access control
1223              list before receiving facsimile.   If  QualifyPWD  is  non-null,
1224              then  only  messages  from  facsimile machines identified in the
1225              file specified by the  string  (typically  etc/passwd)  will  be
1226              accepted; similar to QualifyTSI.
1227
1228       QualifyTSI
1229              A  string  that specifies whether or not the identity of calling
1230              facsimile machines should be checked against an  access  control
1231              list  before  receiving  facsimile.   If QualifyTSI is non-null,
1232              then only messages from facsimile  machines  identified  in  the
1233              file  specified  by  the  string  (typically  etc/tsi)  will  be
1234              accepted; see tsi(5F).  If QualifyTSI is not  specified  in  the
1235              configuration file, or the value is null, then all incoming fac‐
1236              simile messages will be accepted.
1237
1238       RecvDataFormat
1239              The data format (compression scheme) to write received facsimile
1240              data when copy quality checking is performed on the host.  (When
1241              copy quality checking is not done by  the  server,  for  example
1242              when  error  correction protocol is used, the received facsimile
1243              data is written exactly as it is received from the modem.)   The
1244              format  may  be  one:  ``1-D  MH'',  ``2-D MR'', ``2-D MMR'', or
1245              ``adaptive''.  An ``adaptive'' format causes the  received  data
1246              to be written using the data format negotiated by the sender and
1247              receiver.  Note that while 2-D MMR is the  most  space-efficient
1248              data format the resultant file may not be viewable (certain com‐
1249              monly used programs do not properly read multi-strip  TIFF  with
1250              2-D MMR data).
1251
1252       RecvFileMode
1253              The file protection mode that should be used when creating files
1254              to hold incoming facsimile.  Note that this value  is  given  in
1255              octal.   The default value of 0600 implies that only the facsim‐
1256              ile user can read received facsimile.  If incoming facsimile are
1257              to  be  publicly accessible, this value may be set, for example,
1258              to 0644.  See also chmod(2).
1259
1260       RejectCall
1261              If this is set to true, the current call will not  be  answered,
1262              and  will  be rejected.  This option has no effect if set in the
1263              configuration file, but when set by the  DynamicConfig  program,
1264              controls the current call.  This options supersedes the obsolete
1265              QualifyCID option.
1266
1267       RingData
1268              A modem status string that identifies that an incoming  call  is
1269              for  data  use.  This string should be set when a phone line has
1270              been setup with distinctive ring service.  See also RingFax  and
1271              RingVoice.
1272
1273       RingExtended
1274              An  identifier  which matches the initial portion of an extended
1275              RING message sent by the modem to relay  CID  and/or  DNIS  data
1276              instead of sending it formatted on separate lines.
1277
1278       RingFax
1279              A  modem  status string that identifies that an incoming call is
1280              for facsimile use.  This string should be set when a phone  line
1281              has been setup with distinctive ring service.  See also RingData
1282              and RingVoice.
1283
1284       RingsBeforeAnswer
1285              The number of rings to wait before answering the phone.  If this
1286              value  is  set  to  0,  then  the phone will only be answered in
1287              response to an explicit answer command; see faxanswer(8C).
1288
1289       RingTimeout
1290              If a ring is heard and the call is not answered, the time in  ms
1291              to wait before reinitializing the modem for the next call.
1292
1293       RingVoice
1294              A  modem  status string that identifies that an incoming call is
1295              for voice use.  This string should be set when a phone line  has
1296              been setup with distinctive ring service.  See also RingData and
1297              RingFax.
1298
1299       RTNHandlingMethod
1300              Specifies how to react  to  an  RTN  signal  received  from  the
1301              remote:   one   of   ``Retransmit'',  ``Giveup'',``Ignore'',  or
1302              ``Retransmit-Ignore''.
1303
1304              ``Retransmit'' assumes that the page is  not  received  success‐
1305              fully.   HylaFAX will make up to two additional attempts to send
1306              the page, decreasing signalling rate  and  retraining.   If  RTN
1307              continues,  up  to 2 additional calls will be placed.  The down‐
1308              side is that if the remote always responds with  RTN,  the  page
1309              will  be sent 9 times and no following pages will be sent.  Many
1310              fax machines will not behave this way, although T.30  specifica‐
1311              tion seems clear that this is the intent of the RTN signal.
1312
1313              Some  fax machines will interpret RTN as meaning to not send the
1314              same data again.  That is because RTN may indicate problems with
1315              flow  control,  incorrectly encoded T.4 data, or some incompati‐
1316              bility other than line noise.  Fax machines that  interpret  RTN
1317              this  way  will  disconnect and require a manual retransmission.
1318              This  ``over  and  out''  behavior  can  be  activated  by   the
1319              ``Giveup''  value.   The  advantage to this behavior is that the
1320              same page of image data will not be sent multiple times, but the
1321              downside is that the following pages will not be sent.
1322
1323              ``Ignore'' is similar to ``Giveup'' in that it makes the assump‐
1324              tion the data cannot be automatically accepted by the  receiver.
1325              However,  rather  than  disconnecting  the page of image data is
1326              abandoned and processing moves on to the next.   The  remote  is
1327              left  to  decide  what to do with the unacceptable page of image
1328              data.  The downside to this behavior, is that the remote may  or
1329              may  not  have kept the page, depending on its interpretation of
1330              the RTN signal - but it does allow us to continue on to the next
1331              page.
1332
1333              ``Retransmit-Ignore''  is  a  combination  of ``Retransmit'' and
1334              ``Ignore''.  The page of image data is retransmitted up  to  two
1335              additional  times,  but  rather than disconnecting after a third
1336              RTN signal for the same page, processing then  continues  on  to
1337              the  next  page.   This  approach  is  an effort to satisfy both
1338              interpretations of an RTN signal.  It  allows  the  receiver  to
1339              hopefully  receive  a  better  copy  of the image data while not
1340              failing to send subsequent pages.   If  the  receiver  saves  or
1341              prints a copy of pages for which it transmits RTN, then it could
1342              save or print up to three copies of every page.
1343
1344       SaveUnconfirmedPages
1345              Whether or not to save a received facsimile image  page  if  the
1346              sender  disconnects without sending the post-page message, with‐
1347              out hearing our  message  confirmation,  without  retraining  as
1348              requested, or otherwise breaks fax protocol following such pages
1349              for which the sender should not have a ``receipt confirmation''.
1350
1351       SendFaxCmd¹
1352              The command to use  to  process  outbound  facsimile  jobs;  see
1353              faxsend(8C).
1354
1355       SendPageCmd¹
1356              The  command  to  use  to process outbound pager jobs; see page‐
1357              send(8C).
1358
1359       SendUUCPCmd¹
1360              The command to use to process outbound UUCP jobs.  This  parame‐
1361              ter is not currently used, it is for future development.
1362
1363       ServerTracing²
1364              A  number that controls the generation of tracing information by
1365              a server when  not  actively  sending  or  receiving  facsimile.
1366              Tracing  is divided into areas that are individually controlled.
1367              To enable tracing of multiple areas of operation, the flag asso‐
1368              ciated  with  each area should be bit-or'd to form the value for
1369              this tag.
1370              Flag                Area                    Description
1371              1 (0x00001)         Server Operation        queue management and general operation
1372              2 (0x00002)         FAX/IXO Protocol        T.30 facsimile protocol or IXO/TAP protocol
1373              4 (0x00004)         Modem Operations        modem hardware manipulation
1374              8 (0x00008)         Modem Communications    commands passed between host and modem
1375              16 (0x00010)        Timeouts                timer operations
1376              32 (0x00020)        Modem Capabilities      modem capabilities
1377              64 (0x00040)        HDLC Frames             binary T.30 HDLC frames
1378              128 (0x00080)       Binary Modem I/O        binary communication between host and modem
1379              256 (0x00100)       Server State Transitionsserver program state transitions
1380              512 (0x00200)       Queue Management        job queue management
1381              1024 (0x00400)      Copy Quality            copy quality checking of received facsimile
1382              2048 (0x00800)      Job Management          low-level job management
1383              4096 (0x01000)      IXO Protocol            low-level IXO protocol
1384              8192 (0x02000)      Config File Parsing     unknown configuration file parameters
1385              16384 (0x04000)     FIFO Messages           inter-application messages
1386              32768 (0x08000)     Modem State Transitions modem state changes (down, busy, ready)
1387              65536 (0x10000)     Dial Rules              dialstring rules parsing and execution
1388              131072 (0x20000)    Docq Changes            document reference handling
1389              262144 (0x40000)    TIFF library            any messages produced by the TIFF library
1390              524288 (0x80000)    ECM Frames              binary T.30-A HDLC ECM frames
1391              For example, to enable tracing of server operations and protocol
1392              operations,  a  value of 1+2=3 should be specified.  NB: tracing
1393              timeouts and/or binary modem I/O can adversely affect the opera‐
1394              tion of the fax server; enabling these areas should be done with
1395              extreme care.
1396
1397              Server tracing is directed to syslog(3) using the facility spec‐
1398              ified  with  the LogFacility configuration parameter.  Note that
1399              syslogd(8C) must be configured to capture facility.info,  facil‐
1400              ity.debug,  facility.warning,  and  facility.err  messages.  See
1401              hylafax-log(5F) for a description of the logged messages.
1402
1403       SessionTracing²
1404              A number that controls the generation of tracing information  by
1405              a  server  while  sending or receiving facsimile.  The number is
1406              interpreted identically to  ServerTracing.   Note  that  session
1407              tracing  is  placed  in  log  files in the log subdirectory; see
1408              hylafax-log(5F) for more information.
1409
1410       ShareCallFailures²
1411              A string which indicates the types of call failures that  should
1412              be  shared  to blocked jobs (in the scheduler config file) or to
1413              batched jobs (in the per-device configuration files).  The  pur‐
1414              pose  of this configuration is to prevent a large set of jobs to
1415              the same destination from stalling for long periods of  time  in
1416              the queue and repeatedly initiating failed delivery attempts due
1417              to call-related errors (such as an incorrectly-entered  destina‐
1418              tion  number).   Jobs which are batched or blocked (depending on
1419              which configuration file is used) will receive the same  failure
1420              indication  and  ``dials'' increment as the job which was active
1421              and running at the time (or lead the batch).   ShareCallFailures
1422              may  contain  the  following  key  words  in  any order with any
1423              deliniation:
1424
1425              Key Word    Meaning
1426              busy        Busy signal detected
1427              nocarrier   No carrier detected
1428              noanswer    No answer from remote
1429              nodialtone  No local dialtone
1430
1431              Alternatively,  ShareCallFailures  may   be   set   exactly   to
1432              ``always'' which makes it apply to all of the call failure types
1433              listed above and is synonymous with  ``busy  nocarrier  noanswer
1434              nodialtone''.
1435
1436       SpeakerVolume
1437              The volume level that the in-modem speaker should be adjusted to
1438              while in command mode.  The possible values are:
1439              Value     Description
1440              Off       silent
1441              Quiet     almost inaudible
1442              Low       tolerable in privacy
1443              Medium    loud enough to hear in the next room
1444              High      intolerable
1445              Note that the speaker is  always  turned  off  once  carrier  is
1446              established.   Also beware that some modems support fewer volume
1447              settings; see ModemSetVolumeCmd.
1448
1449       StaggerCalls¹
1450              The time, in seconds, to delay between initiating  outbound  job
1451              calls.   If HylaFAX is using a single phone line shared for both
1452              sending and receiving of faxes using a StaggerCalls setting  of,
1453              for  example,  300  would  ensure that outbound calls be made in
1454              succession no more frequently than every 5 minutes, thus  allow‐
1455              ing time between jobs for incoming calls to be received.
1456
1457       TagLineFont
1458              The  filename of the font to use in imaging tag lines across the
1459              top of each transmitted page.  Fonts must be stored in the  Por‐
1460              table  Compiled Font (PCF) format used by the X11 Window System.
1461              Filenames are specified relative to the  root  of  the  spooling
1462              area;  e.g. etc/lutRS18.pcf or etc/LiberationSans-25.pcf.  If no
1463              font is specified, if a null filename is specified,  or  if  the
1464              specified  font file is not readable, then tag lines will not be
1465              generated.  Note that the etc/lutRS18.pcf TagLineFont  that  has
1466              historically  been the default with HylaFAX does not have glyphs
1467              available beyond basic ASCII, and to show non-ASCII characters a
1468              different  file  must be used that has characters matching those
1469              characters found in TagLineFormat as decoded by  the  TagLineLo‐
1470              cale setting.  For this reason, the etc/LiberationSans-25.pcf is
1471              now considered the default as it has unicode support for  Latin,
1472              Greek, and Cyrillic characters.
1473
1474       TagLineFormat
1475              The  format  string to use when imaging tag lines across the top
1476              of each transmitted page.  This string may include escape  codes
1477              that  cause various items to be interpolated into the imaged tag
1478              line.  Any escape code supported by strftime(3C)  (which  use  a
1479              single ``%'') may be used as well as the following server-imple‐
1480              mented codes:
1481              Escape    Description
1482              %%a       destination subaddress
1483              %%c       destination company name
1484              %%C       sender's company name
1485              %%d       destination phone number
1486              %%g       sender's geographic location
1487              %%G       destination geographic location
1488              %%i       job identifier
1489              %%I       group identifier
1490              %%j       user-specified job tag
1491              %%l       job TSI or LocalIdentifier or canonicalized FAXNumber
1492              %%m       sender's electronic mail address
1493              %%n       canonicalized FAXNumber
1494              %%p       current page number of session
1495              %%P       current page number of job
1496              %%r       receiver's name
1497              %%s       sender's name
1498              %%S       subject
1499              %%t       total pages in session
1500              %%T       total pages in job
1501              %%v       sender's voice number
1502              %%V       destination voice number
1503              %%%       ``%''
1504              There are  numerous  date  and  time  format  options  available
1505              through strftime(3C).  Users are encouraged to refer to its doc‐
1506              umentation for elaboration.  Used by default, ``%c'' is  defined
1507              as  ``The preferred date and time representation for the current
1508              locale.''
1509
1510              In addition, the format string may indicate that text is  to  be
1511              broken  into multiple equal-sized fields by separating text with
1512              ``|'' characters.  If the first character  in  the  field  is  a
1513              ``{''  then  the text is left-aligned; if the first character in
1514              the field is a ``}'' then the text is right-aligned;  otherwise,
1515              the  text  is  centered  in the field.  For example, ``{a|b|}c''
1516              would cause the tag line to be broken up into three  equal-sized
1517              areas  with  the  string ``a'' left-aligned in the first region,
1518              ``b'' centered in the second region, and ``c'' right-aligned  in
1519              the  third region.  The default tag line format string is ``From
1520              %%n|%c|Page %%P of %%T''.  The differences between  the  %%p  or
1521              %%P  and  the  %%t  or %%T options are noticed when a fax job is
1522              retried after an incomplete  attempt  and  only  the  previously
1523              unsent  pages are then queued in a successive session.  See also
1524              TagLineFont.
1525
1526       TagLineLocale
1527              The locale setting  for  handling  TagLineFormat,  for  example,
1528              ``en_US.UTF-8''.  If TagLineFormat is encoded via UTF-8 then the
1529              correct setting of TagLineLocale is requisite for proper  decod‐
1530              ing  by  the  parser.   By  default the environment settings are
1531              used.
1532
1533       TIFF2FaxCmd²
1534              The command to invoke to convert a TIFF submitted for  transmis‐
1535              sion to TIFF/F, suitable for transmission; see tiff2fax(8C).  In
1536              the scheduler configuration file this is used  in  outbound  job
1537              preparation.  In the per-device configuration files this is used
1538              in conjunction with RTFCC features for comparing  relative  data
1539              sizes between different formats.
1540
1541       TimeOfDay¹
1542              The  default time-of-day restrictions to apply to outbound jobs.
1543              Outbound jobs will be processed only during the specified  time.
1544              Any  jobs  submitted outside this time period will be held until
1545              the start of this time.  The syntax for time-of-day restrictions
1546              is  designed  to  be compatible with the syntax used by the UUCP
1547              software.  The following BNF describes the syntax:
1548                 Syntax = tod ["," tod]
1549                    tod = <days><timerange>
1550                   days = "Any" | "Wk" | <dayname>+ | nothing
1551                dayname = "Sun" | "Mon" | "Tue" | "Wed" | "Thu" | "Fri" | "Sat"
1552              timerange = <start> "-" <end> | nothing
1553                  start = <24hrtime>
1554                    end = <24hrtime>
1555               24hrtime = {0-9}{0-9}{0-9}{0-9}
1556                nothing =
1557              where start and end are 24-hour times, day names can  be  either
1558              2-  or  3-characters, and a null day or time specification means
1559              any time or day.  White space and other syntactic sugar  may  be
1560              freely  inserted  between tokens but may not be inserted between
1561              24-hour times in the time range.
1562
1563              This value may be overridden by rules in the  JobControl  mecha‐
1564              nism.
1565
1566       TSIRecvdCmd
1567              The  pathname  of  the  optional program, e.g. ``etc/tsirecvd'',
1568              that similar to DynamicConfig can set the RejectCall  option  to
1569              cause  the  current  call  to  be rejected instead of continued.
1570              TSIRecvdCmd should provide a more capable mechanism than  Quali‐
1571              fyTSI  for  those wishing to screen calls based on received TSI.
1572              Note that this file must be marked as executable by the faxgetty
1573              process.  Note also that any configuration modifications made by
1574              the TSIRecvdCmd script other than RejectCall is unsupported  and
1575              has undefined results.
1576
1577       Unblock¹
1578              Intended  to  only  be used from the faxconfig(8C) utility, this
1579              will force faxq(8C) to unblock one call to  the  value-specified
1580              destination  number.   The destination number should be provided
1581              in the format known by faxq(8C), as seen in the hylafax-info(5F)
1582              database files.
1583
1584       Use2D¹ Control the use of 2D-encoded data for transmitted facsimile.
1585
1586       UseJobTagLine
1587              Allow  the  use of the job-specified tagline instead of the con‐
1588              figured TaglineFormat
1589
1590       UUCPLockMode²
1591              The file protection mode that should be used when creating  UUCP
1592              lockfiles.  Note that this value is given in octal.
1593
1594       UUCPLockDir²
1595              The  pathname of the directory in which UUCP lockfiles are to be
1596              created.
1597
1598       UUCPLockTimeout²
1599              The time in seconds to wait before removing a stale  UUCP  lock‐
1600              file (i.e. a lockfile whose owner does not appear to exist).  If
1601              this value is set to 0, then the fax server will never remove  a
1602              stale lockfile.
1603
1604       UUCPLockType²
1605              A  string  that  specifies  the type of UUCP lockfile to create.
1606              The string may be one of ``ascii'' or  ``binary''  depending  on
1607              whether  the process-ID of the lock owner is written to the file
1608              as an ascii string or as a binary value, respectively.  In addi‐
1609              tion, two prefixes may be used to control the format of the lock
1610              filename.  If the type string is prefixed  with  a  ``+'',  then
1611              SVR4-style filenames are generated using the major device number
1612              of the tty device and the major and minor device numbers for the
1613              filesystem  on which the tty device resides.  If the type string
1614              is prefixed with a ``-'', then any upper  case  letters  in  the
1615              device  part  of  the  lockfile name are converted to lower case
1616              letters;  for   example,   ``LCK..ttyA01''   is   converted   to
1617              ``LCK..ttya01''.   This upper-to-lower case conversion is useful
1618              for systems such as SCO where the convention is to name  devices
1619              with  upper-case  letters,  but create lockfiles with lower-case
1620              letters.
1621
1622       VGettyArgs
1623              A string that indicates whether or not the server should  invoke
1624              a voice getty program in response to an incoming voice call.  If
1625              the string value is not null, then it is interpreted as a set of
1626              arguments  to  pass to the vgetty program.  Before supplying the
1627              arguments,  the  string  is  first  scanned   for   ``%''-escape
1628              sequences:  any  appearance  of  ``%l'' is replaced with the tty
1629              name and any appearance of ``%s'' is replaced  with  the  serial
1630              port  speed  (in  decimal).  Any appearance of escaped numbers 1
1631              through 9 (``%1'' through ``%9'') are replaced by the  match  to
1632              the  corresponding CallIDPattern, if present.  The ``%'' charac‐
1633              ter can be specified with ``%%''.  If the  VGettyArgs  parameter
1634              is  not  specified  in  the  configuration file or if the string
1635              value is null, then voice connections will  be  rejected.   Note
1636              that  in  addition  to the specified command line arguments, the
1637              vgetty program is invoked with its standard input,  output,  and
1638              error descriptors directed to the controlling tty device.
1639
1640       WedgedCmd¹
1641              The  program  to  invoke  when a modem is deemed ``wedged''; see
1642              wedged(8C).
1643

MODEM-ORIENTED CONFIGURATION PARAMETERS

1645       This section lists configuration parameters that are  specific  to  the
1646       setup  and  operation  of  the  modem.   All commands must be specified
1647       exactly as they are to be transmitted to the modem (note that this is a
1648       departure  from  previous  versions of this software that automatically
1649       prepended ``AT'' to each line of commands sent  to  the  modem).   When
1650       multi-line  commands  are required, enclose the commands in quote marks
1651       (``"'') and insert a newline character ``\n''  where  lines  should  be
1652       broken.     An    example   of   a   multi-line   command   string   is
1653       ``AT+FCQ=1\nAT+FBADMUL=20\nAT+FBADLIN=10''.
1654
1655       Command strings sent to the modem  may  include  command  escapes  that
1656       force  the  host to alter the DTE-DCE communication rate, the flow con‐
1657       trol scheme used between the host and modem,  delay  for  a  period  of
1658       time,  flush  input  data,  and  wait  for a specific response from the
1659       modem.  The following escape codes are interpreted:
1660              Escape      Effect
1661              <none>      enable no flow control between DTE and DCE
1662              <xon>       enable software flow control between DTE and DCE
1663              <rts>       enable hardware flow control between DTE and DCE
1664              <2400>      set the DCE-DTE baud rate to 2400 bps
1665              <4800>      set the DCE-DTE baud rate to 4800 bps
1666              <9600>      set the DCE-DTE baud rate to 9600 bps
1667              <19200>     set the DCE-DTE baud rate to 19200 bps
1668              <38400>     set the DCE-DTE baud rate to 38400 bps
1669              <57600>     set the DCE-DTE baud rate to 57600 bps
1670              <76800>     set the DCE-DTE baud rate to 76800 bps
1671              <115200>    set the DCE-DTE baud rate to 115200 bps
1672              <delay:N>   delay N x 10 ms on the host (0 <= N <= 255)
1673              <flush>     flush any pending input data from the modem
1674              <waitfor:R> wait for the response R from the modem (see below)
1675              <play:C>    play the etc/playC.raw audio file (see below)
1676       Note that commands to the left of an escape code are sent to the  modem
1677       before the associated actions are carried out on the host.  This may be
1678       important when changing baud rates, as the result code from  a  command
1679       may  be  returned at the new baud rate.  Also, beware that not all baud
1680       rates are supported by all systems and modems; the set  of  baud  rates
1681       supported by a host is usually listed in stty(1).
1682
1683       The  ``<waitfor:..>'' escape can be used to override the default behav‐
1684       ior which is to wait for an ``OK'' response to a command  sent  to  the
1685       modem.  The possible response codes are:
1686              NOTHING       a null response
1687              OK            the default response
1688              CONNECT       ``CONNECT...''
1689              NOANSWER      ``NO ANSWER...''
1690              NOCARRIER     ``NO CARRIER...''
1691              NODIALTONE    ``NO DIALTONE...''
1692              BUSY          ``BUSY''
1693              OFFHOOK       ``PHONE OFF-HOOK''
1694              RING          ``RING...''
1695              ERROR         error status from modem
1696              VCON          voice connection indicator
1697              OTHER         any unrecognized modem response
1698       For  example  ``ATO\r<waitfor:CONNECT>''  would  send  ``ATO\r'' to the
1699       modem and then wait for a response with a leading  ``CONNECT''  in  it;
1700       and     ``ATS99=2\r<delay:2><flush><waitfor:NOTHING>''    would    send
1701       ``ATS99=2\r'' to the modem, delay 20  ms,  flush  any  input  from  the
1702       modem, and then continue (not wait for any response).
1703
1704       The  ``<play:C>''  escape  can  be used to play a raw audio file with a
1705       voice modem.  The files are named  etc/playC.raw  where  ``C''  is  any
1706       character.   This  feature  can  be  used, for example, to play a brief
1707       audio message after picking up the line but before answering.   A  con‐
1708       figuration example may be:
1709
1710         ModemRingResponse:  "AT+FCLASS=8;H1\nAT+VSM=131\nAT+VLS=1\nAT+VTX\n<waitfor:CONNECT><play:1><waitfor:OK>AT+VTS=[933,,150]"
1711         ModemAnswerCmd:     "<delay:100>AT+FCLASS=1;A"
1712         CallIDPattern:      SHIELDED_DTMF
1713         CallIDAnswerLength: 4
1714
1715       In  this  example using an IS-101 voice-compliant modem, a RING indica‐
1716       tion from the modem will cause the modem to be placed  in  voice  mode,
1717       set  ulaw audio compression, and via the connected phone line play back
1718       the etc/play1.raw audio file, which may say, "After the  tone  enter  a
1719       four-digit  extension,  then  start  the fax."  Following the message a
1720       tone is played.
1721
1722       ModemAnswerCmd
1723              The command to answer the  phone.   If  possible,  this  command
1724              should  generate  a  result  string  that identifies whether the
1725              incoming call is from a facsimile, voice, or data modem.   Typi‐
1726              cally this auto-detection is configured ahead of time; e.g.  for
1727              Class 2 modems with the ``AT+FAA=1'' command.
1728
1729              The following table describes how the result  codes  are  inter‐
1730              preted by the facsimile server.
1731              Result String    Default          Class 1      Class 2      Class2.0
1732              CONNECT FAX      Fax              -            -            --
1733              CONNECT          Data             Unknown      -            -
1734              NO ANSWER        No Answer        -            -            -
1735              NO CARRIER       No Carrier       -            -            -
1736              NO DIALTONE      No Dialtone      -            -            -
1737              ERROR            Error            -            -            -
1738              FAX              Fax              -            -            -
1739              DATA             Data             -            -            -
1740              +FCON            -                -            Fax          Fax
1741              +FCO             -                -            Fax          Fax
1742              +FDM             -                -            Data         Data
1743              +FHNG:           -                -            Error        Error
1744              VCON             -                -            Voice        Voice
1745              The ``Default'' column indicates the interpretation made for the
1746              result string in either class 1 or 2 unless explicitly  overrid‐
1747              den.   The  ``Class  1'' column indicates result strings handled
1748              specially for modems operating in class 1, the ``Class 2''  col‐
1749              umn  indicates special handling for modems operating in class 2,
1750              and the ``Class 2.0''  column  indicates  special  handling  for
1751              modems  operating  in  class  2.0.   Unknown  entries imply that
1752              interpretation is based  on  the  way  in  which  the  call  was
1753              answered;  if  answering is done for an explicit call type, that
1754              type is assumed, otherwise a Fax call is presumed.
1755
1756       ModemAnswerAgainCmd
1757              The command to answer the phone  if  ModemAnswerCmd  appears  to
1758              have been ignored.  Typically this should include a delay escape
1759              in order to set the timing of the answer away from the  ring  in
1760              case  the  modem  is incapable of answering so closely following
1761              the ring.
1762
1763       ModemAnswerDataBeginCmd
1764              The command to send to the modem once a data connection has been
1765              established.
1766
1767       ModemAnswerDataCmd
1768              The  command  to  explicitly answer the phone for a data connec‐
1769              tion.  This command must generate a result string  that  identi‐
1770              fies  the incoming call is from a data modem.  If this parameter
1771              is not specified or is null, then the value of ModemAnswerCmd is
1772              used instead.  See also AdaptiveAnswer and AnswerRotary.
1773
1774       ModemAnswerDialCmd
1775              The  command to explicitly answer the phone for a dialed connec‐
1776              tion.  This command must generate a result string  that  identi‐
1777              fies  the  incoming  call  is  from  a facsimile modem.  If this
1778              parameter is not specified or is null, then the value  of  Mode‐
1779              mAnswerCmd is used instead.
1780
1781       ModemAnswerFaxBeginCmd
1782              The command to send to the modem once a facsimile connection has
1783              been established.
1784
1785       ModemAnswerFaxCmd
1786              The command to explicitly answer the phone for a facsimile  con‐
1787              nection.   This command must generate a result string that iden‐
1788              tifies the incoming call is from a  facsimile  modem.   If  this
1789              parameter  is  not specified or is null, then the value of Mode‐
1790              mAnswerCmd is used instead.  See also AdaptiveAnswer and Answer‐
1791              Rotary.
1792
1793       ModemAnswerVoiceBeginCmd
1794              The  command  to  send  to the modem once a voice connection has
1795              been established.
1796
1797       ModemAnswerVoiceCmd
1798              The command to explicitly answer the phone for a  voice  connec‐
1799              tion.   This  command must generate a result string that identi‐
1800              fies the incoming call is for voice.  If this parameter  is  not
1801              specified  or  is null, then the value of ModemAnswerCmd is used
1802              instead.  See also AdaptiveAnswer and AnswerRotary.
1803
1804       ModemAnswerResponseTimeout
1805              The maximum time, in milliseconds, to wait for a  response  from
1806              the  modem after sending ModemAnswerCmd.  Note that you may want
1807              to shorten this  value  when  using  the  server-based  adaptive
1808              answer strategy; see AdaptiveAnswer.
1809
1810       ModemATCmdDelay
1811              A  delay,  in milliseconds, that should be performed before each
1812              ``AT'' command string is sent to the modem.
1813
1814       ModemBaudRateDelay
1815              The amount of time, in milliseconds, to pause after setting  the
1816              baud rate on the serial line.  This is only needed for hosts and
1817              modems (such as USRs) where setting the serial  line  parameters
1818              does not take effect immediately.
1819
1820       ModemCEDCmd
1821              The  command to signal CED and raise the V.21 HDLC transmit car‐
1822              rier after a session has started.  This is used after  a  proce‐
1823              dure  interrupt.   Normally  this command is ``ATA'', but if the
1824              modem does not permit ``ATA'' after a session has started,  then
1825              ``AT+FTH=3'' should probably be used, instead.
1826
1827       ModemCNGCmd
1828              The  command to signal CNG and listen for V.21 HDLC after a ses‐
1829              sion has started.  This is used  after  a  procedure  interrupt.
1830              Normally this command is ``ATD'', but if the modem does not per‐
1831              mit ``ATD'' after  a  session  has  started,  then  ``AT+FRH=3''
1832              should probably be used, instead.
1833
1834       ModemCommaPauseTimeCmd
1835              The  command  to set the time, in seconds, that the modem should
1836              pause when encountering a ``,'' modifier in the dialing string.
1837
1838       ModemDialCmd
1839              The command to place a phone call.  The string is assumed to  be
1840              suitable  for use as a parameter to the sprintf(3S) function; so
1841              the ``%'' character should be escaped as ``%%''.  The dial  com‐
1842              mand must include a single ``%s'' where the number that is to be
1843              dialed is to be substituted.  The command may include  a  single
1844              ``%d'' where the origin number is to be substituted.  Facilities
1845              such as tone or pulse dialing, outgoing prefixes to route though
1846              a  PBX,  and  so  on  should  be included in the dialing command
1847              string.  It is also important  that,  if  possible,  a  trailing
1848              ``@'' symbol should be included so that the modem returns result
1849              codes that distinguish between no answer and no carrier.  Use of
1850              the  ``@''  permits  the server to reduce the probability that a
1851              wrong number is continually redialed.  If  the  modem  does  not
1852              support  this  facility,  then  it may be necessary to raise the
1853              number of retries done when a ``NO CARRIER'' result is returned.
1854
1855       ModemDialResponseTimeout
1856              The maximum time to wait, in milliseconds, for a  response  from
1857              the  modem  after  sending  This value should be longer than the
1858              timeout programmed into the modem through  the  ModemWaitTimeCmd
1859              parameter.   This additional server-based timeout is provided to
1860              guard against modems that can ``lock up'' when dialing the tele‐
1861              phone.
1862
1863       ModemDoPhaseCDebug
1864              Whether  or  not  to  query the modem for responses during image
1865              data transmission.  Normally the modem should  not  produce  any
1866              responses  during  Phase  C data transmission.  However, in some
1867              debugging scenarios (i.e. some Class 2.1 modems may show  debug‐
1868              ging  information)  it may be appropriate to query the modem for
1869              responses during the data transmission.
1870
1871       ModemDTRDropDelay
1872              The time, in milliseconds, to pause between placing DTR OFF  and
1873              DTR  ON  while resetting a modem.  This value should be at least
1874              equal to the time-value of  the  analogous  S-register,  usually
1875              S25.   This  so-called DTR drop can be bypassed entirely by set‐
1876              ting ModemDTRDropDelay to 0, but this should likely only be used
1877              for debugging purposes.
1878
1879       ModemEchoOffCmd
1880              The command to disable echoing of commands sent to the modem.
1881
1882       ModemFlowControl
1883              The  type  of  flow  control  to use between DTE and DCE; one of
1884              ``NONE'', ``XONXOFF'' and ``RTSCTS''.  This  value  is  used  to
1885              select  the string sent to the modem to initially establish DTE-
1886              DCE flow control; one of ModemNoFlowCmd,  ModemSoftFlowCmd,  and
1887              ModemHardFlowCmd.  The current flow control setting is also used
1888              to select the appropriate flow control command to  send  to  the
1889              modem  when  the  software  switches  to Class 1, 2, or 2.0; see
1890              Class1HFLOCmd,  Class1NFLOCmd,   Class1SFLOCmd,   Class2HFLOCmd,
1891              Class2NFLOCmd, and Class2SFLOCmd.
1892
1893              The  server supports both software and hardware flow control for
1894              Class 1, Class 2, and Class 2.0 modems.  Whether to use hardware
1895              or  software  flow  control  depends  on the capabilities of the
1896              modem and the host hardware and operating system.  Communication
1897              rates  above  9600 baud often require that hardware flow control
1898              be used for reliable  DTE-DCE  communication.   However,  beware
1899              that many modems only support software flow control when sending
1900              or receiving facsimile.
1901
1902              Note that modems usually support software flow control  even  if
1903              they have no explicit AT-command to activate it; in this case it
1904              is  switched  on  when  the  modem  enters  fax   mode,   having
1905              AT+FCLASS=... from DTE.
1906
1907       ModemFrameFillOrder
1908              The bit order to expect for received HDLC frames and to use when
1909              formulating HDLC frames to  send.   This  value  may  be  either
1910              LSB2MSB  when  bits  are  ordered  from least-significant-bit to
1911              most-significant-bit (as in the CCITT specification) or  MSB2LSB
1912              when bits are ordered in the reverse direction.
1913
1914       ModemHardFlowCmd
1915              The command to setup hardware (RTS/CTS) flow control between DTE
1916              and DCE.
1917
1918       ModemMinSpeed
1919              The minimum acceptable signalling rate for transmitting  facsim‐
1920              ile  page  data.   Possible  values are: 2400, 4800, 7200, 9600,
1921              12200, and 14400.
1922
1923       ModemMfrQueryCmd
1924              The command to send to the modem to get the manufacturer identi‐
1925              fication  string.  If this parameter is not set, then it is ini‐
1926              tialized to ``AT+FMFR?'' for Class 2 modems, or  to  ``AT+FMI?''
1927              for Class 2.0 modems, or to ``ATI3'' for Class 1 modems.  If the
1928              parameter begins with a ``!'', then the remainder of the  string
1929              is  taken  to  be  the  identification  string and no command is
1930              issued to the modem.
1931
1932       ModemModelQueryCmd
1933              The command to send to the modem to get the model identification
1934              string.  If this parameter is not set, then it is initialized to
1935              to ``AT+FMDL?'' for Class 2 modems, or to ``AT+FMM?'' for  Class
1936              2.0 modems, or to ``ATI0'' for Class 1 modems.  If the parameter
1937              begins with a ``!'', then the remainder of the string  is  taken
1938              to  be the identification string and no command is issued to the
1939              modem.
1940
1941       ModemNoAutoAnswerCmd
1942              The command to stop the modem from automatically answering  when
1943              the phone rings.
1944
1945       ModemNoAutoAnswerCmdDelay
1946              The  time, in milliseconds, to pause after receiving the OK fol‐
1947              lowing ModemNoAutoAnswerCmd before any further commands are sent
1948              to  the  modem.  All input from the modem is flushed after paus‐
1949              ing.
1950
1951       ModemNoFlowCmd
1952              The command to disable flow control between DTE and DCE.
1953
1954       ModemOnHookCmd
1955              The command to place the phone ``on hook'' (i.e. hangup).
1956
1957       ModemPageDoneTimeout
1958              The maximum time to wait, in milliseconds, for a  response  from
1959              the modem after sending a page of facsimile data (e.g.  the time
1960              to wait for a response to a Class 2/2.0 AT+FET command).
1961
1962       ModemPageStartTimeout
1963              The maximum time  to  wait,  in  milliseconds,  for  an  initial
1964              response  from  the  modem when sending a page of facsimile data
1965              (e.g. the time to wait for a response to a  Class  2/2.0  AT+FDR
1966              command).
1967
1968       ModemRaiseATCommands
1969              Indicates  whether  or not all configuration AT commands for the
1970              modem should be raised to upper-case automatically.   The  stan‐
1971              dard  is  for  all  upper-case  to  be  used in AT commands, and
1972              indeed, some rare modems have been  known  to  malfunction  with
1973              lower-case  commands.   However,  sometimes an administrator may
1974              want to use lower-case commands in a rare condition such  as  to
1975              work around modem blacklisting of dialed numbers.
1976
1977       ModemRate
1978              The  baud rate to use for DCE-DTE communication.  This value may
1979              be one of: 115200, 76800, 57600, 38400, 19200, 9600, 4800, 2400,
1980              1200.   The  default value is 19200 because many modems lock the
1981              rate at 19200 when sending or receiving  facsimile.   Note  that
1982              not  all  values  are  supported  by  all  operating systems and
1983              modems; consult stty(1) for the available rates on your system.
1984
1985       ModemReadyCmds
1986              A string of commands to issue to the modem during reception ini‐
1987              tialization.   This  string is sent to the modem after the stan‐
1988              dard set of configuration commands required by the  fax  server.
1989              This  is  done, for example, to un-busy a DID line so that calls
1990              can come through.
1991
1992       ModemRecvFillOrder
1993              The bit order to expect for received facsimile data.  This value
1994              may  be either LSB2MSB when bits are ordered from least-signifi‐
1995              cant-bit to most-significant-bit (as in the CCITT specification)
1996              or  MSB2LSB  when  bits  are  ordered  in the reverse direction.
1997              According to the various specifications all modems should return
1998              data  in  LSB2MSB  order.   However  most Class 2 modems (except
1999              maybe only Multitech) use MSB2LSB for compatibility with  modems
2000              that  were built with Rockwell hardware/firmware that included a
2001              bug that was too widespread to correct.
2002
2003              If this parameter is not set, then it is autodetected and set to
2004              LSB2MSB  for  Class  1 and Class 2.0 modems and MSB2LSB for non-
2005              Multitech Class 2 modems. However this may  be  wrong  for  your
2006              modem, so you will have to specify this parameter explicitly.
2007
2008       ModemRecvSuccessCmd
2009              A  string  of  commands to issue to the modem after a successful
2010              receive session before the call is disconnected.
2011
2012       ModemResetCmds
2013              A string of commands to issue to the  modem  during  initializa‐
2014              tion.   This string is sent to the modem before the standard set
2015              of configuration commands required by the fax server.  Note that
2016              these commands should not include normal reset commands that are
2017              specified through other parameters.  For  example,  commands  to
2018              setup  flow  control, DCD handling, DTR handling, etc. should be
2019              specified through the appropriate configuration  parameters  and
2020              not  through this parameter.  In addition the soft reset command
2021              (usually ``ATZ'') should not be included  in  this  string;  the
2022              servers issue this command explicitly.
2023
2024       ModemResetDelay
2025              The  time, in milliseconds, to pause after setting DTR ON, while
2026              resetting a modem.  DTR ON does not respond with ``OK'', so this
2027              parameter  should  be  long enough to allow the modem time to be
2028              ready for ModemSoftResetCmd successively.
2029
2030       ModemResultCodesCmd
2031              The command to enable result codes.
2032
2033       ModemRevQueryCmd
2034              The command to send to the modem  to  get  a  firmware  revision
2035              identification string.  If this parameter is not set, then it is
2036              initialized  to  ``AT+FREV?''  for  Class  2   modems,   or   to
2037              ``AT+FMR?''  for Class 2.0 modems.  If the parameter begins with
2038              a ``!'', then the remainder of the string is  taken  to  be  the
2039              identification string and no command is issued to the modem.
2040
2041       ModemSendBeginCmd
2042              The  command to send to the modem upon establishing carrier dur‐
2043              ing a transmit operation.  This parameter is useful for  systems
2044              that are incapable of enabling hardware flow control without DCD
2045              asserted.
2046
2047       ModemSendFillOrder
2048              The bit order the modem expects for transmitted facsimile  data.
2049              This value may be either LSB2MSB or MSB2LSB (see also ModemRecv‐
2050              FillOrder above.)  Virtually all modems expect transmitted  fac‐
2051              simile data in LSB2MSB bit order.
2052
2053       ModemSetOriginCmd
2054              The  command  to  use  to set the call origin information before
2055              placing a call.  The command may include a single  ``%d''  where
2056              the  job request ``faxnumber'' string is to be substituted.  The
2057              command may also include a single ``%s'' where the  job  request
2058              ``faxname'' string is to be subsituted.
2059
2060       ModemSetVolumeCmd
2061              The  commands  to  use  to  set the modem speaker volume levels.
2062              There should be five whitespace-separated commands, one each for
2063              setting  the  volume to ``Off'', ``Quiet'', ``Low'', ``Medium'',
2064              and ``High'';  the  default  is  ``"ATM0  ATL0M1  ATL1M1  ATL2M1
2065              ATL3M1"''.  See also SpeakerVolume.
2066
2067       ModemSetupAACmd
2068              The  command  to  setup  adaptive answer support in the modem-if
2069              available.  Adaptive answer is the term used for the ability  to
2070              distinguish  between  calls  from  facsimile,  voice,  and  data
2071              sources.  Note that this string is the last  command  issued  by
2072              the  device  drivers during setup, so the command string may, if
2073              necessary, switch to a different operating mode  (e.g.  on  some
2074              Rockwell-based  modems it is necessary to issue the ``AT+FAA=1''
2075              command in Class 0).
2076
2077       ModemSetupDCDCmd
2078              The command to setup DCD handling.  On most systems the  facsim‐
2079              ile  server  will  enable  the  CLOCAL flag on the tty device to
2080              which the modem is connected.  This should ensure that the  sys‐
2081              tem  does  not close an open file descriptor associated with the
2082              modem if carrier is dropped.  Thus, for most systems and  modems
2083              ModemSetupDCDCmd should setup DCD to reflect carrier.
2084
2085       ModemSetupDTRCmd
2086              The  command  to  setup  DTR handling so that the modem is reset
2087              when the DTR signal is  lowered  by  the  host.   The  facsimile
2088              server  uses this facility to ensure that modems are not left in
2089              a ``locked up'' state.
2090
2091       ModemSoftFlowCmd
2092              The command to setup software (XON/XOFF)  flow  control  between
2093              DTE and DCE.
2094
2095       ModemSoftResetCmd
2096              The command to force a soft reset of the modem.
2097
2098       ModemSoftResetCmdDelay
2099              The  time, in milliseconds, to pause after receiving the OK fol‐
2100              lowing ModemSoftResetCmd before any further commands are sent to
2101              the modem.
2102
2103       ModemSoftRTFCC
2104              Whether  or not to enable software-driven Real-Time Fax Compres‐
2105              sion Conversion.  RTFCC allows HylaFAX to convert the image com‐
2106              pression  between  MH  MR and MMR formats regardless of how faxq
2107              formatted the image file.  Note that when using RTFCC, the  com‐
2108              pression  format  of  the file will be ignored, thus the ``-1'',
2109              ``-2'', and ``-3'' options for sendfax, ps2fax, and others  will
2110              only influence how the document is prepared by faxq and will not
2111              influence the actual negotiated session parameters.  Class2RTFCC
2112              takes  precedence  over  ModemSoftRTFCC and if both are enabled,
2113              then software-driven RTFCC will not be performed in favor of the
2114              firmware-driven RTFCC.
2115
2116       ModemType
2117              This  parameter must be set to one of: ``Class2'', ``Class2.0'',
2118              ``Class1'', or ``Class1.0''; to indicate that  the  modem  is  a
2119              Class  2-,  Class  2.0-,  Class  1-,  or  Class 1.0-style modem,
2120              respectively.  If  this  parameter  is  not  set,  then  HylaFAX
2121              detects  which  classes  are supported by the modem and makes an
2122              internal decision on which to use.  Historically  this  decision
2123              chooses  Class  2.1  over  Class 2.0 over Class 2 over Class 1.0
2124              over Class 1.  However, some exceptions are made, for  instance,
2125              with US Robotics modems where Class 2.0 support is avoided.
2126
2127       ModemVerboseResultsCmd
2128              The  command  to  enable  verbose, as opposed to numeric, result
2129              codes.
2130
2131       ModemWaitForConnect
2132              If enabled, the facsimile server will not consider a  connection
2133              established  when answering an incoming call until a ``CONNECT''
2134              status string is received.  This is useful mainly  for  Rockwell
2135              RC32ACL-based  modems that send ``FAX'' and ``DATA'' status mes‐
2136              sages before sending ``CONNECT''.
2137
2138       ModemWaitTimeCmd
2139              The command to set the number of seconds to wait for  a  carrier
2140              signal when placing a call or answering the phone.
2141

T.30 PROTOCOL CONFIGURATION PARAMETERS

2143       The  following parameters apply to the implementation of the CCITT T.30
2144       facsimile protocol in the Class 1 device driver.  They  should  not  be
2145       changed without full understanding of the operation of the server.
2146
2147       FaxT1Timer
2148              The  value  of the T1 timer in milliseconds.  This timer is used
2149              to time  out  the  initial  session  contact;  i.e.  receipt  of
2150              DIS/DCS.
2151
2152       FaxT2Timer
2153              The  value  of the T2 timer in milliseconds.  This timer is used
2154              to time out receiving responses and commands.
2155
2156       FaxT4Timer
2157              The value of the T4 timer in milliseconds.  This timer  is  used
2158              to  time  out the reception of HDLC frames and, usually, trigger
2159              frame retransmissions.
2160

CLASS 1 MODEM CONFIGURATION PARAMETERS

2162       The following parameters are specific to  the  configuration  of  Class
2163       1-style modems; they should not be changed lightly:
2164
2165       Class1Cmd
2166              The command to set the modem into Class 1 operation.
2167
2168       Class1AdaptRecvCmd
2169              The  command  used to enable adaptive reception support (usually
2170              ``AT+FAR=1'').  This feature is new in  T.31,  and  many  modems
2171              will  not  support  it.   This  feature may reduce the number of
2172              reception failures due to errors cascading  from  +FCERROR  mes‐
2173              sages.
2174
2175       Class1ColorJPEGSupport
2176              Whether or not to enable support for T.30-E full-color facsimile
2177              with JPEG  compression.   Enabling  this  automatically  enables
2178              Class1GreyJPEGSupport.
2179
2180       Class1EnableV34Cmd
2181              The command to enable V.34-fax support with at least the desired
2182              maximum primary channel rate.
2183
2184       Class1ECMCheckFrameLength
2185              Whether or not to require the frame length for ECM  data  frames
2186              to be complete when checking for frame integrity.  Normally this
2187              is not beneficial (and can be problematic for some senders), but
2188              in  some  cases  the  frame CRC is not reliable because of modem
2189              behavior.
2190
2191       Class1ECMSupport
2192              Whether or not to support T.30-A error correction protocol.  Use
2193              of  ECM  will  require  64 kilobytes of free memory per modem in
2194              active use.
2195
2196       Class1PersistentECM
2197              Whether or not to continue to retransmit and allow  to  continue
2198              to  receive  image data in ECM protocol which is not accepted as
2199              valid after four successive attempts.
2200
2201       Class1ECMFrameSize
2202              The size in bytes of image frames to transmit during ECM  proto‐
2203              col.   This  setting  will also indicate a preference in receive
2204              sessions.  The only acceptable values are 64 and 256.  A setting
2205              of  64  may be useful on high-load systems and possibly environ‐
2206              ments with extremely poor line quality.
2207
2208       Class1ExtendedRes
2209              Whether or not to support  resolutions  other  than  normal  and
2210              fine.  This option has been deprecated by Class1Resolutions.
2211
2212       Class1FrameOverhead
2213              The  number  of extraneous bytes in HDLC frames sent to the host
2214              in response to an ``AT+FRH'' command.  For modems that  properly
2215              implement  the  Class  1 interface, this number should be 4 (the
2216              default).
2217
2218       Class1GreyJPEGSupport
2219              Whether or not to enable support for T.30-E greyscale  facsimile
2220              with  JPEG  compression.  This is always enabled if Class1Color‐
2221              JPEGSupport is enabled.
2222
2223       Class1HookSensitivity
2224              The number of times to  ignore  on-hook  detections  and  merely
2225              treat them as command or modem errors.
2226
2227       Class1JBIGSupport
2228              Whether  or  not to enable support for T.85 monochrome facsimile
2229              with JBIG compression.  Options are ``true'' for support in both
2230              sending  and  receiving,  ``false'' for no support, ``send'' for
2231              support only in sending, and ``receive''  for  support  only  in
2232              receiving.   If,  during  the  build  process  a compatible JBIG
2233              library was found then send support is enabled by default.   If,
2234              during  the  build  process  the TIFF tools are found to support
2235              JBIG then receive support is enabled by default.
2236
2237       Class1MRSupport
2238              Whether or not to enable support  for  two-dimensional  Modified
2239              Read (MR) image data format compression.
2240
2241       Class1MMRSupport
2242              Whether  or  not  to enable support for two-dimensional Modified
2243              Modified Read (MMR) image data format  compression.   Note  that
2244              MMR support requires also ECM support to be enabled.
2245
2246       Class1HasRHConnectBug
2247              A  Class  1 modem should only report CONNECT after AT+FRH=3 when
2248              V.21 HDLC data is detected.  However, some  modems  will  incor‐
2249              rectly  report  CONNECT  after  AT+FRH=3 whenever any carrier is
2250              present. In such cases Class1HasRHConnectBug should  be  set  to
2251              ``true''.
2252
2253       Class1HFLOCmd
2254              The command to setup hardware (RTS/CTS) flow control between DTE
2255              and DCE when operating in Class 1.  This command is issued imme‐
2256              diately after sending the Class1Cmd to switch the modem to Class
2257              1 operation.
2258
2259       Class1NFLOCmd
2260              The command to setup no flow control between DTE  and  DCE  when
2261              operating  in Class 1.  This command is issued immediately after
2262              sending the Class1Cmd to switch the modem to Class 1 operation.
2263
2264       Class1PageLengthSupport
2265              The coded value for page lengths supported by  the  modem.   The
2266              only  correct  values  and  meanings  are  these: ``1'', A4 page
2267              length; ``3'', both A4 and B4 page length; ``7'', unlimited page
2268              length.
2269
2270       Class1PageWidthSupport
2271              The  coded  value  for  page widths supported by the modem.  The
2272              only correct values and  meanings  are  these:  ``1'',  A4  page
2273              width;  ``3'',  both A4 and B4 page width; ``7'', all of A4, B4,
2274              and A3 page widths.
2275
2276       Class1PPMWaitCmd
2277              The command used to stop and wait before sending the  post  page
2278              message,  except  before  sending  EOP, when Class1EOPWaitCmd is
2279              used instead.  We must ensure that the  high-speed  carrier  has
2280              stopped  completely.  According to T.30, Chapter 5, Note 4, this
2281              delay should be 75 +/- 20 ms.
2282
2283       Class1ResponseWaitCmd
2284              The command used to stop and  wait  after  sending  TCF,  before
2285              attempting  to receive a training response from the remote.  Set
2286              this to ``AT+FTS=1'' if the modem responds ``OK''  before  actu‐
2287              ally dropping the high-speed TCF carrier.
2288
2289       Class1Resolutions
2290              A  bitmapped  (bit-or'd)  value indicating the resolutions to be
2291              supported during facsimile  operation.   Individual  resolutions
2292              follow Table 21/T.32 and are defined as follows:
2293              Bit              Description
2294              0 (0x00)         R8 x 3.85 l/mm, Normal
2295              1 (0x01)         R8 x 7.7 l/mm, Fine
2296              2 (0x02)         R8 x 15.4 l/mm, Superfine
2297              4 (0x04)         R16 x 15.4 l/mm, Hyperfine
2298              8 (0x08)         200 dpi x 100 l/inch
2299              16 (0x10)        200 dpi x 200 l/inch
2300              32 (0x20)        200 dpi x 400 l/inch
2301              64 (0x40)        300 dpi x 300 l/inch
2302              Thus,  a value of 3 would indicate support for normal, fine, and
2303              superfine resolutions.
2304
2305       Class1RMQueryCmd
2306              The command to send to the modem to get the  list  of  supported
2307              reception bit-rates.  If the parameter begins with a ``!'', then
2308              the remainder of the string is taken to be  the  modem  response
2309              and no command is issued to the modem.
2310
2311       Class1TCFWaitCmd
2312              The command used to stop and wait before sending TCF, similar to
2313              Class1PPMWaitCmd.  According to T.30, Chapter 5,  Note  3,  this
2314              delay should be 75 +/- 20 ms.
2315
2316       Class1TMQueryCmd
2317              The  command  to  send to the modem to get the list of supported
2318              transmission bit-rates.  If the parameter begins with  a  ``!'',
2319              then  the  remainder  of  the  string  is  taken to be the modem
2320              response and no command is issued to the modem.
2321
2322       Class1EOPWaitCmd
2323              The command used to stop and wait before sending the  post  page
2324              message  similar to Class1PPMWaitCmd.  We allow a different set‐
2325              ting in the case  of  EOP,  however,  because  empirically  some
2326              machines may need more time.
2327
2328       Class1ModemHasDLEBug
2329              Used to indicate that the modem does not correctly duplicate DLE
2330              characters in the V.21 communication to the DTE.
2331
2332       Class1MsgRecvHackCmd
2333              If receive failures occur due to +FCERROR just  prior  to  image
2334              data  reception,  setting  Class1MsgRecvHackCmd  to AT+FRS=1 may
2335              help.
2336
2337       Class1RecvAbortOK
2338              The time, in milliseconds, to wait for  an  ``OK''  result  code
2339              from   the   modem   after   aborting   an  HDLC  frame  receive
2340              (``AT+FRH=3'').  If this number  is  zero,  then  the  modem  is
2341              assumed  to  not  correctly  implement  aborting and instead the
2342              driver will wait 200ms, flush any input, and then send  ``AT\n''
2343              and wait 100ms for an ``OK'' result.
2344
2345       Class1RecvIdentTimer
2346              The  time,  in  milliseconds,  to  wait  for an initial DCS when
2347              receiving a facsimile.  CCITT recommendation T.30 specifies this
2348              as  the  value  of  the  T1  timer.  However, adaptive answering
2349              schemes such as that described above  under  the  AdaptiveAnswer
2350              parameter may require that this timer be shortened.
2351
2352       Class1RestrictPoorDestinations¹
2353              The  threshold  of destination audio quality corruption at which
2354              resolution support should be restricted to ``normal'' and  color
2355              support  should  be  disabled.   This  is intended to reduce the
2356              amount of image data that will be attempted to be sent to a des‐
2357              tination  with  poor audio quality, thus reducing the call dura‐
2358              tion, and should improve the likelihood  of  successful  session
2359              completion.  The threshold is the ratio, expressed as an integer
2360              percentage, of data indicated as corrupt by the destination com‐
2361              pared  to  total  data  sent  to the destination in the previous
2362              three fax sessions.  Although Class1RestrictPoorDestinations  is
2363              functional  for destinations with a history of both ECM and non-
2364              ECM sessions, the ECM session history is preferred and  weighted
2365              considerably higher than non-ECM session history.
2366
2367       Class1RestrictPoorSenders
2368              The  threshold of sender audio quality corruption at which reso‐
2369              lution support should be restricted to ``normal'' and color sup‐
2370              port  should be disabled.  This is intended to reduce the amount
2371              of image data that a sender with poor audio quality will attempt
2372              to transmit, thus reducing the call duration, and should improve
2373              the likelihood of successful session completion.  The  threshold
2374              is  the  ratio,  expressed  as an integer percentage, of corrupt
2375              data received compared to total data received from  the  current
2376              sender in the previous three fax sessions.  Class1RestrictPoorS‐
2377              enders requires that a CallIDType of ``calling-number'' be  con‐
2378              figured  in  order  to  match a sender with an entry in the info
2379              database.
2380
2381       Class1RMPersistence
2382              The number of times that an attempt to  receive  the  high-speed
2383              data  carrier  should be made, resulting in +FCERROR, before the
2384              low-speed message carrier reception is attempted.   Some  modems
2385              are  quick  to  (perhaps  incorrectly)  return +FCERROR, and for
2386              those modems a value of 2 or 3 should be used.  For modems  that
2387              are  not  quick to return +FCERROR, a value of 1 should be used.
2388              Proper tuning of this can provide a type of "adaptive  reception
2389              control" for modems that accurately return +FCERROR without sup‐
2390              porting  Class1AdaptRecvCmd.   For  those  modems  that  support
2391              Class1AdaptRecvCmd,  Class1RMPersistence  should probably not be
2392              set at 1, although +FCERROR should almost never occur with  such
2393              modems.
2394
2395              If the modem does not support the reporting of +FCERROR or adap‐
2396              tive reception control, then Class1RMPersistence should probably
2397              be set at 0, which causes the timeout looking for the high-speed
2398              data carrier to be shortened, thus increasing the likelihood  of
2399              recovery  from  any dissynchronization. When Class1RMPersistence
2400              is other than 0 it is assumed that  the  +FCERROR  reporting  or
2401              Class1AdaptRecvCmd is functional and therefore the timeout look‐
2402              ing for the high-speed data carrier is lengthened.
2403
2404       Class1SwitchingCmd
2405              The command used to ensure that the sending facsimile device has
2406              turned  off  its modulator (i.e. loss-of-carrier) as recommended
2407              by T.31: Appendix II.1.
2408
2409       Class1SFLOCmd
2410              The command to setup software (XON/XOFF)  flow  control  between
2411              DTE  and  DCE when operating in Class 1.  This command is issued
2412              immediately after sending the Class1Cmd to switch the  modem  to
2413              Class 1 operation.
2414
2415       Class1SSLFaxCert
2416              The  relative  path to the PEM certificate file for SSL Fax use.
2417              This is normally created by faxsetup(8C).
2418
2419       Class1SSLFaxClientTimeout
2420              The time, in milliseconds, that the SSL Fax server  should  wait
2421              for  the client connection to complete before abandoning SSL Fax
2422              and proceeding with a traditional fax operation.
2423
2424       Class1SSLFaxInfo
2425              The formatted hostname and port number for  SSL  Fax  connection
2426              for  this  modem.   (Each modem should use a different port num‐
2427              ber.)  This instructs  the  remote  system  on  how  to  connect
2428              through  the  IP  network  to  this system as an SSL Fax server.
2429              Firewalling and port forwarding should  be  carefully  addressed
2430              prior to using this configuration.  The format for Class1SSLFax‐
2431              Info is ``<hostname>:<port>''.  During fax protocol this  infor‐
2432              mation  will  be  made  into  a URL by prepending ``ssl://<pass‐
2433              code>@'' and communicated as part of CSA and TSA signals for SSL
2434              Fax.  (``<passcode>'' is a string of random characters.)
2435
2436              ``<hostname>''  may  be  specified as an IP address; however, in
2437              such   cases   it   should   be    bracketed,    for    example:
2438              ``[<address>]:<port>''.   This  prevents  confusion,  especially
2439              with IPv6 addresses.
2440
2441              Either the sender or the receiver (or both) must signal  an  SSL
2442              Fax URL in order for SSL Fax to operate.  If no Class1SSLFaxInfo
2443              is configured for one system, then it is always dependent on the
2444              remote systems to operate as the SSL Fax server.
2445
2446       Class1SSLFaxServerTimeout
2447              The  time,  in milliseconds, that the SSL Fax client should wait
2448              for the connection to the server to complete  before  abandoning
2449              SSL  Fax  and proceeding with a traditional fax operation.  Usu‐
2450              ally this must be shorter than 3 seconds.
2451
2452       Class1SSLFaxSupport
2453              Whether or not to enable SSL Fax support.
2454
2455       Class1TCFMaxNonZero
2456              The maximum percentage of non-zero data bytes  permitted  in  an
2457              acceptable received TCF.  Note that this number does not include
2458              any leading non-zero  data  in  the  received  data.   See  also
2459              Class1TCFMinRun.
2460
2461       Class1TCFMinRun
2462              The  duration,  in milliseconds, of the minimum run of zero data
2463              in an acceptable received TCF.  This value should  be  specified
2464              according  to  a  1.5  second transmission of zero data (i.e. it
2465              should be between 0 and 1500).  See also Class1TCFMaxNonZero and
2466              Class1TCFMinRunECMMod.
2467
2468       Class1TCFMinRunECMMod
2469              The  factor  by  which Class1TCFMinRun should be modified in the
2470              case of an ECM session.  As ECM protocol allows  retransmissions
2471              it is commonly faster to accept a lesser-quality data stream and
2472              the subsequent retransmisisons than it is to allow the  communi‐
2473              cation  speed to slow down (where the demodulation may still not
2474              produce an ideal data stream, anyway).
2475
2476       Class1TCFRecvHackCmd
2477              If receive failures occur due to +FCERROR just prior to TCF data
2478              reception, setting Class1TCFRecvHackCmd to AT+FRS=1 may help.
2479
2480       Class1TCFRecvTimeout
2481              The  maximum  time  to wait, in milliseconds, for the first byte
2482              and again for the entirety of the Training Check  (TCF)  message
2483              data that is received during the training phase of the facsimile
2484              reception protocol.
2485
2486       Class1TMConnectDelay
2487              The time, in milliseconds, to delay after receiving CONNECT fol‐
2488              lowing  +FTM before sending image data.  T.31 8.3.3 requires the
2489              modem to respond with CONNECT  before  the  modulation  training
2490              pattern.   If transmission begins before the remote has success‐
2491              fully completed its own modulation training pattern  then  data,
2492              especially during TCF, could be lost.  Many modems do not follow
2493              T.31 in this regard, and thus the default is zero;  however  its
2494              use with such modems would likely have a negligible effect.
2495
2496       Class1ValidateV21Frames
2497              Whether  or not to use the FCS bits of received V.21 HDLC frames
2498              to check the validity of the frame itself.  Most Class 1  modems
2499              perform  this  check  independently  (per  T.31  7.4) and do not
2500              require this feature to be enabled.
2501

CLASS 2 AND 2.0 MODEM CONFIGURATION PARAMETERS

2503       The following parameters are specific to the configuration of Class  2-
2504       and Class 2.0-style modems:
2505
2506       Class2Cmd
2507              The command to set the modem into Class 2/2.0 operation.
2508
2509       Class2AbortCmd
2510              The command to use to abort an established session.  After using
2511              this command to abort a session,  the  fax  software  will  send
2512              ModemOnHookCmd and then reset the modem by dropping DTR .
2513
2514       Class2APCmd
2515              A  largely  unused  option for modems supporting ITU-T.32, Class
2516              2.1, standards.  This command would be used  to  enable  sending
2517              and receiving SUB, SEP, and PWD frames.
2518
2519       Class2APQueryCmd
2520              A  largely  unused  option for modems supporting ITU-T.32, Class
2521              2.1, standards.  This command would be used to query  the  capa‐
2522              bilities of sending and receiving SUB, SEP, and PWD frames.  The
2523              value ``none'' may be used if the modem  does  not  support  any
2524              Class2APQueryCmd.
2525
2526       Class2BORCmd
2527              The  command to setup the bit order of sent and received facsim‐
2528              ile data.  Usually the command ``AT+FBOR=0''  is  used  so  that
2529              data  is  sent and received in direct bit order (LSB2MSB).  Some
2530              modems, such as the Everex 24/96D, must use reversed  bit  order
2531              for  Phase B and D data exchanges to avoid a bug that results in
2532              garbage data being placed in the padding of EOL codes.  The  bit
2533              order  specified by this command must correspond to the settings
2534              of the ModemSendFillOrder and ModemRecvFillOrder parameters.
2535
2536       Class2BUGCmd
2537              The command to use to enable or  disable  the  tracing  of  HDLC
2538              frames sent and received by the modem.  This tracing information
2539              should be returned to the host in ``+FHR:'' and ``+FHT:'' status
2540              strings.   Note  that  many  Class  2 modems do not support this
2541              facility, which is largely used for  diagnostic  purposes.   The
2542              value  ``none''  may  be  used if the modem does not support any
2543              Class2BUGCmd.
2544
2545       Class2CIGCmd
2546              The command used to set a polling identifier.   This  string  is
2547              inserted into the format ``%s="<id>"''.
2548
2549       Class2CQCmd
2550              The  command to use to set up parameters for copy quality check‐
2551              ing.  For example, for an Everex  24/96D  modem  this  parameter
2552              might   be  set  to  ``AT+FCQ=1\nAT+FBADMUL=20\nAT+FBADLIN=10''.
2553              Class2CQCmd should be configured to set-up  all  available  copy
2554              quality  services  available  per  Class2CQQueryCmd.  To disable
2555              features that are available, configure Class2CQQueryCmd  with  a
2556              ``!'', and then set Class2CQCmd accordingly.
2557
2558       Class2CQQueryCmd
2559              The  command  to send to the modem to get the copy quality capa‐
2560              bilities string.  If the parameter begins with a ``!'', then the
2561              remainder  of  the string is taken to be the capabilities string
2562              and no command is issued to the modem; this can be used together
2563              with  the  Class2CQCmd to force copy quality checking to be done
2564              in the server instead of in the modem.   See  also  PercentGood‐
2565              Lines  and  MaxConsecutiveBadLines  for  parameters  used  to do
2566              server copy quality checking.  If copy quality checking is  con‐
2567              figured  to  be  done  by  the  modem then it is not done by the
2568              server.
2569
2570       Class2CRCmd
2571              The command to use to enable the reception of facsimile.
2572
2573       Class2DCCCmd
2574              The command used to set  modem  capabilities.   This  string  is
2575              inserted into the format ``%s=vr,br,wd,ln,df,ec,bf,st''.
2576
2577       Class2DCCQueryCmd
2578              The command to send to the modem to get the Class 2/2.0 capabil‐
2579              ities.  If the parameter begins with a ``!'', then the remainder
2580              of the string is taken to be the capabilities string and no com‐
2581              mand is issued to the modem.
2582
2583       Class2DDISCmd
2584              The command to set  session  parameters  before  dialing.   This
2585              string       is       inserted       into       the       format
2586              ``%s=vr,br,wd,ln,df,ec,bf,st''.  Setting this parameter  enables
2587              support  for  Class  2 modems that do not properly implement the
2588              ``AT+FDIS'' command by  setting  up  session  parameters  before
2589              dialing the telephone.
2590
2591       Class2DISCmd
2592              The  command  used  to set the current session parameters.  This
2593              string       is       inserted       into       the       format
2594              ``%s=vr,br,wd,ln,df,ec,bf,st''.
2595
2596       Class2ECMType
2597              The interpretation of the EC parameter in the modem DCC response
2598              varies between the Class 2, ``2'', and Class 2.0, ``2.0'', spec‐
2599              ifications.  This configuration parameter allows the administra‐
2600              tor to specify which type to use.  The corresponding  specifica‐
2601              tion type is used by default.
2602
2603       Class2HexNSF
2604              Whether  or  not  to parse the NSF strings reported by the modem
2605              using hexadecimal values.  By default, they are parsed as  hexa‐
2606              decimal values.
2607
2608       Class2HFLOCmd
2609              The command to setup hardware (RTS/CTS) flow control between DTE
2610              and DCE when operating in Class 2/2.0.  This command  is  issued
2611              immediately  after  sending the Class2Cmd to switch the modem to
2612              Class 2/2.0 operation.  For Class 2.0 operation the  default  is
2613              ``AT+FLO=2''.
2614
2615       Class2JBIGSupport
2616              Whether  or  not to enable support for T.85 monochrome facsimile
2617              with JBIG compression.  Options are ``true'' for support in both
2618              sending  and  receiving,  ``false'' for no support, ``send'' for
2619              support only in sending, and ``receive''  for  support  only  in
2620              receiving.   If  the  modem  supports JBIG, and during the build
2621              process a compatible JBIG library was found then send support is
2622              enabled  by default.  If the modem supports JBIG, and during the
2623              build process the TIFF tools are  found  to  support  JBIG  then
2624              receive support is enabled by default.
2625
2626       Class2JPEGSupport
2627              Whether  or  not to enable and utilize the JPEG support found in
2628              the modem.
2629
2630       Class2LIDCmd
2631              The command used to  set  the  local  identifier  string.   This
2632              string is inserted into the format ``%s="<id>"''
2633
2634       Class2MINSPCmd
2635              The command used to set the minimum acceptable speed to be nego‐
2636              tiated for transmitting page data.  This string is inserted into
2637              the format ``%s=<speed>''
2638
2639       Class2NFLOCmd
2640              The  command  to  setup no flow control between DTE and DCE when
2641              operating in Class 2/2.0.  This command  is  issued  immediately
2642              after sending the Class2Cmd to switch the modem to Class 2 oper‐
2643              ation.  For Class 2.0 operation the default is ``AT+FLO=0''.
2644
2645       Class2NRCmd
2646              (Class 2.0  only)  The  command  to  setup  negotiation  message
2647              reporting.   For  the  correct operation of the Class 2.0 driver
2648              this command must enable the reporting of: receiver  parameters,
2649              transmitter  parameters, and ID strings.  It is not necessary to
2650              enable reporting of non-standard frames for correct operation of
2651              the Class 2.0 driver.
2652
2653       Class2PACmd
2654              A  largely  unused  option for modems supporting ITU-T.32, Class
2655              2.1, standards.  This command  would  be  used  to  set  up  the
2656              polling address string enabled by the Class2APCmd.
2657
2658       Class2PHCTOCmd
2659              The command to use to set the Phase C timeout parameter (in sec‐
2660              onds).  The value ``none'' may be used if  the  modem  does  not
2661              support any Class2PHCTOCmd.
2662
2663       Class2PIECmd
2664              (Class  2.0 only) The command to use to control procedure inter‐
2665              rupt handling.  Procedure interrupts should be disabled  because
2666              HylaFAX  does  not provide a mechanism for dispatching procedure
2667              interrupts to an administrator.
2668
2669       Class2PTSCmd
2670              The command to use to set the received page status  code.   When
2671              copy  quality  checking is done in the host, this command may be
2672              used to control the post-page response delivered to the  sender.
2673              Beware  that  some modems do not properly implement this command
2674              in which case the server should be configured  to  not  do  copy
2675              quality  check:  see the PercentGoodLines and MaxConsecutiveBad‐
2676              Lines parameters to understand how to defeat copy quality check‐
2677              ing.
2678
2679       Class2PTSQueryCmd
2680              The command to use to query the received page status code.  This
2681              command may be used to determine the post-page response returned
2682              from  the  receiver.   Beware  that  some modems do not properly
2683              implement this command in which case this setting should be  set
2684              to ``none''.
2685
2686       Class2PWCmd
2687              A  largely  unused  option for modems supporting ITU-T.32, Class
2688              2.1, standards.  This command would be used to set up the  pass‐
2689              word string enabled by the Class2APCmd.
2690
2691       Class2RecvDataTrigger
2692              The  character  to send to the modem to trigger the transmission
2693              of received data from the modem to the host.  This character  is
2694              specified to be DC1 (octal 21) in the draft specification 2388-A
2695              and DC2 (octal 22) in the 2388-B specification.   Most  Class  2
2696              modems accept DC1 or both DC1 and DC2.  Some modems however only
2697              accept DC2.  Note that string parameters may use C-style  escape
2698              sequences,   so   DC2,   for  example,  would  be  specified  as
2699              ``"\022"''.
2700
2701       Class2RELCmd
2702              The command to use to enable the delivery  of  byte-aligned  EOL
2703              codes in received facsimile.  If this parameter is defined, then
2704              received facsimile data will be  marked  to  indicate  that  EOL
2705              codes  are  byte-aligned;  otherwise  they will be marked as not
2706              (necessarily) having byte-aligned codes.
2707
2708       Class2RTFCC
2709              Whether or not to enable MultiTech's Real-Time  Fax  Compression
2710              Conversion  which  is  available in later firmware revisions for
2711              the MT5634ZBA-V92, MT5634ZPX-PCI-V92, and other  models.   RTFCC
2712              allows  HylaFAX  to  convert the image compression between MH MR
2713              and MMR formats regardless of how faxq formatted the image file.
2714              If  RTFCC  is available with your firmware, then the response to
2715              ``AT+FFC=?'' is non-zero.  Note that when using RTFCC, the  com‐
2716              pression  format  of  the file will be ignored, thus the ``-1'',
2717              ``-2'', and ``-3'' options for sendfax, ps2fax, and others  will
2718              not influence the actual negotiated session parameters.
2719
2720       Class2SACmd
2721              A  largely  unused  option for modems supporting ITU-T.32, Class
2722              2.1, standards.  This command would be used to set up the desti‐
2723              nation subaddress string enabled by the Class2APCmd.
2724
2725       Class2SendRTC
2726              Whether or not to append an explicit ``Return To Control'' (RTC)
2727              signal to the page data when  transmitting.   The  Class  2  and
2728              Class  2.0 specs (i.e. SP-2388-A and TIA/EIA-592) state that the
2729              modem will append RTC when it  receives  the  post-page  message
2730              command  from  the  host; this parameter is provided in case the
2731              modem does not correctly implement this.
2732
2733       Class2SFLOCmd
2734              The command to setup software (XON/XOFF)  flow  control  between
2735              DTE  and  DCE  when  operating  in Class 2/2.0.  This command is
2736              issued immediately after sending the  Class2Cmd  to  switch  the
2737              modem  to  Class  2/2.0  operation.  For Class 2.0 operation the
2738              default is ``AT+FLO=1''.
2739
2740       Class2SPLCmd
2741              The command to use to  enable  a  polling  request.   The  value
2742              ``none''  may  be  used  if  the  modem  does  not  support  any
2743              Class2SPLCmd.
2744
2745       Class2TBCCmd
2746              The command to use to enable stream-mode  communication  between
2747              the host and modem.  The value ``none'' may be used if the modem
2748              does not support any Class2TBCCmd.
2749
2750       Class2UseLineCount
2751              Whether or not to use the line count reported to HylaFAX by  the
2752              modem firmware decoder.
2753
2754       Class2UseHex
2755              Whether or not to parse the capabilities strings reported by the
2756              modem using hexadecimal values.  By default, they are parsed  as
2757              decimal values.
2758
2759       Class2XmitWaitForXON
2760              Whether  or  not  to  wait  for  an XON character from the modem
2761              before sending facsimile data to  the  modem  for  transmission.
2762              Note  that  this is only relevant for modems that conform to the
2763              Class 2 spec (i.e.  SP-2388-A).   The  Class  2.0  specification
2764              states  that the host may transmit data immediately upon receiv‐
2765              ing CONNECT and that no XON character will be sent to the host.
2766
2768       The following parameters are specific to the configuration  and  opera‐
2769       tion  of the IXO/TAP and UCP support for sending pager messages and GSM
2770       SM. Parameter not used for UCP are marked with ``(IXO/TAP only)''.
2771
2772       PagerSetupCmds
2773              The commands to send to a modem to prepare the modem for a  call
2774              to  pager  service  provider.   Typically  these  commands place
2775              direct the modem to communicate with the service provider at 300
2776              bps  using  the  V.21  protocol.   Per-service  provider command
2777              strings can be setup in the info database; see hylafax-info(5F).
2778
2779       PagerMaxMsgLength
2780              The maximum length for a pager text  message.   Messages  longer
2781              than  this  number  are truncated.  Per-service provider message
2782              lengths can be setup in the info database; see hylafax-info(5F).
2783
2784       IXOService
2785              (IXO/TAP only) The service identification string transmitted  as
2786              part of the IXO/TAP protocol.
2787
2788       IXODeviceID
2789              (IXO/TAP  only) The terminal device identification string trans‐
2790              mitted as part of the IXO/TAP protocol.
2791
2792       IXOMaxUnknown
2793              The  maximum  number  of  unrecognized  messages  that  will  be
2794              accepted  at  various  stages of the IXO/TAP protocol before the
2795              sender will abort and hang up the phone.
2796
2797       IXOIDProbe
2798              (IXO/TAP only) The time, in seconds, between  sending  a  ``\r''
2799              during the initial ID recognition sequence of the IXO/TAP proto‐
2800              col.
2801
2802       IXOIDTimeout
2803              (IXO/TAP only) The maximum time, in seconds,  to  wait  for  the
2804              initial ID response from the service provider.
2805
2806       IXOLoginRetries
2807              (IXO/TAP only) The maximum number of attempts to login to a ser‐
2808              vice provider.
2809
2810       IXOLoginTimeout
2811              (IXO/TAP only) The maximum time, in seconds, to wait to complete
2812              the login procedure.
2813
2814       IXOGATimeout
2815              (IXO/TAP  only)  The maximum time, in seconds, to wait for a Go-
2816              Ahead message from the service provider.
2817
2818       IXOXmitRetries
2819              The maximum number of times to try sending a text message  block
2820              in a single call.
2821
2822       IXOXmitTimeout
2823              The maximum time, in seconds, to try transmitting a text message
2824              block.
2825
2826       IXOAckTimeout
2827              (IXO/TAP only) integer          30                      IXO: max
2828              time  to wait for msg block ack (secs) The maximum time, in sec‐
2829              onds, to wait for an acknowledgement to a transmitted message.
2830

PROTOTYPE CONFIGURATION FILES

2832       Per-modem configuration files  are  typically  derived  from  prototype
2833       files  that  have been created for known modems.  These prototype files
2834       are kept in the config subdirectory and, by convention, have names that
2835       identify  a  brand or type of modem and the DTE-DCE flow control scheme
2836       the prototype files configures.  The faxaddmodem(8C)  program  that  is
2837       used to configure a modem for use with HylaFAX selects a prototype con‐
2838       figuration file using information retrieved from the modem and comments
2839       embedded  in  the  prototype  files.  For Class 1 modems the product ID
2840       code returned by the command ``ATI0'' and the response from the command
2841       ``ATI3''  are  used to select a prototype configuration file, while for
2842       Class 2 modems the manufacturer and model as returned  by  ``AT+FMFR?''
2843       and   ``AT+FMDL?'',   respectively,   are   used  (or  ``AT+FMI?''  and
2844       ``AT+FMM?'' for Class 2.0 modems).
2845
2846       A Class 1 prototype configuration file is identified for use by  faxad‐
2847       dmodem by searching for a comment of the form:
2848       # CONFIG:CLASS1:144:.*:RTSCTS: Manufacturer='AT&T' Model=Dataport
2849       In  this  example  ``144''  is the product ID code for an AT&T DataPort
2850       modem, ``.*'' is a regular expression matched against the result string
2851       returned by the ``ATI3'' command, and ``RTSCTS'' indicates the modem is
2852       configured to use hardware flow  control  during  fax  operation.   The
2853       remainder of the line is evaluated by the sh(1) and used to specify the
2854       modem's manufacturer and model (since Class 1 modems do not have  stan‐
2855       dard commands to query this information).
2856
2857       Class  2 and 2.0 prototype configuration files match the string ``manu‐
2858       facturer-model-flowcontrol'' against a sh(1) glob pattern specified  in
2859       the  configuration  file,  where manufacturer and model are the strings
2860       returned by querying the modem and flowcontrol is either ``RTSCTS'' for
2861       hardware  flow  control  or ``XONXOFF'' for software flow control.  For
2862       example:
2863       # CONFIG: CLASS2: ZyXEL*-RTSCTS
2864       # CONFIG: CLASS2.0: USRobotics*-XONXOFF
2865       are configuration comments that appear in  the  prototype  file  for  a
2866       ZyXEL  1496E  with Class 2 support, and for a US Robotics Courier modem
2867       with Class 2.0 firmware.
2868
2869       The faxaddmodem program merges server-specific configuration parameters
2870       into a prototype configuration according to comments placed in the pro‐
2871       totype file.  All lines  between  ``BEGIN-SERVER''  and  ``END-SERVER''
2872       comments  are  placed with the appropriate server configuration parame‐
2873       ters.  Note that this means modem-related configuration parameters must
2874       be placed outside this area of the file.
2875

SEE ALSO

2877       faxaddmodem(8C),    faxq(8C),   faxgetty(8C),   faxsend(8C),   hylafax-
2878       server(5F)
2879
2880
2881
2882             $Date: 2013-02-26 15:46:36 -0800 (Tue, 26 Feb 20H1Y3L)AF$AX-CONFIG(5F)
Impressum