MAN page from RedHat Other hylafax-man-4.0pl1-9.i386.rpm

CONFIG

Section: Misc. Reference Manual Pages (5F)
Updated: August 28, 1996
Index 

NAME

config - HylaFAX configuration database 

DESCRIPTION

HylaFAX uses a configuration file for the central queueingagent and for each facsimile modem attachedto a machine.These files contain information about the modems and about howthe HylaFAX server processes that service these modem should operate.Configuration files are located in theetcsubdirectory.The configuration file for the faxq(8C)program is namedconfig.The per-modem configuration files used by thefaxgetty(8C),faxsend(8C),andpagesend(8C)programs have names of the formconfig.devid,wheredevidis an identifier derived from the name ofthe modem's device file; for examplettym2for/dev/ttym2,term_10for/dev/term/10.

Configuration files have a simple format and are entirelyASCII.A configuration parameter is of the form

     tag: value

where a tag identifies a parameter and a valueis either a string, number, or boolean value.Comments are introduced by the ``#'' characterand extend to the end of the line.String values start at the first non-blank characterafter the ``:'' and continue to the first non-whitespacecharacter or, if whitespace is to be included, may beenclosed in quote marks (``"'').String values enclosed in quote marks may also use thestandard C programming conventions for specifying escapecodes; e.g. ``\n'' for a newline character and ``\xxx''for an octal value.Numeric values are specified according to the C programmingconventions (leading ``0x'' for hex, leading ``0'' for octal, otherwisedecimal), except for a few parameters, such asRecvFileMode,whose value is interpreted strictly as an octal numberandPageChopThresholdwhose value is interpreted strictly as a floating point number.Boolean values are case insensitive.For a true value, either ``Yes'' or ``On'' shouldbe used.For a false value, use ``No'' or ``Off''.

The following table itemizes the tags and the expected typeof their value.The first part lists items specific to the operation of eachserver, while the second part has items related to theservicing of the modem.Parameters marked with a - are used onlyby the HylaFAX scheduler process and should appear only in the file namedconfig.Parameters marked with a = are used by both the scheduler andthe per-device applications and so should appear in all appropriateconfiguration files (i.e. configand any per-device files that make sense).Parameters not otherwise marked should appear only in per-deviceconfiguration files.More detailed information about each item is given following the table.

Tag                           Type       Default            DescriptionAdaptiveAnswer                boolean    No                 enable adaptive answer of inbound callsAnswerRotary                  string     Any                alternatives for answering callsAnswerBias                    integer    -                  bias to apply to successful rotary answer AreaCode=                     string     -                  local area codeCIDName                       string     -                  Caller ID name pattern stringCIDNumber                     string     -                  Caller ID number pattern stringClocalAsRoot                  boolean    No                 set CLOCAL using root UIDContCoverCmd-                 string     bin/mkcover        continuation cover page generation scriptContCoverPage-                string     -                  continuation cover page template filenameCountryCode=                  string     -                  local country codeDestControls-                 string     -                  per-destination controls fileDeviceMode                    octal      0600               protection mode to use for modem deviceDialStringRules=              string     -                  dial string rules fileFAXNumber                     string     -                  facsimile modem phone numberFaxRcvdCmd                    string     bin/faxrcvd        notification script for received facsimileGettyArgs                     string     -                  arguments passed to getty programInternationalPrefix=          string     -                  dialing prefix for international callsJobReqBusy                    integer    180                requeue interval for BUSY dial resultJobReqDataConn                integer    300                requeue interval for data connection dial resultJobReqNoAnswer                integer    300                requeue interval for NO ANSWER dial resultJobReqNoCarrier               integer    300                requeue interval for NO CARRIER dial resultJobReqNoFCon                  integer    300                requeue interval for carrier without +FCON dial resultJobReqOther=                  integer    300                requeue interval for ``other'' problemsJobReqProto                   integer    60                 requeue interval after fax protocol errorLockDataCalls                 boolean    Yes                lock modem for the duration of an inbound data callLockVoiceCalls                boolean    Yes                lock modem for the duration of an inbound voice callLogFacility=                  string     daemon             syslog facility name for ServerTracing messagesLogFileMode                   octal      0600               protection mode to use for session log filesLocalIdentifier               string     -                  local station identification stringLongDistancePrefix            string     -                  dialing prefix for long distance callsMaxConcurrentJobs-            integer    1                  max concurrent jobs to process for a destinationMaxConsecutiveBadLines        integer    5                  max consecutive bad rows for OK page qualityMaxDials-                     integer    unlimited          max phone calls to make to transmit a jobMaxRecvPages                  integer    unlimited          max pages to permit in a receiveMaxSendPages-                 integer    unlimited          max pages to permit in a sendMaxSetupAttempts              integer    2                  max attempts to initialize a modemMaxTries-                     integer    3                  max attempts to transmit a jobModemClass-                   string     -                  define a name for a set of modemsModemPriority                 integer    255                scheduling priority for outbound jobsModemReadyState               string     R                  ``ready state'' sent by faxgettyNoCarrierRetrys               integer    1                  number of times to retry dialing on ``NO CARRIER''NotifyCmd=                    string     bin/notify         user notification command scriptPageChop-                     string     last               control automatic truncation of trailing whitespacePageChopThreshold-            float      3.0                whitespace truncation threshold (inches)PCL2FaxCmd-                   string     bin/pcl2fax        PCL RIP command scriptPercentGoodLines              integer    95                 percentage of good rows for OK page qualityPollLockWait=                 integer    30                 polling interval when in ``lock wait'' state (secs)PollModemWait                 integer    30                 polling interval when in ``modem wait'' state (secs)PollRcvdCmd                   string     bin/pollrcvd       delivery script for facsimile received by pollingPostScriptTimeout-            integer    300                timeout on POSTSCRIPT interpreter runs (secs)PS2FaxCmd-                    string     bin/ps2fax         POSTSCRIPT RIP command scriptQualifyCID                    string     -                  file of Caller-ID patterns for checking inbound callsQualifyTSI                    string     -                  file of TSI patterns for qualifying sendersRecvDataFormat                string     adaptive           format for received facsimile dataRecvFileMode                  octal      0600               protection mode to use for received facsimile filesRingData                      string     -                  distinctive ring data call identifierRingFax                       string     -                  distinctive ring fax call identifierRingsBeforeAnswer             integer    0                  rings to wait before answering phoneRingVoice                     string     -                  distinctive ring voice call identifierSendFaxCmd-                   string     bin/faxsend        fax transmit command scriptSendPageCmd-                  string     bin/pagesend       pager transmit command scriptSendUUCPCmd-                  string     bin/uucpsend       UUCP transmit command scriptServerTracing=                integer    1                  non-session server tracingSessionTracing=               integer    1                  send and receive session tracingSpeakerVolume                 string     Quiet              volume level for modem speakerTagLineFont                   string     -                  tag line font filenameTagLineFormat                 string     see below          tag line format stringTIFF2FaxCmd-                  string     bin/tiff2fax       TIFF converter command scriptTimeOfDay-                    string     Any                default time-of-day restrictionsUse2D-                        boolean    Yes                restrict/permit use of 2D-encoded fax dataUUCPLockMode=                 octal      0600               protection mode for UUCP lock filesUUCPLockDir=                  string     see below          UUCP lockfile directoryUUCPLockTimeout=              integer    30                 time before removing stale UUCP lockfileUUCPLockType=                 string     see below          UUCP lockfile typeVGettyArgs                    string     -                  arguments passed to voice getty programWedgedCmd-                    string     bin/wedged         command to run when modem is wedgedModemAnswerCmd                string     ATA                command for answering phoneModemAnswerDataBeginCmd       string     -                  command for start of answered data callModemAnswerDataCmd            string     ATA                command for answering data callModemAnswerFaxBeginCmd        string     -                  command for start of answered fax callModemAnswerFaxCmd             string     ATA                command for answering fax callModemAnswerResponseTimeout    integer    180000             answer command timeout (ms)ModemAnswerVoiceBeginCmd      string     -                  command for start of answered voice callModemAnswerVoiceCmd           string     ATA                command for answering voice callModemATCmdDelay               integer    0                  delay before sending modem an AT cmd (ms)ModemBaudRateDelay            integer    0                  delay (ms) after setting baud rateModemClassQueryCmd            string     AT+FCLASS=?        command for querying modem servicesModemCommaPauseTimeCmd        string     ATS8=2             command for setting time to pause for ``,'' in dialing stringModemDialCmd                  string     ATDT%s             command for dialing (%s for number to dial)ModemDialResponseTimeout      integer    180000             dialing command timeout (ms)ModemEchoOffCmd               string     ATE0               command for disabling command echoModemFlowControl              string     None               DTE-DCE flow control schemeModemFrameFillOrder           string     LSB2MSB            bit order for HDLC framesModemHardFlowCmd              string     -                  command for setting hardware flow control between DTE and DCEModemMinSpeed                 string     2400               minimum acceptable transmit speedModemMfrQueryCmd              string     -                  command for querying modem manufacturerModemModelQueryCmd            string     -                  command for querying modem modelModemNoAutoAnswerCmd          string     ATS0=0             command for disabling auto-answerModemNoFlowCmd                string     -                  command for disabling hardware flow control between DTE and DCEModemOnHookCmd                string     ATH0               command for placing phone ``on hook''ModemPageDoneTimeout          integer    180000             page send/receive timeout (ms)ModemPageStartTimeout         integer    180000             page send/receive timeout (ms)ModemRate                     integer    19200              baud rate to use for DCE-DTE communicationModemRecvFillOrder            string     LSB2MSB            bit order for received facsimile dataModemResetCmds                string     -                  additional commands when resetting modemModemResetDelay               integer    2600               delay (ms) after sending modem reset commandsModemResultCodesCmd           string     ATQ0               command for enabling result codesModemRevQueryCmd              string     see below          command for querying modem firmware revisionModemSendBeginCmd             string     -                  command to send on establishing carrierModemSendFillOrder            string     LSB2MSB            bit order for sending facsimile dataModemSetVolumeCmd             string     see below          commands for setting modem speaker volume levelModemSetupAACmd               string     -                  command for setting up adaptive answerModemSetupDCDCmd              string     -                  command for setting up DCD handlingModemSetupDTRCmd              string     -                  command for setting up DTR handlingModemSoftFlowCmd              string     -                  command for setting software flow control between DTE and DCEModemSoftResetCmd             string     ATZ                command for doing a soft resetModemType                     string     -                  modem typeModemVerboseResultsCmd        string     ATV1               command for enabling verbose result codesModemWaitForConnect           boolean    No                 force server to wait for ``CONNECT'' response on answerModemWaitTimeCmd              string     ATS7=60            command for setting time to wait for carrier when dialingFaxT1Timer                    integer    35000              CCITT T.30 T1 timer (ms)FaxT2Timer                    integer    7000               CCITT T.30 T2 timer (ms)FaxT4Timer                    integer    3100               CCITT T.30 T4 timer (ms)Class0Cmd                     string     AT+FCLASS=0        Class 0: command to enter class 0Class1Cmd                     string     AT+FCLASS=1        Class 1: command to enter class 1Class1HFLOCmd                 string     -                  Class 1: command to set hardware flow controlClass1FrameOverhead           integer    4                  Class 1: extra bytes in a received HDLC frameClass1NFLOCmd                 string     -                  Class 1: command to set no flow controlClass1RecvAbortOK             integer    100                Class 1: max wait (ms) for ``OK'' after recv abortClass1RecvIdentTimer          integer    35000              Class 1: max wait (ms) for initial ident frameClass1SFLOCmd                 string     -                  Class 1: command to set software flow controlClass1TCFMaxNonZero           integer    10                 Class 1: max% of non-zero data in good TCFClass1TCFMinRun               integer    1000               Class 1: minimum zero run in good TCFClass1TCFRecvTimeout          integer    4500               Class 1: max wait (ms) for TCFClass1TCFResponseDelay        integer    75                 Class 1: delay between TCF and ack/nakClass1SendPPMDelay            integer    75                 Class 1: delay before sending post-page messageClass1SendTCFDelay            integer    75                 Class 1: delay between sending DCS and TCFClass1TrainingRecovery        integer    1500               Class 1: delay after failed trainingClass2Cmd                     string     AT+FCLASS=2        Class 2: command to enter class 2/2.0Class2AbortCmd                string     AT+FK              Class 2: command to abort active sessionClass2BORCmd                  string     AT+FBOR=0          Class 2: command to setup bit orderClass2BUGCmd                  string     AT+FBUG=1          Class 2: command to enable HDLC frame tracingClass2CIGCmd                  string     AT+FCIG            Class 2: command to set polling identifierClass2CRCmd                   string     AT+FCR=1           Class 2: command to enable receive capabilityClass2CQCmd                   string     -                  Class 2: command to setup copy quality parametersClass2CQQueryCmd              string     AT+FCQ=?           Class 2: command to query modem copy quality capabilitiesClass2DCCCmd                  string     AT+FDCC            Class 2: command to set modem capabilitiesClass2DCCQueryCmd             string     AT+FDCC=?          Class 2: command to query modem capabilitiesClass2DISCmd                  string     AT+FDIS            Class 2: command to set session parametersClass2DDISCmd                 string     -                  Class 2: command to set session parameters before dialingClass2HFLOCmd                 string     -                  Class 2: command to set hardware flow controlClass2LIDCmd                  string     AT+FLID            Class 2: command to set local identifier stringClass2MINSPCmd                string     AT+FMINSP          Class 2: command to set minimum transmit speedClass2NFLOCmd                 string     -                  Class 2: command to set no flow controlClass2PHCTOCmd                string     AT+FPHCTO=30       Class 2: command to set Phase C timeout parameterClass2PTSCmd                  string     AT+FPTS            Class 2: command to set received page statusClass2RecvDataTrigger         string     ``\21''            Class 2: character to send to trigger recvClass2RELCmd                  string     -                  Class 2: command to enable byte-aligned EOL codesClass2SendRTC                 boolean    No                 Class 2: append RTC to page data on transmitClass2SFLOCmd                 string     -                  Class 2: command to set software flow controlClass2SPLCmd                  string     AT+FSPL            Class 2: command to set polling requestClass2TBCCmd                  string     AT+FTBC=0          Class 2: command to enable stream modeClass2XmitWaitForXON          boolean    Yes                Class 2: wait for XON before sending facsimile dataClass2Cmd                     string     AT+FCLASS=2.0      Class 2.0: command to enter class 2/2.0Class2AbortCmd                string     AT+FKS             Class 2.0: command to abort active sessionClass2BORCmd                  string     AT+FBO=0           Class 2.0: command to setup bit orderClass2BUGCmd                  string     AT+FBU=1           Class 2.0: command to enable HDLC frame tracingClass2CIGCmd                  string     AT+FPI             Class 2.0: command to set polling identifierClass2CRCmd                   string     AT+FCR=1           Class 2.0: command to enable receive capabilityClass2CQCmd                   string     -                  Class 2.0: command to setup copy quality parametersClass2DCCCmd                  string     AT+FCC             Class 2.0: command to set modem capabilitiesClass2DCCQueryCmd             string     AT+FCC=?           Class 2.0: command to query modem capabilitiesClass2DISCmd                  string     AT+FIS             Class 2.0: command to set session parametersClass2HFLOCmd                 string     AT+FLO=2           Class 2.0: command to set hardware flow controlClass2LIDCmd                  string     AT+FLI             Class 2.0: command to set local identifier stringClass2MINSPCmd                string     AT+FMS             Class 2.0: command to set minimum transmit speedClass2NFLOCmd                 string     AT+FLO=0           Class 2.0: command to set no flow controlClass2NRCmd                   string     AT+FNR=1,1,1,1     Class 2.0: command to set negotiation message reportingClass2PHCTOCmd                string     AT+FCT=30          Class 2.0: command to set Phase C timeout parameterClass2PIECmd                  string     AT+FIE=0           Class 2.0: command to set procedure interrupt handlingClass2PTSCmd                  string     AT+FPS             Class 2.0: command to set received page statusClass2RecvDataTrigger         string     ``\22''            Class 2.0: character to send to trigger recvClass2RELCmd                  string     -                  Class 2.0: command to enable byte-aligned EOL codesClass2SFLOCmd                 string     AT+FLO=1           Class 2.0: command to set software flow controlClass2SPLCmd                  string     AT+FSP             Class 2.0: command to set polling requestClass2TBCCmd                  string     AT+FPP=0           Class 2.0: command to enable stream modePagerSetupCmds                string     -                  commands for setting up modem for a pager callPagerMaxMsgLength             integer    128                max length of a text message IXOService                    string     ``PG''             IXO: service identification stringIXODeviceID                   string     ``1''              IXO: device identification stringIXOMaxUnknown                 integer    3                  IXO: max unknown responses before abortIXOIDProbe                    integer    2                  IXO: time between sending \r during ID sequence (secs)IXOIDTimeout                  integer    20                 IXO: max time to wait for ID= response (secs)IXOLoginRetries               integer    3                  IXO: max attempts to loginIXOLoginTimeout               integer    15                 IXO: max time to complete login (secs)IXOGATimeout                  integer    30                 IXO: max time to wait for Go-Ahead response (secs)IXOXmitRetries                integer    3                  IXO: max retries to send text msg blockIXOXmitTimeout                integer    15                 IXO: max time to transmit text msg blockIXOAckTimeout                 integer    30                 IXO: max time to wait for msg block ack (secs)

 

SERVER-ORIENTED CONFIGURATION PARAMETERS

These configuration parameters affect the generaloperation of the fax server.

AdaptiveAnswer

Control whether or not an adaptive answeringstrategy is used whereby an incoming call isanswered in multiple ways according to the list specified in theAnswerRotaryparameter.For example, if adaptive answering is enabled andAnswerRotaryspecifies ``fax data'', then an incoming call willfirst be answered as fax usingModemAnswerFaxCmdand then, if that fails, as data usingModemAnswerDataCmd.If the adaptive answer strategy is not enabled, then callsare answered using the appropriateModemAnswer*Cmdparameter (normallyModemAnswerCmdfor unattended operation).Note that the adaptive answer strategy depends on many factorsthat limit its usefulness.When calls are answered first as fax,it typically only works with a Class 1 modem because it isimportant that the sequence of operations related to answeringas fax be completed in a short enough time that a subsequentanswer for data be done before the caller times out and hangsup the telephone(for this reasonClass1RecvIdentTimershould be set to a value that is shorter thanFaxT1Timer.)Also, note that it is sometimes necessary to arrange that the phone beplaced on-hook between successive answers; this can typically bedone by inserting the appropriate command at the start of thesecond and subsequentModemAnswer*Cmds.

AnswerRotary

The sequence of answering techniques the server should``rotate through'' when answer incoming calls.Answering techniques are:

Name      Descriptionfax       answer a fax calldata      answer a data callvoice     answer a voice callextern    use the vgetty application to answer a callany       answer a call of any/unknown type

When a call is not answered succesfully, the serveradvances the rotary to the next specified answeringtechnique.IfAdaptiveAnsweris enabled, the server will try all the answering techniques foreach incoming call.Otherwise, the rotary is advancedbetweenunsuccessful phone calls.For example, ifAdaptiveAnsweris disabled andAnswerRotaryis ``fax data'',then the calls will initially be answered as fax untilthe first call is received that does not appear to befrom a fax machine; after that calls will be answeredas if they were from a data modem until the next unsuccessfulcall; after which they will one again be answered as fax. Only the first three techniques listed are used; any additionalones are (silently) ignored.See alsoAnswerBias.

AnswerBias

The index into theAnswerRotarylist that the server should rotate the list to aftereach successful incoming phone call.List indices are numbered starting at zero.For example, ifAnswerRotaryis ``fax data'' andAnswerBiasis 1, then after each successful inbound call, thenext call will be answered as data.

AreaCode=

The local area code in which the facsimile modem resides.This value is passed to the dial string rules that areused, for example,to formulate canonical phone numbers for dialing (seeDialStringRulesbelow.)

CIDName

A string that identifies the caller's identity in any Caller-IDstatus messages.The specified string is compared against anyunrecognized status messages received from the modem before thephone is placed off-hook.If there is a match, then the remainderof the message is returned as the ``caller name''.For example, for the ZyXEL U-1496 this parameter would be set to``CALLER NAME: '' (note the trailing space).See alsoCIDNumberandQualifyCID.

CIDNumber

A string that identifies the caller's phone number in any Caller-IDstatus messages.The specified string is compared against anyunrecognized status messages received from the modem before thephone is placed off-hook.If there is a match, then the remainderof the message is returned as the phone number of the caller.For example, for the ZyXEL U-1496 this parameter would be set to``CALLER NUMBER: ''.See alsoCIDNameandQualifyCID.

ClocalAsRoot

Control whether operations that set theCLOCALbit on the modem device special file are done with the effectiveuser-ID set to the super-user or the ``fax'' user.By default such operations are done as the fax user, except underIRIXwhere they are done as the super-user(because IRIXdisallows manipulation ofCLOCALby anyone but the super-user).

ContCoverCmd-

The command to invoke to generate a continuation cover page; seeContCoverPageandmkcover(8C).

ContCoverPage-

A template file to use in creatingcontinuation cover pages.If this parameter is non-null, then the server will pass thefilename to the command specified byContCoverCmdto generate cover pages for outbound jobs that arecontinued after protocol errors.These cover pages identify the receiver and indicate that the document is a continued transmission.If this parameter is not specified or is null, then the serverwill not generate continuation cover pages.The specified pathname must be relative to the top of the fax server'sspooling area.

CountryCode=

The local country code in which the facsimile modem resides.As forAreaCode,this value is passed to the dial string rules for use informulating canonical phone numbers for dialing (amongother things.)

DestControls-

An optional file containing rules for controllingparameters on a per-destination basis; seedestctrls(5F)The following parameters may be controlled with this mechanism:MaxConcurrentJobs,MaxDials,MaxSendPages,MaxTries,RejectNotice,SessionTracing,andTimeOfDay.If noDestControlsparameter is specified, or if the controls file does notspecify defaultvalues for these parameters, then any settings in theconfigfile used byfaxq(8C)are used for default settings.Note thatfaxqautomatically rereads the contents of aDestControlsfile if it is modified while the server is running.

DeviceMode

The file protection mode that the server should set for themodem device file.Note that this value is given in octal.The default value of 0600 implies that only thefacsimile user (usually uucp)can access the modem.See alsochmod(2).

DialStringRules=

The pathname of the file that holds the rules for processinguser-specified dial strings; c.f.dialrules(5F).The specified pathname must be relative to the top of the fax server'sspooling area; e.g.etc/dialrules.

FAXNumber

The phone number associated with the facsimile modem.This string is used to generate theTransmitter Subscriber Identification (TSI) and Caller Subscriber Identification (CSI) information passed to remote machines---unless theLocalIdentifierparameter is explicitly set.TheFAXNumberis also used to name the session log file where informationfor incoming phone calls is recorded; seelog(5F).If this phone number is not a fully qualified numberthe values ofAreaCodeandCountryCodeare used to generate the transmittedCSIandTSI.

InternationalPrefix=

The string to use to place an international phone call.In the United States, this is ``011''.This string is passed to the dial string rules.

JobReqBusy

The delay in seconds to wait before retrying a job whosedialing attempt failed with a ``BUSY'' status result.

JobReqDataConn

The delay in seconds to wait before retrying a facsimile job whosedialing attempt failed because a data modem answered the phone.

JobReqNoAnswer

The delay in seconds to wait before retrying a job whosedialing attempt failed with a ``NO ANSWER'' status result.

JobReqNoCarrier

The delay in seconds to wait before retrying a job whosedialing attempt failed with a ``NO CARRIER'' status result.

JobReqNoFCon

The delay in seconds to wait before retrying a facsimile job whosedialing attempt failed because the initial facsimile protocolhandshake failed (i.e. no ``+FCON:'' result was receivedfrom a Class 2/2.0 modem).

JobReqOther=

The delay in seconds to wait before retrying a job thatfailed for a reason not already covered by one of theJob*parameters.

JobReqProto

The delay in seconds to wait before retrying a facsimile job thatfailed because of a fax protocol error.

GettyArgs

A string that indicates whether or not the server should invokethegetty(8C)program in response to an incoming call from a data modem.If the string value is not null, then it is interpretedas a set of arguments to pass to the getty program.Before supplying the arguments, the string is first scannedfor ``%''-escape sequences: any appearance of ``%l'' is replacedwith the tty name and any appearance of ``%s'' is replaced withthe serial port speed (in decimal).The ``%'' character can be specified with ``%%''.If theGettyArgsparameter is not specified in the configuration file or ifthe string value is null, then data connections will be rejected.Note that in addition to the specified command line arguments, thegettyprogram is invoked with its standard input, output, and errordescriptors directed to the controlling tty device.

LocalIdentifier

The local station identification string to use when transmittingTSIandCSIstrings (see FAXNumberabove).NB: while this string may contain any printable ASCIIcharacters; beware thatCCITT T.30specifies a restricted character set and some fax modems and machinesmay reject or not display non-conforming strings.If the local identifier is not specified, a canonical form of theFAXNumberis used instead.

LockDataCalls

Hold theUUCPlockfile during the time an inbound data call is processed by theexternal getty program.If this is disabled then the lockfile will be removed just beforethe getty program is invoked.Note however that doing this introduces a race condition wherebyan outbound program may sneak in and take control of the modemafter the inbound call has been accepted, but before the gettyprogram has started up and installed it's own lockfile.

LockVoiceCalls

Hold theUUCPlockfile during the time an inbound data call is processed by theexternal voice getty program.If this is disabled then the lockfile will be removed just beforethe voice getty program is invoked.Note however that doing this introduces a race condition wherebyan outbound program may sneak in and take control of the modemafter the inbound call has been accepted, but before the voice gettyprogram has started up and installed it's own lockfile.

LogFacility=

