HYLAFAX-CONFIG(5F)
🌸 NAME 🌸
config — the HylaFAX configuration database, aka the master vibes file 💖
✨ DESCRIPTION ✨
okay bestie, sit down, hydrate, because this is the blueprint 🫶
HylaFAX keeps a configuration file for the central queueing agent, and also one for every single facsimile modem attached to a machine. That's right, every modem gets its own little personality doc 💅. These files hold all the info about the modems and about how the HylaFAX server processes that service those modem should operate.
All these files live in the etc subdirectory. No cap.
- The configuration file for the
faxq(8C)program is namedconfig. - The per-modem configuration files, used by the
faxgetty(8C),faxsend(8C), andpagesend(8C)programs, have names of the formconfig.devid, where devid is an identifier derived from the name of the modem's device file. For example,ttym2for/dev/ttym2, andterm_10for/dev/term/10. 🎀
🦋 the format, because it's literally so simple 🦋
Configuration files have a simple format and are entirely ASCII. A configuration parameter is of the form:
tag: valuewhere a tag identifies a parameter and a value is either a string, a number, or a boolean value. Slay, that's it.
- Comments are introduced by the
#character and extend to the end of the line. so go ahead and annotate, queen ✍️ - String values start at the first non-blank character after the
:and continue to the first non-whitespace character — or, if you want whitespace in there, you can enclose them in quote marks ("). String values wrapped in quote marks may also use the standard C programming conventions for specifying escape codes; e.g.\nfor a newline character and\xxxfor an octal value. iconic behavior honestly 🌈 - Numeric values are specified according to the C programming conventions — leading
0xfor hex, leading0for octal, otherwise decimal — except for a few parameters, such asRecvFileMode, whose value is interpreted strictly as an octal number, andPageChopThreshold, whose value is interpreted strictly as a floating point number. ⚠️ don't get caught lacking on those two, fr fr. - Boolean values are case insensitive. For a true value, either
YesorOnshould be used. For a false value, useNoorOff. periodt 💀
ngl the whole file is giving "just read the tags and chill" — no fancy syntax, no drama, just tag, colon, value. iykyk 💜
okay so real talk: this table is the master list of every tag and what type of value it expects. First half = stuff specific to how each server operates. Second half = stuff about servicing the modem. And the footnote markers? They are not decoration, bestie:
- ¹ means the tag is used only by the HylaFAX scheduler process, so it should appear only in the file named
config. - ² means both the scheduler and the per-device applications use it, so it should appear in all appropriate configuration files — like
configand any per-device files that make sense. - No marker? Then it belongs only in per-device configuration files.
More detailed info about each item is coming after the table. For now, here's the whole lineup, no skips, no cap:
AdaptiveAnswer— typeboolean, defaultNo— enable adaptive answer of inbound callsAdminGroup— typestring, defaultfaxadmin— System user group for administration (if PAM enabled)AllowIgnoreModemBusy¹ — typeboolean, defaultNo— honor job requests to ignore modem busy statusAnswerRotary— typestring, defaultAny— alternatives for answering callsAnswerBias— typeinteger, default-— bias to apply to successful rotary answerAreaCode² — typestring, default-— local area codeAuditHook¹ — typestring, default-— command to run for faxq event auditingBadPageHandlingMethod— typestring, defaultRTN-SAVE— bad page received handling methodBatchLogs¹ — typeboolean, defaultYes— keep all session logs of a batch in a single logCallIDAnswerLength— typeinteger, default-— answer call when CallIDPattern receivedCallIDDisplay— typeboolean, defaultNo— display match in modem statusCallIDLabel— typestring, default-— label to use in presentation of the matchCallIDPattern— typestring, default-— call identification pattern stringCallIDRecord— typeboolean, defaultYes— record match in recvq image fileCallIDType— typestring, default-— type identifier for the CallIDPattern matchCIDName— typestring, default-— equivalent to CallIDPattern (2)CIDNameAnswerLength— typeinteger, default0— equivalent to CallIDAnswerLength (2)CIDNumber— typestring, default-— equivalent to CallIDPattern (1)CIDNumberAnswerLength— typeinteger, default0— equivalent to CallIDAnswerLength (1)ClocalAsRoot— typeboolean, defaultNo— set CLOCAL using root UIDContCoverCmd¹ — typestring, defaultbin/mkcover— continuation cover page generation programContCoverPage¹ — typestring, default-— continuation cover page template filenameCountryCode² — typestring, default-— local country codeDestControls¹ — typeobsolete, default-— Obsoleted by JobControlDeviceMode— typeoctal, default0600— protection mode to use for modem deviceDialStringRules² — typestring, default-— dial string rules fileDistinctiveRings— typestring, default-— configuration for distinctive ring cadencesDRingOff— typestring, default-— distinctive ring ``off'' cadence indicatorDRingOn— typestring, default-— distinctive ring ``on'' cadence indicatorDynamicConfig— typestring, default-— program for dynamic receive configurationEGettyArgs— typestring, default-— arguments passed to external getty programFAXNumber— typestring, default-— facsimile modem phone numberFaxRcvdCmd— typestring, defaultbin/faxrcvd— notification program for received facsimileGettyArgs— typestring, default-— arguments passed to getty programInclude² — typestring, default-— include another config fileInternationalPrefix² — typestring, default-— dialing prefix for international callsJobControlCmd¹ — typestring, default-— job control commandJobReqBusy— typeinteger, default180— requeue interval for BUSY dial resultJobReqDataConn— typeinteger, default300— requeue interval for data connection dial resultJobReqNoAnswer— typeinteger, default300— requeue interval for NO ANSWER dial resultJobReqNoCarrier— typeinteger, default300— requeue interval for NO CARRIER dial resultJobReqNoFCon— typeinteger, default300— requeue interval for carrier without +FCON dial resultJobReqOther² — typeinteger, default300— requeue interval for ``other'' problemsJobReqProto— typeinteger, default60— requeue interval after fax protocol errorJobRetryBusy— typeinteger, default-— number of retries for BUSY dial resultJobRetryDataConn— typeinteger, default-— number of retries for data connection dial resultJobRetryNoAnswer— typeinteger, default-— number of retries for NO ANSWER dial resultJobRetryNoCarrier— typeinteger, default1— number of retries for NO CARRIER dial resultJobRetryNoFCon— typeinteger, default-— number of retries for carrier without +FCON dial resultJobRetryOther— typeinteger, default-— number of retries for ``other'' problemsLockDataCalls— typeboolean, defaultYes— lock modem for the duration of an inbound data callLockVoiceCalls— typeboolean, defaultYes— lock modem for the duration of an inbound voice callLogCalls— typeboolean, defaultYes— Log all incoming calls as CALL records in xferfaxlogLogFacility² — typestring, defaultdaemon— syslog facility name for ServerTracing messagesLogFileMode— typeoctal, default0600— protection mode to use for session log filesLogRecv— typeboolean, defaultYes— Log received faxes as RECV records in xferfaxlogLogSend— typeboolean, defaultYes— Log sent faxes as SEND records in xferfaxlogLocalIdentifier— typestring, default-— local station identification stringLongDistancePrefix— typestring, default-— dialing prefix for long distance callsMaxBatchJobs¹ — typeinteger, default64— max jobs in a batchMaxConcurrentCalls¹ — typeinteger, default1— max concurrent jobs to process for a destinationMaxConcurrentPreps¹ — typeinteger, default1— maximum number of simultaneous job preparationsMaxConsecutiveBadLines— typeinteger, default5— max consecutive bad rows for OK page qualityMaxDials¹ — typeinteger, default12— max phone calls to make to transmit a jobMaxProxyJobs¹ — typeinteger, default64— max number of concurrent proxy jobsMaxRecvPages— typeinteger, defaultunlimited— max pages to permit in a receiveMaxSendPages¹ — typeinteger, defaultunlimited— max pages to permit in a sendMaxSetupAttempts— typeinteger, default2— max attempts to initialize a modemMaxTraversal¹ — typeinteger, default256— max traversal into queue for batchingMaxTries¹ — typeinteger, default3— max attempts to transmit a jobMinAcceptedLineCount— typeinteger, default10— min number of rows for OK page qualityMissedPageHandlingMethod— typestring, defaultRTN— missed page received handling methodModemGroup¹ — typestring, default-— define a name for a set of modemsModemPriority— typeinteger, default255— scheduling priority for outbound jobsModemReadyState— typestring, defaultR— ``ready state'' sent by faxgettyModemRingResponse— typestring, default-— command to respond after hearing RINGModemRingsBeforeResponse— typeinteger, default0— the number of rings before ModemRingResponseNoAnswerVoice— typeboolean, defaultfalse— disable the answering of voice-indicated callsNoCarrierRetrys— typeinteger, default-— Deprecated - See JobRetryNoCarrierNotifyCmd¹ — typestring, defaultbin/notify— user notification programPageChop¹ — typestring, defaultlast— control automatic truncation of trailing whitespacePageChopThreshold¹ — typefloat, default3.0— whitespace truncation threshold (inches)PCL2FaxCmd¹ — typestring, defaultbin/pcl2fax— PCL RIP command scriptPDF2FaxCmd¹ — typestring, defaultbin/pdf2fax— PDF RIP command scriptPercentGoodLines— typeinteger, default95— percentage of good rows for OK page qualityPollLockPokeModem— typeboolean, defaultfalse— check on modem every time the lock is polledPollLockWait² — typeinteger, default30— polling interval for lockfile presence/removal (secs)PollModemWait— typeinteger, default30— polling interval when in ``modem wait'' state (secs)PollRcvdCmd— typestring, defaultbin/pollrcvd— delivery program for facsimile received by pollingPostScriptTimeout¹ — typeinteger, default180— timeout on POSTSCRIPT interpreter runs (secs)PriorityScheduling— typeboolean, defaultsee below— use available priority job scheduling mechanismPS2FaxCmd¹ — typestring, defaultbin/ps2fax— POSTSCRIPT RIP command scriptQualifyCID— typeobsolete, default-— See DynamicConfig and RejectCall for rejecting callsQualifyPWD— typestring, default-— file of PWD patterns for qualifying sendersQualifyTSI— typestring, default-— file of TSI patterns for qualifying sendersRecvDataFormat— typestring, defaultadaptive— format for received facsimile dataRecvFileMode— typeoctal, default0600— protection mode to use for received facsimile filesRejectCall— typeboolean, defaultfalse— Reject the current callRingData— typestring, default-— distinctive ring data call identifierRingExtended— typestring, default-— extended ring message identifierRingFax— typestring, default-— distinctive ring fax call identifierRingsBeforeAnswer— typeinteger, default0— rings to wait before answering phoneRingTimeout— typeinteger, default6000— timeout in ms after RING before resetRingVoice— typestring, default-— distinctive ring voice call identifierRTNHandlingMethod— typestring, defaultRetransmit-Ignore— RTN signal handling methodSaveUnconfirmedPages— typeboolean, defaulttrue— save or delete unconfirmed pages
okay bestie, we're still deep in the config parameter section and there is no turning back 💅 every single one is here, no skips, no cap ✨
SendFaxCmd¹ — string — defaultbin/faxsend— the fax transmit command script 💖SendPageCmd¹ — string — defaultbin/pagesend— the pager transmit command script ✨SendUUCPCmd¹ — string — defaultbin/uucpsend— the UUCP transmit command script 🦋ServerTracing² — integer — default1— non-session server tracing, lowkey logging vibe 👑SessionTracing² — integer — default0xFFF— send and receive session tracing, fr fr 💜ShareCallFailures² — string — defaultnone— which call failures should be shared 👀SpeakerVolume— string — defaultQuiet— volume level for the modem speaker 🔇StaggerCalls¹ — integer — default0— time to delay between starting outbound calls ⏳TagLineFont— string — default-— tag line font filename 🎀TagLineFormat— string — defaultsee below— tag line format string ✨TagLineLocale— string — defaultsee below— tag line format locale 🌍TIFF2FaxCmd² — string — defaultbin/tiff2fax— TIFF converter command script 🖼️TimeOfDay¹ — string — defaultAny— default time-of-day restrictions ⏰TSIRecvdCmd— string — default-— program executed after TSI receipt, and yes it can drop calls 💀Unblock¹ — string — default-— forcefaxqto unblock the specified destination 🔓Use2D¹ — boolean — defaultYes— restrict or permit use of 2D-encoded fax data 🌀UseJobTSI— boolean — defaultNo— use job-specified TSI instead ofLocalIdentifier📠UseJobTagLine— boolean — defaultYes— allow use of job-specified Tagline instead ofTagLineFormat🏷️UUCPLockMode² — octal — default0444— protection mode for UUCP lock files 🔒UUCPLockDir² — string — defaultsee below— UUCP lockfile directory 📁UUCPLockTimeout² — integer — default30— time before removing a stale UUCP lockfile ⏱️UUCPLockType² — string — defaultsee below— UUCP lockfile type 🔑VGettyArgs— string — default-— arguments passed to the voice getty program 🗣️WedgedCmd¹ — string — defaultbin/wedged— program to run when the modem is wedged 😵ModemAnswerCmd— string — defaultATA— command for answering the phone 📞ModemAnswerAgainCmd— string — default<delay:50>ATA— command for answer recovery 🔁ModemAnswerDataBeginCmd— string — default-— command for the start of an answered data call 💾ModemAnswerDataCmd— string — defaultATA— command for answering a data call 📶ModemAnswerDialCmd— string — defaultATA— command for answering a dialed call 📲ModemAnswerFaxBeginCmd— string — default-— command for the start of an answered fax call 📠ModemAnswerFaxCmd— string — defaultATA— command for answering a fax call 🖨️ModemAnswerResponseTimeout— integer — default180000— answer command timeout in ms ⏳ModemAnswerVoiceBeginCmd— string — default-— command for the start of an answered voice call 🎙️ModemAnswerVoiceCmd— string — defaultATA— command for answering a voice call ☎️ModemATCmdDelay— integer — default0— delay before sending the modem an AT cmd, in ms ⏲️ModemBaudRateDelay— integer — default10— delay in ms after setting the baud rate 🐢ModemCEDCmd— string — defaultATA— command to signal CED and start V.21 HDLC transmit 📡ModemClassQueryCmd— string — defaultAT+FCLASS=?— command for querying modem services 🔍ModemCNGCmd— string — defaultATD— command to signal CNG and listen for V.21 HDLC 👂ModemCommaPauseTimeCmd— string — defaultATS8=2— command for setting time to pause for ``,'' in dialing string ⏸️ModemDialCmd— string — defaultATDT%s— command for dialing, where%sis the number to dial 📞ModemDialResponseTimeout— integer — default180000— dialing command timeout in ms ⏳ModemDoPhaseCDebug— boolean — defaultNo— query modem responses during Phase C transmit 🐛ModemDTRDropDelay— integer — default75— delay in ms between DTR OFF and DTR ON ⚡ModemEchoOffCmd— string — defaultATE0— command for disabling command echo 🔇ModemFlowControl— string — defaultXONXOFF— DTE-DCE flow control scheme 🌊ModemFrameFillOrder— string — defaultLSB2MSB— bit order for HDLC frames 🧬ModemHardFlowCmd— string — default-— command for setting hardware flow control between DTE and DCE 🔧ModemMinSpeed— string — default2400— minimum acceptable transmit speed 🐌ModemMfrQueryCmd— string — default-— command for querying the modem manufacturer 🏭ModemModelQueryCmd— string — default-— command for querying the modem model 🔎ModemNoAutoAnswerCmd— string — defaultATS0=0— command for disabling auto-answer 🙅ModemNoAutoAnswerCmdDelay— integer — default0— time in ms to pause after disabling auto-answer ⏸️ModemNoDialtoneRetries— integer — default1— maximum number of attempts to get dialtone 📞ModemNoFlowCmd— string — default-— command for disabling hardware flow control between DTE and DCE 🚫ModemOnHookCmd— string — defaultATH0— command for placing the phone ``on hook'' 📴ModemPageDoneTimeout— integer — default180000— page send/receive timeout in ms ⏳ModemPageStartTimeout— integer — default180000— page send/receive timeout in ms ⏳ModemRaiseATCommands— boolean — defaultYes— raise AT commands in configuration to upper-case 🔠ModemRate— integer — default19200— baud rate to use for DCE-DTE communication 📶ModemReadyCmds— string — default-— additional final commands when resetting the modem 🔄ModemRecvFillOrder— string — defaultsee below— bit order for received facsimile data 📥ModemRecvSuccessCmd— string — default-— command to send after a successful reception ✅ModemResetCmds— string — default-— additional commands when resetting the modem 🔁ModemResetDelay— integer — default2600— delay in ms after placing DTR ON ⏲️ModemResultCodesCmd— string — defaultATQ0— command for enabling result codes 📋ModemRevQueryCmd— string — defaultsee below— command for querying modem firmware revision 🔢ModemSecondAnswerCmd— string — default-— command to restart the answer process 🔄ModemSendBeginCmd— string — default-— command to send on establishing carrier 📡ModemSendFillOrder— string — defaultLSB2MSB— bit order for sending facsimile data 📤ModemSetOriginCmd— string — default-— command to set call origin information 🌍ModemSetVolumeCmd— string — defaultsee below— commands for setting modem speaker volume level 🔊ModemSetupAACmd— string — default-— command for setting up adaptive answer 🧠ModemSetupDCDCmd— string — default-— command for setting up DCD handling 🔌ModemSetupDTRCmd— string — default-— command for setting up DTR handling 🔌ModemSoftFlowCmd— string — default-— command for setting software flow control between DTE and DCE 🌊ModemSoftResetCmd— string — defaultATZ— command for doing a soft reset 🔄ModemSoftResetCmdDelay— integer — default3000— time in ms to pause after a soft reset ⏸️ModemSoftRTFCC— boolean — defaultYes— enable software-driven real-time fax compression conversion 🗜️ModemType— string — defaultsee below— modem type 📠ModemVerboseResultsCmd— string — defaultATV1— command for enabling verbose result codes 🗣️ModemWaitForConnect— boolean — defaultNo— force server to wait for ``CONNECT'' response on answer ⏳ModemWaitTimeCmd— string — defaultATS7=60— command for setting time to wait for carrier when dialing 📞FaxT1Timer— integer — default35000— CCITT T.30 T1 timer in ms ⏱️FaxT2Timer— integer — default7000— CCITT T.30 T2 timer in ms ⏱️FaxT4Timer— integer — default3100— CCITT T.30 T4 timer in ms ⏱️Class0Cmd— string — defaultAT+FCLASS=0— Class 0: command to enter class 0 🌀Class1Cmd— string — defaultAT+FCLASS=1— Class 1: command to enter class 1 1️⃣Class1Cmd— string — defaultAT+FCLASS=1.0— Class 1.0: command to enter class 1 💫 (yes, same name again, it's giving duplicate but we don't make the rules 💀)Class1AdaptRecvCmd— string — default-— Class 1/1.0: command for adaptive reception support 🧠Class10AutoFallback— boolean — defaultYes— Class 1.0: modem implements G3 fallback 🔙Class1ColorJPEGSupport— boolean — defaultNo— Class 1/1.0: to enable color JPEG fax support 🌈Class1EnableV34Cmd— string — default-— Class 1/1.0: command to enable V.34-fax support 🚀Class1ECMCheckFrameLength— boolean — defaultNo— Class 1/1.0: require complete ECM frame lengths 📏Class1ECMSupport— boolean — defaultYes— Class 1/1.0: enable T.30-A ECM support 🛠️Class1PersistentECM— boolean — defaultYes— Class 1/1.0: to continue to correct while in ECM 🔁Class1ECMFrameSize— integer — default256— Class 1/1.0: image frame size in ECM protocol 📦Class1ExtendedRes— boolean — default-— Class 1/1.0: enable extended resolution support 🖼️Class1ExpectedPageSize— integer — default100000— Class 1/1.0: expected page size in bytes 📄Class1HasRHConnectBug— boolean — defaultNo— Class 1/1.0: modem can reportCONNECTincorrectly 🐛Class1HasRMHookIndication— boolean — defaultYes— Class 1/1.0: modem reportsERRORcorrectly ✅Class1HFLOCmd— string — default-— Class 1/1.0: command to set hardware flow control 🔧Class1FrameOverhead— integer — default4— Class 1/1.0: extra bytes in a received HDLC frame 🧩Class1FRHNeedsReset— boolean — defaultNo— Class1/1.0:+FRH=3command needs resetting sometimes 🔄Class1FullDuplexTrainingSync— boolean — defaultNo— Class 1/1.0: to enable full-duplex during training sync 🔄Class1GreyJPEGSupport— boolean — defaultNo— Class 1/1.0: to enable grey JPEG fax support 🌫️Class1HookSensitivity— integer — default0— Class 1/1.0: times to ignore on-hook detection 🙉Class1JBIGSupport— string — defaultsee below— Class 1/1.0: to enable monochrome JBIG fax support ⚫Class1MRSupport— boolean — defaultYes— Class 1/1.0: enable 2-D MR support 🧬Class1MMRSupport— boolean — defaultYes— Class 1/1.0: enable 2-D MMR support 🧬Class1NFLOCmd— string — default-— Class 1/1.0: command to set no flow control 🚫Class1PageLengthSupport— integer — default7— Class 1/1.0: coded value for modem page length support 📏Class1PageWidthSupport— integer — default7— Class 1/1.0: coded value for modem page width support 📐Class1RecvAbortOK— integer — default200— Class 1/1.0: max wait in ms for ``OK'' after recv abort ⏳Class1RecvIdentTimer— typeinteger, default40000— Class 1/1.0: this is literally the max wait in ms for the initial ident frame, so give it a sec bestie ⏳✨Class1RestrictPoorDestinations¹— typeinteger, default0— Class 1/1.0: restrict features for destinations with poor quality, no cap 🚫💅Class1RestrictPoorSenders— typeinteger, default0— Class 1/1.0: restrict features for senders with poor quality, fr fr 📵Class1RMPersistence— typeinteger, default2— Class 1/1.0: how many times to attempt high-speed carrier recv, the way it just keeps trying 😤Class1SendNSF— typeboolean, defaultYes— Class 1/1.0: whether or not to send NSF, it's giving yes energy ✅Class1SFLOCmd— typestring, default-— Class 1/1.0: command to set software flow control, iconic for flow control girlies 🎀Class1PPMWaitCmd— typestring, defaultAT+FTS=7— Class 1/1.0: command to stop and wait before PPM, periodt ✋Class1PhaseBRecvTimeoutCmd— typestring, default-— Class 1/1.0: command to issue if Phase B receive times out, not me preparing for the worst 😭Class1ResponseWaitCmd— typestring, default-— Class 1/1.0: command to wait before TCF response, lowkey patient vibes 🧘Class1Resolutions— typeinteger, default0x7F— Class 1/1.0: bitmap of supported resolutions, the way it's hex and cute 🔥Class1RMQueryCmd— typestring, defaultAT+FRM=?— Class 1/1.0: command to query modem data reception rates, asking the modem what's tea ☕Class1TCFWaitCmd— typestring, defaultAT+FTS=7— Class 1/1.0: command to stop and wait before TCF, same energy as PPM wait 💅Class1TMQueryCmd— typestring, defaultAT+FTM=?— Class 1/1.0: command to query modem data transmission rates, transmission rates check ✨Class1EOPWaitCmd— typestring, defaultAT+FTS=9— Class 1/1.0: command to stop and wait before EOP, wait before end of page, iconic 🎬Class1ModemHasDLEBug— typeboolean, defaultNo— Class 1/1.0: modem fails to double DLE in V.21, it's giving buggy modem energy 💀Class1MsgRecvHackCmd— typestring, default""— Class 1/1.0: command to avoid +FCERROR before image data, a little hack, we love to see it 🙈Class1SSLFaxCert— typestring, defaultetc/ssl.pem— Class 1/1.0: PEM certificate file for SSL Fax, secure girlie 🔐Class1SSLFaxClientTimeout— typeinteger, default5000— Class 1/1.0: timeout waiting for client connection, don't leave me on read ⏰Class1SSLFaxInfo— typestring, default-— Class 1/1.0: hostname and port number for SSL Fax, the info bestie 🌐Class1SSLFaxProxy— typestring, default-— Class 1/1.0: hostname and port number for SSL Fax Proxy, proxy main character energy 👑Class1SSLFaxSupport— typeboolean, defaultYes— Class 1/1.0: support for SSL Fax, yes we support it 💖Class1SSLFaxServerTimeout— typeinteger, default2000— Class 1/1.0: timeout waiting for server connection, server better hurry 🏃♀️Class1TCFRecvHackCmd— typestring, default""— Class 1/1.0: command to avoid +FCERROR before TCF, another hack, we stay hacking 💅Class1TCFMaxNonZero— typeinteger, default10— Class 1/1.0: max% of non-zero data in good TCF, keep it lowkey zero 📉Class1TCFMinRun— typeinteger, default1000— Class 1/1.0: minimum zero run in good TCF, a nice long run of zeros 🏃Class1TCFMinRunECMMod— typeinteger, default2— Class 1/1.0: modify minimum zero run in ECM by this factor, math but make it cute ✨Class1TCFRecvTimeout— typeinteger, default4500— Class 1/1.0: max wait (ms) for TCF, don't wait forever ⏳Class1TMConnectDelay— typeinteger, default0— Class 1/1.0: delay between +FTM CONNECT and data transmission, zero delay, we move fast 🚀Class1SwitchingCmd— typestring, defaultAT+FRS=7— Class 1/1.0: command to ensure silence after HDLC reception, shhh 🤫Class1ValidateV21Frames— typeboolean, defaultNo— Class 1/1.0: check FCS against received frames, validation era 💯
Class2Cmd— typestring, defaultAT+FCLASS=2— Class 2: command to enter class 2/2.0, come through class 2 🚪Class2AbortCmd— typestring, defaultAT+FK— Class 2: command to abort active session, abort mission 🛑Class2APCmd— typestring, defaultAT+FAP— Class 2: enable support for sending and receiving SUB, SEP, and PWD frames, all the frames 💌Class2APQueryCmd— typestring, defaultAT+FAP=?— Class 2: query capabilities for sending and receiving SUB, SEP, and PWD frames, ask and you shall receive ❓Class2BORCmd— typestring, defaultAT+FBOR=0— Class 2: command to setup bit order, bits in order, periodt 🔢Class2BUGCmd— typestring, defaultAT+FBUG=1— Class 2: command to enable HDLC frame tracing, tracing the frames like a detective 🕵️♀️Class2CIGCmd— typestring, defaultAT+FCIG— Class 2: command to set polling identifier, who's polling? 👀Class2CRCmd— typestring, defaultAT+FCR=1— Class 2: command to enable receive capability, we can receive, yes we can 📥Class2CQCmd— typestring, default-— Class 2: command to setup copy quality parameters, copy quality matters 💅Class2CQQueryCmd— typestring, defaultAT+FCQ=?— Class 2: command to query modem copy quality capabilities, asking about quality 🎨Class2DCCCmd— typestring, defaultAT+FDCC— Class 2: command to set modem capabilities, capabilities set ✅Class2DCCQueryCmd— typestring, defaultAT+FDCC=?— Class 2: command to query modem capabilities, what can you do? 🤔Class2DisableV17Cmd— typestring, default-— Class 2: command to disable V.17 support, bye V.17 👋Class2DISCmd— typestring, defaultAT+FDIS— Class 2: command to set session parameters, session tea ☕Class2DDISCmd— typestring, default-— Class 2: command to set session parameters before dialing, pre-dial prep 📞Class2ECMType— typestring, default``2''— Class 2: ECM specification type to follow, following the spec 📜Class2HexNSF— typeboolean, defaultYes— Class 2: parse NSF strings as hex values, hex girlie 🔢Class2HFLOCmd— typestring, default-— Class 2: command to set hardware flow control, hardware flow, we love 💖Class2LIDCmd— typestring, defaultAT+FLID— Class 2: command to set local identifier string, local ID, main character 🪪Class2MINSPCmd— typestring, defaultAT+FMINSP— Class 2: command to set minimum transmit speed, minimum speed but still cute 🐢Class2NFLOCmd— typestring, default-— Class 2: command to set no flow control, no flow, no problem 🚫Class2PACmd— typestring, defaultAT+FPA— Class 2: set polling address string, address bestie 🏠Class2PHCTOCmd— typestring, defaultAT+FPHCTO=30— Class 2: command to set Phase C timeout parameter, Phase C timeout, set it ⏲️Class2PTSCmd— typestring, defaultAT+FPTS— Class 2: command to set received page status, page status update 📄Class2PWCmd— typestring, defaultAT+FPW— Class 2: set password string, password protected 🔐Class2RecvDataTrigger— typestring, default``\21''— Class 2: character to send to trigger recv, trigger the receive 🎯Class2RELCmd— typestring, default-— Class 2: command to enable byte-aligned EOL codes, EOL codes aligned 💫Class2SACmd— typestring, defaultAT+FSA— Class 2: set destination subaddress string, subaddress set 📬Class2SendRTC— typeboolean, defaultNo— Class 2: append RTC to page data on transmit, RTC on transmit, maybe later ⏰Class2SFLOCmd— typestring, default-— Class 2: command to set software flow control, software flow control, iconic 💻Class2SPLCmd— typestring, defaultAT+FSPL— Class 2: command to set polling request, polling request, periodt 📊Class2TBCCmd— typestring, defaultAT+FTBC=0— Class 2: command to enable stream mode, stream mode activated 🌊Class2UseLineCount— typeboolean, defaultNo— Class 2: use the line count from the firmware decoder, line count from firmware, okay 📏Class2UseHex— typeboolean, defaultNo— Class 2: parse capabilities strings as hex values, hex parsing, maybe later 🔣Class2XmitWaitForXON— typeboolean, defaultYes— Class 2: wait for XON before sending facsimile data, wait for XON, patient bestie ✋
Class2Cmd— typestring, defaultAT+FCLASS=2.0— Class 2.0: command to enter class 2/2.0, class 2.0 entrance 🚪Class2AbortCmd— typestring, defaultAT+FKS— Class 2.0: command to abort active session, abort but class 2.0 style 🛑Class2APCmd— typestring, defaultAT+FAP— Class 2.0: enable support for sending and receiving SUB, SEP, and PWD frames, frames galore 💌Class2APQueryCmd— typestring, defaultAT+FAP=?— Class 2.0: query capabilities for sending and receiving SUB, SEP, and PWD frames, query the frames ❓Class2BORCmd— typestring, defaultAT+FBO=0— Class 2.0: command to setup bit order, bit order setup, periodt 🔢Class2BUGCmd— typestring, defaultAT+FBU=1— Class 2.0: command to enable HDLC frame tracing, tracing frames, detective mode 🕵️♀️Class2CIGCmd— typestring, defaultAT+FPI— Class 2.0: command to set polling identifier, polling ID, who dis? 👀Class2CRCmd— typestring, defaultAT+FCR=1— Class 2.0: command to enable receive capability, receive capability, yes 📥Class2CQCmd— typestring, default-— Class 2.0: command to setup copy quality parameters, copy quality, important 💅Class2CQQueryCmd— typestring, defaultAT+FCQ=?— Class 2.0: command to query modem copy quality capabilities, query quality 🎨Class2DCCCmd— typestring, defaultAT+FCC— Class 2.0: command to set modem capabilities, set capabilities ✅Class2DCCQueryCmd— typestring, defaultAT+FCC=?— Class 2.0: command to query modem capabilities, query capabilities 🤔Class2DisableV17Cmd— typestring, default-— Class 2.0: command to disable V.17 support, bye V.17 again 👋Class2DisableV34Cmd— typestring, default-— Class 2.0: command to disable V.34 support, bye V.34 👋Class2DISCmd— typestring, defaultAT+FIS— Class 2.0: command to set session parameters, session parameters, set them ☕Class2ECMType— typestring, default``2.0''— Class 2.0: ECM specification type to follow, following the spec 2.0 📜Class2HexNSF— typeboolean, defaultYes— Class 2.0: parse NSF strings as hex values, hex parsing, yes 🔢Class2HFLOCmd— typestring, defaultAT+FLO=2— Class 2.0: command to set hardware flow control, hardware flow control, iconic 💖Class2JBIGSupport— typestring, defaultsee below— Class 2.0: to enable monochrome JBIG fax support, JBIG support, see below bestie 👇Class2JPEGSupport— typeboolean, defaultNo— Class 2.0: use modem JPEG support, JPEG support, maybe later 📷Class2LIDCmd— typestring, defaultAT+FLI— Class 2.0: command to set local identifier string, local ID, main character 🪪Class2MINSPCmd— typestring, defaultAT+FMS— Class 2.0: command to set minimum transmit speed, minimum transmit speed 🐢Class2NFLOCmd— typestring, defaultAT+FLO=0— Class 2.0: command to set no flow control, no flow control, periodt 🚫Class2NRCmd— typestring, defaultAT+FNR=1,1,1,1— Class 2.0: command to set negotiation message reporting, negotiation messages, report them 📢Class2PACmd— typestring, defaultAT+FPA— Class 2.0: set polling address string, polling address 🏠Class2PHCTOCmd— typestring, defaultAT+FCT=30— Class 2.0: command to set Phase C timeout parameter, Phase C timeout, set it ⏲️Class2PIECmd— typestring, defaultAT+FIE=0— Class 2.0: command to set procedure interrupt handling, procedure interrupt handling, handle it 🛠️Class2PWCmd— typestring, defaultAT+FPW— Class 2.0: set password string, password, protected 🔐Class2PTSCmd— typestring, defaultAT+FPS— Class 2.0: command to set received page status, page status, set it 📄Class2PTSQueryCmd— typestring, defaultAT+FPS?— Class 2.0: command to query received page status, query page status ❓Class2RecvDataTrigger— typestring, default``\22''— Class 2.0: character to send to trigger recv, trigger the receive 🎯Class2RELCmd— typestring, default-— Class 2.0: command to enable byte-aligned EOL codes, EOL codes, aligned 💫Class2RTFCC— typeboolean, defaultNo— Class 2.0: enable real-time fax compression conversion, real-time compression conversion, fancy ✨Class2SACmd— typestring, defaultAT+FSA— Class 2.0: set destination subaddress string, subaddress, set it 📬Class2SendRTC— typeboolean, defaultNo— Class 2.0: append RTC to page data on transmit, RTC on transmit, maybe later ⏰Class2SFLOCmd— typestring, defaultAT+FLO=1— Class 2.0: command to set software flow control, software flow control 💻Class2SPLCmd— typestring, defaultAT+FSP— Class 2.0: command to set polling request, polling request, periodt 📊Class2TBCCmd— typestring, defaultAT+FPP=0— Class 2.0: command to enable stream mode, stream mode, activated 🌊Class2UseLineCount— typeboolean, defaultNo— Class 2.0: use the line count from the firmware decoder, line count from firmware 📏Class2UseHex— typeboolean, defaultNo— Class 2.0: parse capabilities strings as hex values, hex parsing, maybe later 🔣PagerSetupCmds— typestring, default-— commands for setting up modem for a pager call, pager call setup, iconic 📟PagerMaxMsgLengthinteger — default128— the longest a text message can be, bestie.IXOServicestring — defaultPG— IXO: the service identification string.IXODeviceIDstring — default1— IXO: the device identification string.IXOMaxUnknowninteger — default3— IXO and UCP: how many unknown responses we put up with before we abort. 💀IXOIDProbeinteger — default2— IXO: time between sending\rduring the ID sequence, in secs.IXOIDTimeoutinteger — default20— IXO: max time to wait for theID=response, in secs.IXOLoginRetriesinteger — default3— IXO: max attempts to log in.IXOLoginTimeoutinteger — default15— IXO: max time to complete login, in secs.IXOGATimeoutinteger — default30— IXO: max time to wait for the Go-Ahead response, in secs.IXOXmitRetriesinteger — default3— IXO and UCP: max retries to send a text msg block.IXOXmitTimeoutinteger — default15— IXO and UCP: max time to transmit a text msg block.IXOAckTimeoutinteger — default30— IXO: max time to wait for a msg block ack, in secs.
👑 SERVER-ORIENTED CONFIGURATION PARAMETERS 👑
Okay so these ones? These are the ones that run the whole fax server's general vibe. The big-picture settings. Let's get into it, no cap. 🫶
AdaptiveAnswer— Controls whether we do the adaptive answering thing or not. Adaptive answering = an incoming call gets answered in multiple ways, following the list you put inAnswerRotary. So like, if adaptive answering is on andAnswerRotarysaysfax data, then an incoming call gets answered first as fax usingModemAnswerFaxCmd, and then, if that fails, as data usingModemAnswerDataCmd. If adaptive answering is not enabled, calls just get answered with the appropriateModemAnswer*Cmdparameter (normallyModemAnswerCmdfor unattended operation). Heads up though — adaptive answering depends on a lot of factors, and those factors limit how useful it actually is. When calls get answered as fax first, it typically only works with a Class 1 modem, because it matters that the whole answering-as-fax sequence finish fast enough that the follow-up data answer happens before the caller times out and hangs up the phone. (That's whyClass1RecvIdentTimershould be set shorter thanFaxT1Timer.) Also, sometimes you gotta arrange for the phone to go on-hook between successive answers — usually done by sticking the right command at the start of the second and subsequentModemAnswer*Cmds. ✨AdminGroup— Tells PAM which user group is allowed to administer the fax server. Only useful if the server was compiled with PAM enabled.AllowIgnoreModemBusy¹ — Whether or not to honor job requests that say "ignore modem busy status" when allocating jobs to a modem. The intended use here is letting configurations where aDynamicConfigprogram can send a fax to an incoming caller (which is contrary to T.30 protocol for sending or polling).AnswerRotary— The sequence of answering techniques the server shouldrotate throughwhen answering incoming calls. The techniques are:fax— 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 isn't answered successfully, the server advances the rotary to the next specified answering technique. If AdaptiveAnswer is enabled, the server will try all the answering techniques for each incoming call. Otherwise, the rotary advances between unsuccessful phone calls. So like, if AdaptiveAnswer is disabled and AnswerRotary is fax data, calls get answered as fax until the first call comes in that doesn't look like it's from a fax machine; after that, calls get answered as if they came from a data modem until the next unsuccessful call; and after that they go back to being answered as fax. Only the first three techniques listed are used — any extra ones are (silently) ignored. See also AnswerBias. 💅
AnswerBias— The index into theAnswerRotarylist that the server should rotate the list to after each successful incoming phone call. List indices start numbering at zero. Example: ifAnswerRotaryisfax dataandAnswerBiasis1, then after each successful inbound call, the next call gets answered as data.- **
AreaCode² — The local area code where the facsimile modem lives. This value gets passed to the dial string rules, which are used (for example) to formulate canonical phone numbers for dialing — seeDialStringRulesbelow. - **
AuditHook¹ — Specifies a program command and an interest specification saying which events (as described infaxwatch(8C)) should trigger the execution of that program. For example, this configuration:
AuditHook: "bin/hook: J*S*M*R*"would cause bin/hook to be executed upon every event. The arguments passed to the hook program are respectively <class>, <mask>, <id>, and optionally [info] where…
<class> = JOB | SEND | MODEM | RECV
<mask> = the specific event
<id> = id of the job/modem with which the event is associated
[info] = additional informationBadPageHandlingMethod— (Class 1/1.0 only) Specifies how to react to a bad page received from the remote sender: one ofRTN,DCN, orRTN-SAVE.
If a page is received in non-ECM mode with unacceptable quality according to PercentGoodLines or MaxConseutiveBadLines, then it can be a little bit hard to tell the sender about the problem. Historically, HylaFAX has assumed that signalling RTN to the sender will get the job done. But some senders literally cannot retransmit pages, and to reduce burden they treat an RTN signal as a receipt confirmation and just move on to the next page without notifying the sending user that there might be a readability problem on the receive-end. (The assumption there being that the receiving user will tell the sending user if there actually is a readability problem.)
A setting of RTN is the historic behavior, and it assumes an RTN signal is enough to get the sender to retransmit or otherwise be informed of a potential readability problem on the receive-end. The previously-received page data is marked to be overwritten by the next page data received from the sender.
A setting of DCN tells HylaFAX to transmit a DCN signal in response to the post-page message, which should trigger a call abortion by the sender. This should clearly indicate a problem in page readability to the sender, although receiving any following pages in a later call can't be guaranteed. 😭
A setting of RTN-SAVE more closely approximates how other fax receivers (especially fax machines) behave. It causes HylaFAX to send the RTN signal, but it saves the previously received page data and puts the next transmitted page data in another page. This is the default setting. However, it could result in multiple copies of the same page image being saved in the same file — if the sender does indeed retransmit the unacceptable pages during the same call.
- **
BatchLogs¹ — When sending or receiving multiple documents (denoted by EOM), this value determines if the session logs span the entire batch or, if set tono, only contain a single document. CallIDPattern— A string that identifies the caller's identity in any call identification messages the modem provides (like Caller*ID or DNIS/DID). The specified string is compared against any unrecognized status messages received from the modem beforeModemAnswerCmdis sent to the modem. If there's a match, then the remainder of the message is returned asCallIDnwhere n corresponds to the n'th instance that thisCallIDPatternis from the top in the modem configuration file. For example, for the ZyXEL U-1496 this parameter would be set toCallIDPattern: "CALLER NAME: "(note the trailing space). If more than one message matches between instances of "RING" messages, then the message remainders are concatenated.
The special CallID value of "SHIELDED_DTMF" is used together with ModemRingResponse and CallIDAnswerLength. After executing ModemRingResponse, HylaFAX will expect DTMF data (usually DLE-shielded) for CallIDn until CallIDAnswerLength is reached. Note that if the modem is in voice mode to hear these DTMF digits, then it must be returned to fax mode in the ModemAnswerCmd. And to keep this feature from losing incoming fax calls: if fax sender CNG is detected while waiting for DTMF, or if ten seconds elapse without sufficient DTMF, then the remaining expected digits will be populated by whitespace, which triggers fax answering. 🦋
For example, the following settings will cause HylaFAX to enter voice mode and go off-hook when a RING is detected. It will then expect four DTMF digits (presumably for routing), and then it will pause for 100 ms before returning to fax mode and answering the call.
ModemRingResponse: AT+FCLASS=8;H1
CallIDPattern: SHIELDED_DTMF
CallIDAnswerLength: 4
ModemAnswerCmd: <delay:100>AT+FCLASS=1;AFor modems that don't support AT+FCLASS=8 (like some USR modems) this may be an appropriate equivalent:
ModemRingResponse: "AT#CLS=8\nAT#VLS=4\nATA"
CallIDPattern: SHIELDED_DTMF
CallIDAnswerLength: 4
ModemAnswerCmd: "<delay:100>AT+FCLASS=1\nATA"Multiple entries of CallIDPattern are used together in one modem configuration file in order to capture multiple CallID responses. For example, the following settings would capture "NDID" responses from the modem as CallID1, "NMBR" responses from the modem as CallID2, "NAME" responses as CallID3, and it would trigger ModemAnswerCmd whenever CallID1 or CallID2 were longer than 7 or 10 characters, respectively.
CallIDPattern: "NDID="
CallIDAnswerLength: 7
CallIDPattern: "NMBR="
CallIDAnswerLength: 10
CallIDPattern: "NAME="Okay bestie, but listen — this example is only an example, and it probably would cause unexpected results. 💀 Here's why: pattern-matching ends when ModemAnswerCmd is sent to the modem. So if "NDID", "NMBR", and "NAME" responses came from the modem in that order, and the "NDID" response was at least 7 characters long, then ModemAnswerCmd would be sent to the modem immediately following the "NDID" response, and the "NMBR" and "NAME" responses would be ignored. 🙈 Generally only one CallIDAnswerLength item should be in a modem configuration file.
Call identification data is usually only sent once by the telco or PBX, and the timing of its arrival varies upon the telco or PBX and the type of line. If HylaFAX is configured to answer via RingsBeforeAnswer prior to the arrival of the data, then all CallID values will be null. 😭 For example, on US analog lines, caller-ID data is usually sent between RINGs 1 and 2. In this situation, RingsBeforeAnswer should be set to `2` or greater. (iykyk)
✨ CallIDAnswerLength ✨
An integer indicating the minimum number of characters in a CallID matching the previous CallIDPattern to be received when ModemAnswerCmd is sent to the modem irrespective of any RingsBeforeAnswer value greater than zero. This allows the answering of calls which deliver CID/DID data but not RINGs. 🎀 For example,
CallIDAnswerLength: ``7''would cause the call to be answered when CallID2 reached a length of seven digits. A value of zero for CallIDAnswerLength disables this feature.
💅 CallIDDisplay 💅
Whether or not to display the CallIDPattern match in the modem status line. 👀
🎀 CallIDLabel 🎀
The label to use in the presentation of any CallIDPattern match. (For example, when CallIDDisplay or CallIDRecord indicate to display or record the match.) 🏷️
🦋 CallIDRecord 🦋
Whether or not to record the CallIDPattern match in the received image file. 📝
⭐ CallIDType ⭐
Identifies the type of indicator in the associated CallIDPattern match. The special type `calling-number` enables the faxgetty process to utilize an associated entry in the info database for items such as senderDataSent, senderDataMissed, senderConfusesRTN, senderConfusesPIN, senderFumblesECM, senderHasV17Trouble, and senderSkipsV29. See hylafax-info(5F).
🌈 ClocalAsRoot 🌈
Control whether operations that set the CLOCAL bit on the modem device special file are done with the effective user-ID set to the super-user or the `fax` user. By default such operations are done as the fax user, except under IRIX where they are done as the super-user (because IRIX disallows manipulation of CLOCAL by anyone but the super-user). 👑
🔥 ContCoverCmd¹ 🔥
The program to invoke to generate a continuation cover page; see ContCoverPage and mkcover(8C).
🔥 ContCoverPage¹ 🔥
A template file to use in creating continuation cover pages. If this parameter is non-null, then the server will pass the filename to the command specified by ContCoverCmd to generate cover pages for outbound jobs that are continued 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 server will not generate continuation cover pages. The specified pathname must be relative to the top of the fax server's spooling area. 📂
🌍 CountryCode² 🌍
The local country code in which the facsimile modem resides. As for AreaCode, this value is passed to the dial string rules for use in formulating canonical phone numbers for dialing (among other things.) ☎️
🔧 DeviceMode 🔧
The file protection mode that the server should set for the modem device file. Note that this value is given in octal. The default value of 0600 implies that only the facsimile user (usually uucp) can access the modem. See also chmod(2).
📞 DialStringRules² 📞
The pathname of the file that holds the rules for processing user-specified dial strings; c.f. dialrules(5F). The specified pathname must be relative to the top of the fax server's spooling area; e.g. etc/dialrules.
🎶 DistinctiveRings 🎶
Modern distinctive ring support on most modems indicates the ring cadence rather than the older style of `RING1`, `RING2`, etc. To indicate the ring cadence, DRingOn and DRingOff values are presented by the modem to the faxgetty process. The modem indicates the entire cadence between `RING` indications Like this:
RING
DROF=40
DRON=8
DROF=4
DRON=8
RINGThe corresponding DistinctiveRings parameter for this ring cadence would be:
DistinctiveRings: F-8-4-8where `F` tells the faxgetty process that the ring cadence is for a facsimile (`V` for voice and `D` for data), and the other values describe the ring cadence with leading and ending DRingOff values ignored. Multiple ring cadences are indicated by delimiting them with commas in this fashion:
DistinctiveRings: V-20,F-8-4-8,D-4-2-4-8🔕 DRingOff 🔕
A string that identifies the `off` value in any distinctive ring cadence, for example `DROF=`. See also DRingOn and DistinctiveRings.
🔔 DRingOn 🔔
A string that identifies the `on` value in any distinctive ring cadence, for example `DRON=`. See also DRingOff and DistinctiveRings.
🧚 DynamicConfig 🧚
The pathname of the optional program, e.g. `etc/localid`, that makes dynamic configuration changes, i.e., to LocalIdentifier, based on device ID and call identification. The program is passed those values as the parameters ($1 = device id, $2 = CallID1, $3 = CallID2, $4 = CallID3, ...), when answering an incoming call. The program can then perform local processing as desired to send on standard output the configuration items to change in a `parameter:value` format, i.e. `LocalIdentifier: +1.800.555.1212`. If there are multiple parameters to be changed, then each item must be on its own line. This is commonly used to dynamically alter the local identification of systems which use DID/DNIS, but it can also be used to allow different modem configurations for different senders. This program can also set the RejectCall options to cause the current call to be rejected instead of answered. Note that this file must be marked as executable by the faxgetty process. ⚠️
💜 EGettyArgs 💜
A string that indicates whether or not the server should use an an external getty application (egetty) to perhaps deduce and possibly handle an incoming call. If the string value is not null, then it is interpreted as a set of arguments to pass to egetty. Before supplying the arguments, the string is first scanned for `%`-escape sequences: any appearance of `%l` is replaced with the tty name and any appearance of `%s` is replaced with the serial port speed (in decimal). Any appearance of escaped numbers 1 through 9 (`%1` through `%9`) are replaced by the match to the corresponding CallIDPattern, if present. The `%` character can be specified with `%%`. If the EGettyArgs parameter is not specified in the configuration file or if the string value is null, then `extern` connections will be rejected. 🚫 Note that in addition to the specified command line arguments, egetty is invoked with its standard input, output, and error descriptors directed to the controlling tty device.
When egetty finishes up, bestie, we gotta read its exit status, because that number is literally the whole plot twist — it tells us what to do with the call. Here's the tea 🍵:
- Exit status
0— unknown call type, no clue what this is. Handle the call likeegettywas never even involved, periodt. - Exit status
1— it's a data connection! So use thegetty(8C)program to handle it if it's configured (peepGettyArgs). If it's not configured, we just assume the call got answered and the data connection is up, and we keep it moving by sendingModemAnswerDataBeginCmdto the modem (if that's configured, obvi). - Exit status
2— a fax connection is established 🎀, so we proceed by issuingModemAnswerFaxBeginCmdto the modem (if configured). - Exit status
3— it's a voice call 📞, so use thevgettyprogram if it's configured (seeVGettyArgs). If not, we assume the call was answered and the voice connection is established, and we proceed by issuingModemAnswerVoiceBeginCmdto the modem (if configured). - Exit status
4— this one's an ERROR condition. The session gets terminated. Bye. - Exit status
5—egettyhandled the whole call by itself, it's not an error, and the session is considered terminated. Clean exit, slay ✨. - Exit statuses
11,12, and13— these are the same as1,2, and3respectively, EXCEPT they mean the call hasn't been answered yet with a data, fax, or voice connection. So ifGettyArgsisn't configured,ModemAnswerDataCmdgets issued to the modem first for an exit status of11;ModemAnswerFaxCmdgets issued first for12; and ifVGettyArgsisn't configured,ModemAnswerVoiceCmdgets issued first for13.
💖 FAXNumber
The phone number that belongs to the facsimile modem. This string gets used to build the Transmitter Subscriber Identification (TSI) and Caller Subscriber Identification (CSI) info we send to remote machines — unless the LocalIdentifier parameter is explicitly set, in which case that wins. The FAXNumber is also what names the session log file where incoming-call info gets recorded; check hylafax-log(5F) for that. And if this phone number isn't fully qualified, then the values of AreaCode and CountryCode step in to generate the transmitted CSI and TSI. 🫶
✨ Include²
Include the config file you name, as if it were literally part of this config file. Copy-paste energy, but make it official.
🌍 InternationalPrefix²
The string you use to place an international phone call. In the United States, this is ``011''. This string gets passed along to the dial string rules.
🎀 JobControlCmd¹
The command to invoke that provides Job Control information for a job. See jobcontrol(8C).
⏳ JobReqBusy
The delay, in seconds, to wait before retrying a job whose dialing attempt failed with a ``BUSY'' status result.
📞 JobReqDataConn
The delay in seconds to wait before retrying a facsimile job whose dialing attempt failed because a data modem picked up the phone. Rude, honestly.
🕳️ JobReqNoAnswer
The delay in seconds to wait before retrying a job whose dialing attempt failed with a ``NO ANSWER'' status result.
📵 JobReqNoCarrier
The delay in seconds to wait before retrying a job whose dialing attempt failed with a ``NO CARRIER'' status result.
💀 JobReqNoFCon
The delay in seconds to wait before retrying a facsimile job whose dialing attempt failed because the initial facsimile protocol handshake flopped (aka no ``+FCON:'' result came back from a Class 2/2.0 modem).
🔁 JobReqOther²
The delay in seconds to wait before retrying a job that failed for a reason not already covered by one of the JobReq* parameters. The catch-all, the safety net, the bestie who covers your shift.
🧬 JobReqProto
The delay in seconds to wait before retrying a facsimile job that failed because of a fax protocol error.
🔥 JobRetryBusy
The number of times to redial a phone number after getting a ``BUSY'' result code, when the number has not been successfully dialed before.
🌸 JobRetryDataConn
The number of times to redial a phone number after the dialing attempt failed because a data modem answered the phone, when the number has not been successfully dialed before.
😭 JobRetryNoAnswer
The number of times to redial a phone number after the dialing attempt failed because of NO ANSWER, when the number has not been successfully dialed before.
🫠 JobRetryNoCarrier
The number of times to redial a phone number after the dialing attempt failed because of NO CARRIER, when the number has not been successfully dialed before.
So here's the vibe: in normal operation the fax server treats this result code as meaning a facsimile modem/machine did not answer the phone, and it rejects the transmit job. Why? To avoid repeatedly dialing wrong phone numbers — and this whole thing depends on the modem being able to tell the difference between no carrier and no answer. But plot twist: some modems genuinely cannot reliably distinguish between no carrier and no answer, or when you tell them to, they don't identify a busy signal correctly. For those modems you might find it necessary to bump up this parameter's value to compensate.
⚠️ It is strongly recommended, however, that you do NOT set this value to a large number. Fr fr. Do not do it. 💀
🌈 JobRetryOther
The number of times to redial a phone number after the dialing attempt failed for a reason not already covered by one of the other JobRetry* parameters, when the number has not been successfully dialed before.
👑 GettyArgs
A string that says whether or not the server should invoke the getty(8C) program in response to an incoming call from a data modem.
If the string value is not null, then it's interpreted as a set of arguments to pass to the getty program. Before the arguments get supplied, the string is first scanned for ``%''-escape sequences:
- any appearance of ``%l'' gets replaced with the tty name
- any appearance of ``%s'' gets replaced with the serial port speed (in decimal)
- any appearance of escaped numbers 1 through 9 (
%1'' through%9'') gets replaced by the match to the correspondingCallIDPattern, if present - the
%'' character itself can be specified with%%''
If the GettyArgs parameter isn't specified in the configuration file, or if the string value is null, then data connections get rejected. Bye bestie 🙈.
Also note — on top of the command line arguments you specify, the getty program is invoked with its standard input, output, and error descriptors directed to the controlling tty device. Iykyk.
💅 LocalIdentifier
The local station identification string to use when transmitting TSI and CSI strings (see FAXNumber above).
NB: while this string may contain any printable ASCII characters, beware that CCITT T.30 specifies a restricted character set, and some fax modems and machines may reject or not display non-conforming strings. So maybe don't get too creative, babe.
If the local identifier isn't specified, a canonical form of the FAXNumber is used instead.
🔒 LockDataCalls
Hold the UUCP lockfile during the time an inbound data call is being processed by the external getty program. If this is disabled, then the lockfile gets removed just before the getty program is invoked.
⚠️ But note: doing that introduces a race condition — an outbound program may sneak in and take control of the modem after the inbound call has been accepted, but before the getty program has started up and installed its own lockfile. Sneaky sneaky. 🐍
🎙️ LockVoiceCalls
Hold the UUCP lockfile during the time an inbound data call is processed by the external voice getty program. If this is disabled, then the lockfile gets removed just before the voice getty program is invoked.
⚠️ Same warning, same energy: this introduces a race condition where an outbound program may sneak in and grab the modem after the inbound call has been accepted, but before the voice getty program has started up and installed its own lockfile.
📋 LogFacility²
The symbolic name for the syslog(3) facility to use when logging error messages and informational/debugging messages requested through the ServerTracing parameter. The list of facility names is standardized — you'll find it in the system include file <syslog.h> — and comparisons are case-insensitive.
📞 LogCalls
Log all incoming calls into xferfaxlog as CALL records. This gives you a quick check of all incoming calls, whether the fax completed or not, all unified and tidy with the other fax logs. Chef's kiss. 😘
🔐 LogFileMode
The file protection mode to use when creating files that hold session logs. Heads up: this value is given in octal. The default value of 0600 means the log files aren't generally accessible — which matters a LOT if sensitive info like calling card access codes is getting logged. If log files are meant to be publicly accessible, you may set this value to, for example, 0644. See also chmod(2).
📥 LogRecv
Log all received faxes into xferfaxlog as RECV records.
📤 LogSend
Log all sent faxes into xferfaxlog as SEND records.
☎️ LongDistancePrefix²
The string to use to place a long distance phone call. In the United States, this is ``1''.
MaxConcurrentCalls¹
okay so this one is the default value for the max number of jobs for the same destination that get processed at the same time. so basically it's the ceiling on how many phone calls can be happening concurrently to one destination. 💅
ngl unless literally all of your fax destinations have multiple fax lines using the same fax number per destination, you should just leave this at the default of 1 and handle the exceptions with the JobControl mechanism instead. lowkey the move.
BUT for high-throughput applications there's a special value of "0" you can use — that tells the server to allow limitless concurrent calls to the same destination, provided that all existing calls to that destination have connected. and in that setup, if a busy signal happens on a concurrent call, the various "dials" counters are not incremented, and further concurrent calls get temporarily stalled. 🫶
MaxConcurrentPreps¹
the maximum number of job preparations that may be run simultaneously. its whole job is to stop the scheduler from kicking off so many job preparations that system resources get constrained in the operations. protect the vibes, protect the CPU. ✨
MaxBatchJobs¹
the maximum number of jobs to batch together in a single call. that's it, that's the whole thing. 🎀
MaxConsecutiveBadLines
the maximum number of consecutive erroneous rows of image data that the server will receive before it decides a page has unacceptable copy quality. 🚫
set this to zero and the server just… won't check the quality of received facsimile at all. facsimile received with error-correction do not have copy quality checking performed. see also PercentGoodLines.
MaxDials¹
the default value for the max number of times the server will place a call for an outbound job. this can be overridden by rules in the JobControl mechanism. 👑
heads up bestie: this feature is completely distinct from the identically-named feature in the client-server communication, and jobs triggering these limits get handled differently for each one. see also MaxTries.
MaxProxyJobs¹
the maximum number of jobs that can be concurrently delivered to a proxy for transmission. this limit exists so proxy use doesn't overwhelm the available system processes. 🌸
MaxRecvPages
the maximum number of pages the server will accept in a received facsimile before it aborts the session. 💀
MaxSendPages¹
the default value for the maximum number of pages the server will permit in a transmitted facsimile. outbound jobs that exceed this limit get rejected, no negotiation. this value may be overridden by rules in the JobControl mechanism. ✨
MaxSetupAttempts
the maximum number of times a HylaFAX server program will attempt to initialize a modem before considering it "wedged". it's giving "we tried, we really did". 😭
MaxTraversal¹
the maximum depth into the job queues that the scheduler will traverse when it's attempting to batch jobs together into a single call. the whole point is to stop the scheduler from burning a ton of CPU on batching attempts when the job queues get very long — which is exactly when batching is unlikely to be useful anyway. 🧚
MaxTries¹
the default value for the maximum number of times the server will attempt to communicate with a remote site. 📞
note the difference fr fr: for a call to be counted against this limit, carrier must be established. this is in contrast to MaxDials, which limits the number of calls that will be placed on behalf of a job.
this value may be overridden by rules in the JobControl mechanism. and again — this feature is completely distinct from the identically-named feature in the client-server communication, and jobs triggering these limits are handled differently for each. see also MaxDials.
MinAcceptedLineCount
the minimum number of received scanlines allowed on an "OK" page. using this setting stops confirmation from being sent for very short pages. tiny page? not today. 🙈
MissedPageHandlingMethod
(Class 1/1.0 only) — specifies how to react to a missed page received from the remote sender. it's one of: "RTN", "PIN", "DCN", or "CFR". 👑
if a page is missed (meaning the modem does not train on the Phase C carrier) in non-ECM mode, then — like BadPageHandlingMethod — it can be somewhat difficult to inform the sender of the problem. 😭
here's the tea on each option:
"RTN"— the proper behavior that fax protocol employs to request the sender retransmit the page after retraining. unfortunately, though, some senders will perceive this as a receipt confirmation and won't retransmit the page at all. ifsenderConfusesRTNis set to"yes"in the associatedhylafax-info(5F)file for this sender, then this method will not be used."PIN"— the proper behavior that fax protocol employs to request the sender retransmit the page after a procedural interrupt. however, procedural interrupts are rarely used and may not be widely supported by other systems. ifsenderConfusesPINis set to"yes"in the associatedhylafax-info(5F)file for this sender, then this method will not be used."DCN"— should trigger a call abortion by the sender. this should clearly indicate a problem to the sender, although a retransmission attempt in a later call cannot be guaranteed."CFR"— causes an out-of-spec behavior where the CFR signal is used in response to the post-page message. while other HylaFAX senders should handle this signal in a way that leads to a retransmission of the page without retraining, most senders will disconnect after receiving this signal, since it is not a permitted response in Phase D — and the sender response will be undefined. this method will only be used if it is explicitly configured for use.
historically, HylaFAX has employed both "RTN" and "DCN" behaviors by default, with complaints using either. the "PIN" and "CFR" behaviors were developed in order to evaluate whether other systems besides HylaFAX would tolerate them. 🧪
MissedPageHandlingMethod is designed to give the administrator the opportunity to vary between these options through the DynamicConfig feature, to achieve a more nuanced approach. main character admin energy honestly. 💅
ModemGroup¹
define a logical name for a set of modem devices. this parameter lets you define a name that clients can use to refer to a collection of modems. 🌈
the syntax is:
<name>:<definition>where <name> is the name for the group, and <definition> is of the syntax:
[<limit>:]<regex>where <limit> is an optional formatted expression of the limits for this ModemGroup, and <regex> is a regular expression that faxq(8C) matches against known modems.
presently <limit> only refers to a number that is the minimum number of modems in the group that must be left to stay idle (for receiving) after assigning an active job to the ModemGroup. the default for <limit> is 0.
so for example, the default modem to use for a job, any, is defined as:
any:0:.*this parameter may be specified multiple times to define multiple modem classes. modem classes may overlap. ✨ and the actual set of modems in a modem class that are considered for 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 lesser values signifying higher (more desirable) priority. the HylaFAX scheduler process assigns the highest priority modem that is ready for use when scheduling an outbound job. 👑
if multiple available modems in a job's selected ModemGroup have the same ModemPriority value, then the HylaFAX scheduler assigns jobs to them in a round-robin fashion. fair and balanced, we love to see it. 🎀
NoAnswerVoice
whether or not to disable the answering of calls indicated as voice (e.g. by DistinctiveRings). 🔇
NoCarrierRetrys
this is mapped onto JobRetryNoCarrier. (yep, that's the whole description, bestie, don't @ me.) 🙈
ModemReadyState
define the state transmitted to the HylaFAX scheduler process each time a modem is made ready by a faxgetty process. state is one of:
"R"— ready for use"B"— busy"D"— down"E"— exempt
the modem state can be used to control whether or not modems are assigned to outbound jobs. a modem's state is initially set to "R" (ready). modem state can be dynamically changed with the faxstate(8C) program, or by setting this configuration parameter with the faxconfig(8C) program.
the HylaFAX scheduler process will not assign jobs to a modem with a ModemReadyState of anything other than "R". 🚫
the differences between "B", "D", and "E":
"B"refers to a temporary condition that will automatically clear in the passing of time (as if the modem were in-use with receiving a fax)."D"refers to a condition that will not automatically clear (such as a wedged condition)."E"refers to a permanent condition as configured by the administrator (as for a receive-only modem).
if a user submits a job to a specific modem that has a ModemReadyState of "B" or "D", then the job will wait in the queue until the modem is made available, or until the job times out. in contrast, jobs submitted to a specific modem with a ModemReadyState of "E" will be rejected outright. 💀
exempt modems should be removed from any ModemGroup to which they belong (i.e. "any").
ModemRingResponse
this can be used to cause the command defined by ModemRingResponse to be sent to the modem after hearing at least ModemRingsBeforeResponse RINGs — in order to receive DID-DTMF data, for example. 📞✨
ModemRingsBeforeResponse
this defines the minimum number of RINGs that must be heard before ModemRingResponse is first sent to the modem. 🦋
NotifyCmd²
the program to invoke to notify a client of a job status change; see notify(8C). 💌
PageChop¹ — do we auto-truncate the trailing whitespace on outbound fax pages (when we can)? Obsessed with efficiency, honestly. If chopping is on, then any page with at leastPageChopThresholdtrailing whitespace gets sent as ashort page'' — but only if the receiver can handle variable-length pages. Your values are:last'' = chop just the last page of each doc,all'' = chop every single page, ornone'' = no chopping, we're keeping the whitespace, bestie. ✨PageChopThreshold¹ — the minimum amount of trailing whitespace that has to be sitting on a page before page chopping even gets attempted; peepPageChop. Heads up: this value is in inches. 📏PCL2FaxCmd¹ — the command to invoke to convert an HP-PCL document submitted for transmission into TIFF/F, suitable for transmission. 💅PDF2FaxCmd¹ — the command to invoke to convert a PDF document submitted for transmission into TIFF/F, suitable for transmission.PercentGoodLines— the minimum percentage of good rows of image data required for a received fax page to be deemed acceptable copy quality. Set this to zero and the server just... does not check received fax quality at all, no thoughts head empty. Also: fax received with error-correction don't get copy quality checking performed, periodt. See alsoMaxConsecutiveBadLines. 👑PollLockPokeModem— when we're polling for a UUCP lockfile to show up or disappear, also test that the modem is still reachable. Genuinely useful for when the modem is apt to become disconnected while it's idle — like an external modem that might lose power — and the admin wants to get notified of that (as a ``wedged'' condition). 🫠PollLockWait— when polling for the presence/removal of a UUCP lockfile, the time (in seconds) to wait between checks. Lockfile polling exists so the fax server doesn't collide with another process that's using the modem. Sharing is caring, but locks are law.PollModemWait— the time (in seconds) to wait between checks for a modem to become ready for use. Modem polling happens when a modem fails to reset cleanly. 😭PriorityScheduling— should the HylaFAX scheduler use the available priority job scheduling mechanisms to boost realtime execution, especially with Class 1 configurations on older or slower systems?
As of right now, PriorityScheduling is available for IRIX, SVR/4, HP-UX, and POSIX-compliant (i.e. Linux) operating systems. The default value varies so traditional HylaFAX behavior is maintained. On IRIX, SVR/4, and HP-UX systems where the configure script detects one of the functions schedctl(), priocntl() or rtprio(), the default is true. The only other supported priority mechanism is POSIX sched_setscheduler(), which gets used on Linux, OpenServer and possibly other systems. On those systems, and also on systems where no priority scheduling mechanism exists at all, the default is false. 💀
PS2FaxCmd¹ — the command to invoke to convert a POSTSCRIPT document submitted for transmission into TIFF/F, suitable for transmission; seeps2fax(8C). 🎀QualifyPWD— a string that says whether or not the identity of calling fax machines should be checked against an access control list before receiving fax. IfQualifyPWDis non-null, then only messages from fax machines identified in the file specified by that string (typicallyetc/passwd) will be accepted; it's similar toQualifyTSI. 🔐QualifyTSI— a string that says whether or not the identity of calling fax machines should be checked against an access control list before receiving fax. IfQualifyTSIis non-null, then only messages from fax machines identified in the file specified by that string (typicallyetc/tsi) will be accepted; seetsi(5F). IfQualifyTSIisn't specified in the config file, or the value is null, then literally every incoming fax message gets accepted. Come one, come all.RecvDataFormat— the data format (compression scheme) to write received fax data in when copy quality checking is performed on the host. (When copy quality checking is not done by the server — say, when the error correction protocol is in use — the received fax data gets written exactly as it came off the modem.) The format can be one of:1-D MH'',2-D MR'',2-D MMR'', oradaptive''. An ``adaptive'' format makes the received data get written using whatever data format the sender and receiver negotiated. Heads up though: 2-D MMR is the most space-efficient data format, but the resulting file may not be viewable — some commonly used programs do not properly read multi-strip TIFF with 2-D MMR data. 🙈RecvFileMode— the file protection mode to use when creating files that hold incoming fax. Note that this value is given in octal. The default value of0600means only the fax user can read received fax. If incoming fax are meant to be publicly accessible, you can set this, for example, to0644. See alsochmod(2). 🧚RejectCall— set this totrueand the current call will not be answered, it'll be rejected. This option has no effect if it's set in the configuration file — but when it's set by theDynamicConfigprogram, it controls the current call. This option supersedes the obsoleteQualifyCIDoption. Not me rejecting your call fr fr.RingData— a modem status string that identifies an incoming call as being for data use. Set this string when a phone line has been set up with distinctive ring service. See alsoRingFaxandRingVoice. 🌈RingExtended— an identifier that matches the initial portion of an extended RING message sent by the modem, used to relay CID and/or DNIS data instead of sending it formatted on separate lines. ⭐RingFax— a modem status string that identifies an incoming call as being for fax use. Set this string when a phone line has been set up with distinctive ring service. See alsoRingDataandRingVoice. 💜RingsBeforeAnswer— how many rings to wait before answering the phone. If this value is set to0, then the phone only gets answered in response to an explicit answer command; seefaxanswer(8C). ☎️RingTimeout— if a ring is heard and the call isn't answered, the time in ms to wait before reinitializing the modem for the next call. ⏳RingVoice— a modem status string that identifies an incoming call as being for voice use. Set this string when a phone line has been set up with distinctive ring service. See alsoRingDataandRingFax. 🌸RTNHandlingMethod— specifies how to react to an RTN signal received from the remote: one ofRetransmit'',Giveup'',Ignore'', orRetransmit-Ignore''. Pick your fighter.
``Retransmit'' assumes the page was not received successfully. HylaFAX will make up to two additional attempts to send that page, decreasing the signalling rate and retraining. If the RTN keeps coming, up to 2 additional calls will be placed. The downside? If the remote always responds with RTN, the page gets sent 9 times and no following pages get sent at all. Many fax machines will not behave this way, even though the T.30 specification seems clear that this is the intent of the RTN signal. 😵💫
Some fax machines interpret RTN as meaning don't send the same data again. That's because RTN may indicate problems with flow control, incorrectly encoded T.4 data, or some incompatibility other than line noise. Fax machines that read RTN this way will disconnect and require a manual retransmission. This over and out'' behavior can be activated with the Giveup'' value. The advantage here is that the same page of image data won't get sent multiple times — but the downside is that the following pages will not be sent. 💀
Ignore'' is similar to Giveup'' in that it makes the assumption the data cannot be automatically accepted by the receiver. But instead of disconnecting, the page of image data is abandoned and processing moves on to the next one. The remote is left to decide what to do with that unacceptable page of image data. The downside of this behavior is that the remote may or may not have kept the page, depending on how it interpreted the RTN signal — but it does let us continue on to the next page. 🤷♀️
Retransmit-Ignore'' is a combo of Retransmit'' and ``Ignore''. The page of image data gets retransmitted up to two additional times, but rather than disconnecting after a third RTN signal for the same page, processing then continues on to the next page. This approach is an effort to satisfy both interpretations of an RTN signal. It lets the receiver hopefully get a better copy of the image data while not failing to send subsequent pages. And if the receiver saves or prints a copy of pages it transmits RTN for, then it could save or print up to three copies of every page. 😭
SaveUnconfirmedPages— whether or not to save a received fax image page if the sender disconnects without sending the post-page message, without hearing our message confirmation, without retraining as requested, or otherwise breaks fax protocol following such pages for which the sender should not have a ``receipt confirmation''. 🫶SendFaxCmd¹ — the command to use to process outbound fax jobs; seefaxsend(8C). 🔥SendPageCmd¹ — the command to use to process outbound pager jobs; seepagesend(8C). 📟SendUUCPCmd¹ — the command to use to process outbound UUCP jobs. This parameter is not currently used, it's there for future development. Main character in waiting, lowkey.
ServerTracing²
Okay so bestie, this one is a number that controls the generation of tracing information by a server when it is not actively sending or receiving facsimile. 👀
Tracing is split into areas, and every area is controlled on its own. To trace multiple areas at once, you bit-or the flag for each area together and that combined value is what you put in this tag. Math but make it fax. 💅
1(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: commands 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 Transitions: server 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 execution131072(0x20000) — Docq Changes: document reference handling262144(0x40000) — TIFF library: any messages produced by the TIFF library524288(0x80000) — ECM Frames: binary T.30-A HDLC ECM frames1048576(0x100000) — SSL Fax data: SSL Fax data bytes
So like, if you wanna trace server operations and protocol operations, you'd put 1+2=3. Periodt. 🎀
NB: tracing timeouts and/or binary modem I/O can adversely affect the operation of the fax server; enabling these areas should be done with extreme care. 😭 Not a drill, bestie — treat those two like a hot stove.
Server tracing gets directed to syslog(3) using the facility you picked with the LogFacility configuration parameter. And heads up: syslogd(8C) must be configured to capture facility.info, facility.debug, facility.warning, and facility.err messages. See hylafax-log(5F) for a description of the logged messages. 🦋
SessionTracing²
A number that controls the generation of tracing information by a server while it's sending or receiving facsimile. ✨ The number is interpreted identically to ServerTracing — same vibe, different moment.
Important lil difference tho: session tracing goes into log files in the log subdirectory; peep hylafax-log(5F) for more info. 💖
ShareCallFailures²
A string that says which types of call failures should get shared to blocked jobs (in the scheduler config file) or to batched jobs (in the per-device configuration files). 🫶
Why tho? To stop a big ol' pile of jobs headed to the same destination from just stalling in the queue forever and repeatedly yeeting out failed delivery attempts because of call-related errors — think an incorrectly-entered destination number. 💀 Jobs that are batched or blocked (depends which config file you're in) get the same failure indication and the same ``dials'' increment as the job that was active and running at the time (or the one leading the batch). Iconic, honestly.
ShareCallFailures may contain these key words, in any order, with any deliniation:
busy— Busy signal detectednocarrier— No carrier detectednoanswer— No answer from remotenodialtone— No local dialtone
Alternatively, you can set ShareCallFailures exactly to always'' — that makes it apply to **all** of the call failure types listed above and is synonymous with busy nocarrier noanswer nodialtone''. 🌈
SpeakerVolume
The volume level the in-modem speaker should be adjusted to while in command mode. 🔥 The possible values are:
Off— 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; see ModemSetVolumeCmd. 🙈
StaggerCalls¹
The time, in seconds, to delay between initiating outbound job calls. ⏳
So if HylaFAX is using a single phone line shared for both sending and receiving of faxes, a StaggerCalls setting of, for example, 300 would ensure that outbound calls are made in succession no more frequently than every 5 minutes — which leaves time between jobs for incoming calls to be received. Giving your line a lil breather, as it deserves. 🌸
TagLineFont
The filename of the font to use in imaging tag lines across 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 or etc/LiberationSans-25.pcf.
If no font is specified, if a null filename is specified, or if the specified font file is not readable, then tag lines will not be generated. 😭
Note that the etc/lutRS18.pcf TagLineFont that has historically been the default with HylaFAX does not have glyphs available beyond basic ASCII — and to show non-ASCII characters you need a different file that has characters matching those characters found in TagLineFormat as decoded by the TagLineLocale setting. For this reason, the etc/LiberationSans-25.pcf is now considered the default, since it has unicode support for Latin, Greek, and Cyrillic characters. 🌍💜
TagLineFormat
The format string to use when imaging tag lines across the top of each transmitted page. ✨ This string may include escape codes that cause various items to be interpolated into the imaged tag line.
Any escape code supported by strftime(3C) (which use a single ``%'') may be used, as well as the following server-implemented codes:
%%a— destination subaddress%%c— destination company name%%C— sender's company name%%d— destination phone number%%g— sender's geographic location%%G— destination geographic location%%i— job identifier%%I— group identifier%%j— user-specified job tag%%l— job TSI or LocalIdentifier or canonicalized FAXNumber%%m— sender's electronic mail address%%n— canonicalized FAXNumber%%p— current page number of session%%P— current page number of job%%r— receiver's name%%s— sender's name%%S— subject%%t— total pages in session%%T— total pages in job%%v— sender's voice number%%V— destination voice number%%%— a literal ``%''
There are numerous date and time format options available through strftime(3C). Bestie, go read its documentation for the elaboration — it's giving rich. 📚 Used by default, %c'' is defined as The preferred date and time representation for the current locale.''
In addition, the format string may indicate that text is to be broken into multiple equal-sized fields by separating text with ``|'' characters. 🎯 Here's the rules:
- If the first character in the field is a ``{'' then the text is left-aligned.
- If the first character in the field is a ``}'' then the text is right-aligned.
- Otherwise, the text is centered in the field.
For example, {a|b|}c'' would cause the tag line to be broken up into three equal-sized areas, with the string a'' left-aligned in the first region, b'' centered in the second region, and c'' right-aligned in the third region. ✨
The default tag line format string is:
From %%n|%c|Page %%P of %%TThe differences between the %%p or %%P and the %%t or %%T options are noticed when a fax job is retried after an incomplete attempt, and only the previously unsent pages are then queued in a successive session. 👑 See also TagLineFont.
TagLineLocale
The locale setting for handling TagLineFormat, for example, ``en_US.UTF-8''. 🌸 If TagLineFormat is encoded via UTF-8 then the correct setting of TagLineLocale is requisite for proper decoding by the parser. By default the environment settings are used. 💅
TIFF2FaxCmd²
The command to invoke to convert a TIFF submitted for transmission to TIFF/F, suitable for transmission; see tiff2fax(8C). 🦋
In the scheduler configuration file this is used in outbound job preparation. In the per-device configuration files this is used in conjunction with RTFCC features for comparing relative data sizes between different formats. ✨
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 until the start of this time. The syntax for time-of-day restrictions is designed to be compatible with the syntax used by the UUCP software. The following BNF describes 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 either 2- or 3-characters, and a null day or time specification means any time or day. White space and other syntactic sugar may be freely inserted between tokens but may not be inserted between 24-hour times in the time range.
This value may be overridden by rules in the JobControl mechanism.
TSIRecvdCmd The pathname of the optional program, e.g. ``etc/tsirecvd'', that similar to DynamicConfig can set the RejectCall option to cause the current call to be rejected instead of continued. TSIRecvdCmd should provide a more capable mechanism than QualifyTSI for those wishing to screen calls based on received TSI. Note that this file must be marked as executable by the faxgetty process. Note also that any configuration modifications made by the TSIRecvdCmd script other than RejectCall is unsupported and has undefined results.
Unblock¹ Intended to only be used from the faxconfig(8C) utility, this will force faxq(8C) to unblock one call to the value-specified destination number. The destination number should be provided in the format known by faxq(8C), as seen in the hylafax-info(5F) database files.
Use2D¹ Control the use of 2D-encoded data for transmitted facsimile.
UseJobTagLine Allow the use of the job-specified tagline instead of the configured TaglineFormat
UUCPLockMode² The file protection mode that should be used when creating UUCP lockfiles. Note that this value is given in octal.
UUCPLockDir² The pathname of the directory in which UUCP lockfiles are to be created.
UUCPLockTimeout² The time in seconds to wait before removing a stale UUCP lockfile (i.e. a lockfile whose owner does not appear to exist). If this value is set to 0, then the fax server will never remove a stale lockfile.
UUCPLockType² A string that specifies the type of UUCP lockfile to create. The string may be one of ascii'' or binary'' depending on whether the process-ID of the lock owner is 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 of the lock filename. If the type string is prefixed with a +'', then SVR4-style filenames are generated using the major device number of the tty device and the major and minor device numbers for the filesystem on which the tty device resides. If the type string is prefixed with a -'', then any upper case letters in the device part of the lockfile name are converted to lower case letters; for example, LCK..ttyA01'' is converted to LCK..ttya01''. This upper-to-lower case conversion is useful for systems such as SCO where the convention is to name devices with upper-case letters, but create lockfiles with lower-case letters.
VGettyArgs A string that indicates whether or not the server should invoke a voice getty program in response to an incoming voice call. If the string value is not null, then it is interpreted as a set of arguments to pass to the vgetty program. Before supplying the arguments, the string is first scanned for %''-escape sequences: any appearance of %l'' is replaced with the tty name and any appearance of %s'' is replaced with the serial port speed (in decimal). Any appearance of escaped numbers 1 through 9 (%1'' through %9'') are replaced by the match to the corresponding CallIDPattern, if present. The %'' character can be specified with ``%%''. If the VGettyArgs parameter is not specified in the configuration file or if the string value is null, then voice connections will be rejected. Note that in addition to the specified command line arguments, the vgetty program is invoked with its standard input, output, and error descriptors directed to the controlling tty device.
WedgedCmd¹ The program to invoke when a modem is deemed ``wedged''; see wedged(8C).
MODEM-ORIENTED CONFIGURATION PARAMETERS This section lists configuration parameters that are specific to the setup and operation of the modem. All commands must be specified exactly as they are to be transmitted to the modem (note that this is a departure from previous versions of this software that automatically prepended AT'' to each line of commands sent to the modem). When multi-line commands are required, enclose the commands in quote marks ("'') and insert a newline character \n'' where lines 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 command escapes that force the host to alter the DTE-DCE communication rate, the flow control scheme used between the host and modem, delay for a period of time, flush input data, 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) <play:C> play the etc/playC.raw audio file (see below) Note that commands to the left of an escape code are sent to the modem before the associated actions are carried out on the host. This may be important when changing baud rates, as the result code from a command may be returned at the new baud rate. Also, beware that not all baud rates are supported by all systems and modems; the set of baud rates supported by a host is usually listed in stty(1).
The <waitfor:..>'' escape can be used to override the default behavior which is to wait for an OK'' response to a command sent to the modem. The possible response codes are: NOTHING a null response OK the default response CONNECT CONNECT...'' NOANSWER NO ANSWER...'' NOCARRIER NO CARRIER...'' NODIALTONE NO DIALTONE...'' BUSY BUSY'' OFFHOOK PHONE OFF-HOOK'' RING RING...'' ERROR error status from modem VCON voice connection indicator OTHER any unrecognized modem response For example ATO\r<waitfor:CONNECT>'' would send ATO\r'' to the modem and then wait for a response with 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 any input from the modem, and then continue (not wait for any response).
The <play:C>'' escape can be used to play a raw audio file with a voice modem. The files are named etc/playC.raw where C'' is any character. This feature can be used, for example, to play a brief audio message after picking up the line but before answering. A configuration example may be:
ModemRingResponse: "AT+FCLASS=8;H1\nAT+VSM=131\nAT+VLS=1\nAT+VTX\n<waitfor:CONNECT><play:1><waitfor:OK>AT+VTS=[933,,150]" ModemAnswerCmd: "<delay:100>AT+FCLASS=1;A" CallIDPattern: SHIELDED_DTMF CallIDAnswerLength: 4
In this example using an IS-101 voice-compliant modem, a RING indication from the modem will cause the modem to be placed in voice mode, set ulaw audio compression, and via the connected phone line play back the etc/play1.raw audio file, which may say, "After the tone enter a four- digit extension, then start the fax." Following the message a tone is played.
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 by the facsimile server. 👑
CONNECT FAX— Default: Fax · Class 1:-· Class 2:-· Class 2.0:--CONNECT— Default: Data · Class 1: Unknown · Class 2:-· Class 2.0:-NO ANSWER— Default: No Answer · Class 1:-· Class 2:-· Class 2.0:-NO CARRIER— Default: No Carrier · Class 1:-· Class 2:-· Class 2.0:-NO DIALTONE— Default: No Dialtone · Class 1:-· Class 2:-· Class 2.0:-ERROR— Default: Error · Class 1:-· Class 2:-· Class 2.0:-FAX— Default: Fax · Class 1:-· Class 2:-· Class 2.0:-DATA— Default: Data · Class 1:-· Class 2:-· Class 2.0:-+FCON— Default:-· Class 1:-· Class 2: Fax · Class 2.0: Fax+FCO— Default:-· Class 1:-· Class 2: Fax · Class 2.0: Fax+FDM— Default:-· Class 1:-· Class 2: Data · Class 2.0: Data+FHNG:— Default:-· Class 1:-· Class 2: Error · Class 2.0: ErrorVCON— Default:-· Class 1:-· Class 2: Voice · Class 2.0: Voice
Okay so real talk about those columns, bestie. The Default''</purple> column tells you how that result string gets read in <hotpink>either class 1 or 2</hotpink>, unless something explicitly overrides it. The <purple>Class 1'' column is all about result strings that get special handling for modems running in class 1, the Class 2''</purple> column is the special handling for class 2 modems, and the <purple>Class 2.0'' column is the special handling for class 2.0 modems. 💅
And if you see Unknown in there? That just means the interpretation depends on how the call got answered — if the answering happened for an explicit call type, that type is what's assumed; otherwise a Fax call is presumed. Not guessing, that's literally the rule. 🦋
ModemAnswerAgainCmd
The command to answer the phone if ModemAnswerCmd looks like it just got ignored 🙈. Typically this should include a delay escape, so the timing of the answer sits away from the ring — because if the modem can't answer that closely following the ring, you're gonna have a bad time.
ModemAnswerDataBeginCmd
The command to send to the modem once a data connection 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 as coming from a data modem. If this parameter isn't specified, or it's null, then the value of ModemAnswerCmd is used instead. Also peep AdaptiveAnswer and AnswerRotary. ✨
ModemAnswerDialCmd
The command to explicitly answer the phone for a dialed connection. This command must generate a result string that identifies the incoming call as coming from a facsimile modem. If this parameter isn't specified, or it's null, then the value of ModemAnswerCmd is used instead.
ModemAnswerFaxBeginCmd
The command to send to the modem once a facsimile connection 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 as coming from a facsimile modem. If this parameter isn't specified, or it's null, then the value of ModemAnswerCmd is used instead. See also AdaptiveAnswer and AnswerRotary. 🎀
ModemAnswerVoiceBeginCmd
The command to send to the modem once a voice connection 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 as being for voice. If this parameter isn't specified, or it's null, then the value of ModemAnswerCmd is used instead. See also AdaptiveAnswer and AnswerRotary. 🫶
ModemAnswerResponseTimeout
The maximum time, in milliseconds, to wait for a response from the modem after sending ModemAnswerCmd. Heads up though — you may wanna shorten this value when you're using the server-based adaptive answer strategy; go look at AdaptiveAnswer. 👀
ModemATCmdDelay
A delay, in milliseconds, that should be performed before each ``AT'' command string gets sent to the modem. ⏳
ModemBaudRateDelay
The amount of time, in milliseconds, to pause after setting the baud rate on the serial line. This is only needed for hosts and modems (think USRs) where setting the serial line parameters does not take effect immediately.
ModemCEDCmd
The command to signal CED and raise the V.21 HDLC transmit carrier after a session has started. This gets used after a procedure interrupt. Normally this command is ATA'', but if the modem doesn't permit ATA'' after a session has started, then ``AT+FTH=3'' should probably be used instead.
ModemCNGCmd
The command to signal CNG and listen for V.21 HDLC after a session has started. This gets used after a procedure interrupt. Normally this command is ATD'', but if the modem doesn't permit ATD'' after a session has started, then ``AT+FRH=3'' should probably be used instead.
ModemCommaPauseTimeCmd
The command to set the time, in seconds, that the modem should pause when it hits a ``,'' modifier in the dialing string. 🦋
ModemDialCmd
The command to place a phone call. The string is assumed to be suitable for use as a parameter to the sprintf(3S) function — so the %'' character should be escaped as %%''. The dial command must include a single %s'' where the number that's to be dialed gets substituted. The command may include a single %d'' where the origin number gets substituted.
Facilities like tone or pulse dialing, outgoing prefixes to route through a PBX, and so on, should all be baked into the dialing command string. Also super important: if possible, a trailing @'' symbol should be included so the modem returns result codes that distinguish between **no answer** and **no carrier**. Using the @'' lets the server reduce the probability that a wrong number is continually redialed. If your modem doesn't support this facility, then it may be necessary to raise the number of retries done when a ``NO CARRIER'' result comes back. 🔥
ModemDialResponseTimeout
The maximum time to wait, in milliseconds, for a response from the modem after sending [the original text just kind of stops right there, bestie — no cap 💀] This value should be longer than the timeout programmed into the modem through the ModemWaitTimeCmd parameter. This extra server-based timeout exists to guard against modems that can ``lock up'' while dialing the telephone. 😭
ModemDoPhaseCDebug
Whether or not to query the modem for responses during image data transmission. Normally the modem shouldn't produce any responses during Phase C data transmission. However, in some debugging scenarios (i.e. some Class 2.1 modems may show debugging information) it may be appropriate to query the modem for responses during the data transmission. 🔍
ModemDTRDropDelay
The time, in milliseconds, to pause between placing DTR OFF and DTR ON while resetting a modem. This value should be at least equal to the time-value of the analogous S-register, usually S25. This so-called DTR drop can be bypassed entirely by setting ModemDTRDropDelay to 0 — but that should likely only be used for debugging purposes. 🙈
ModemEchoOffCmd
The command to disable echoing of commands sent to the modem.
ModemFlowControl
The type of flow control to use between DTE and DCE; one of NONE'', XONXOFF'' and ``RTSCTS''. This value is used to select the string sent to the modem to initially establish DTE-DCE flow control; one of ModemNoFlowCmd, ModemSoftFlowCmd, and ModemHardFlowCmd. The current flow control setting is also used to select the appropriate flow control command to send to the modem when the software switches to Class 1, 2, or 2.0; see Class1HFLOCmd, Class1NFLOCmd, Class1SFLOCmd, Class2HFLOCmd, Class2NFLOCmd, and Class2SFLOCmd. ✨
The server supports both software and hardware flow control for Class 1, Class 2, and Class 2.0 modems. Whether to use hardware or software flow control depends on the capabilities of the modem and the host hardware and operating system. Communication rates above 9600 baud often require that hardware flow control be used for reliable DTE-DCE communication. However — beware — many modems only support software flow control when sending or receiving facsimile. ⚠️
Note that modems usually support software flow control even if they have no explicit AT-command to activate it; in this case it gets switched on when the modem enters fax mode, having AT+FCLASS=... from DTE.
ModemFrameFillOrder
The bit order to expect for received HDLC frames and to use when formulating HDLC frames to send. This value may be either LSB2MSB when bits are ordered from least-significant-bit to most-significant-bit (as in the CCITT specification) or MSB2LSB when bits are ordered in the reverse direction. 🦋
ModemHardFlowCmd
The command to setup hardware (RTS/CTS) flow control between DTE and DCE.
ModemMinSpeed
The minimum acceptable signalling rate for transmitting facsimile page data. Possible values are: 2400, 4800, 7200, 9600, 12000, and 14400. ⚡
ModemMfrQueryCmd
The command to send to the modem to get the manufacturer identification string. If this parameter isn't set, then it gets initialized to AT+FMFR?'' for Class 2 modems, or to AT+FMI?'' for Class 2.0 modems, or to ATI3'' for Class 1 modems. And if the parameter begins with a !'', then the remainder of the string is taken to be the identification string and no command is issued to the modem. 👑
ModemModelQueryCmd
The command to send to the modem to get the model identification string. If this parameter isn't set, then it gets initialized to to AT+FMDL?'' for Class 2 modems, or to AT+FMM?'' for Class 2.0 modems, or to ATI0'' for Class 1 modems. And if the parameter begins with a !'', then the remainder of the string is taken to be the identification string and no command is issued to the modem. 💜
ModemNoAutoAnswerCmd— the command that stops the modem from picking up all by itself when the phone rings. we do NOT do auto-answer here 🛑ModemNoAutoAnswerCmdDelay— how long to pause, in milliseconds, after you get theOKback fromModemNoAutoAnswerCmdbefore you send literally anything else to the modem. and bestie, all input coming in from the modem gets flushed once that pause is over. 🫧ModemNoDialtoneRetries— the max number of attempts to snag a dialtone off the line when you're placing a call. how many times we're willing to try 🔁ModemNoFlowCmd— the command that turns OFF flow control between DTE and DCE. goodbye flow control 🚫ModemOnHookCmd— the command that puts the phone on hook, aka hangs it up. like actually ending the call 💀☎️ModemPageDoneTimeout— the max time to wait, in milliseconds, for the modem to say something back after you send a whole page of facsimile data. think: waiting for the response to a Class 2/2.0AT+FETcommand. we are waiting, respectfully ⏳ModemPageStartTimeout— the max time to wait, in milliseconds, for that first response from the modem when you start sending a page of facsimile data. think: waiting for the response to a Class 2/2.0AT+FDRcommand. the opening beat of the page 🎬ModemRaiseATCommands— says whether ALL the config AT commands for the modem should get auto-raised to upper-case. the standard is upper-case everything in AT commands, and honestly some rare modems are known to act a whole mess with lower-case commands. BUT sometimes an admin wants lower-case commands for a rare edge case, like working around a modem that blacklists dialed numbers. upper-case is the moment, but exceptions exist 🔠ModemRate— the baud rate for DCE-DTE communication. this value can be one of:115200,76800,57600,38400,19200,9600,4800,2400,1200. the default is19200because so many modems lock the rate at 19200 when they're sending or receiving facsimile. ⚠️ heads up: not every value is supported by every operating system and modem, so go consultstty(1)for the rates your system actually has. default 19200, no cap 📶ModemReadyCmds— a string of commands to throw at the modem during reception initialization. this string goes out to the modem after the standard set of configuration commands the fax server needs. why tho? for stuff like un-busying a DID line so calls can actually come through. let the calls in!! 🚪✨ModemRecvFillOrder— the bit order to expect for received facsimile data. this value can be eitherLSB2MSBwhen bits are ordered from least-significant-bit to most-significant-bit (that's the CCITT specification way) orMSB2LSBwhen bits are ordered the other direction. per all the various specs, every modem should return data inLSB2MSBorder. HOWEVER 💀 most Class 2 modems (except maybe only Multitech) useMSB2LSBfor compatibility with modems built on Rockwell hardware/firmware that shipped with a bug that was way too widespread to ever correct.
if this parameter isn't set, it gets autodetected and set to LSB2MSB for Class 1 and Class 2.0 modems, and MSB2LSB for non-Multitech Class 2 modems. but that autodetect may be straight-up wrong for your modem, so you'll have to specify this parameter explicitly. autodetect is giving best guess energy 🔍
ModemRecvSuccessCmd— a string of commands to send to the modem after a successful receive session, before the call gets disconnected. victory lap commands 🏆ModemResetCmds— a string of commands to send to the modem during initialization. this string goes to the modem before the standard set of configuration commands the fax server requires. ⚠️ important: these commands should NOT include normal reset commands that are already specified through other parameters. for example, commands to set up flow control, DCD handling, DTR handling, etc. belong in the appropriate configuration parameters, NOT in this one. also, the soft reset command (usuallyATZ) should NOT be included in this string — the servers issue that command explicitly. do not double up, bestie, the servers handle it 🙅♀️ModemResetDelay— the time, in milliseconds, to pause after setting DTR ON while resetting a modem. here's the thing: DTR ON doesn't respond withOK, so this parameter has to be long enough to give the modem time to be ready forModemSoftResetCmdnext. give it a sec to wake up 😴ModemResultCodesCmd— the command that enables result codes. turn the codes on ✅ModemRevQueryCmd— the command you send to the modem to get a firmware revision identification string back. if this parameter isn't set, it's initialized toAT+FREV?for Class 2 modems, or toAT+FMR?for Class 2.0 modems. and if the parameter starts with a!, then the rest of the string is just taken as the identification string and no command gets issued to the modem at all. sneaky little shortcut 🕵️♀️ModemSecondAnswerCmd— the command to send to the modem in case that first answer command comes back withOKinstead of the indication you'd otherwise expect. this command exists to resume the answer procedure right where the first one left off. take two, continue from where we were 🎯ModemSendBeginCmd— the command to send to the modem once carrier is established during a transmit operation. this parameter is genuinely useful for systems that can't enable hardware flow control without DCD asserted. niche but iconic 🔧ModemSendFillOrder— the bit order the modem expects for transmitted facsimile data. this value can be eitherLSB2MSBorMSB2LSB(peepModemRecvFillOrderabove for the full lore). virtually every modem expects transmitted facsimile data inLSB2MSBbit order. LSB2MSB, basically always 📤ModemSetOriginCmd— the command used to set the call origin information before placing a call. the command can include a single%d, which is where the job requestfaxnumberstring gets substituted. it can also include a single%s, which is where the job requestfaxnamestring gets substituted. templating era 🪄ModemSetVolumeCmd— the commands used to set the modem speaker volume levels. there should be FIVE whitespace-separated commands, one each for setting the volume toOff,Quiet,Low,Medium, andHigh. the default is"ATM0 ATL0M1 ATL1M1 ATL2M1 ATL3M1". also seeSpeakerVolume. 🔊✨ModemSetupAACmd— the command to set up adaptive answer support in the modem, if it's available. "adaptive answer" is the term for the ability to tell apart calls coming from facsimile, voice, and data sources. 📝 note that this string is the LAST command issued by the device drivers during setup, so if it needs to, the command string can switch to a different operating mode (for example, on some Rockwell-based modems you have to issue theAT+FAA=1command in Class 0). last one in, so it can change the vibe 🎭ModemSetupDCDCmd— the command to set up DCD handling. on most systems the facsimile server enables the CLOCAL flag on the tty device the modem is connected to. this should make sure the system does NOT close an open file descriptor associated with the modem when carrier gets dropped. so for most systems and modems,ModemSetupDCDCmdshould set up DCD to reflect carrier. carrier dropped ≠ hang up the fd 📡ModemSetupDTRCmd— the command to set up DTR handling so the modem gets reset when the host lowers the DTR signal. the facsimile server uses this facility to make sure modems don't get left in a "locked up" state. nobody likes a stuck modem 🔒ModemSoftFlowCmd— the command to set up software (XON/XOFF) flow control between DTE and DCE. soft flow, soft life 🌊ModemSoftResetCmd— the command that forces a soft reset of the modem. gentle reset, not a hard one 🔄ModemSoftResetCmdDelay— the time, in milliseconds, to pause after receiving theOKfollowingModemSoftResetCmd, before any further commands get sent to the modem. let it breathe 🌬️ModemSoftRTFCC— whether or not to enable software-driven Real-Time Fax Compression Conversion. RTFCC lets HylaFAX convert the image compression between MH MR and MMR formats, regardless of howfaxqformatted the image file. 🚨 note that when you're using RTFCC, the compression format of the file gets IGNORED, which means the-1,-2, and-3options forsendfax,ps2fax, and others will only influence how the document is prepared byfaxq— they will NOT influence the actual negotiated session parameters. also,Class2RTFCCtakes precedence overModemSoftRTFCC, and if both are enabled, then software-driven RTFCC will not be performed in favor of the firmware-driven RTFCC. firmware wins the tiebreak, periodt ⚔️ModemType— this parameter MUST be set to one of:Class2,Class2.0,Class1, orClass1.0, to indicate that the modem is a Class 2-, Class 2.0-, Class 1-, or Class 1.0-style modem, respectively. if this parameter isn't set, HylaFAX detects which classes the modem supports and makes an internal decision on which one to use. historically, that decision picks Class 2.1 over Class 2.0 over Class 2 over Class 1.0 over Class 1. BUT some exceptions get made — for instance, with US Robotics modems, where Class 2.0 support is avoided. the class hierarchy is real 👑ModemVerboseResultsCmd— the command that enables verbose result codes, as opposed to numeric ones. words not numbers 💬ModemWaitForConnect— if this is enabled, the facsimile server will NOT consider a connection established when answering an incoming call until it receives aCONNECTstatus string. this is mainly useful for Rockwell RC32ACL-based modems, which sendFAXandDATAstatus messages before they sendCONNECT. wait for the CONNECT, bestie, it's coming ⏱️ModemWaitTimeCmd— the command that sets the number of seconds to wait for a carrier signal when placing a call or answering the phone. carrier signal, please show up 📞
✨ T.30 PROTOCOL CONFIGURATION PARAMETERS ✨
Okay so these parameters are all about the implementation of the CCITT T.30 facsimile protocol inside the Class 1 device driver. And listen — do not go changing these unless you have a full, deep, spiritually-complete understanding of how the server operates. Like, fully. 💀 These are not vibe-check-and-see settings.
FaxT1Timer— the value of the T1 timer, in milliseconds. This one times out the initial session contact, i.e. the receipt ofDIS/DCS.FaxT2Timer— the value of the T2 timer, in milliseconds. This one caps how long we wait for expected HDLC frame commands from the remote. Example: waiting on thePPSsignal during Phase D. The spec says this should be6.0s +/- 15%. Usually when this timer expires it means the fax session has failed, periodt. 😭FaxT4Timer— the value of the T4 timer, in milliseconds. This one caps how long we wait for HDLC frame responses from the remote. Example: waiting for the response to thePPSsignal during Phase D. The spec gives this as3.0s +/- 15%for automatic units and4.5s +/- 15%for manual units. Usually when this one expires it triggers retransmissions of commands.
🦋 CLASS 1 MODEM CONFIGURATION PARAMETERS 🦋
These ones are specific to configuring Class 1-style modems. And fr fr, they should not be changed lightly:
Class1Cmd— the command that puts the modem into Class 1 operation.Class1AdaptRecvCmd— the command used to enable adaptive reception support (usuallyAT+FAR=1). This feature is new in T.31, and ngl a lot of modems just won't support it. But when it works? It may reduce the number of reception failures caused by errors cascading from+FCERRORmessages. 💅Class10AutoFallback— whether or not the modem implements an automatic fallback to G3 mode when V.8 handshakingANSamis not detected for a Class 1.0 V.34-Fax (SuperG3) call.Class1ColorJPEGSupport— whether or not to enable support for T.30-E full-color facsimile with JPEG compression. Turning this on automatically turns onClass1GreyJPEGSupporttoo. Iconic.Class1EnableV34Cmd— the command to enable V.34-fax support with at least the desired maximum primary channel rate.Class1ECMCheckFrameLength— whether or not to require the frame length for ECM data frames to be complete when checking for frame integrity. Normally this is not beneficial (and it can be problematic for some senders), but in some cases the frame CRC isn't reliable because of modem behavior. 🫶Class1ECMSupport— whether or not to support the T.30-A error correction protocol. Heads up: using ECM requires 64 kilobytes of free memory per modem in active use.Class1PersistentECM— whether or not to keep retransmitting and allow you to keep receiving image data in ECM protocol that isn't accepted as valid after four successive attempts.Class1ECMFrameSize— the size in bytes of image frames to transmit during ECM protocol. This setting also indicates a preference in receive sessions. The only acceptable values are64and256. A setting of64may be useful on high-load systems, and possibly in environments with extremely poor line quality.Class1ExtendedRes— whether or not to support resolutions other than normal and fine. This option has been deprecated byClass1Resolutions. 🙈Class1ExpectedPageSize— the expected receive page size in bytes, used to calculate wait times for non-ECM Phase D if a premature Phase C carrier loss occurs.Class1FrameOverhead— the number of extraneous bytes in HDLC frames sent to the host in response to anAT+FRHcommand. For modems that properly implement the Class 1 interface, this number should be4(the default).Class1FRHNeedsReset— if the modem's+FRH=3command sometimes needs to be reset in order to do its job, enable this. Doing so limits the wait time for the+FRH=3command before re-issuing it.Class1FullDuplexTrainingSync— whether or not to enable support for a full-duplex modem feature while receiving training, for when the sender doesn't readily sync.Class1GreyJPEGSupport— whether or not to enable support for T.30-E greyscale facsimile with JPEG compression. This is always enabled ifClass1ColorJPEGSupportis enabled.Class1HookSensitivity— the number of times to ignore on-hook detections and merely treat them as command or modem errors.Class1JBIGSupport— whether or not to enable support for T.85 monochrome facsimile with JBIG compression. The options are:true— support in both sending and receivingfalse— no supportsend— support only in sendingreceive— support only in receiving
And also: if a compatible JBIG library was found during the build process, then send support is enabled by default. If the TIFF tools were found to support JBIG during the build process, then receive support is enabled by default. 🎀
Class1MRSupport— whether or not to enable support for two-dimensional Modified Read (MR) image data format compression.Class1MMRSupport— whether or not to enable support for two-dimensional Modified Modified Read (MMR) image data format compression. Note: MMR support also requires ECM support to be enabled. They're a package deal, bestie. 🫶Class1HasRHConnectBug— a Class 1 modem should only reportCONNECTafterAT+FRH=3when V.21 HDLC data is detected. But some modems will incorrectly reportCONNECTafterAT+FRH=3whenever any carrier is present. In those cases,Class1HasRHConnectBugshould be set totrue. 😭Class1HasRMHookIndication— a Class 1 modem should returnERRORafterAT+FRM=<mod>when it is on hook. But some modems will incorrectly useERRORto report a carrier detection mismatch. In those cases,Class1HasRMHookIndicationshould be set tofalse.Class1HFLOCmd— the command to set up hardware (RTS/CTS) flow control between DTE and DCE when operating in Class 1. This command is issued immediately after sending theClass1Cmdto switch the modem to Class 1 operation.Class1NFLOCmd— the command to set up no flow control between DTE and DCE when operating in Class 1. This command is issued immediately after sending theClass1Cmdto switch the modem to Class 1 operation.Class1PageLengthSupport— the coded value for page lengths supported by the modem. The only correct values and their meanings are exactly these:1— A4 page length3— both A4 and B4 page length7— unlimited page length
Class1PageWidthSupport— the coded value for page widths supported by the modem. The only correct values and their meanings are exactly these:1— A4 page width3— both A4 and B4 page width7— all of A4, B4, and A3 page widths
Class1PPMWaitCmd— the command used to stop and wait before sending the post page message, except before sendingEOP, whereClass1EOPWaitCmdis used instead. We have to make sure the high-speed carrier has completely stopped. Per T.30, Chapter 5, Note 4, this delay should be75 +/- 20 ms.Class1PhaseBRecvTimeoutCmd— in the event that Phase B receive times out without receiving signaling, this command is issued after each attempt. Some callers can require the callee to do something (besides the usual fax signaling) to bridge the call.Class1ResponseWaitCmd— the command used to stop and wait after sendingTCF, before attempting to receive a training response from the remote. Set this toAT+FTS=1if the modem respondsOKbefore actually dropping the high-speed TCF carrier.Class1Resolutions— a bitmapped (bit-or'd) value indicating the resolutions to be supported during facsimile operation. The individual resolutions follow Table 21/T.32 and are defined as follows:- Bit
0(0x00) —R8 x 3.85 l/mm, Normal - Bit
1(0x01) —R8 x 7.7 l/mm, Fine - Bit
2(0x02) —R8 x 15.4 l/mm, Superfine - Bit
4(0x04) —R16 x 15.4 l/mm, Hyperfine - Bit
8(0x08) —200 dpi x 100 l/inch - Bit
16(0x10) —200 dpi x 200 l/inch - Bit
32(0x20) —200 dpi x 400 l/inch - Bit
64(0x40) —300 dpi x 300 l/inch
- Bit
So like, a value of 3 would indicate support for normal, fine, and superfine resolutions. Math is giving ✨
Class1RMQueryCmd— the command to send to the modem to get the list of supported reception bit-rates. If the parameter begins with a!, then the rest of the string is taken to be the modem response and no command is issued to the modem.Class1TCFWaitCmd— the command used to stop and wait before sendingTCF, similar toClass1PPMWaitCmd. Per T.30, Chapter 5, Note 3, this delay should be75 +/- 20 ms.Class1TMQueryCmd— the command to send to the modem to get the list of supported transmission bit-rates. If the parameter begins with a!, then the rest of the string is taken to be the modem response and no command is issued to the modem.Class1EOPWaitCmd— the command used to stop and wait before sending the post page message, similar toClass1PPMWaitCmd. We allow a different setting in the case ofEOPthough, because empirically some machines may need more time. 😮💨Class1ModemHasDLEBug— used to indicate that the modem does not correctly duplicateDLEcharacters in the V.21 communication to the DTE.Class1MsgRecvHackCmd— if receive failures occur due to+FCERRORjust prior to image data reception, settingClass1MsgRecvHackCmdtoAT+FRS=1may help.Class1RecvAbortOK— the time, in milliseconds, to wait for anOKresult code from the modem after aborting an HDLC frame receive (AT+FRH=3). If this number is zero, then the modem is assumed to not correctly implement aborting, and instead the driver will sendAT\nand wait500msfor anOKresult. If this number is zero, then the same is assumed for abortingAT+FRM=n. 🫠
Class1RecvIdentTimer — how long, in milliseconds, you're gonna sit there waiting for that very first DCS when you're receiving a fax. CCITT recommendation T.30 says this should be the value of the T1 timer, periodt. BUT. If you're running one of those adaptive answering schemes — you know, like the one described above under the AdaptiveAnswer parameter — you might need to shorten this timer. She's flexible like that. 💅
Class1RestrictPoorDestinations¹ — the threshold of destination audio quality corruption at which resolution support gets restricted to ``normal'' and color support gets switched off. Why? To reduce the amount of image data we even try to send to a destination with trash audio quality, which cuts the call duration down, which should make a successful session more likely. Iconic problem-solving honestly. 🌸
The threshold is a ratio — an integer percentage — of the data the destination flagged as corrupt versus the total data sent to that destination across the previous three fax sessions. And okay so, Class1RestrictPoorDestinations does work for destinations with a history of both ECM and non-ECM sessions, but the ECM session history is preferred and weighted considerably higher than the non-ECM session history. ECM stays the main character. 👑
Class1RestrictPoorSenders — same energy, sender edition. This is the threshold of sender audio quality corruption at which resolution support gets restricted to ``normal'' and color support gets disabled. The goal is to reduce the amount of image data a sender with poor audio quality will try to transmit, cutting call duration and improving the odds of a successful session. 🫶
The threshold is the ratio, expressed as an integer percentage, of corrupt data received compared to total data received from the current sender in the previous three fax sessions. Heads up though: Class1RestrictPoorSenders requires a CallIDType of ``calling-number'' to be configured, otherwise it can't match a sender to an entry in the info database. No CallIDType, no vibes. 🦋
Class1RMPersistence — how many times we attempt to receive the high-speed data carrier (which results in +FCERROR) before we go ahead and attempt low-speed message carrier reception. Some modems are quick to (maybe incorrectly 😭) return +FCERROR, and for those lil guys you want a value of 2 or 3. For modems that aren't quick about it, use 1. Tuning this right gives you a kind of "adaptive reception control" for modems that accurately return +FCERROR without supporting Class1AdaptRecvCmd. And for modems that do support Class1AdaptRecvCmd, Class1RMPersistence should probably not be set at 1 — although honestly +FCERROR should almost never happen with those modems anyway.
If your modem doesn't support reporting +FCERROR or adaptive reception control at all, then Class1RMPersistence should probably be set at 0, which shortens the timeout spent looking for the high-speed data carrier — increasing the likelihood of recovery from any dissynchronization. But when Class1RMPersistence is anything other than 0, it's assumed that +FCERROR reporting or Class1AdaptRecvCmd is functional, so the timeout looking for the high-speed data carrier gets lengthened. Pick your fighter. 💀
Class1SwitchingCmd — the command used to make sure the sending facsimile device has turned its modulator off (i.e. loss-of-carrier), exactly as recommended by T.31: Appendix II.1. ✨
Class1SendNSF — whether or not to send an NSF signal when answering a fax call. That's it, that's the whole thing. 🙈
Class1SFLOCmd — the command to set up software (XON/XOFF) flow control between DTE and DCE when operating in Class 1. This one gets issued immediately after sending the Class1Cmd to flip the modem into Class 1 operation. Timing is everything bestie. ⭐
Class1SSLFaxCert — the relative path to the PEM certificate file for SSL Fax use. Normally this is created for you by faxsetup(8C). 🎀
Class1SSLFaxClientTimeout — the time, in milliseconds, that the SSL Fax server should wait for the client connection to complete before it gives up on SSL Fax and proceeds with a traditional fax operation. 🧚
Class1SSLFaxInfo — the formatted hostname and port number for the SSL Fax connection for this modem. (And yes, every modem should use a different port number, don't be messy.) This tells the remote system how to connect through the IP network to this system acting as an SSL Fax server. 🔥
Firewalling and port forwarding should be carefully addressed prior to using this configuration. Do not skip this step, I'm literally begging. 😭
The format for Class1SSLFaxInfo is <hostname>:<port>. During fax protocol, this information gets made into a URL by prepending ssl://<passcode>@ and it's communicated as part of CSA and TSA signals for SSL Fax. (<passcode> is a string of random characters, very mysterious of it.)
<hostname> may be specified as an IP address — however, in those cases it should be bracketed, like this: [<address>]:<port>. This prevents confusion, especially with IPv6 addresses. 💜
Either the sender or the receiver (or both!) must signal an SSL Fax URL in order for SSL Fax to operate at all. And if no Class1SSLFaxInfo is configured for one system, then that system is always dependent on the remote systems to operate as the SSL Fax server. No solo missions. 🌈
Class1SSLFaxProxy — the formatted password, hostname, and port number (<passcode@<hostname>:<port>) for an SSL Fax proxy connection, to be used if no Class1SSLFaxInfo is configured. This makes HylaFAX establish an outbound SSL Fax connection to a configured SSL Fax proxy server when fax connections to remote systems support SSL Fax. The proxy server then hands the proxied SSL Fax URL back to HylaFAX, which uses it in the CSA and TSA signals for SSL Fax. Middleman but make it slay. 💅
Class1SSLFaxServerTimeout — the time, in milliseconds, that the SSL Fax client should wait for the connection to the server to complete before abandoning SSL Fax and proceeding with a traditional fax operation. Usually this has to be shorter than 3 seconds. Clock's ticking bestie ⏳
Class1SSLFaxSupport — whether or not to enable SSL Fax support. Toggle away. ✨
Class1TCFMaxNonZero — the maximum percentage of non-zero data bytes permitted in an acceptable received TCF. Important note: this number does not include any leading non-zero data in the received data. See also Class1TCFMinRun. 🌸
Class1TCFMinRun — the duration, in milliseconds, of the minimum run of zero data in an acceptable received TCF. This value should be specified according to a 1.5 second transmission of zero data, meaning it should be between 0 and 1500. See also Class1TCFMaxNonZero and Class1TCFMinRunECMMod. 🦋
Class1TCFMinRunECMMod — the factor by which Class1TCFMinRun should be modified in the case of an ECM session. Since ECM protocol allows retransmissions, it's commonly faster to accept a lesser-quality data stream and deal with the subsequent retransmissions than it is to let the communication speed slow down — where the demodulation may still not produce an ideal data stream anyway. So like, why bother. 💀
Class1TCFRecvHackCmd — if you're getting receive failures due to +FCERROR right before TCF data reception, setting Class1TCFRecvHackCmd to AT+FRS=1 may help. It's a hack, it's in the name, but it works. 🙈
Class1TCFRecvTimeout — the maximum time to wait, in milliseconds, for the first byte, and again for the entirety of the Training Check (TCF) message data that gets received during the training phase of the facsimile reception protocol. Two waits, one parameter. 💅
Class1TMConnectDelay — the time, in milliseconds, to delay after receiving CONNECT following +FTM before sending image data. Here's the lore: T.31 8.3.3 requires the modem to respond with CONNECT before the modulation training pattern. But if the modem can't buffer all the data sent to it before successful modulation training, then data — especially during TCF, since it's so short — could be lost. 😭
Many modems reasonably do not follow T.31 in this regard, and thus the default is zero; however, using it with such modems would likely have a negligible effect. And when you're using modems that can buffer data during the training period, the default is also functional. So it's giving "everyone's fine either way". 🫶
The modulator training time period varies by modulation and bitrate. V.17 fast train and V.29 both take less than 400 ms. However, V.27ter can take twice that long, and V.17 slow train can take four times as long. So the early CONNECT stipulation by T.31 8.3.3 becomes programmatically cumbersome for the DTE. Not the vibe. 😮💨
T.31 8.3.3 also requires the modem to transmit constant ones after modulator training completes and before the DTE supplies data. Because of that, some receivers have become dependent on seeing a 1-to-0 bit transition at the outset of Phase C ECM data — and honestly, that same expectation for TCF would not be surprising either, since both Phase C ECM and TCF involve predictable patterns. So, when not using SSL Fax or SuperG3 V.34-Fax, HylaFAX transmits a single byte of ones at the outset of both TCF and Phase C ECM image data to make sure there's a 1-to-0 bit transition. ⭐
Such a thing does not seem necessary at the outset of non-ECM Phase C data, though — that data pattern isn't so predictable, and any data loss is likely to go unnoticed anyway. ✨
Class1ValidateV21Frames — whether or not to use the FCS bits of received V.21 HDLC frames to check the validity of the frame itself. Most Class 1 modems perform this check independently (per T.31 7.4) and don't require this feature to be enabled. So like, it's there if you need it bestie. 👑
🌈 CLASS 2 AND 2.0 MODEM CONFIGURATION PARAMETERS 🌈
The following parameters are specific to the configuration of Class 2- and Class 2.0-style modems. Different modem, different rules. 🎀
Class2Cmd — the command to set the modem into Class 2/2.0 operation. The switch-flipper. 💅
Class2AbortCmd — the command to use to abort an established session. And listen: after using this command to abort a session, the fax software will send ModemOnHookCmd and then reset the modem by dropping DTR. So it's a whole sequence, not just a one-and-done. 🦋
Class2APCmd — a largely unused option for modems supporting ITU-T.32, Class 2.1, standards. This command would be used to enable sending and receiving SUB, SEP, and PWD frames. Would. If you used it. Which, largely, you don't. 💀
Class2APQueryCmd— the lowkey forgotten one 💅 it's a mostly-unused option for modems that ride with ITU-T.32, Class 2.1, standards. It'd be the command you use to query the capabilities of sending and receiving SUB, SEP, and PWD frames. If your modem doesn't support anyClass2APQueryCmd, just set it tononeand move on bestie 🫶Class2BORCmd— this sets the bit order of sent and received facsimile data. Normally you'd useAT+FBOR=0so data goes out and comes in as direct bit order (LSB2MSB). But some modems, like the Everex 24/96D, have to use reversed bit order for Phase B and D data exchanges, otherwise a bug drops straight-up garbage into the padding of EOL codes 😭. Whatever bit order this command picks, it must match up with theModemSendFillOrderandModemRecvFillOrderparameters. no cap.Class2BUGCmd— turns tracing of HDLC frames (sent + received by the modem) on or off. That tracing info is supposed to come back to the host in+FHR:and+FHT:status strings. Heads up though: lots of Class 2 modems don't support this at all, and it's basically a diagnostic thing. If your modem has zero support, usenone💀Class2CIGCmd— the command that sets a polling identifier. Your string gets inserted into the format%s="<id>".Class2CQCmd— the command that sets up the parameters for copy quality checking. Say, for an Everex 24/96D you might set this toAT+FCQ=1\nAT+FBADMUL=20\nAT+FBADLIN=10. You should configureClass2CQCmdto set up all the available copy quality services thatClass2CQQueryCmdsays you've got. Wanna disable some of those available features? ConfigureClass2CQQueryCmdwith a!, then setClass2CQCmdto match ✨Class2CQQueryCmd— the command you send to the modem to get the copy quality capabilities string. Fun trick: if the parameter starts with a!, then the rest of the string is taken as the capabilities string and no command goes to the modem at all. That lets you pair it withClass2CQCmdto force copy quality checking to happen in the server instead of the modem. PeepPercentGoodLinesandMaxConsecutiveBadLinesfor the server-side copy quality checking params 👀. Oh and — if copy quality checking is configured to be done by the modem, then it is not done by the server. one or the other, bestie.Class2CRCmd— the command used to enable the reception of facsimile.Class2DCCCmd— the command used to set modem capabilities. Inserted into the format%s=vr,br,wd,ln,df,ec,bf,st.Class2DCCQueryCmd— the command you send to the modem to get the Class 2/2.0 capabilities. Same little trick as before: if the parameter starts with a!, the rest of the string is taken as the capabilities string and nothing gets sent to the modem 💅Class2DDISCmd— the command to set session parameters before dialing. Inserted into the format%s=vr,br,wd,ln,df,ec,bf,st. Setting this parameter turns on support for those Class 2 modems that don't properly implement theAT+FDIScommand, by setting up session parameters before the telephone gets dialed. iconic workaround fr.Class2DISCmd— the command used to set the current session parameters. Inserted into the format%s=vr,br,wd,ln,df,ec,bf,st.Class2ECMType— the way the EC parameter in the modem DCC response gets interpreted actually differs between the Class 2 spec (that's2) and the Class 2.0 spec (that's2.0). This config parameter lets the administrator pick which type to use. By default, the spec type that corresponds is the one used 🎀Class2HexNSF— whether or not to parse the NSF strings the modem reports using hexadecimal values. By default, they are parsed as hexadecimal values.Class2HFLOCmd— the command to set up hardware (RTS/CTS) flow control between DTE and DCE while running in Class 2/2.0. It gets issued right after sending theClass2Cmdto flip the modem into Class 2/2.0 operation. For Class 2.0 operation the default isAT+FLO=2.Class2JBIGSupport— whether or not to enable support for T.85 monochrome facsimile with JBIG compression. Your options:truefor support in both sending and receiving,falsefor no support at all,sendfor sending only, andreceivefor receiving only. If the modem supports JBIG and a compatible JBIG library was found during the build process, then send support is on by default. And if the modem supports JBIG and the TIFF tools were found during the build to support JBIG, then receive support is on by default 🌸Class2JPEGSupport— whether or not to enable and actually utilize the JPEG support found in the modem.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 negotiated for transmitting page data. This string is inserted into the format%s=<speed>Class2NFLOCmd— the command to set up no flow control between DTE and DCE while running in Class 2/2.0. It's issued immediately after sending theClass2Cmdto flip the modem into Class 2 operation. For Class 2.0 operation the default isAT+FLO=0.Class2NRCmd— (Class 2.0 only, bestie 👑) the command to set up negotiation message reporting. For the Class 2.0 driver to work correctly, this command must enable the reporting of: receiver parameters, transmitter parameters, and ID strings. It is not necessary to enable reporting of non-standard frames for correct Class 2.0 driver operation.Class2PACmd— another largely-unused option for modems that support ITU-T.32, Class 2.1, standards. It'd set up the polling address string that's enabled byClass2APCmd.Class2PHCTOCmd— the command to set the Phase C timeout parameter (in seconds). If your modem doesn't support anyClass2PHCTOCmd, usenone💅Class2PIECmd— (Class 2.0 only) the command to control procedure interrupt handling. Procedure interrupts should be disabled, because HylaFAX doesn't provide any mechanism for dispatching procedure interrupts to an administrator. so like, don't.Class2PTSCmd— the command to set the received page status code. When copy quality checking happens in the host, this command can control the post-page response delivered to the sender. But beware ⚠️ some modems don't implement this command properly — in that case the server should be configured to not do copy quality check. Check out thePercentGoodLinesandMaxConsecutiveBadLinesparameters to understand how to defeat copy quality checking.Class2PTSQueryCmd— the command to query the received page status code. You can use it to figure out the post-page response that came back from the receiver. Beware again though 🙈 some modems don't implement this one properly either, and in that case you should set this setting tonone.Class2PWCmd— yet another largely-unused option for modems supporting ITU-T.32, Class 2.1, standards. It'd set up the password string enabled byClass2APCmd.Class2RecvDataTrigger— the character you send to the modem to trigger it to send received data from the modem over to the host. In draft specification 2388-A this character is specified as DC1 (octal 21), and in the 2388-B specification it's DC2 (octal 22). Most Class 2 modems accept DC1, or both DC1 and DC2. Some modems, though, only accept DC2 😭. Note that string parameters can use C-style escape sequences, so DC2, for example, would be specified as"\022".Class2RELCmd— the command to enable delivery of byte-aligned EOL codes in received facsimile. If this parameter is defined, then received facsimile data gets marked to indicate that EOL codes are byte-aligned; otherwise they'll be marked as not (necessarily) having byte-aligned codes.Class2RTFCC— whether or not to enable MultiTech's Real-Time Fax Compression Conversion, which shows up in later firmware revisions for the MT5634ZBA-V92, MT5634ZPX-PCI-V92, and other models. RTFCC lets HylaFAX convert the image compression between MH, MR, and MMR formats no matter howfaxqformatted the image file 🔥. If RTFCC is available with your firmware, then the response toAT+FFC=?is non-zero. Note that when you're using RTFCC, the compression format of the file gets ignored — so the-1,-2, and-3options forsendfax,ps2fax, and others will not influence the actual negotiated session parameters. iykyk.Class2SACmd— a largely-unused option for modems supporting ITU-T.32, Class 2.1, standards. It'd set up the destination subaddress string enabled byClass2APCmd.Class2SendRTC— whether or not to append an explicit "Return To Control" (RTC) signal to the page data when transmitting. The Class 2 and Class 2.0 specs (that's SP-2388-A and TIA/EIA-592) state that the modem will append RTC when it receives the post-page message command from the host — this parameter exists just in case your modem doesn't correctly implement that 🫶Class2SFLOCmd— the command to set up software (XON/XOFF) flow control between DTE and DCE while running in Class 2/2.0. It gets issued immediately after sending theClass2Cmdto flip the modem into Class 2/2.0 operation. For Class 2.0 operation the default isAT+FLO=1.Class2SPLCmd— the command to enable a polling request. If your modem doesn't support anyClass2SPLCmd, the valuenoneis there for you ✨Class2TBCCmd— the command you use to turn on stream-mode communication between the host and the modem. If your modem doesn't support anyClass2TBCCmd, you can use the valuenone. slay 💅Class2UseLineCount— whether or not to use the line count that the modem firmware decoder reports to HylaFAX. simple as that 👑Class2UseHex— whether or not to parse the capability strings your modem reports using hexadecimal values. By default, they're parsed as decimal values. math girlie moment 🔢Class2XmitWaitForXON— whether or not to wait for an XON character from the modem before sending facsimile data to the modem for transmission. important note, bestie: this is only relevant for modems that conform to the Class 2 spec (i.e.SP-2388-A). The Class 2.0 specification states that the host may transmit data immediately upon receivingCONNECTand that no XON character will be sent to the host. 🫶
🎀 PAGER-RELATED CONFIGURATION PARAMETERS 🎀
These parameters are specific to the configuration and operation of the IXO/TAP and UCP support for sending pager messages and GSM SM. Parameters not used for UCP are marked with (IXO/TAP only). iykyk ✨
PagerSetupCmds— the commands to send to a modem to prepare the modem for a call to a pager service provider. Typically these commands direct the modem to communicate with the service provider at 300 bps using the V.21 protocol. Per-service provider command strings can be set up in the info database; seehylafax-info(5F). 📟PagerMaxMsgLength— the maximum length for a pager text message. Messages longer than this number are truncated. Per-service provider message lengths can be set up in the info database; seehylafax-info(5F). ✂️IXOService—(IXO/TAP only)the service identification string transmitted as part of the IXO/TAP protocol. 💖IXODeviceID—(IXO/TAP only)the terminal device identification string transmitted as part of the IXO/TAP protocol. 🖥️IXOMaxUnknown— the maximum number of unrecognized messages that will be accepted at various stages of the IXO/TAP protocol before the sender will abort and hang up the phone. no cap, it hangs up 🚫IXOIDProbe—(IXO/TAP only)the time, in seconds, between sending a\rduring the initial ID recognition sequence of the IXO/TAP protocol. ⏱️IXOIDTimeout—(IXO/TAP only)the maximum time, in seconds, to wait for the initial ID response from the service provider. ⏳IXOLoginRetries—(IXO/TAP only)the maximum number of attempts to login to a service provider. 🔁IXOLoginTimeout—(IXO/TAP only)the maximum time, in seconds, to wait to complete the login procedure. 🕰️IXOGATimeout—(IXO/TAP only)the maximum time, in seconds, to wait for a Go-Ahead message from the service provider. 🚦IXOXmitRetries— the maximum number of times to try sending a text message block in a single call. 📤IXOXmitTimeout— the maximum time, in seconds, to try transmitting a text message block. ⌛IXOAckTimeout—(IXO/TAP only)integer30IXO: max time to wait for msg block ack (secs)— the maximum time, in seconds, to wait for an acknowledgement to a transmitted message. ack wait vibes 💌
🦋 PROTOTYPE CONFIGURATION FILES 🦋
Per-modem configuration files are typically derived from prototype files that have been created for known modems. These prototype files are kept in the config subdirectory and, by convention, have names that identify a brand or type of modem and the DTE-DCE flow control scheme the prototype files configures. The faxaddmodem(8C) program that is used to configure a modem for use with HylaFAX selects a prototype configuration file using information retrieved 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 command ATI3 are used to select a prototype configuration file, while for Class 2 modems the manufacturer and model as returned by AT+FMFR? and AT+FMDL?, respectively, are used (or AT+FMI? and AT+FMM? for Class 2.0 modems). the detective work is real 🔍
A Class 1 prototype configuration file is identified for use by faxaddmodem by searching for a comment of the form:
# CONFIG:CLASS1:144:.*:RTSCTS: Manufacturer='AT&T' Model=DataportIn this example 144 is the product ID code for an AT&T DataPort modem, .* is a regular expression matched against the result string returned by the ATI3 command, and RTSCTS indicates the modem is configured to use hardware flow control during fax operation. The remainder of the line is evaluated by the sh(1) and used to specify the modem's manufacturer and model (since Class 1 modems do not have standard commands to query this information). AT&T DataPort said hello 👑
Class 2 and 2.0 prototype configuration files match the string manufacturer-model-flowcontrol against a sh(1) glob pattern specified in the configuration file, where manufacturer and model are the strings returned by querying the modem and flowcontrol is either RTSCTS for hardware flow control or XONXOFF for software flow control. For example:
# CONFIG: CLASS2: ZyXEL*-RTSCTS
# CONFIG: CLASS2.0: USRobotics*-XONXOFFare configuration comments that appear in the prototype file for a ZyXEL 1496E with Class 2 support, and for a US Robotics Courier modem with Class 2.0 firmware. ZyXEL and US Robotics eating ✨
The faxaddmodem program merges server-specific configuration parameters into a prototype configuration according to comments placed in the prototype file. All lines between BEGIN-SERVER and END-SERVER comments are placed with the appropriate server configuration parameters. Note that this means modem-related configuration parameters must be placed outside this area of the file. so keep modem stuff out of that zone, bestie 🚧
🌈 SEE ALSO 🌈
faxaddmodem(8C)faxq(8C)faxgetty(8C)faxsend(8C)hylafax-server(5F)
and that's a wrap, bestie 💖 the footer says this page's source/version is $Date: 2013-02-26 15:46:36 -0800 and it's the HYLAFAX-CONFIG(5F) manual, dated Tue, 26 Feb 20... vintage 2013 energy, periodt ✨🫶
📦 where this page comes from
- alpine 3.24: hylafaxplus-doc 7.0.11-r0 · MIT
- fedora 43: hylafax+ 7.0.11-4.fc43 · libtiff AND LicenseRef-Callaway-BSD-with-advertising
- fedora 43: hylafax+ 7.0.11-4.fc43 · libtiff AND LicenseRef-Callaway-BSD-with-advertising
- fedora 44: hylafax+ 7.0.11-5.fc44 · libtiff AND LicenseRef-Callaway-BSD-with-advertising
- fedora 44: hylafax+ 7.0.11-5.fc44 · libtiff AND LicenseRef-Callaway-BSD-with-advertising
- nixos 26.05: hylafaxplus 7.0.11
- nixpkgs unstable: hylafaxplus 7.0.11
- Copyright (c) 1990-1996 Sam Leffler
- Copyright (c) 1991-1996 Silicon Graphics, Inc
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms