传真(Fax)编程

开发平台：

C/C++

hylafax-config.4f：源码内容

." $Id: hylafax-config.4f,v 1.68 2009/03/05 06:46:35 faxguy Exp $
."
." HylaFAX Facsimile Software
."
." HylaFAX is a trademark of Silicon Graphics
."
." Permission to use, copy, modify, distribute, and sell this software and
." its documentation for any purpose is hereby granted without fee, provided
." that (i) the above copyright notices and this permission notice appear in
." all copies of the software and related documentation, and (ii) the names of
." Sam Leffler and Silicon Graphics may not be used in any advertising or
." publicity relating to the software without the specific, prior written
." permission of Sam Leffler and Silicon Graphics.
."
." THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
." EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
." WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
."
." IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
." ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
." OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
." WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
." LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
." OF THIS SOFTWARE.
."
.if n .po 0
.ds Fx fIHylas-1FAXs+1fP
.ds Ps Ps-2OSTs+2Ss-2CRIPTs+2
.TH HYLAFAX-CONFIG ${MANNUM4_5} "$Date: 2009/03/05 06:46:35 $"
.SH NAME
config - *(Fx configuration database
.SH DESCRIPTION
*(Fx uses a configuration file for the central queueing
agent and for each facsimile modem attached
to a machine.
These files contain information about the modems and about how
the *(Fx server processes that service these modem should operate.
Configuration files are located in the
.B etc
subdirectory.
The configuration file for the
.IR faxq (${MANNUM1_8})
program is named
.BR config .
The per-modem configuration files used by the
.IR faxgetty (${MANNUM1_8}),
.IR faxsend (${MANNUM1_8}),
and
.IR pagesend (${MANNUM1_8})
programs have names of the form
.BI config. devid ,
where
.I devid
is an identifier derived from the name of
the modem's device file; for example
.I ttym2
for
.IR /dev/ttym2 ,
.I term_10
for
.IR /dev/term/10 .
.PP
Configuration files have a simple format and are entirely
.SM ASCII.
A configuration parameter is of the form
.sp .5
.ti +0.5i
fBtagfP: fIvaluefP
.br
.sp .5
where a fItagfP identifies a parameter and a fIvaluefP
is either a string, number, or boolean value.
Comments are introduced by the ``#'' character
and extend to the end of the line.
String values start at the first non-blank character
after the ``:'' and continue to the first non-whitespace
character or, if whitespace is to be included, may be
enclosed in quote marks (``"'').
String values enclosed in quote marks may also use the
standard C programming conventions for specifying escape
codes; e.g. ``en'' for a newline character and ``exxx''
for an octal value.
Numeric values are specified according to the C programming
conventions (leading ``0x'' for hex, leading ``0'' for octal, otherwise
decimal), except for a few parameters, such as
.BR RecvFileMode ,
whose value is interpreted strictly as an octal number
and
.BR PageChopThreshold
whose value is interpreted strictly as a floating point number.
Boolean values are case insensitive.
For a true value, either ``Yes'' or ``On'' should
be used.
For a false value, use ``No'' or ``Off''.
.PP
The following table itemizes the tags and the expected type
of their value.
The first part lists items specific to the operation of each
server, while the second part has items related to the
servicing of the modem.
Parameters marked with a 鹿 are used only
by the *(Fx scheduler process and should appear only in the file named
.BR config .
Parameters marked with a 虏 are used by both the scheduler and
the per-device applications and so should appear in all appropriate
configuration files (i.e.
.B config
and any per-device files that make sense).
Parameters not otherwise marked should appear only in per-device
configuration files.
More detailed information about each item is given following the table.
.sp .5
.nf
.ta w'ModemAnswerResponseTimeout 'u +w'integer 'u +w's-1AT+FCLASS=2.0s+1 'u
fBTag Type Default DescriptionfP
AdaptiveAnswer boolean s-1Nos+1 enable adaptive answer of inbound calls
AdminGroup string s-1faxadmins+1 System user group for administration (if PAM enabled)
AllowIgnoreModemBusy鹿 boolean s-1Nos+1 honor job requests to ignore modem busy status
AnswerRotary string s-1Anys+1 alternatives for answering calls
AnswerBias integer - bias to apply to successful rotary answer
AreaCode虏 string - local area code
AuditHook鹿 string - command to run for faxq event auditing
BadPageHandlingMethod string s-1RTN-SAVEs+1 bad page received handling method
BatchLogs鹿 boolean s-1Yess+1 keep all session logs of a batch in a single log
CallIDAnswerLength integer - answer call when CallIDPattern received
CallIDDisplay boolean s-1Nos+1 display match in modem status
CallIDLabel string - label to use in presentation of the match
CallIDPattern string - call identification pattern string
CallIDRecord boolean s-1Yess+1 record match in recvq image file
CallIDType string - type identifier for the CallIDPattern match
CIDName string - equivalent to CallIDPattern (2)
CIDNameAnswerLength integer s-10s+1 equivalent to CallIDAnswerLength (2)
CIDNumber string - equivalent to CallIDPattern (1)
CIDNumberAnswerLength integer s-10s+1 equivalent to CallIDAnswerLength (1)
ClocalAsRoot boolean s-1Nos+1 set s-1CLOCALs+1 using root s-1UIDs+1
ContCoverCmd鹿 string s-1bin/mkcovers+1 continuation cover page generation script
ContCoverPage鹿 string - continuation cover page template filename
CountryCode虏 string - local country code
DestControls鹿 obsolete - Obsoleted by JobControl
DeviceMode octal s-10600s+1 protection mode to use for modem device
DialStringRules虏 string - dial string rules file
DistinctiveRings string - configuration for distinctive ring cadences
DRingOff string - distinctive ring ``off'' cadence indicator
DRingOn string - distinctive ring ``on'' cadence indicator
DynamicConfig string - script for dynamic receive configuration
EGettyArgs string - arguments passed to external getty program
FAXNumber string - facsimile modem phone number
FaxRcvdCmd string s-1bin/faxrcvds+1 notification script for received facsimile
GettyArgs string - arguments passed to getty program
Include虏 string - include another config file
InternationalPrefix虏 string - dialing prefix for international calls
JobControlCmd鹿 string - job control command
JobReqBusy integer s-1180s+1 requeue interval for s-1BUSYs+1 dial result
JobReqDataConn integer s-1300s+1 requeue interval for data connection dial result
JobReqNoAnswer integer s-1300s+1 requeue interval for s-1NO ANSWERs+1 dial result
JobReqNoCarrier integer s-1300s+1 requeue interval for s-1NO CARRIERs+1 dial result
JobReqNoFCon integer s-1300s+1 requeue interval for carrier without s-1+FCONs+1 dial result
JobReqOther虏 integer s-1300s+1 requeue interval for ``other'' problems
JobReqProto integer s-160s+1 requeue interval after fax protocol error
JobRetryBusy integer - number of retries for s-1BUSYs+1 dial result
JobRetryDataConn integer - number of retries for data connection dial result
JobRetryNoAnswer integer - number of retries for s-1NO ANSWERs+1 dial result
JobRetryNoCarrier integer 1 number of retries for s-1NO CARRIERs+1 dial result
JobRetryOther integer - number of retries for ``other'' problems
LockDataCalls boolean s-1Yess+1 lock modem for the duration of an inbound data call
LockVoiceCalls boolean s-1Yess+1 lock modem for the duration of an inbound voice call
LogCalls boolean s-1Yess+1 Log all incoming calls as CALL records in xferfaxlog
LogFacility虏 string s-1daemons+1 fIsyslogfP facility name for ServerTracing messages
LogFileMode octal s-10600s+1 protection mode to use for session log files
LocalIdentifier string - local station identification string
LongDistancePrefix string - dialing prefix for long distance calls
MaxBatchJobs鹿 integer 64 max jobs in a batch
MaxConcurrentCalls鹿 integer s-11s+1 max concurrent jobs to process for a destination
MaxConsecutiveBadLines integer s-15s+1 max consecutive bad rows for s-1OKs+1 page quality
MaxDials鹿 integer s-112s+1 max phone calls to make to transmit a job
MaxRecvPages integer s-1fIunlimitedfPs+1 max pages to permit in a receive
MaxSendPages鹿 integer s-1fIunlimitedfPs+1 max pages to permit in a send
MaxSetupAttempts integer s-12s+1 max attempts to initialize a modem
MaxTries鹿 integer s-13s+1 max attempts to transmit a job
MinAcceptedLineCount integer s-110s+1 min number of rows for s-1OKs+1 page quality
ModemGroup鹿 string - define a name for a set of modems
ModemPriority integer 255 scheduling priority for outbound jobs
ModemReadyState string s-1Rs+1 ``ready state'' sent by fIfaxgettyfP
ModemRingResponse string - command to respond after hearing RING
ModemRingsBeforeResponse integer s-10s+1 the number of rings before ModemRingResponse
NoAnswerVoice boolean s-1falses+1 disable the answering of voice-indicated calls
NoCarrierRetrys integer - Deprecated - See JobRetryNoCarrier
NotifyCmd鹿 string s-1bin/notifys+1 user notification command script
PageChop鹿 string s-1lasts+1 control automatic truncation of trailing whitespace
PageChopThreshold鹿 float s-13.0s+1 whitespace truncation threshold (inches)
PCL2FaxCmd鹿 string s-1bin/pcl2faxs+1 PCL s-1RIPs+1 command script
PercentGoodLines integer s-195s+1 percentage of good rows for s-1OKs+1 page quality
PollLockPokeModem boolean s-1falses+1 check on modem every time the lock is polled
PollLockWait虏 integer s-130s+1 polling interval for lockfile presence/removal (secs)
PollModemWait integer s-130s+1 polling interval when in ``modem wait'' state (secs)
PollRcvdCmd string s-1bin/pollrcvds+1 delivery script for facsimile received by polling
PostScriptTimeout鹿 integer s-1300s+1 timeout on *(Ps interpreter runs (secs)
PriorityScheduling boolean s-1fIsee belowfPs+1 use available priority job scheduling mechanism
PS2FaxCmd鹿 string s-1bin/ps2faxs+1 *(Ps s-1RIPs+1 command script
QualifyCID obsolete - See s-1DynamicConfigs+1 and s-1RejectCalls+1 for rejecting calls
QualifyPWD string - file of s-1PWDs+1 patterns for qualifying senders
QualifyTSI string - file of s-1TSIs+1 patterns for qualifying senders
RecvDataFormat string s-1adaptives+1 format for received facsimile data
RecvFileMode octal s-10600s+1 protection mode to use for received facsimile files
RejectCall boolean s-1falses+1 Reject the current call
RingData string - distinctive ring data call identifier
RingExtended string - extended ring message identifier
RingFax string - distinctive ring fax call identifier
RingsBeforeAnswer integer s-10s+1 rings to wait before answering phone
RingTimeout integer s-16000s+1 timeout in ms after RING before reset
RingVoice string - distinctive ring voice call identifier
RTNHandlingMethod string s-1Retransmit-Ignores+1 RTN signal handling method
SaveUnconfirmedPages boolean s-1trues+1 save or delete unconfirmed pages
SendFaxCmd鹿 string s-1bin/faxsends+1 fax transmit command script
SendPageCmd鹿 string s-1bin/pagesends+1 pager transmit command script
SendUUCPCmd鹿 string s-1bin/uucpsends+1 s-1UUCPs+1 transmit command script
ServerTracing虏 integer s-11s+1 non-session server tracing
SessionTracing虏 integer s-10xFFFs+1 send and receive session tracing
SpeakerVolume string s-1Quiets+1 volume level for modem speaker
StaggerCalls鹿 integer s-10s+1 time to delay between starting outbound calls
TagLineFont string - tag line font filename
TagLineFormat string s-1fIsee belowfPs+1 tag line format string
TagLineLocale string s-1fIsee belowfPs+1 tag line format locale
TIFF2FaxCmd虏 string s-1bin/tiff2faxs+1 s-1TIFFs+1 converter command script
TimeOfDay鹿 string s-1Anys+1 default time-of-day restrictions
TSIRecvdCmd string - script executed after TSI receipt, can drop calls
Use2D鹿 boolean s-1Yess+1 restrict/permit use of 2D-encoded fax data
UseJobTSI boolean s-1Nos+1 use job-specified TSI instead of s-1LocalIdentifiers+1
UseJobTagLine boolean s-1Yess+1 Allow use of job-specified Tagline instead of s-1TagLineFormats+1
UUCPLockMode虏 octal s-10600s+1 protection mode for s-1UUCPs+1 lock files
UUCPLockDir虏 string s-1fIsee belowfPs+1 s-1UUCPs+1 lockfile directory
UUCPLockTimeout虏 integer s-130s+1 time before removing stale s-1UUCPs+1 lockfile
UUCPLockType虏 string s-1fIsee belowfPs+1 s-1UUCPs+1 lockfile type
VGettyArgs string - arguments passed to voice getty program
WedgedCmd鹿 string s-1bin/wedgeds+1 command to run when modem is wedged
.sp .5
ModemAnswerCmd string s-1ATAs+1 command for answering phone
ModemAnswerDataBeginCmd string - command for start of answered data call
ModemAnswerDataCmd string s-1ATAs+1 command for answering data call
ModemAnswerDialCmd string s-1ATAs+1 command for answering data call
ModemAnswerFaxBeginCmd string - command for start of answered fax call
ModemAnswerFaxCmd string s-1ATAs+1 command for answering fax call
ModemAnswerResponseTimeout integer s-1180000s+1 answer command timeout (ms)
ModemAnswerVoiceBeginCmd string - command for start of answered voice call
ModemAnswerVoiceCmd string s-1ATAs+1 command for answering voice call
ModemATCmdDelay integer s-10s+1 delay before sending modem an AT cmd (ms)
ModemBaudRateDelay integer s-110s+1 delay (ms) after setting baud rate
ModemClassQueryCmd string s-1AT+FCLASS=?s+1 command for querying modem services
ModemCommaPauseTimeCmd string s-1ATS8=2s+1 command for setting time to pause for ``,'' in dialing string
ModemDialCmd string s-1ATDT%ss+1 command for dialing (%s for number to dial)
ModemDialResponseTimeout integer s-1180000s+1 dialing command timeout (ms)
ModemDoPhaseCDebug boolean s-1Nos+1 query modem responses during Phase C transmit
ModemDTRDropDelay integer s-175s+1 delay (ms) between DTR OFF and DTR ON
ModemEchoOffCmd string s-1ATE0s+1 command for disabling command echo
ModemFlowControl string s-1XONXOFFs+1 s-1DTE-DCEs+1 flow control scheme
ModemFrameFillOrder string s-1LSB2MSBs+1 bit order for s-1HDLCs+1 frames
ModemHardFlowCmd string - command for setting hardware flow control between s-1DTEs+1 and s-1DCEs+1
ModemMinSpeed string s-12400s+1 minimum acceptable transmit speed
ModemMfrQueryCmd string - command for querying modem manufacturer
ModemModelQueryCmd string - command for querying modem model
ModemNoAutoAnswerCmd string s-1ATS0=0s+1 command for disabling auto-answer
ModemNoAutoAnswerCmdDelay integer s-10s+1 time, in ms, to pause after a disabling auto-answer
ModemNoFlowCmd string - command for disabling hardware flow control between s-1DTEs+1 and s-1DCEs+1
ModemOnHookCmd string s-1ATH0s+1 command for placing phone ``on hook''
ModemPageDoneTimeout integer s-1180000s+1 page send/receive timeout (ms)
ModemPageStartTimeout integer s-1180000s+1 page send/receive timeout (ms)
ModemRaiseATCommands boolean s-1Yess+1 raise AT commands in configuration to upper-case
ModemRate integer s-119200s+1 baud rate to use for s-1DCE-DTEs+1 communication
ModemReadyCmds string - additional final commands when resetting modem
ModemRecvFillOrder string s-1fIsee belowfPs+1 bit order for received facsimile data
ModemRecvSuccessCmd string - command to send after a successful reception
ModemResetCmds string - additional commands when resetting modem
ModemResetDelay integer s-12600s+1 delay (ms) after placing DTR ON
ModemResultCodesCmd string s-1ATQ0s+1 command for enabling result codes
ModemRevQueryCmd string s-1fIsee belowfPs+1 command for querying modem firmware revision
ModemSendBeginCmd string - command to send on establishing carrier
ModemSendFillOrder string s-1LSB2MSBs+1 bit order for sending facsimile data
ModemSetOriginCmd string - command to set call origin information
ModemSetVolumeCmd string s-1fIsee belowfPs+1 commands for setting modem speaker volume level
ModemSetupAACmd string - command for setting up adaptive answer
ModemSetupDCDCmd string - command for setting up s-1DCDs+1 handling
ModemSetupDTRCmd string - command for setting up s-1DTRs+1 handling
ModemSoftFlowCmd string - command for setting software flow control between s-1DTEs+1 and s-1DCEs+1
ModemSoftResetCmd string s-1ATZs+1 command for doing a soft reset
ModemSoftResetCmdDelay integer s-13000s+1 time, in ms, to pause after a soft reset
ModemSoftRTFCC boolean s-1Yess+1 enable software-driven real-time fax compression conversion
ModemType string s-1fIsee belowfPs+1 modem type
ModemVerboseResultsCmd string s-1ATV1s+1 command for enabling verbose result codes
ModemWaitForConnect boolean s-1Nos+1 force server to wait for ``s-1CONNECTs+1'' response on answer
ModemWaitTimeCmd string s-1ATS7=60s+1 command for setting time to wait for carrier when dialing
.sp .5
FaxT1Timer integer s-135000s+1 s-1CCITT T.30 T1s+1 timer (ms)
FaxT2Timer integer s-17000s+1 s-1CCITT T.30 T2s+1 timer (ms)
FaxT4Timer integer s-13100s+1 s-1CCITT T.30 T4s+1 timer (ms)
.sp .5
Class0Cmd string s-1AT+FCLASS=0s+1 Class 0: command to enter class 0
.sp .5
Class1Cmd string s-1AT+FCLASS=1s+1 Class 1: command to enter class 1
Class1Cmd string s-1AT+FCLASS=1.0s+1 Class 1.0: command to enter class 1
Class1AdaptRecvCmd string - Class 1/1.0: command for adaptive reception support
Class1ColorJPEGSupport boolean s-1Nos+1 Class 1/1.0: to enable color JPEG fax support
Class1EnableV34Cmd string - Class 1/1.0: command to enable V.34-fax support
Class1ECMSupport boolean s-1Yess+1 Class 1/1.0: enable T.30-A ECM support
Class1PersistentECM boolean s-1Yess+1 Class 1/1.0: to continue to correct while in ECM
Class1ECMFrameSize integer s-1256s+1 Class 1/1.0: image frame size in ECM protocol
Class1ExtendedRes boolean - Class 1/1.0: enable extended resolution support
Class1HasRHConnectBug boolean s-1Nos+1 Class 1/1.0: modem can report CONNECT incorrectly
Class1HFLOCmd string - Class 1/1.0: command to set hardware flow control
Class1FrameOverhead integer s-14s+1 Class 1/1.0: extra bytes in a received s-1HDLCs+1 frame
Class1GreyJPEGSupport boolean s-1Nos+1 Class 1/1.0: to enable grey JPEG fax support
Class1HookSensitivity integer s-10s+1 Class 1/1.0: times to ignore on-hook detection
Class1JBIGSupport string s-1fIsee belowfPs+1 Class 1/1.0: to enable monochrome JBIG fax support
Class1MRSupport boolean s-1Yess+1 Class 1/1.0: enable 2-D MR support
Class1MMRSupport boolean s-1Yess+1 Class 1/1.0: enable 2-D MMR support
Class1NFLOCmd string - Class 1/1.0: command to set no flow control
Class1PageLengthSupport integer s-17s+1 Class 1/1.0: coded value for modem page length support
Class1PageWidthSupport integer s-17s+1 Class 1/1.0: coded value for modem page width support
Class1RecvAbortOK integer s-1200s+1 Class 1/1.0: max wait (ms) for ``s-1OKs+1'' after recv abort
Class1RecvIdentTimer integer s-140000s+1 Class 1/1.0: max wait (ms) for initial ident frame
Class1RMPersistence integer s-12s+1 Class 1/1.0: times to attempt high-speed carrier recv
Class1SFLOCmd string - Class 1/1.0: command to set software flow control
Class1PPMWaitCmd string s-1AT+FTS=7s+1 Class 1/1.0: command to stop and wait before PPM
Class1ResponseWaitCmd string - Class 1/1.0: command to wait before TCF response
Class1Resolutions integer s-10x7Fs+1 Class 1/1.0: bitmap of supported resolutions
Class1RMQueryCmd string s-1AT+FRM=?s+1 Class 1/1.0: command to query modem data reception rates
Class1TCFWaitCmd string s-1AT+FTS=7s+1 Class 1/1.0: command to stop and wait before TCF
Class1TMQueryCmd string s-1AT+FTM=?s+1 Class 1/1.0: command to query modem data transmission rates
Class1EOPWaitCmd string s-1AT+FTS=9s+1 Class 1/1.0: command to stop and wait before EOP
Class1ModemHasDLEBug boolean s-1Nos+1 Class 1/1.0: modem fails to double DLE in V.21
Class1MsgRecvHackCmd string s-1""s+1 Class 1/1.0: command to avoid +FCERROR before image data
Class1TCFRecvHackCmd string s-1""s+1 Class 1/1.0: command to avoid +FCERROR before TCF
Class1TCFMaxNonZero integer s-110s+1 Class 1/1.0: max% of non-zero data in good s-1TCFs+1
Class1TCFMinRun integer s-11000s+1 Class 1/1.0: minimum zero run in good s-1TCFs+1
Class1TCFMinRunECMMod integer s-12s+1 Class 1/1.0: modify minimum zero run in ECM by this factor
Class1TCFRecvTimeout integer s-14500s+1 Class 1/1.0: max wait (ms) for s-1TCFs+1
Class1TMConnectDelay integer s-10s+1 Class 1/1.0: delay between +FTM CONNECT and data transmission
Class1SwitchingCmd string s-1AT+FRS=7s+1 Class 1/1.0: command to ensure silence after HDLC reception
Class1ValidateV21Frames boolean s-1Nos+1 Class 1/1.0: check FCS against received frames
.sp .5
Class2Cmd string s-1AT+FCLASS=2s+1 Class 2: command to enter class 2/2.0
Class2AbortCmd string s-1AT+FKs+1 Class 2: command to abort active session
Class2APCmd string s-1AT+FAPs+1 Class 2: enable support for sending and receiving SUB, SEP, and PWD frames
Class2APQueryCmd string s-1AT+FAP=?s+1 Class 2: query capabilities for sending and receiving SUB, SEP, and PWD frames
Class2BORCmd string s-1AT+FBOR=0s+1 Class 2: command to setup bit order
Class2BUGCmd string s-1AT+FBUG=1s+1 Class 2: command to enable s-1HDLCs+1 frame tracing
Class2CIGCmd string s-1AT+FCIGs+1 Class 2: command to set polling identifier
Class2CRCmd string s-1AT+FCR=1s+1 Class 2: command to enable receive capability
Class2CQCmd string - Class 2: command to setup copy quality parameters
Class2CQQueryCmd string s-1AT+FCQ=?s+1 Class 2: command to query modem copy quality capabilities
Class2DCCCmd string s-1AT+FDCCs+1 Class 2: command to set modem capabilities
Class2DCCQueryCmd string s-1AT+FDCC=?s+1 Class 2: command to query modem capabilities
Class2DisableV17Cmd string - Class 2: command to disable V.17 support
Class2DISCmd string s-1AT+FDISs+1 Class 2: command to set session parameters
Class2DDISCmd string - Class 2: command to set session parameters before dialing
Class2ECMType string s-1``2''s+1 Class 2: ECM specification type to follow
Class2HexNSF boolean s-1Yess+1 Class 2: parse NSF strings as hex values
Class2HFLOCmd string - Class 2: command to set hardware flow control
Class2LIDCmd string s-1AT+FLIDs+1 Class 2: command to set local identifier string
Class2MINSPCmd string s-1AT+FMINSPs+1 Class 2: command to set minimum transmit speed
Class2NFLOCmd string - Class 2: command to set no flow control
Class2PACmd string s-1AT+FPAs+1 Class 2: set polling address string
Class2PHCTOCmd string s-1AT+FPHCTO=30s+1 Class 2: command to set Phase C timeout parameter
Class2PTSCmd string s-1AT+FPTSs+1 Class 2: command to set received page status
Class2PWCmd string s-1AT+FPWs+1 Class 2: set password string
Class2RecvDataTrigger string s-1``e21''s+1 Class 2: character to send to trigger recv
Class2RELCmd string - Class 2: command to enable byte-aligned s-1EOLs+1 codes
Class2SACmd string s-1AT+FSAs+1 Class 2: set destination subaddress string
Class2SendRTC boolean s-1Nos+1 Class 2: append s-1RTCs+1 to page data on transmit
Class2SFLOCmd string - Class 2: command to set software flow control
Class2SPLCmd string s-1AT+FSPLs+1 Class 2: command to set polling request
Class2TBCCmd string s-1AT+FTBC=0s+1 Class 2: command to enable stream mode
Class2UseLineCount boolean s-1Nos+1 Class 2: use the line count from the firmware decoder
Class2UseHex boolean s-1Nos+1 Class 2: parse capabilities strings as hex values
Class2XmitWaitForXON boolean s-1Yess+1 Class 2: wait for s-1XONs+1 before sending facsimile data
.sp .5
Class2Cmd string s-1AT+FCLASS=2.0s+1 Class 2.0: command to enter class 2/2.0
Class2AbortCmd string s-1AT+FKSs+1 Class 2.0: command to abort active session
Class2APCmd string s-1AT+FAPs+1 Class 2.0: enable support for sending and receiving SUB, SEP, and PWD frames
Class2APQueryCmd string s-1AT+FAP=?s+1 Class 2.0: query capabilities for sending and receiving SUB, SEP, and PWD frames
Class2BORCmd string s-1AT+FBO=0s+1 Class 2.0: command to setup bit order
Class2BUGCmd string s-1AT+FBU=1s+1 Class 2.0: command to enable s-1HDLCs+1 frame tracing
Class2CIGCmd string s-1AT+FPIs+1 Class 2.0: command to set polling identifier
Class2CRCmd string s-1AT+FCR=1s+1 Class 2.0: command to enable receive capability
Class2CQCmd string - Class 2.0: command to setup copy quality parameters
Class2CQQueryCmd string s-1AT+FCQ=?s+1 Class 2.0: command to query modem copy quality capabilities
Class2DCCCmd string s-1AT+FCCs+1 Class 2.0: command to set modem capabilities
Class2DCCQueryCmd string s-1AT+FCC=?s+1 Class 2.0: command to query modem capabilities
Class2DisableV17Cmd string - Class 2.0: command to disable V.17 support
Class2DisableV34Cmd string - Class 2.0: command to disable V.34 support
Class2DISCmd string s-1AT+FISs+1 Class 2.0: command to set session parameters
Class2ECMType string s-1``2.0''s+1 Class 2.0: ECM specification type to follow
Class2HexNSF boolean s-1Yess+1 Class 2.0: parse NSF strings as hex values
Class2HFLOCmd string s-1AT+FLO=2s+1 Class 2.0: command to set hardware flow control
Class2JBIGSupport string s-1fIsee belowfPs+1 Class 2.0: to enable monochrome JBIG fax support
Class2JPEGSupport boolean s-1Nos+1 Class 2.0: use modem JPEG support
Class2LIDCmd string s-1AT+FLIs+1 Class 2.0: command to set local identifier string
Class2MINSPCmd string s-1AT+FMSs+1 Class 2.0: command to set minimum transmit speed
Class2NFLOCmd string s-1AT+FLO=0s+1 Class 2.0: command to set no flow control
Class2NRCmd string s-1AT+FNR=1,1,1,1s+1 Class 2.0: command to set negotiation message reporting
Class2PACmd string s-1AT+FPAs+1 Class 2.0: set polling address string
Class2PHCTOCmd string s-1AT+FCT=30s+1 Class 2.0: command to set Phase C timeout parameter
Class2PIECmd string s-1AT+FIE=0s+1 Class 2.0: command to set procedure interrupt handling
Class2PWCmd string s-1AT+FPWs+1 Class 2.0: set password string
Class2PTSCmd string s-1AT+FPSs+1 Class 2.0: command to set received page status
Class2PTSQueryCmd string s-1AT+FPS?s+1 Class 2.0: command to query received page status
Class2RecvDataTrigger string s-1``e22''s+1 Class 2.0: character to send to trigger recv
Class2RELCmd string - Class 2.0: command to enable byte-aligned s-1EOLs+1 codes
Class2RTFCC boolean s-1Nos+1 Class 2.0: enable real-time fax compression conversion
Class2SACmd string s-1AT+FSAs+1 Class 2.0: set destination subaddress string
Class2SendRTC boolean s-1Nos+1 Class 2.0: append s-1RTCs+1 to page data on transmit
Class2SFLOCmd string s-1AT+FLO=1s+1 Class 2.0: command to set software flow control
Class2SPLCmd string s-1AT+FSPs+1 Class 2.0: command to set polling request
Class2TBCCmd string s-1AT+FPP=0s+1 Class 2.0: command to enable stream mode
Class2UseLineCount boolean s-1Nos+1 Class 2.0: use the line count from the firmware decoder
Class2UseHex boolean s-1Nos+1 Class 2.0: parse capabilities strings as hex values
.sp .5
PagerSetupCmds string - commands for setting up modem for a pager call
PagerMaxMsgLength integer s-1128s+1 max length of a text message
.sp .5
IXOService string s-1``PG''s+1 IXO: service identification string
IXODeviceID string s-1``1''s+1 IXO: device identification string
IXOMaxUnknown integer s-13s+1 IXO and UCP: max unknown responses before abort
IXOIDProbe integer s-12s+1 IXO: time between sending er during ID sequence (secs)
IXOIDTimeout integer s-120s+1 IXO: max time to wait for ID= response (secs)
IXOLoginRetries integer s-13s+1 IXO: max attempts to login
IXOLoginTimeout integer s-115s+1 IXO: max time to complete login (secs)
IXOGATimeout integer s-130s+1 IXO: max time to wait for Go-Ahead response (secs)
IXOXmitRetries integer s-13s+1 IXO and UCP: max retries to send text msg block
IXOXmitTimeout integer s-115s+1 IXO and UCP: max time to transmit text msg block
IXOAckTimeout integer s-130s+1 IXO: max time to wait for msg block ack (secs)
.fi
.SH "SERVER-ORIENTED CONFIGURATION PARAMETERS"
.PP
These configuration parameters affect the general
operation of the fax server.
.TP
.B AdaptiveAnswer
Control whether or not an adaptive answering
strategy is used whereby an incoming call is
answered in multiple ways according to the list specified in the
.B AnswerRotary
parameter.
For example, if adaptive answering is enabled and
.B AnswerRotary
specifies ``fax data'', then an incoming call will
first be answered as fax using
.B ModemAnswerFaxCmd
and then, if that fails, as data using
.BR ModemAnswerDataCmd .
If the adaptive answer strategy is not enabled, then calls
are answered using the appropriate
.B ModemAnswer*Cmd
parameter (normally
.B ModemAnswerCmd
for unattended operation).
Note that the adaptive answer strategy depends on many factors
that limit its usefulness.
When calls are answered first as fax,
it typically only works with a Class 1 modem because it is
important that the sequence of operations related to answering
as fax be completed in a short enough time that a subsequent
answer for data be done before the caller times out and hangs
up the telephone
(for this reason
.B Class1RecvIdentTimer
should be set to a value that is shorter than
.BR FaxT1Timer .)
Also, note that it is sometimes necessary to arrange that the phone be
placed on-hook between successive answers; this can typically be
done by inserting the appropriate command at the start of the
second and subsequent
.BR ModemAnswer*Cmd s.
.TP
.B AdminGroup
Tells PAM what user group is allowed to administer the fax server.
Only useful if the server is compiled with PAM enabled.
.TP
.B AllowIgnoreModemBusy鹿
Whether or not to honor job requests to ignore modem busy status when
allocating jobs to a modem. The intended use for this feature is to
allow configurations whereby a
.B DynamicConfig
script can send a fax to an incoming caller (contrary to T.30 protocol
for sending or polling).
.TP
.B AnswerRotary
The sequence of answering techniques the server should
``rotate through'' when answer incoming calls.
Answering techniques are:
.sp .5
.ta w'fBNamefP 'u
.nf
fBName DescriptionfP
fax answer a fax call
data answer a data call
voice answer a voice call
extern use the fIvgettyfP application to answer a call
any answer a call of any/unknown type
.fi
.sp .5
When a call is not answered successfully, the server
advances the rotary to the next specified answering
technique.
If
.B AdaptiveAnswer
is enabled, the server will try all the answering techniques for
each incoming call.
Otherwise, the rotary is advanced
.I between
unsuccessful phone calls.
For example, if
.B AdaptiveAnswer
is disabled and
.B AnswerRotary
is ``fax data'',
then the calls will initially be answered as fax until
the first call is received that does not appear to be
from a fax machine; after that calls will be answered
as if they were from a data modem until the next unsuccessful
call; after which they will one again be answered as fax.
Only the first three techniques listed are used; any additional
ones are (silently) ignored.
See also
.BR AnswerBias .
.TP
.B AnswerBias
The index into the
.B AnswerRotary
list that the server should rotate the list to after
each successful incoming phone call.
List indices are numbered starting at zero.
For example, if
.B AnswerRotary
is ``fax data'' and
.B AnswerBias
is 1, then after each successful inbound call, the
next call will be answered as data.
.TP
.B AreaCode虏
The local area code in which the facsimile modem resides.
This value is passed to the dial string rules that are
used, for example,
to formulate canonical phone numbers for dialing (see
.B DialStringRules
below.)
.TP
.B AuditHook鹿
Specifies a program command and an interest specification indicating which events as
described in
.IR faxwatch (${MANNUM1_8})
should trigger the execution of the program. For example, this configuration:
.nf
AuditHook: "bin/hook: J*S*M*R*"
.fi
would cause bin/hook to be executed upon every event. The arguments passed to the
hook program are respectively
.IR <class> ,
.IR <mask> ,
.IR <id> ,
and optionally
.IR [info]
where...
.nf
<class> = JOB | SEND | MODEM | RECV
<mask> = the specific event
<id> = id of the job/modem with which the event is associated
[info] = additional information
.fi
.TP
.B BadPageHandlingMethod
(Class 1/1.0 only) Specifies how to react to a bad page received from the remote sender:
one of ``s-1RTNs+1'', ``s-1DCNs+1'', or ``s-1RTN-SAVEs+1''.
If a page is received in non-ECM mode with unacceptable quality
according to
.BR PercentGoodLines
or
.BR MaxConseutiveBadLines
then it can be somewhat difficult to inform the sender of the problem.
Historically, *(Fx has assumed that signalling RTN to the sender will
accomplish this. However, some senders are incapable of retransmitting
pages, and to reduce burden they treat an RTN signal as a receipt
confirmation and proceed to the next page without notifying the sending
user of the potential problem in readability on the receive-end. (The
assumption there being that the receiving user will notify the sending
user if there actually is a readability problem.)
A setting of ``s-1RTNs+1'' is the historic behavior and assumes that
an RTN signal will be enough to get the sender to retransmit or be
otherwise 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 ``s-1DCNs+1'' tells *(Fx to transmit a DCN signal in
response to the post-page message and should trigger a call abortion by
the sender. This should clearly indicate a problem in page readability
to the sender, although the receipt of any following pages in a later
call cannot be guaranteed.
A setting of ``s-1RTN-SAVEs+1'' more closely approximates the behavior
of other fax receivers (especially fax machines). It causes *(Fx to
send the RTN signal but it saves the previously received page data and places
the next transmitted page data in another page. This is the default
setting. However, this 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.
.TP
.B BatchLogs鹿
When sending or receiving multiple documents (denoted by EOM), this
value determines if the session logs span the entire batch or, if set
to no, only contain a single document.
.TP
.B CallIDPattern
A string that identifies the caller's identity in any call
identification messages provided by the modem (such as Caller*ID or DNIS/DID).
The specified string is compared against any
unrecognized status messages received from the modem before
.B ModemAnswerCmd
is sent to the modem.
If there is a match, then the remainder
of the message is returned as
.B CallIDn
where n corresponds to the n'th instance that this
.B CallIDPattern
is from the top in the modem configuration file.
For example, for the ZyXEL U-1496 this parameter would be set to
.nf
s-1CallIDPattern: ``CALLER NAME: ''s+1 (note the trailing space).
.fi
If more than one message matches between instances of "RING" messages, then the message remainders are
concatenated.
The special
.B CallID
value of "SHIELDED_DTMF" is used in conjunction with
.B ModemRingResponse
and
.B CallIDAnswerLength.
After executing
.B ModemRingResponse,
HylaFAX will expect
DTMF data (usually DLE-shielded) for
.B CallIDn
until
.B 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
.B ModemAnswerCmd.
In order to prevent 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, triggering 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.
.nf
ModemRingResponse: AT+FCLASS=8;H1
CallIDPattern: SHIELDED_DTMF
CallIDAnswerLength: 4
ModemAnswerCmd: <delay:100>AT+FCLASS=1;A
.fi
For modems that do not support AT+FCLASS=8 (such as some USR modems) this
may be an appropriate equivalent:
.nf
ModemRingResponse: "AT#CLS=8\nAT#VLS=4\nATA"
CallIDPattern: SHIELDED_DTMF
CallIDAnswerLength: 4
ModemAnswerCmd: "<delay:100>AT+FCLASS=1\nATA"
.fi
Multiple entries of
.B CallIDPattern
are used together in one modem configuration file in order to capture multiple
.B 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
.B ModemAnswerCmd
whenever CallID1 or CallID2 were longer than 7 or 10 characters, respectively.
.nf
CallIDPattern: "NDID="
CallIDAnswerLength: 7
CallIDPattern: "NMBR="
CallIDAnswerLength: 10
CallIDPattern: "NAME="
.fi
Note that this example is only given as an example, and probably would cause unexpected
results. Because pattern-matching ends when
.B ModemAnswerCmd
is sent to the modem, if "NDID", "NMBR", and "NAME" responses came from the modem in
that order, and the "NDID" response was at least 7 characters long, then
.B ModemAnswerCmd
would be sent to the modem immediately following the "NDID" response, and the "NMBR" and
"NAME" responses would be ignored. Generally only one
.B 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
.B 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,
.B RingsBeforeAnswer
should be set to ``2'' or greater.
.TP
.B CallIDAnswerLength
An integer indicating the minimum number of characters in a
.B CallID
matching the previous
.B CallIDPattern
to be received when
.B ModemAnswerCmd
is sent to the modem irrespective of any
.B RingsBeforeAnswer
value greater than zero. This allows the answering of calls
which deliver CID/DID data but not RINGs.
For example,
.nf
s-1CallIDAnswerLength: ``7''s+1
.fi
would cause the call to be answered
when
.B CallID2
reached a length of seven digits.
A value of zero for
.B CallIDAnswerLength
disables this feature.
.TP
.B CallIDDisplay
Whether or not to display the
.B CallIDPattern
match in the modem status line.
.TP
.B CallIDLabel
The label to use in the presentation of any
.B CallIDPattern
match. (For example, when
.B CallIDDisplay
or
.B CallIDRecord
indicate to diplay or record the match.)
.TP
.B CallIDRecord
Whether or not to record the
.B CallIDPattern
match in the received image file.
.TP
.B CallIDType
Identifies the type of indicator in the associated
.B CallIDPattern
match. The special type ``calling-number'' enables the
.I faxgetty
process to utilize an associated entry in the info database for
items such as
.B senderHasV17Trouble
and
.BR senderSkipsV29 .
See
.IR hylafax-info (${MANNUM4_5}).
.TP
.B ClocalAsRoot
Control whether operations that set the
.SM 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
.SM IRIX
where they are done as the super-user
(because
.SM IRIX
disallows manipulation of
.SM CLOCAL
by anyone but the super-user).
.TP
.B ContCoverCmd鹿
The command to invoke to generate a continuation cover page; see
.B ContCoverPage
and
.IR mkcover (${MANNUM1_8}).
.TP
.B ContCoverPage鹿
A template file to use in creating
.IR "continuation cover pages" .
If this parameter is non-null, then the server will pass the
filename to the command specified by
.B 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.
.TP
.B CountryCode虏
The local country code in which the facsimile modem resides.
As for
.BR AreaCode ,
this value is passed to the dial string rules for use in
formulating canonical phone numbers for dialing (among
other things.)
.TP
.B 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
.IR uucp )
can access the modem.
See also
.IR chmod (2).
.TP
.B DialStringRules虏
The pathname of the file that holds the rules for processing
user-specified dial strings; c.f.
.IR dialrules (${MANNUM4_5}).
The specified pathname must be relative to the top of the fax server's
spooling area; e.g.
.BR etc/dialrules .
.TP
.B 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,
.B DRingOn
and
.B DRingOff
values are presented by the modem to the
.I faxgetty
process. The modem indicates the entire cadence between ``RING'' indications
Like this:
.nf
RING
DROF=40
DRON=8
DROF=4
DRON=8
RING
.fi
The corresponding
.B DistinctiveRings
parameter for this ring cadence would be:
.nf
DistinctiveRings: F-8-4-8
.fi
where ``F'' tells the
.I 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
.B DRingOff
values ignored. Multiple ring cadences are indicated by delimiting
them with commas in this fashion:
.nf
DistinctiveRings: V-20,F-8-4-8,D-4-2-4-8
.fi
.TP
.B DRingOff
A string that identifies the ``off'' value in any distinctive
ring cadence, for example ``s-1DROF=s+1''.
See also
.B DRingOn
and
.BR DistinctiveRings .
.TP
.B DRingOn
A string that identifies the ``on'' value in any distinctive
ring cadence, for example ``s-1DRON=s+1''.
See also
.B DRingOff
and
.BR DistinctiveRings .
.TP
.B DynamicConfig
The pathname of the optional program, e.g. ``etc/localid'', that
makes dynamic configuration changes, i.e., to
.B 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
.BR 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.
.TP
.B 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
.BR CallIDPattern ,
if present.
The ``%'' character can be specified with ``%%''.
If the
.B 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 completes, its exit status is evaluated
and is interpreted to indicate what, if anything, should be done with the call.
An exit status of ``0'' indicates an unknown call type and that the call should
be handled as if egetty had not been used. An exit status
of ``1'' indicates a data connection and that the
.IR getty (${MANNUM1_8})
program should be used to handle the call if configured (see
.BR GettyArgs ),
otherwise it will assume that the call has been answered and that a data
connection is established and that it should proceed by issuing
.B ModemAnswerDataBeginCmd
(if configured) to the modem.
An exit status of ``2'' indicates a fax connection is established and that it
should proceed by issuing
.B ModemAnswerFaxBeginCmd
(if configured) to the modem.
An exit status of ``3'' indicates a voice call and
that the
.I vgetty
program should be used to handle the call if configured (see
.BR VGettyArgs ),
otherwise it will assume that the call has been answered and that a voice
connection is established and that it should proceed by issuing
.B ModemAnswerVoiceBeginCmd
(if configured) to the modem.
An exit status of ``4'' is considered to be an error condition. The session
will be terminated. An exit status of ``5'' is used to indicate that
egetty handled the call entirely, is not an error condition, and
that the session is to be considered terminated.
Exit status values of ``11'', ``12'', and ``13'' correspond to values ``1'',
``2'', and ``3'' respectively except that values ``11'', ``12'', and ``13''
indicate that the call has not been answered yet with a data, fax, or voice
connection. So if
.B GettyArgs
is not configured then
.B ModemAnswerDataCmd
is first issued to the modem for an exit status of ``11'',
.B ModemAnswerFaxCmd
is first issued to the modem for an exit status of ``12'', and if
.B VGettyArgs
is not configured then
.B ModemAnswerVoiceCmd
is first issued to the modem for an exit status of ``13''.
.TP
.B FAXNumber
The phone number associated with the facsimile modem.
This string is used to generate the
Transmitter Subscriber Identification (c
.SM TSIc
) and Caller Subscriber Identification (c
.SM CSIc
) information passed to remote machines(emunless the
.B LocalIdentifier
parameter is explicitly set.
The
.B FAXNumber
is also used to name the session log file where information
for incoming phone calls is recorded; see
.IR hylafax-log (${MANNUM4_5}).
If this phone number is not a fully qualified number
the values of
.B AreaCode
and
.B CountryCode
are used to generate the transmitted
.SM CSI
and
.SM TSI.
.TP
.B Include虏
Include the specified config file as if it were part of this config file.
.TP
.B InternationalPrefix虏
The string to use to place an international phone call.
In the United States, this is ``011''.
This string is passed to the dial string rules.
.TP
.B JobControlCmd鹿
The command to invoke to which provides Job Control information for a
job. See
.IR jobcontrol (${MANNUM1_8}).
.TP
.B JobReqBusy
The delay in seconds to wait before retrying a job whose
dialing attempt failed with a ``s-1BUSYs+1'' status result.
.TP
.B JobReqDataConn
The delay in seconds to wait before retrying a facsimile job whose
dialing attempt failed because a data modem answered the phone.
.TP
.B JobReqNoAnswer
The delay in seconds to wait before retrying a job whose
dialing attempt failed with a ``s-1NO ANSWERs+1'' status result.
.TP
.B JobReqNoCarrier
The delay in seconds to wait before retrying a job whose
dialing attempt failed with a ``s-1NO CARRIERs+1'' status result.
.TP
.B JobReqNoFCon
The delay in seconds to wait before retrying a facsimile job whose
dialing attempt failed because the initial facsimile protocol
handshake failed (i.e. no ``s-1+FCON:s+1'' result was received
from a Class 2/2.0 modem).
.TP
.B JobReqOther虏
The delay in seconds to wait before retrying a job that
failed for a reason not already covered by one of the
.B JobReq*
parameters.
.TP
.B JobReqProto
The delay in seconds to wait before retrying a facsimile job that
failed because of a fax protocol error.
.TP
.B JobRetryBusy
The number of times to redial a phone number after receiving
a ``s-1BUSYs+1'' result code when the number has not
been successfully dialed before.
.TP
.B 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.
.TP
.B 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.
.TP
.B 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.
In normal operation the fax server will treat this result code
to mean that a facsimile modem/machine did not answer the
phone and reject the transmit job.
This is done to avoid repeatedly dialing wrong phone numbers
and depends on the modem distinguishing between
no carrier and no answer.
However, some modems are not capable of reliably
distinguishing between no carrier and no answer, or when instructed
to do so do not identify a busy signal correctly.
For these modems one may find it necessary to increase the
value of this parameter to compensate.
It is strongly recommended, however, that this value
not be set to a large number.
.TP
.B 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.
.TP
.B GettyArgs
A string that indicates whether or not the server should invoke
the
.IR getty (${MANNUM1_8})
program in response to an incoming call from a data modem.
If the string value is not null, then it is interpreted
as a set of arguments to pass to the getty 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
.BR CallIDPattern ,
if present.
The ``%'' character can be specified with ``%%''.
If the
.B GettyArgs
parameter is not specified in the configuration file or if
the string value is null, then data connections will be rejected.
Note that in addition to the specified command line arguments, the
.I getty
program is invoked with its standard input, output, and error
descriptors directed to the controlling tty device.
.TP
.B LocalIdentifier
The local station identification string to use when transmitting
.SM TSI
and
.SM CSI
strings (see
.B FAXNumber
above).
NB: while this string may contain any printable
.SM ASCII
characters; beware that
.SM "CCITT T.30"
specifies a restricted character set and some fax modems and machines
may reject or not display non-conforming strings.
If the local identifier is not specified, a canonical form of the
.B FAXNumber
is used instead.
.TP
.B LockDataCalls
Hold the
.SM UUCP
lockfile during the time an inbound data call is processed by the
external getty program.
If this is disabled then the lockfile will be removed just before
the getty program is invoked.
Note however that doing this introduces a race condition whereby
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 it's own lockfile.
.TP
.B LockVoiceCalls
Hold the
.SM UUCP
lockfile during the time an inbound data call is processed by the
external voice getty program.
If this is disabled then the lockfile will be removed just before
the voice getty program is invoked.
Note however that doing this introduces a race condition whereby
an outbound program may sneak in and take control of the modem
after the inbound call has been accepted, but before the voice getty
program has started up and installed it's own lockfile.
.TP
.B LogFacility虏
The symbolic name for the
.IR syslog (3)
facility to use when logging error messages and
informational/debugging messages requested through the
.B ServerTracing
parameter.
The list of facility names is standardized; it can be found
in the system include file
.BR <syslog.h> ;
comparisons are case-insensitive.
.TP
.B LogCalls
Log all incoming calls into xferfaxlog as CALL records. This allows
a quick check of all incoming calls, regardless of fax completion or
not in a unified manner with other fax logs.
.TP
.B LogFileMode
The file protection mode that should be used when
creating files to hold session logs.
Note that this value is given in octal.
The default value of 0600 implies that the log files are not
generally accessible, which is important if sensitive information
such as calling card access codes are logged.
If log files are to be publicly accessible, this
value may be set, for example, to 0644.
See also
.IR chmod (2).
.TP
.B LongDistancePrefix虏
The string to use to place a long distance phone call.
In the United States, this is ``1''.
.TP
.B MaxConcurrentCalls鹿
The default value to use for the maximum number of jobs for the
same destination that are processed concurrently.
Thus this parameter defines the maximum number of concurrent phone calls
to the same destination.
Unless all of your fax destinations have multiple fax lines
using the same fax number per destination then
.B MaxConcurrentCalls
is probably best left as the default of 1 and exceptions should
be accommodated by the
.B JobControl
mechanism.
.TP
.B MaxBatchJobs鹿
The maximum number of jobs to batch together in a single call.
.TP
.B MaxConsecutiveBadLines
The maximum number of consecutive erroneous rows of image data that
the server will receive before it deems a page to have unacceptable
copy quality.
Setting this parameter to zero causes the server to not check
the quality of received facsimile.
Facsimile received with error-correction do not have copy quality
checking performed.
See also
.BR PercentGoodLines .
.TP
.B MaxDials鹿
The default value for the maximum number of times the server will
place a call for an outbound job.
This value may be overridden by rules in the
.B JobControl
mechanism.
See also
.BR MaxTries .
.TP
.B MaxRecvPages
The maximum number of pages the server will accept in a received
facsimile before it aborts the session.
.TP
.B MaxSendPages鹿
The default value for the maximum number of pages the server will
permit in a transmitted facsimile.
Outbound jobs that exceed this limit are rejected.
This value may be overridden by rules in the
.B JobControl
mechanism.
.TP
.B MaxSetupAttempts
The maximum number of times a *(Fx server program will attempt
to initialize a modem before considering it ``fIwedgedfP''.
.TP
.B MaxTries鹿
The default value for the maximum number of times the server will
attempt to communicate with a remote site.
Note that for a call to be counted against this limit, carrier must
be established;
this is in contrast to the value of
.B 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
.B JobControl
mechanism.
See also
.BR MaxDials .
.TP
.B MinAcceptedLineCount
The minimum number of received scanlines allowed on an ``OK'' page.
The use of this setting prevents confirmation from being sent for
very short pages.
.TP
.B ModemGroup鹿
Define a logical name for a set of modem devices.
This parameter can be used to define a name that clients can use
to refer to a collection of modems.
The syntax is ``fI<name>fP:fI<regex>fP'' where
.I <name>
is the name for the group and
.I <regex>
is a regular expression that
.IR faxq (${MANNUM1_8})
matches against known modems.
Thus for example, the default modem to use for a job,
.BR any ,
is defined as ``any:.*''.
This parameter may be specified multiple times to define multiple
modem classes.
Modem classes may overlap.
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.
.TP
.B 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 *(Fx 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
.B ModemGroup
have the same
.B ModemPriority
value, then the *(Fx scheduler assigns jobs to them in
a round-robin fashion.
.TP
.B NoAnswerVoice
Whether or not to disable the answering of calls indicated as
voice (e.g. by
.B DistinctiveRings
).
.TP
.B NoCarrierRetrys
This is mapped onto s-1JobRetryNoCarriers+1
.TP
.B ModemReadyState
Define the
.I state
transmitted to the *(Fx scheduler process each time a modem
is made ready by a
.I faxgetty
process.
State is one of: ``R'' (ready for use), ``B'' (busy), ``D'' (down), or ``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
.IR faxstate (${MANNUM1_8})
program or by setting this configuration parameter with the
.IR faxconfig (${MANNUM1_8})
program. The *(Fx scheduler process will not assign jobs to a modem with a
.B ModemReadyState
of anything other than ``R''. The differences between ``B'', ``D'', and ``E'' are that
``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);
and ``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
.B 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
.B ModemReadyState
of ``E'' will be rejected outright. Exempt modems should be removed from any
.B ModemGroup
to which they belong (i.e. ``any'').
.TP
.B ModemRingResponse
This can be used
to cause the command defined by
.B ModemRingResponse
to be sent to the modem after hearing at least
.B ModemRingsBeforeResponse
RINGs in order to receive DID-DTMF data, for example.
.TP
.B ModemRingsBeforeResponse
This defines the minimum number of RINGs that must be heard before
.B ModemRingResponse
is first sent to the modem.
.TP
.B NotifyCmd虏
The command to invoke to notify a client of a job status change; see
.IR notify (${MANNUM1_8}).
.TP
.B PageChop鹿
Whether or not to automatically truncate trailing whitespace on
pages of outbound facsimile (when possible).
If page chopping is enabled, then pages with at least
.B PageChopThreshold
trailing whitespace on a page will be transmitted as a ``short page''
if the receiver is capable of accepting variable-length pages.
The possible values are: ``last'' to enable chopping of the last
page of each document, ``all'' to enable chopping of all pages, or
``none'' to disable page chopping.
.TP
.B PageChopThreshold鹿
The minimum amount of trailing whitespace that must be present
on a page before page chopping will be attempted; see
.BR PageChop .
Note that this value is specified in inches.
.TP
.B PCL2FaxCmd鹿
The command to invoke to convert a HP-PCL document submitted
for transmission to
.SM TIFF/F,
suitable for transmission.
.TP
.B PercentGoodLines
The minimum percentage of good rows of image data required
for a received facsimile page to be deemed to have acceptable
copy quality.
Setting this parameter to zero causes the server to not
check the quality of received facsimile.
Facsimile received with error-correction do not have copy quality
checking performed.
See also
.BR MaxConsecutiveBadLines .
.TP
.B PollLockPokeModem
When polling for the presence/removal of a
.SM UUCP
lockfile, also test to make sure the modem is still reachable.
This is useful for scenarios where the modem is apt to become
disconnected while the modem is idle, such as an external modem
that may lose power, where the administrator wants notification
of this (as a ``wedged'' condition).
.TP
.B PollLockWait
When polling for the presence/removal of a
.SM UUCP
lockfile, the time (in seconds) to wait between checks.
Lockfile polling occurs to ensure the fax server doesn't collide
with another process using the modem.
.TP
.B PollModemWait
The time (in seconds) to wait between checks
for a modem to become ready for use.
Modem polling occurs when a modem fails to reset cleanly.
.TP
.B PriorityScheduling
Indicates whether the *(Fx scheduler should utilize available
priority job scheduling mechanisms to enhance realtime execution,
particularly with Class 1 configurations on older or slower
systems.
Currently
.B PriorityScheduling
is available for IRIX, SVR/4, HP-UX, and POSIX-compliant
(i.e. Linux) operating systems. The default value
varies to maintain traditional *(Fx behavior. 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 is used on Linux, OpenServer and possibly
other systems. On such systems, as well as on systems where no priority
scheduling mechanism exists, the default is false."
.TP
.B PS2FaxCmd鹿
The command to invoke to convert a *(Ps document submitted
for transmission to
.SM TIFF/F,
suitable for transmission;
see
.IR ps2fax (${MANNUM1_8}).
.TP
.B QualifyPWD
A string that specifies whether or not the identity of
calling facsimile machines should be checked against an access
control list before receiving facsimile.
If
.B QualifyPWD
is non-null, then only messages from facsimile machines identified
in the file specified by the string (typically fBetc/passwdfP)
will be accepted; similar to
.B QualifyTSI.
.TP
.B QualifyTSI
A string that specifies whether or not the identity of
calling facsimile machines should be checked against an access
control list before receiving facsimile.
If
.B QualifyTSI
is non-null, then only messages from facsimile machines identified
in the file specified by the string (typically fBetc/tsifP)
will be accepted; see
.IR tsi (${MANNUM4_5}).
If
.B QualifyTSI
is not specified in the configuration file, or the value is
null, then all incoming facsimile messages will be accepted.
.TP
.B RecvDataFormat
The data format (compression scheme) to write received facsimile data
when copy quality checking is performed on the host.
(When copy quality checking is not done by the server, for example when
error correction protocol is used, the received
facsimile data is written exactly as it is received from the modem.)
The format may be one: ``1-D MH'', ``2-D MR'', ``2-D MMR'', or ``adaptive''.
An ``adaptive'' format causes the received data to be written using
the data format negotiated by the sender and receiver.
Note that while 2-D MMR is the most space-efficient data format
the resultant file may not be viewable (certain commonly used programs
do not properly read multi-strip TIFF with 2-D MMR data).
.TP
.B RecvFileMode
The file protection mode that should be used when
creating files to hold incoming facsimile.
Note that this value is given in octal.
The default value of 0600 implies that only the
facsimile user can read received facsimile.
If incoming facsimile are to be publicly accessible, this
value may be set, for example, to 0644.
See also
.IR chmod (2).
.TP
.B RejectCall
If this is set to true, the current call will not be answered, and will
be rejected. This option has no effect if set in the configuration file,
but when set by the
.BR DynamicConfig
program, controls the current call. This options supersedes the obsolete
.BR QualifyCID
option.
.TP
.B RingData
A modem status string that identifies that an incoming call is
for data use.
This string should be set when a phone line has been setup with
fIdistinctive ringfP service.
See also
.B RingFax
and
.BR RingVoice .
.TP
.B RingExtended
An identifier which matches the initial portion of an extended RING
message sent by the modem to relay CID and/or DNIS data instead of
sending it formatted on separate lines.
.TP
.B RingFax
A modem status string that identifies that an incoming call is
for facsimile use.
This string should be set when a phone line has been setup with
fIdistinctive ringfP service.
See also
.B RingData
and
.BR RingVoice .
.TP
.B RingsBeforeAnswer
The number of rings to wait before answering the phone.
If this value is set to 0, then the phone will only
be answered in response to an explicit answer command; see
.IR faxanswer (${MANNUM1_8}).
.TP
.B RingTimeout
If a ring is heard and the call is not answered, the time in
ms to wait before reinitializing the modem for the next call.
.TP
.B RingVoice
A modem status string that identifies that an incoming call is
for voice use.
This string should be set when a phone line has been setup with
fIdistinctive ringfP service.
See also
.B RingData
and
.BR RingFax .
.TP
.B RTNHandlingMethod
Specifies how to react to an RTN signal received from the remote:
one of ``s-1Retransmits+1'', ``s-1Giveups+1'',``s-1Ignores+1'',
or ``s-1Retransmit-Ignores+1''.
``s-1Retransmits+1'' assumes that the page is not received successfully.
HylaFAX will make up to two additional attempts to send the page,
decreasing signalling rate and retraining. If RTN continues,
up to 2 additional calls will be placed. The downside is that if the remote
always responds with RTN, the page will be sent 9 times and no following
pages will be sent. Many fax machines will not behave this way, although
T.30 specification seems clear that this is the intent of the RTN signal.
Some fax machines will interpret RTN as meaning to not send the same data
again. That is because RTN may indicate problems with flow control,
incorrectly encoded T.4 data, or some incompatibility other than line noise.
Fax machines that interpret RTN this way will disconnect and require a manual
retransmission. This ``over and out'' behavior can be activated by the
``s-1Giveups+1'' value. The advantage to this behavior is that the same
page of image data will not be sent multiple times, but the downside is that
the following pages will not be sent.
``s-1Ignores+1'' is similar to ``s-1Giveups+1'' in that it makes the
assumption the data cannot be automatically accepted by the receiver. However,
rather than disconnecting the page of image data is abandoned and processing moves
on to the next. The remote is left to decide what to do with the unacceptable
page of image data. The downside to this behavior, is that the remote may or may
not have kept the page, depending on its interpretation of the RTN signal - but
it does allow us to continue on to the next page.
``s-1Retransmit-Ignores+1'' is a combination of ``s-1Retransmits+1'' and
``s-1Ignores+1''. The page of image data is 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 allows the receiver to hopefully
receive a better copy of the image data while not failing to send subsequent pages.
If the receiver saves or prints a copy of pages for which it transmits RTN, then it
could save or print up to three copies of every page.
.TP
.B SaveUnconfirmedPages
Whether or not to save a received facsimile 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''.
.TP
.B SendFaxCmd鹿
The command to use to process outbound facsimile jobs; see
.IR faxsend (${MANNUM1_8}).
.TP
.B SendPageCmd鹿
The command to use to process outbound pager jobs; see
.IR pagesend (${MANNUM1_8}).
.TP
.B SendUUCPCmd鹿
The command to use to process outbound
.SM UUCP
jobs.
This parameter is not currently used, it is for future development.
.TP
.B ServerTracing虏
A number that controls the generation of tracing
information by a server when not actively sending or
receiving facsimile.
Tracing is divided into
.I areas
that are individually controlled.
To enable tracing of multiple areas of operation, the
flag associated with each area should be bit-or'd to
form the value for this tag.
.ne 1i
.sp .5
.ta w'fB131072 (0x20000) fP'u +w'Modem Communications 'u
.nf
fBFlag Area DescriptionfP
1 (0x00001) Server Operation queue management and general operation
2 (0x00002) s-1FAXs+1/s-1IXOs+1 Protocol s-1T.30s+1 facsimile protocol or s-1IXO/TAPs+1 protocol
4 (0x00004) Modem Operations modem hardware manipulation
8 (0x00008) Modem Communications commands passed between host and modem
16 (0x00010) Timeouts timer operations
32 (0x00020) Modem Capabilities modem capabilities
64 (0x00040) s-1HDLCs+1 Frames binary s-1T.30 HDLCs+1 frames
128 (0x00080) Binary Modem s-1I/Os+1 binary communication between host and modem
256 (0x00100) Server State Transitions server program state transitions
512 (0x00200) Queue Management job queue management
1024 (0x00400) Copy Quality copy quality checking of received facsimile
2048 (0x00800) Job Management low-level job management
4096 (0x01000) s-1IXOs+1 Protocol low-level s-1IXOs+1 protocol
8192 (0x02000) Config File Parsing unknown configuration file parameters
16384 (0x04000) FIFO Messages inter-application messages
32768 (0x08000) Modem State Transitions modem state changes (down, busy, ready)
65536 (0x10000) Dial Rules dialstring rules parsing and execution
131072 (0x20000) Docq Changes document reference handling
262144 (0x40000) TIFF library any messages produced by the TIFF library
524288 (0x80000) ECM Frames binary s-1T.30-A HDLCs+1 ECM frames
.sp .5
.fi
For example, to enable tracing of server operations and
protocol operations, a value of 1+2=3 should be specified.
fBNB: tracing timeouts and/or binary modem s-1I/Os+1 can adversely
affect the operation of the fax server; enabling these areas
should be done with extreme care.fP
.IP
Server tracing is directed to
.IR syslog (3)
using the fIfacilityfP specified with the
.B LogFacility
configuration parameter.
Note that
.IR syslogd (${MANNUM1_8})
must be configured to capture
.IR facility.info ,
.IR facility.debug ,
.IR facility.warning ,
and
.I facility.err
messages.
See
.IR hylafax-log (${MANNUM4_5})
for a description of the logged messages.
.TP
.B SessionTracing虏
A number that controls the generation of tracing information
by a server while sending or receiving facsimile.
The number is interpreted identically to
.B ServerTracing.
Note that session tracing is placed in log files in the
.B log
subdirectory; see
.IR hylafax-log (${MANNUM4_5})
for more information.
.TP
.B SpeakerVolume
The volume level that the in-modem speaker should be
adjusted to while in command mode.
The possible values are:
.ne 1i
.sp .5
.ta w'fBMediumfP 'u
.nf
fBValue DescriptionfP
Off silent
Quiet almost inaudible
Low tolerable in privacy
Medium loud enough to hear in the next room
High intolerable
.sp .5
.fi
Note that the speaker is always turned off once carrier is established.
Also beware that some modems support fewer volume settings;
see
.BR ModemSetVolumeCmd .
.TP
.B StaggerCalls鹿