The symbolic name for the syslog(3)facility to use when logging error messages andinformational/debugging messages requested through theServerTracingparameter.The list of facility names is found in the system include file<syslog.h>;comparisons are case-insensitive.

LogFileMode

The file protection mode that should be used whencreating files to hold session logs.Note that this value is given in octal.The default value of 0600 implies that the log files are notgenerally accessible, which is important if sensitive informationsuch as calling card access codes are logged.If log files are to be publicly accessible, thisvalue may be set, for example, to 0644.See alsochmod(2).

LongDistancePrefix=

The string to use to place a long distance phone call.In the United States, this is ``1''.

MaxConcurrentJobs-

The default value to use for the maximum number of jobs for thesame destination that are processed concurrently.Note that each job is processed with a separate phone call;job batching is not currently supported.Thus this parameter defines the maximum number of concurrent phone callsto the same destination.This value may be overridden by rules in theDestControlsfile.

MaxConsecutiveBadLines

The maximum number of consecutive erroneous rows of image data thatthe server will receive before it deems a page to have unacceptablecopy quality.Setting this parameter to zero causes the server to not checkthe quality of received facsimile.See alsoPercentGoodLines.

MaxDials-

The default value for the maximum number of times the server willplace a call for an outbound job.This value may be overridden by rules in theDestControlsfile.See alsoMaxTries.

MaxRecvPages

The maximum number of pages the server will accept in a receivedfacsimile before it aborts the session.

MaxSendPages-

The default value for the maximum number of pages the server willpermit in a transmitted facsimile.Outbound jobs that exceed this limit are rejected.This value may be overridden by rules in theDestControlsfile.

MaxSetupAttempts

The maximum number of times a HylaFAX server program will attemptto initialize a modem before considering it ``wedged''.

MaxTries-

The default value for the maximum number of times the server willattempt to communicate with a remote site.Note that for a call to be counted against this limit, carrier mustbe established;this is in contrast to the value ofMaxDialswhich limits the number of calls that will be placed on behalfof a job.This value may be overridden by rules in theDestControlsfile.See alsoMaxDials.

ModemClass-

Define a logical name for a set of modem devices.This parameter can be used to define a name that clients can useto refer to a collection of modems.The syntax is ``<name>:<regex>'' where<name>is the name for the class and <regex>is a regular expression that faxq(8C)matches against known modems.Thus for example, the default modem to use for a job,any,is defined as ``any:.*''.This parameter may be specified multiple times to define multiplemodem classes.Modem classes may overlap.The actual set of modems in a modem class that are consideredfor use may vary based on which modems are believed to be ready for use.

ModemPriority

The scheduling priority to use for a modem.Priority values are in the range 0 to 255 with greater values signifyinghigher (more desirable) priority.The HylaFAX scheduler process assigns the highestpriority modem that is ready for use when scheduling an outbound job.

NoCarrierRetrys

The number of times to redial a phone number after receivinga ``NO CARRIER'' result code.In normal operation the fax server will treat this result codeto mean that a facsimile modem/machine did not answer thephone and reject the transmit job.This is done to avoid repeatedly dialing wrong phone numbersand depends on the modem distinguishing betweenno carrier and no answer.However, some modems are not capable of reliablydistinguishing between no carrier and no answer, or when instructedto do so do not identify a busy signal correctly.For these modems one may find it necessary to increase thevalue of this parameter to compensate.It is strongly recommended, however, that this valuenot be set to a large number.

ModemReadyState

Define thestatetransmitted to the HylaFAX scheduler process each time a modemis made ready by afaxgettyprocess.State is one of: ``R'' (ready for use), ``B'' (busy), or ``D'' (down).The modem state can be used to control whether or not modems are assignedto outbound jobs.A modem's state is initially set to ``R'' (ready).Modem state can be dynamically changed with thefaxstate(8C)program or by setting this configuration parameter with thefaxconfig(8C)program.

NotifyCmd=

The command to invoke to notify a client of a job status change; seenotify(8C).

PageChop-

Whether or not to automatically truncate trailing whitespace onpages of outbound facsimile (when possible).If page chopping is enabled, then pages with at leastPageChopThresholdtrailing whitespace on a page will be transmitted as a ``short page''if the receiver is capable of accepting variable-length pages.The possible values are: ``last'' to enable chopping of the lastpage of each document, ``all'' to enable chopping of all pages, or``none'' to disable page chopping.

PageChopThreshold-

The minimum amount of trailing whitespace that must be presenton a page before page chopping will be attempted; see PageChop.Note that this value is specified in inches.

PCL2FaxCmd-

The command to invoke to convert a HP-PCL document submittedfor transmission toTIFF/F,suitable for transmission (for future use).

PercentGoodLines

The minimum percentage of good rows of image data required for a received facsimile page to be deemed to have acceptablecopy quality.Setting this parameter to zero causes the server to notcheck the quality of received facsimile.See alsoMaxConsecutiveBadLines.

PollLockWait

When polling for the presence/removal of a UUCPlockfile, the time (in seconds) to wait between checks.Lockfile polling occurs when the fax server collides withanother process using the modem for outbound use.

PollModemWait

The time (in seconds) to wait between checksfor a modem to become ready for use.Modem polling occurs when a modem fails to reset cleanly.

PS2FaxCmd-

The command to invoke to convert a POSTSCRIPT document submittedfor transmission toTIFF/F,suitable for transmission;seeps2fax(8C).

QualifyCID

A string that specifies whether or not Caller-ID informationshould be checked against an access control list before acceptingan inbound call.If QualifyCIDis non-null and there is Caller-ID service,then only calls from phone numbers identifiedin the file specified by this string (typically etc/cid)will be accepted; seecid(5F).IfQualifyCIDis not specified in the configuration file, or the value isnull, then all incoming calls will be answered.Note that Caller-ID screening is only available when thisservice is enabled on the phone line and the modem is capable ofpresenting Caller-ID status information to the host.TheCIDNumberandCIDNameparameters must also be setup to reflect the manner in whichthe modem returns Caller-ID status information to the host.

QualifyTSI

A string that specifies whether or not the identity of calling facsimile machines should be checked against an accesscontrol list before receiving facsimile.If QualifyTSIis non-null, then only messages from facsimile machines identifiedin the file specified by the string (typically etc/tsi)will be accepted; seetsi(5F).IfQualifyTSIis not specified in the configuration file, or the value isnull, then all incoming facsimile messages will be accepted.

RecvDataFormat

The data format (compression scheme) to write received facsimile datawhen copy quality checking is enabled on the host.(When copy quality checking is not done by the server the receivedfacsimile data is written exactly as it is received from the modem.)The format may be one: ``1-D MR'', ``2-D MR'', ``2-D MMR'', or ``adaptive''.An ``adaptive'' format causes the received data to be written usingthe data format negotiated by the sender and receiver.Note that while 2-D MMR is the most space-efficient data formatthe resultant file may not be viewable (certain commonly used programsdo not properly read multi-strip TIFF with 2-D MMR data).

RecvFileMode

The file protection mode that should be used whencreating files to hold incoming facsimile.Note that this value is given in octal.The default value of 0600 implies that only thefacsimile user can read received facsimile.If incoming facsimile are to be publicly accessible, thisvalue may be set, for example, to 0644.See alsochmod(2).

RingData

A modem status string that identifies that an incoming call isfor data use.This string should be set when a phone line has been setup withdistinctive ring service.See alsoRingFaxandRingVoice.

RingFax

A modem status string that identifies that an incoming call isfor facsimile use.This string should be set when a phone line has been setup withdistinctive ring service.See alsoRingDataandRingVoice.

RingsBeforeAnswer

The number of rings to wait before answering the phone.If this value is set to 0, then the phone will onlybe answered in response to an explicit answer command; seefaxanswer(8C).

RingVoice

A modem status string that identifies that an incoming call isfor voice use.This string should be set when a phone line has been setup withdistinctive ring service.See alsoRingDataandRingFax.

SendFaxCmd-

The command to use to process outbound facsimile jobs; seefaxsend(8C).

SendPageCmd-

The command to use to process outbound pager jobs; seepagesend(8C).

SendUUCPCmd-

The command to use to process outbound UUCPjobs.This parameter is not currently used, it is for future development.

ServerTracing=

A number that controls the generation of tracinginformation by a server when not actively sending orreceiving facsimile.Tracing is divided into areasthat are individually controlled.To enable tracing of multiple areas of operation, theflag associated with each area should be bit-or'd toform the value for this tag.

Flag                 Area                    Description1 (0x00001)          Server Operation        queue management and general operation2 (0x00002)          FAX/IXO Protocol        T.30 facsimile protocol or IXO/TAP protocol4 (0x00004)          Modem Operations        modem hardware manipulation8 (0x00008)          Modem Communications    comands passed between host and modem16 (0x00010)         Timeouts                timer operations32 (0x00020)         Modem Capabilities      modem capabilities64 (0x00040)         HDLC Frames             binary T.30 HDLC frames128 (0x00080)        Binary Modem I/O        binary communication between host and modem256 (0x00100)        Server State Transitionsserver program state transitions512 (0x00200)        Queue Management        job queue management1024 (0x00400)       Copy Quality            copy quality checking of received facsimile2048 (0x00800)       Job Management          low-level job management4096 (0x01000)       IXO Protocol            low-level IXO protocol8192 (0x02000)       Config File Parsing     unknown configuration file parameters16384 (0x04000)      FIFO Messages           inter-application messages32768 (0x08000)      Modem State Transitions modem state changes (down, busy, ready)65536 (0x10000)      Dial Rules              dialstring rules parsing and execution

For example, to enable tracing of server operations andprotocol operations, a value of 1+2=3 should be specified.NB: tracing timeouts and/or binary modem I/O can adverselyaffect the operation of the fax server; enabling these areasshould be done with extreme care.

Server tracing is directed tosyslog(3)using the facility specified with theLogFacilityconfiguration parameter.Note that syslogd(8C)must be configured to capturefacility.info,facility.debug,facility.warning,andfacility.errmessages.Seelog(5F)for a description of the logged messages.

SessionTracing=

A number that controls the generation of tracing informationby a server while sending or receiving facsimile.The number is interpreted identically toServerTracing.Note that session tracing is placed in log files in thelogsubdirectory; seelog(5F)for more information.

SpeakerVolume

The volume level that the in-modem speaker should beadjusted to while in command mode.The possible values are:

Value       DescriptionOff         silentQuiet       almost inaudibleLow         tolerable in privacyMedium      loud enough to hear in the next roomHigh        intolerable

Note that the speaker is always turned off once carrier is established.Also beware that some modems support fewer volume settings;seeModemSetVolumeCmd.

TagLineFont

The filename of the font to use in imaging tag linesacross the top of each transmitted page.Fonts must be stored in the Portable Compiled Font (PCF) format used by the X11 Window System.Filenames are specified relative to the root of the spooling area;e.g. etc/lutRS18.pcf.If no font is specified, if a null filename is specified, or ifthe specified font file is not readable, then tag lines will notbe generated.See alsoTagLineFormat.

TagLineFormat

The format string to use when imagingtag linesacross the top of each transmitted page.This string may include escape codes that cause various itemsto be interpolated into the imaged tag line.Any escape code supported bystrftime(3C)may be used as well as the following server-implemented codes:

Escape      Description%%d         destination phone number%%i         job identifier%%j         user-specified job tag%%l         LocalIdentifier or canonicalized FAXNumber%%m         sender's electronic mail address%%n         canonicalized FAXNumber%%p         current page number%%s         sender's name%%t         total pages in job%%%         ``%''

In addition, the format string may indicate that text is to be centered in multiple equal-sizedfieldsby separating text with ``|'' characters.For example, ``a|b|c'' would cause the tag line to be broken up intothree equal-sized areas with the strings ``a'', ``b'', and ``c''centered within each region.The default tag line format string is ``From %%n|%c|Page %%p of %%t''.See alsoTagLineFont.

TIFF2FaxCmd-

The command to invoke to convert a TIFF submittedfor transmission toTIFF/F,suitable for transmission; seetiff2fax(8C).

TimeOfDay-

The default time-of-day restrictions to apply to outbound jobs.Outbound jobs will be processed only during the specified time.Any jobs submitted outside this time period will be held untilthe start of this time.The syntax for time-of-day restrictions is designed to be compatiblewith the syntax used by theUUCPsoftware.The followingBNFdescribes the syntax:

   Syntax = tod ["," tod]      tod = <days><timerange>     days = "Any" | "Wk" | <dayname>+ | nothing  dayname = "Sun" | "Mon" | "Tue" | "Wed" | "Thu" | "Fri" | "Sat"timerange = <start> "-" <end> | nothing    start = <24hrtime>      end = <24hrtime> 24hrtime = {0-9}{0-9}{0-9}{0-9}  nothing =

where start and end are 24-hour times, day names can be either2- or 3-characters, and a null day or time specification meansany time or day.White space and other syntactic sugar may be freely inserted betweentokens but may not be inserted between 24-hour times in the time range.

This value may be overridden by rules in theDestControlsfile.

Use2D-

Control the use of 2D-encoded data for transmitted facsimile.

UUCPLockMode=

The file protection mode that should be used when creatingUUCPlockfiles.Note that this value is given in octal.

UUCPLockDir=

The pathname of the directory in whichUUCPlockfiles are to be created.

UUCPLockTimeout=

The time in seconds to wait before removing a staleUUCPlockfile (i.e. a lockfile whose owner does not appear to exist).If this value is set to 0, then the fax server will neverremove a stale lockfile.

UUCPLockType=

A string that specifies the type ofUUCPlockfile to create.The string may be one of ``ascii'' or ``binary''depending on whether the process-ID of the lock owneris written to the file as an ascii string or as a binary value, respectively.In addition, two prefixes may be used to control the format ofthe lock filename.If the type string is prefixed with a ``+'', then SVR4-style filenames are generated using the major device number of thetty device and the major and minor devicenumbers for the filesystem on which the tty device resides.If the type string is prefixed with a ``-'', then any uppercase letters in the device part of the lockfile name are convertedto lower case letters;for example, ``LCK..ttyA01'' is converted to ``LCK..ttya01''.This upper-to-lower case conversion is useful for systems such as SCOwhere the convention is to name devices with upper-case letters, butcreate lockfiles with lower-case letters.

VGettyArgs

A string that indicates whether or not the server should invokea voice getty programin response to an incoming voice call.If the string value is not null, then it is interpretedas a set of arguments to pass to the vgetty program.Before supplying the arguments, the string is first scannedfor ``%''-escape sequences: any appearance of ``%l'' is replacedwith the tty name and any appearance of ``%s'' is replaced withthe serial port speed (in decimal).The ``%'' character can be specified with ``%%''.If theVGettyArgsparameter is not specified in the configuration file or ifthe string value is null, then voice connections will be rejected.Note that in addition to the specified command line arguments, thevgettyprogram is invoked with its standard input, output, and errordescriptors directed to the controlling tty device.

WedgedCmd-

The command to invoke when a modem is deemed ``wedged''; seewedged(8C).

 

MODEM-ORIENTED CONFIGURATION PARAMETERS

This section lists configuration parameters that are specificto the setup and operation of the modem.Allcommandsmust be specified exactly as they are to be transmitted to the modem(note that this is a departure from previous versions of this softwarethat automatically prepended ``AT'' to each line of commandssent to the modem).When multi-line commands are required, enclose the commands inquote marks (``"'') and insert a newline character ``\n'' wherelines should be broken.An example of a multi-line command string is``AT+FCQ=1\nAT+FBADMUL=20\nAT+FBADLIN=10''.

Command strings sent to the modem may include commandescapes that force the host to alter the DTE-DCEcommunication rate, the flow control scheme used betweenthe host and modem, delay for a period of time, flush inputdata, and wait for a specific response from the modem.The following escape codes are interpreted:

Escape      Effect<none>      enable no flow control between DTE and DCE<xon>       enable software flow control between DTE and DCE<rts>       enable hardware flow control between DTE and DCE<2400>      set the DCE-DTE baud rate to 2400 bps<4800>      set the DCE-DTE baud rate to 4800 bps<9600>      set the DCE-DTE baud rate to 9600 bps<19200>     set the DCE-DTE baud rate to 19200 bps<38400>     set the DCE-DTE baud rate to 38400 bps<57600>     set the DCE-DTE baud rate to 57600 bps<76800>     set the DCE-DTE baud rate to 76800 bps<115200>    set the DCE-DTE baud rate to 115200 bps<delay:N>   delay N x 10 ms on the host (0 <= N <= 255)<flush>     flush any pending input data from the modem<waitfor:R> wait for the response R from the modem (see below)

Note that commands to the left of an escape code aresent to the modem before the associated actions are carried out on the host.This may be important when changing baud rates, as the result codefrom a command may be returned at the new baud rate.Also, beware that not all baud rates are supported by allsystems and modems; the set of baud rates supported by a host isusually listed in stty(1).

The ``<waitfor:..>'' escape can be used to override the defaultbehaviour which is to wait for an ``OK'' response to acommand sent to the modem.The possible response codes are:

NOTHING         a null responseOK              the default responseCONNECT         ``CONNECT...''NOANSWER        ``NO ANSWER...''NOCARRIER       ``NO CARRIER...''NODIALTONE      ``NO DIALTONE...''BUSY            ``BUSY''OFFHOOK         ``PHONE OFF-HOOK''RING            ``RING...''ERROR           error status from modemOTHER           any unrecognized modem response

For example ``ATO\r<waitfor:CONNECT>'' would send``ATO\r'' to the modem and then wait for a responsewith a leading ``CONNECT'' in it; and``ATS99=2\r<delay:2><flush><waitfor:NOTHING>'' would send``ATS99=2\r'' to the modem, delay 20 ms, flush anyinput from the modem, and then continue (not wait for any response).

ModemAnswerCmd

The command to answer the phone.If possible, this command should generate a result string that identifies whether the incoming call is from a facsimile, voice,or data modem.Typically this auto-detection is configured ahead of time; e.g.for Class 2 modems with the ``AT+FAA=1'' command.

The following table describes how the result codes are interpreted bythe facsimile server.

Result String      Default          Class 1      Class 2      Class2.0CONNECT FAX        Fax              -            -            --CONNECT            Data             Unknown      -            -NO ANSWER          No Answer        -            -            -NO CARRIER         No Carrier       -            -            -NO DIALTONE        No Dialtone      -            -            -ERROR              Error            -            -            -FAX                Fax              -            -            -DATA               Data             -            -            -+FCON              -                -            Fax          Fax+FCO               -                -            Fax          Fax+FDM               -                -            Data         Data+FHNG:             -                -            Error        ErrorVCON               -                -            Voice        Voice

The ``Default'' column indicates the interpretation made for theresult string in either class 1 or 2 unless explicitlyoverridden.The ``Class 1'' column indicates result strings handled speciallyfor modems operating in class 1, the``Class 2'' column indicates special handling for modemsoperating in class 2, and the ``Class 2.0'' column indicatesspecial handling for modems operating in class 2.0.Unknownentries imply that interpretation is based on the way in which thecall was answered; if answering is done for an explicit call type,that type is assumed, otherwise a Fax call is presumed.

ModemAnswerDataBeginCmd

The command to send to the modem once a dataconnection has been established.

ModemAnswerDataCmd

The command to explicitly answer the phone for a data connection.This command must generate a result string that identifies the incoming call is from a data modem.If this parameter is not specified or is null, then the value ofModemAnswerCmdis used instead.See alsoAdaptiveAnswerandAnswerRotary.

ModemAnswerFaxBeginCmd

The command to send to the modem once a facsimileconnection has been established.

ModemAnswerFaxCmd

The command to explicitly answer the phone for a facsimile connection.This command must generate a result string that identifies the incoming call is from a facsimile modem.If this parameter is not specified or is null, then the value ofModemAnswerCmdis used instead.See alsoAdaptiveAnswerandAnswerRotary.

ModemAnswerVoiceBeginCmd

The command to send to the modem once a voiceconnection has been established.

ModemAnswerVoiceCmd

The command to explicitly answer the phone for a voice connection.This command must generate a result string that identifies the incoming call is for voice.If this parameter is not specified or is null, then the value ofModemAnswerCmdis used instead.See alsoAdaptiveAnswerandAnswerRotary.

ModemAnswerResponseTimeout

The maximum time, in milliseconds, to wait for a response fromthe modem after sendingModemAnswerCmd.Note that you may want to shorten this value when using theserver-based adaptive answer strategy; seeAdaptiveAnswer.

ModemATCmdDelay

A delay, in milliseconds, that should be performed before each``AT'' command string is sent to the modem.

ModemBaudRateDelay

The amount of time, in milliseconds, to pause after setting thebaud rate on the serial line.This parameter is only needed for hosts where (apparently)setting the serial line parameters does not take effect immediately.

ModemCommaPauseTimeCmd

The command to set the time,in seconds, that the modem should pause when encounteringa ``,'' modifier in the dialing string.

ModemDialCmd

The command to place a phone call.The string is assumed to be suitable for useas a parameter to thesprintf(3S)function; so the ``%'' character should be escaped as ``%%''.The dial command must include a single ``%s'' where the numberthat is to be dialed is to be substituted.Facilities such as tone or pulse dialing, outgoing prefixesto route though a PBX,and so on should be included in thedialing command string.It is also important that, if possible, a trailing ``@''symbol should be included so that the modemreturns result codes that distinguish between no answer and no carrier.Use of the ``@'' permits the server to reduce the probabilitythat a wrong number is continually redialed.If the modem does not support this facility, then it may benecessary to raise the number of retries done when a``NO CARRIER'' result is returned.

ModemDialResponseTimeout

The maximum time to wait, in milliseconds, for a response fromthe modem after sendingThis value should be longer than the timeout programmed into themodem through theModemWaitTimeCmdparameter.This additional server-based timeout is provided to guard againstmodems that can ``lock up'' when dialing the telephone.

ModemEchoOffCmd

The command to disable echoing of commands sent to the modem.

ModemFlowControl

The type of flow control to use betweenDTEand DCE;one of ``NONE'', ``XONXOFF'' and ``RTSCTS''.This value is used to select the string sent to the modemto initially establish DTE-DCEflow control; one ofModemNoFlowCmd,ModemSoftFlowCmd,andModemHardFlowCmd.The current flow control setting is also used to select theappropriate flow control command to send to the modem whenthe software switches to Class 1, 2, or 2.0; seeClass1HFLOCmd,Class1NFLOCmd,Class1SFLOCmd,Class2HFLOCmd,Class2NFLOCmd,andClass2SFLOCmd.

The server supports both software and hardware flow controlfor Class 1, Class 2, and Class 2.0 modems.Whether to use hardware or software flow control dependson the capabilities of the modemand the host hardware and operating system.Communication rates above 9600 baud often require that hardwareflow control be used for reliableDTE-DCEcommunication.However, beware that many modems only support softwareflow control when sending or receiving facsimile.

ModemFrameFillOrder

The bit order to expect for receivedHDLCframes and to use when formulatingHDLCframes to send.This value may be eitherLSB2MSBwhen bits are ordered from least-significant-bit tomost-significant-bit (as in theCCITTspecification) orMSB2LSBwhen bits are ordered in the reverse direction.

ModemHardFlowCmd

The command to setup hardware (RTS/CTS)flow control betweenDTEandDCE.

ModemMinSpeed

The minimum acceptable signalling rate for transmitting facsimilepage data.Possible values are: 2400, 4800, 7200, 9600, 12200, and 14400.

ModemMfrQueryCmd

The command to send to the modem to get the manufactureridentification string.If this parameter is not set, then it is initializedto ``AT+FMFR?'' for Class 2 modems, orto ``AT+FMI?'' for Class 2.0 modems.If the parameter begins with a ``!'', then the remainder of thestring is taken to be the identification string and no commandis issued to the modem.

ModemModelQueryCmd

The command to send to the modem to get the model identification string.If this parameter is not set, then it is initialized toto ``AT+FMDL?'' for Class 2 modems,or to ``AT+FMM?'' for Class 2.0 modems.If the parameter begins with a ``!'', then the remainder of thestring is taken to be the identification string and no commandis issued to the modem.

ModemNoAutoAnswerCmd

The command to stop the modem from automaticallyanswering when the phone rings.

ModemNoFlowCmd

The command to disable flow control betweenDTEandDCE.

ModemOnHookCmd

The command to place the phone ``on hook''(i.e. hangup).

ModemPageDoneTimeout

The maximum time to wait, in milliseconds, for a responsefrom the modem after sending a page of facsimile data (e.g.the time to wait for a response to a Class 2/2.0AT+FETcommand).

ModemPageStartTimeout

The maximum time to wait, in milliseconds, for an initialresponse from the modem when sending a page of facsimile data(e.g. the time to wait for a response to a Class 2/2.0AT+FDRcommand).

ModemRate

The baud rate to use for DCE-DTE communication.This value may be one of: 115200, 76800, 57600, 38400, 19200, 9600, 4800,2400, 1200.The default value is 19200 because many modems lock therate at 19200 when sending or receiving facsimile.Note that not all values are supported by all operatingsystems and modems; consultstty(1)for the available rates on your system.

ModemRecvFillOrder

The bit order to expect for received facsimile data.This value may be eitherLSB2MSBwhen bits are ordered from least-significant-bit tomost-significant-bit (as in theCCITTspecification) orMSB2LSBwhen bits are ordered in the reverse direction.According to the various specifications all modems should returndata inLSB2MSBorder.However many Class 2 modems useMSB2LSBfor compatibility with modems that were built withRockwell hardware/firmware that included a bugthat was too widespread to correct.

ModemResetCmds

A string of commands to issue to the modem during initialization.This string is sent to the modembeforethe standard set of configuration commands required by the fax server.Note that these commands should not include normalreset commands that are specified through other parameters.For example, commands to setup flow control,DCDhandling,DTRhandling, etc. should be specified through the appropriateconfiguration parameters and not through this parameter.In addition the soft reset command (usually ``ATZ'')should not be included in this string; the servers issue thiscommand explicitly.

ModemResetDelay

The time, in milliseconds, to pause after resetting a modemeither by dropping theDTRsignal, or through a software reset command.This parameter should be long enough to permit the modem todo any reset-related processing it requires.

ModemResultCodesCmd

The command to enable result codes.

ModemRevQueryCmd

The command to send to the modem to get a firmware revision identificationstring.If this parameter is not set, then it is initialized to``AT+FREV?'' for Class 2 modems, orto ``AT+FMR?'' for Class 2.0 modems.If the parameter begins with a ``!'', then the remainder of thestring is taken to be the identification string and no commandis issued to the modem.

ModemSendBeginCmd

The command to send to the modem upon establishing carrier duringa transmit operation.This parameter is useful for systems that are incapable of enablinghardware flow control without DCDasserted.

ModemSendFillOrder

The bit order the modem expects for transmitted facsimile data.This value may be eitherLSB2MSBorMSB2LSB(see alsoModemRecvFillOrderabove.)Virtually all modems expect transmitted facsimile data inLSB2MSBbit order.

ModemSetVolumeCmd

The commands to use to set the modem speaker volume levels.There should be five whitespace-separated commands,one each for setting thevolume to ``Off'', ``Quiet'', ``Low'', ``Medium'', and ``High'';the default is ``"ATM0 ATL0M1 ATL8C1 ATL2M1 ATL3M1"''.See alsoSpeakerVolume.

ModemSetupAACmd

The command to setupadaptive answersupport in the modem-if available.Adaptive answer is the term used for the ability todistinguish between calls from facsimile, voice, anddata sources.Note that this string is the last command issued by the devicedrivers during setup, so the command stringmay, if necessary, switch to a differentoperating mode (e.g. on some Rockwell-based modems it is necessaryto issue the ``AT+FAA=1'' command in Class 0).

ModemSetupDCDCmd

The command to setupDCDhandling.On most systems the facsimile server will enablethe CLOCAL flag on the tty device to whichthe modem is connected.This should insure that the system does not close an openfile descriptor associated with the modem if carrier is dropped.Thus, for most systems and modems ModemSetupDCDCmdshould setupDCDto reflect carrier.

ModemSetupDTRCmd

The command to setupDTRhandling so that the modem is reset when theDTRsignal is lowered by the host.The facsimile server uses this facility to insure that modemsare not left in a ``locked up'' state.

ModemSoftFlowCmd

The command to setup software (XON/XOFF)flow control betweenDTEandDCE.

ModemSoftResetCmd

The command to force a soft reset of the modem.

ModemType

This parameter must be set to one of: ``Class2'', ``Class2.0'',or ``Class1'';to indicate that the modem is a Class 2-,Class 2.0-, or Class 1-style modem, respectively.

ModemVerboseResultsCmd

The command to enable verbose, as opposed to numeric, result codes.

ModemWaitForConnect

If enabled, the facsimile server will not consider a connectionestablished when answering an incoming call until a``CONNECT'' status string is received.This is useful mainly for Rockwell RC32ACL-basedmodems that send ``FAX'' and ``DATA'' statusmessages before sending ``CONNECT''.

ModemWaitTimeCmd

The command to set thenumber of seconds to wait for a carrier signalwhen placing a call or answering the phone.

 

T.30 PROTOCOL CONFIGURATION PARAMETERS

The following parameters apply to the implementation of theCCITT T.30facsimile protocol in the Class 1 device driver.They should not be changed without full understanding of theoperation of the server.

FaxT1Timer

The value of theT1timer in milliseconds.This timer is used to time out the initial session contact;i.e. receipt of DIS/DCS.

FaxT2Timer

The value of theT2timer in milliseconds.This timer is used to time out receiving responses and commands.

FaxT4Timer

The value of theT4timer in milliseconds.This timer is used to time out the reception ofHDLCframes and, usually, trigger frame retransmissions.

 

CLASS 1 MODEM CONFIGURATION PARAMETERS

The following parameters are specific to the configurationof Class 1-style modems; they should not be changed lightly:

Class1Cmd

The command to set the modem into Class 1 operation.

Class1FrameOverhead

The number of extraneous bytes inHDLCframes sent to the host in response to an ``AT+FRH'' command.For modems that properly implement the Class 1 interface, thisnumber should be 4 (the default).

Class1HFLOCmd

The command to setup hardware (RTS/CTS)flow control betweenDTEandDCEwhen operating in Class 1.This command is issued immediately after sending theClass1Cmdto switch the modem to Class 1 operation.

Class1NFLOCmd

The command to setup no flow control betweenDTEandDCEwhen operating in Class 1.This command is issued immediately after sending theClass1Cmdto switch the modem to Class 1 operation.

Class1RecvAbortOK

The time, in milliseconds, to wait for an ``OK'' result codefrom the modem after aborting an HDLCframe receive (``AT+FRH=3'').If this number is zero, then the modem is assumed to not correctlyimplement aborting and instead the driver will wait 200ms,flush any input, and then send ``AT\n'' and wait100ms for an ``OK'' result.

Class1RecvIdentTimer

The time, in milliseconds, to wait for an initialDCSwhen receiving a facsimile.CCITTrecommendationT.30specifies this as the value of theT1timer.However, adaptive answering schemes such as that describedabove under theAdaptiveAnswerparameter may require that this timer be shortened.

Class1SendPPMDelay

The time, in milliseconds, to delay between dropping the highspeed message carrier and sending the post-page message/command.

Class1SendTCFDelay

The time, in milliseconds, to delay between sending DCSandTCF.

Class1SFLOCmd

The command to setup software (XON/XOFF) flow control betweenDTEandDCEwhen operating in Class 1.This command is issued immediately after sending theClass1Cmdto switch the modem to Class 1 operation.

Class1TCFMaxNonZero

The maximum percentage of non-zero data bytespermitted in an acceptable receivedTCF.Note that this number does not include any leading non-zero datain the received data.See alsoClass1TCFMinRun.

Class1TCFMinRun

The duration, in milliseconds, of the minimum run of zero data inan acceptable receivedTCF.This value should be specified according to a 1.5 secondtransmission of zero data (i.e. it should be between 0 and 1500).See alsoClass1TCFMaxNonZero.

Class1TCFRecvTimeout

The maximum time to wait, in milliseconds, for the first byte ofthe Training Check (TCF) message data that is received during thetraining phase of the facsimile reception protocol.

Class1TCFResponseDelay

The time, in milliseconds, to delay between receivingTCFand sending a response on the v.21 carrier to indicate whether or nottraining was successful.

Class1TrainingRecovery

The time, in milliseconds, to delay after a failed training session.This time is used when sending training and when waiting forDCSand subsequent training during receive.

 

CLASS 2 AND 2.0 MODEM CONFIGURATION PARAMETERS

The following parameters are specific to the configurationof Class 2- and Class 2.0-style modems:

Class2Cmd

The command to set the modem into Class 2/2.0 operation.

Class2AbortCmd

The command to use to abort an established session.After using this command to abort a session,the fax software will sendModemOnHookCmdand then reset the modem by droppingDTR .

Class2BORCmd

The command to setup the bit order of sent andreceived facsimile data.Usually the command ``AT+FBOR=0'' is usedso that data is sent and received indirectbit order (LSB2MSB).Some modems, such as the Everex 24/96D,must use reversed bit order forPhase B and D data exchanges to avoid a bug that results ingarbage data being placed in the padding ofEOLcodes.The bit order specified by this command must correspondto the settings of theModemSendFillOrderandModemRecvFillOrderparameters.

Class2BUGCmd

The command to use to enable the tracing ofHDLCframes sent and received by the modem.This tracing information should be returned to the host in ``+FHR:''and ``+FHT:'' status strings.Note that many Class 2 modems do not support this facility.

Class2CIGCmd

The command used to set a polling identifier.This string is inserted into the format ``%s="<id>"''.

Class2CQQueryCmd

The command to send to the modem to get the copy quality capabilities string.If the parameter begins with a ``!'', then the remainder of thestring is taken to be the capabilities string and no commandis issued to the modem; this can be used together with theClass2CQCmdto force copy quality checking to be done in the server insteadof in the modem.See alsoPercentGoodLinesandMaxConsecutiveBadLinesfor parameters used to do server copy quality checking.

Class2CRCmd

The command to use to enable the reception of facsimile.

Class2CQCmd

The command to use to set up parameters for copy quality checking.For example, for an Everex 24/96D modem this parameter might be set to``AT+FCQ=1\nAT+FBADMUL=20\nAT+FBADLIN=10''.

Class2DCCCmd

The command used to set modem capabilities.This string is inserted into the format``%s=vr,br,wd,ln,df,ec,bf,st''.

Class2DCCQueryCmd

The command to send to the modem to get the Class 2/2.0 capabilities.If the parameter begins with a ``!'', then the remainder of thestring is taken to be the capabilities string and no commandis issued to the modem.

Class2DDISCmd

The command to set session parameters before dialing.This string is inserted into the format``%s=vr,br,wd,ln,df,ec,bf,st''.Setting this parameter enables support for Class 2 modems that do notproperly implement the ``AT+FDIS'' command bysetting up session parameters before dialing the telephone.

Class2DISCmd

The command used to set the current session parameters.This string is inserted into the format ``%s=vr,br,wd,ln,df,ec,bf,st''.

Class2HFLOCmd

The command to setup hardware (RTS/CTS)flow control betweenDTEandDCEwhen operating in Class 2/2.0.This command is issued immediately after sending theClass2Cmdto switch the modem to Class 2/2.0 operation.For Class 2.0 operation the default is ``AT+FLO=2''.

Class2LIDCmd

The command used to set the local identifier string.This string is inserted into the format ``%s="<id>"''

Class2MINSPCmd

The command used to set the minimum acceptable speed to be negotiatedfor transmitting page data.This string is inserted into the format ``%s=<speed>''

Class2NFLOCmd

The command to setup no flow control betweenDTEandDCEwhen operating in Class 2/2.0.This command is issued immediately after sending theClass2Cmdto switch the modem to Class 2 operation.For Class 2.0 operation the default is ``AT+FLO=0''.

Class2NRCmd

(Class 2.0 only)The command to setup negotiation message reporting.For the correct operation of the Class 2.0 driverthis command must enable the reporting of:receiver parameters, transmitter parameters, and ID strings.It is not necessary to enable reporting of non-standard framesfor correct operation of the Class 2.0 driver.

Class2PHCTOCmd

The command to use to set the Phase C timeout parameter (in seconds).

Class2PIECmd

(Class 2.0 only)The command to use to control procedure interrupt handling.Procedure interrupts should be disabled becauseHylaFAX does not provide a mechanism for dispatching procedure interruptsto an administrator.

Class2PTSCmd

The command to use to set the received page status code.When copy quality checking is done in the host, this command may beused to control the post-page response delivered to the sender.Beware that some modems do not properly implement this commandin which case the server should be configured to not do copy qualitycheck: see thePercentGoodLinesandMaxConsecutiveBadLinesparameters to understand how to defeat copy quality checking.

Class2RecvDataTrigger

The character to send to the modem to trigger the transmissionof received data from the modem to the host.This character is specified to beDC1(octal 21) in thedraft specification 2388-A andDC2(octal 22) in the 2388-Bspecification.Most Class 2 modems acceptDC1or bothDC1andDC2.Some modems however only acceptDC2.Note that string parameters may use C-style escape sequences,soDC2,for example, would be specified as ``"\022"''.

Class2RELCmd

The command to use to enable the delivery of byte-alignedEOLcodes in received facsimile.If this parameter is defined, then received facsimile datawill be marked to indicate thatEOLcodes are byte-aligned; otherwise they will be marked asnot (necessarily) having byte-aligned codes.

Class2SendRTC

Whether or not to append an explicit ``Return To Control'' (RTC)signal to the page data when transmitting.The Class 2 spec (i.e. SP-2388-A) states the modem will appendRTCwhen it receives the post-page message command from the host; thisparameter is provided in case the modem does not correctly implementthis.

Class2SFLOCmd

The command to setup software (XON/XOFF) flow control betweenDTEandDCEwhen operating in Class 2/2.0.This command is issued immediately after sending theClass2Cmdto switch the modem to Class 2/2.0 operation.For Class 2.0 operation the default is ``AT+FLO=1''.

Class2SPLCmd

The command to use to enable a polling request.

Class2TBCCmd

The command to use to enable stream-mode communication between thehost and modem.

Class2XmitWaitForXON

Whether or not to wait for anXONcharacter from the modembefore sending facsimile data to the modem for transmission.Note that this is only relevant for modems that conform to theClass 2 spec (i.e. SP-2388-A).The Class 2.0 specification states that the host may transmitdata immediately upon receivingCONNECTand that noXONcharacter will be sent to the host.

 

PAGER-RELATED CONFIGURATION PARAMETERS

The following parameters are specific to the configurationand operation of the IXO/TAP support for sending pager messages.

PagerSetupCmds

The commands to send to a modem to prepare the modem for acall to pager service provider.Typically these commands place direct the modem to communicatewith the service provider at 300 bps using the V.21 protocol.Note that there is no method to define different setup command stringsfor different services.

PagerMaxMsgLength

The maximum length for a pager text message.Messages longer than this number are truncated.Per-service provider message lengths can be setup in theinfo database; seeinfo(5F).

IXOService

The service identification string transmitted as part of theIXO/TAPprotocol.

IXODeviceID

The terminal device identification string transmitted as part of theIXO/TAPprotocol.

IXOMaxUnknown

The maximum number of unrecognized messages that will be acceptedat various stages of theIXO/TAPprotocol before the sender will abort and hangup the phone.

IXOIDProbe

The time, in seconds, between sending a ``\r'' during theinitial ID recognition sequence of theIXO/TAPprotocol.

IXOIDTimeout

The maximum time, in seconds, to wait for the initial ID response fromthe service provider.

IXOLoginRetries

The maximum number of attempts to login to a service provider.

IXOLoginTimeout

The maximum time, in seconds, to wait to complete the login procedure.

IXOGATimeout

The maximum time, in seconds, to wait for a Go-Ahead message from the serviceprovider.

IXOXmitRetries

The maximum number of times to try sending a text message blockin a single call.

IXOXmitTimeout

The maximum time, in seconds, to try transmitting a text message block.

IXOAckTimeout

integer30IXO: max time to wait for msg block ack (secs)
The maximum time, in seconds, to wait for an acknowledgementto a transmitted message.

 

PROTOTYPE CONFIGURATION FILES

Per-modem configuration files are typically derived fromprototype files that have been created for known modems.These prototype files are kept in theconfigsubdirectory and, by convention, have namesthat identify a brand or type of modem and theDTE-DCEflow control scheme the prototype files configures.Thefaxaddmodem(8C)program that is used to configure a modem for use withHylaFAX selects a prototype configuration file using informationretrieved from the modem and comments embedded in the prototype files.For Class 1 modems the product ID code returned by the command``ATI0''and the response from the comannd``ATI3''are used to select a prototype configuration file, while for Class 2modems the manufacturer and model as returned by``AT+FMFR?'' and ``AT+FMDL?'', respectively, areused (or ``AT+FMI?'' and ``AT+FMM?'' forClass 2.0 modems).

A Class 1 prototype configuration file is identified for use byfaxaddmodemby searching for a comment of the form:

# CONFIG:CLASS1:144:.*:RTSCTS: Manufacturer='AT&T' Model=Dataport

In this example ``144'' is the product ID code for an AT&T DataPortmodem, ``.*'' is a regular expression matched against the result stringreturned by the ``ATI3'' command,and ``RTSCTS'' indicates the modem is configured touse hardware flow control during fax operation.The remainder of the line is evaluated by thesh(1)and used to specify the modem's manufacturer and model (since Class 1modems do not have standard commands to query this information).

Class 2 and 2.0 prototype configuration files match the string``manufacturer-model-flowcontrol'' against ash(1)glob pattern specified in the configuration file, wheremanufacturerandmodelare the strings returned by querying the modem andflowcontrolis either ``RTSCTS'' for hardware flow control or``XONXOFF'' for software flow control.For example:

# CONFIG: CLASS2: ZyXEL*-RTSCTS
# CONFIG: CLASS2.0: USRobotics*-XONXOFF

are configuration comments that appear in the prototype file fora ZyXEL 1496E with Class 2 support, and for a US Robotics Couriermodem with Class 2.0 firmware.

Thefaxaddmodemprogram merges server-specific configuration parametersinto a prototype configuration according to commentsplaced in the prototype file.All lines between ``BEGIN-SERVER'' and ``END-SERVER''comments are placed with the appropriate server configurationparameters.Note that this means modem-related configuration parametersmust be placed outside this area of the file. 

SEE ALSO

faxaddmodem(8C),faxq(8C),faxgetty(8C),faxsend(8C),hylafax(5F)

---

 

Index

NAME

DESCRIPTION

SERVER-ORIENTED CONFIGURATION PARAMETERS

MODEM-ORIENTED CONFIGURATION PARAMETERS

T.30 PROTOCOL CONFIGURATION PARAMETERS

CLASS 1 MODEM CONFIGURATION PARAMETERS

CLASS 2 AND 2.0 MODEM CONFIGURATION PARAMETERS

PAGER-RELATED CONFIGURATION PARAMETERS

PROTOTYPE CONFIGURATION FILES

SEE ALSO

---

This document was created byman2html,using the manual pages.