传真(Fax)编程

开发平台：

C/C++

hylafax-config.4f：源码内容

The time, in seconds, to delay between initiating outbound job calls. If *(Fx
is using a single phone line shared for both sending and receiving of faxes using a
.B StaggerCalls
setting of, for example, 300 would ensure that outbound calls be made in succession
no more frequently than every 5 minutes, thus allowing time between jobs for incoming
calls to be received.
.TP
.B TagLineFont
The filename of the font to use in imaging
.I "tag lines"
across the top of each transmitted page.
Fonts must be stored in the Portable Compiled Font (c
.SM PCFc
) format used by the X11 Window System.
Filenames are specified relative to the root of the spooling area;
e.g. etc/lutRS18.pcf.
If no font is specified, if a null filename is specified, or if
the specified font file is not readable, then tag lines will not
be generated.
Note that the default
.B TagLineFont
that traditionally comes with *(Fx does not have glyphs
available beyond basic ASCII, and to show non-ASCII characters
a different file must be used that has characters matching those
characters found in
.B TagLineFormat
as decoded by the
.B TagLineLocale
setting.
.TP
.B TagLineFormat
The format string to use when imaging
.I "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
.IR strftime (3C)
may be used as well as the following server-implemented codes:
.sp .5
.ta w'fBEscapefP 'u
.nf
fBEscapefP fBDescriptionfP
%%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 fBLocalIdentifierfP or canonicalized fBFAXNumberfP
%%m sender's electronic mail address
%%n canonicalized fBFAXNumberfP
%%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
%%% ``%''
.fi
.sp .5
In addition, the format string may indicate that
text is to be centered in multiple equal-sized
.I fields
by separating text with ``|'' characters.
For example, ``a|b|c'' would cause the tag line to be broken up into
three equal-sized areas with the strings ``a'', ``b'', and ``c''
centered within each region.
The default tag line format string is ``From %%n|%c|Page %%P of %%T''.
The 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
.BR TagLineFont .
.TP
.B TagLineLocale
The locale setting for handling
.BR TagLineFormat ,
for example, ``en_US.UTF-8''. If
.B TagLineFormat
is encoded via UTF-8 then the correct setting of
.B TagLineLocale
is requisite for proper decoding by the parser. By
default the environment settings are used.
.TP
.B TIFF2FaxCmd虏
The command to invoke to convert a TIFF submitted
for transmission to
.SM TIFF/F,
suitable for transmission; see
.IR tiff2fax (${MANNUM1_8}).
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.
.TP
.B 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
.SM UUCP
software.
The following
.SM BNF
describes the syntax:
.sp .5
.nf
.ft C
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 =
.ft P
.fi
.sp .5
where fIstartfP and fIendfP 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.
.IP
This value may be overridden by rules in the
.B JobControl
mechanism.
.TP
.B TSIRecvdCmd
The pathname of the optional program, e.g. ``etc/tsirecvd'', that similar
to
.B DynamicConfig
can set the
.BR RejectCall
option to cause the current call to be rejected instead of continued.
.B TSIRecvdCmd
should provide a more capable mechanism than
.B 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
.B TSIRecvdCmd
script other than
.BR RejectCall
is unsupported and has undefined results.
.TP
.B Use2D鹿
Control the use of 2D-encoded data for transmitted facsimile.
.TP
.B UseJobTagLine
Allow the use of the job-specified tagline instead of the configured
.B TaglineFormat
.TP
.B UUCPLockMode虏
The file protection mode that should be used when creating
.SM UUCP
lockfiles.
Note that this value is given in octal.
.TP
.B UUCPLockDir虏
The pathname of the directory in which
.SM UUCP
lockfiles are to be created.
.TP
.B UUCPLockTimeout虏
The time in seconds to wait before removing a fIstalefP
.SM 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.
.TP
.B UUCPLockType虏
A string that specifies the type of
.SM 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
.SM SVR4-c
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
.SM SCO
where the convention is to name devices with upper-case letters, but
create lockfiles with lower-case letters.
.TP
.B 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 fIvgettyfP 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 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
.I vgetty
program is invoked with its standard input, output, and error
descriptors directed to the controlling tty device.
.TP
.B WedgedCmd鹿
The command to invoke when a modem is deemed ``fIwedgedfP''; see
.IR wedged (${MANNUM1_8}).
.SH "MODEM-ORIENTED CONFIGURATION PARAMETERS"
.PP
This section lists configuration parameters that are specific
to the setup and operation of the modem.
All
.I 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 ``s-1ATs+1'' 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 ``en'' where
lines should be broken.
An example of a multi-line command string is
``s-1AT+FCQ=1enAT+FBADMUL=20enAT+FBADLIN=10s+1''.
.PP
Command strings sent to the modem may include command
escapes that force the host to alter the
.SM 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:
.ne 1i
.sp .5
.RS
.nf
.ta w'<115200> 'u
fBEscapefP fBEffectfP
<none> enable no flow control between s-1DTEs+1 and s-1DCEs+1
<xon> enable software flow control between s-1DTEs+1 and s-1DCEs+1
<rts> enable hardware flow control between s-1DTEs+1 and s-1DCEs+1
<2400> set the s-1DCE-DTEs+1 baud rate to 2400 bps
<4800> set the s-1DCE-DTEs+1 baud rate to 4800 bps
<9600> set the s-1DCE-DTEs+1 baud rate to 9600 bps
<19200> set the s-1DCE-DTEs+1 baud rate to 19200 bps
<38400> set the s-1DCE-DTEs+1 baud rate to 38400 bps
<57600> set the s-1DCE-DTEs+1 baud rate to 57600 bps
<76800> set the s-1DCE-DTEs+1 baud rate to 76800 bps
<115200> set the s-1DCE-DTEs+1 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)
.fi
.RE
.sp .5
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
.IR stty (1).
.PP
The ``<waitfor:..>'' escape can be used to override the default
behavior which is to wait for an ``s-1OKs+1'' response to a
command sent to the modem.
The possible response codes are:
.ne 1i
.sp .5
.RS
.nf
.ta w's-1NODIALTONEs+1 'u
s-1NOTHINGs+1 a null response
s-1OKs+1 the default response
s-1CONNECTs+1 ``s-1CONNECT...s+1''
s-1NOANSWERs+1 ``s-1NO ANSWER...s+1''
s-1NOCARRIERs+1 ``s-1NO CARRIER...s+1''
s-1NODIALTONEs+1 ``s-1NO DIALTONE...s+1''
s-1BUSYs+1 ``s-1BUSYs+1''
s-1OFFHOOKs+1 ``s-1PHONE OFF-HOOKs+1''
s-1RINGs+1 ``s-1RING...s+1''
s-1ERRORs+1 error status from modem
s-1VCONs+1 voice connection indicator
s-1OTHERs+1 any unrecognized modem response
.fi
.RE
.sp .5
For example ``s-1ATOer<waitfor:CONNECT>s+1'' would send
``s-1ATOs+1er'' to the modem and then wait for a response
with a leading ``s-1CONNECTs+1'' in it; and
``s-1ATS99=2er<delay:2><flush><waitfor:NOTHING>s+1'' would send
``s-1ATS99=2ers+1'' to the modem, delay 20 ms, flush any
input from the modem, and then continue (not wait for any response).
.PP
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:
.nf
ModemRingResponse: "AT+FCLASS=8;H1enAT+VSM=131enAT+VLS=1enAT+VTXen<waitfor:CONNECT><play:1><waitfor:OK>AT+VTS=[933,,150]"
ModemAnswerCmd: "<delay:100>AT+FCLASS=1;A"
CallIDPattern: SHIELDED_DTMF
CallIDAnswerLength: 4
.fi
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.
.TP
.B 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 ``s-1AT+FAA=1s+1'' command.
.IP
The following table describes how the result codes are interpreted by
the facsimile server.
.nf
.sp .5
.ta w's-1CONNECT FAXs+1 'u +w'No Dialtone 'u +w'Unknown 'u +w'Unknown 'u
fBResult StringfP fBDefaultfP fBClass 1fP fBClass 2fP fBClass2.0fP
s-1CONNECT FAXs+1 Fax - - - -
s-1CONNECTs+1 Data Unknown - -
s-1NO ANSWERs+1 No Answer - - -
s-1NO CARRIERs+1 No Carrier - - -
s-1NO DIALTONEs+1 No Dialtone - - -
s-1ERRORs+1 Error - - -
s-1FAXs+1 Fax - - -
s-1DATAs+1 Data - - -
s-1+FCONs+1 - - Fax Fax
s-1+FCOs+1 - - Fax Fax
s-1+FDMs+1 - - Data Data
s-1+FHNG:s+1 - - Error Error
s-1VCONs+1 - - Voice Voice
.ta
.fi
.sp .5
The ``Default'' column indicates the interpretation made for the
result string in either class 1 or 2 unless explicitly
overridden.
The ``Class 1'' column indicates result strings handled specially
for modems operating in class 1, the
``Class 2'' column indicates special handling for modems
operating in class 2, and the ``Class 2.0'' column indicates
special handling for modems operating in class 2.0.
.I Unknown
entries imply that interpretation is based on the way in which the
call was answered; if answering is done for an explicit call type,
that type is assumed, otherwise a Fax call is presumed.
.TP
.B ModemAnswerDataBeginCmd
The command to send to the modem once a data
connection has been established.
.TP
.B ModemAnswerDataCmd
The command to explicitly answer the phone for a data connection.
This command must generate a result string that
identifies the incoming call is from a data modem.
If this parameter is not specified or is null, then the value of
.B ModemAnswerCmd
is used instead.
See also
.B AdaptiveAnswer
and
.BR AnswerRotary .
.TP
.B ModemAnswerDialCmd
The command to explicitly answer the phone for a dialed connection.
This command must generate a result string that
identifies the incoming call is from a facsimile modem.
If this parameter is not specified or is null, then the value of
.B ModemAnswerCmd
is used instead.
.TP
.B ModemAnswerFaxBeginCmd
The command to send to the modem once a facsimile
connection has been established.
.TP
.B ModemAnswerFaxCmd
The command to explicitly answer the phone for a facsimile connection.
This command must generate a result string that
identifies the incoming call is from a facsimile modem.
If this parameter is not specified or is null, then the value of
.B ModemAnswerCmd
is used instead.
See also
.B AdaptiveAnswer
and
.BR AnswerRotary .
.TP
.B ModemAnswerVoiceBeginCmd
The command to send to the modem once a voice
connection has been established.
.TP
.B ModemAnswerVoiceCmd
The command to explicitly answer the phone for a voice connection.
This command must generate a result string that
identifies the incoming call is for voice.
If this parameter is not specified or is null, then the value of
.B ModemAnswerCmd
is used instead.
See also
.B AdaptiveAnswer
and
.BR AnswerRotary .
.TP
.B ModemAnswerResponseTimeout
The maximum time, in milliseconds, to wait for a response from
the modem after sending
.BR ModemAnswerCmd .
Note that you may want to shorten this value when using the
server-based adaptive answer strategy; see
.BR AdaptiveAnswer .
.TP
.B ModemATCmdDelay
A delay, in milliseconds, that should be performed before each
``AT'' command string is sent to the modem.
.TP
.B 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 (such as USRs) where
setting the serial line parameters does not take effect immediately.
.TP
.B ModemCommaPauseTimeCmd
The command to set the time,
in seconds, that the modem should pause when encountering
a ``,'' modifier in the dialing string.
.TP
.B ModemDialCmd
The command to place a phone call.
The string is assumed to be suitable for use
as a parameter to the
.IR sprintf (3S)
function; so the ``%'' character should be escaped as ``%%''.
The dial command must include a single ``%s'' where the number
that is to be dialed is to be substituted.
The command may include a single ``%d'' where the origin number
is to be substituted.
Facilities such as tone or pulse dialing, outgoing prefixes
to route though a s-1PBXs+1,
and so on should be included in the
dialing command string.
It is also important that, if possible, a trailing ``@''
symbol should be included so that the modem
returns result codes that distinguish between no answer and no carrier.
Use of the ``@'' permits the server to reduce the probability
that a wrong number is continually redialed.
If the modem does not support this facility, then it may be
necessary to raise the number of retries done when a
``s-1NO CARRIERs+1'' result is returned.
.TP
.B ModemDialResponseTimeout
The maximum time to wait, in milliseconds, for a response from
the modem after sending
This value should be longer than the timeout programmed into the
modem through the
.B ModemWaitTimeCmd
parameter.
This additional server-based timeout is provided to guard against
modems that can ``lock up'' when dialing the telephone.
.TP
.B ModemDoPhaseCDebug
Whether or not to query the modem for responses during image data
transmission. Normally the modem should not 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.
.TP
.B ModemDTRDropDelay
The time, in milliseconds, to pause between placing
.SM DTR
OFF and
.SM 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
.B ModemDTRDropDelay
to 0, but this should likely only be used for debugging purposes.
.TP
.B ModemEchoOffCmd
The command to disable echoing of commands sent to the modem.
.TP
.B ModemFlowControl
The type of flow control to use between
.SM DTE
and s-1DCEs+1;
one of ``s-1NONEs+1'', ``s-1XONXOFFs+1'' and ``s-1RTSCTSs+1''.
This value is used to select the string sent to the modem
to initially establish
.SM DTE-DCE
flow control; one of
.BR ModemNoFlowCmd ,
.BR ModemSoftFlowCmd ,
and
.BR 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
.BR Class1HFLOCmd ,
.BR Class1NFLOCmd ,
.BR Class1SFLOCmd ,
.BR Class2HFLOCmd ,
.BR Class2NFLOCmd ,
and
.BR Class2SFLOCmd .
.IP
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
.SM DTE-DCE
communication.
However, beware that many modems only support software
flow control when sending or receiving facsimile.
.IP
Note that modems usually support software flow control even
if they have no explicit AT-command to activate it; in this case
it is switched on when the modem enters fax mode, having
AT+FCLASS=... from s-1DTEs+1.
.TP
.B ModemFrameFillOrder
The bit order to expect for received
.SM HDLC
frames and to use when formulating
.SM HDLC
frames to send.
This value may be either
.SM LSB2MSB
when bits are ordered from least-significant-bit to
most-significant-bit (as in the
.SM CCITT
specification) or
.SM MSB2LSB
when bits are ordered in the reverse direction.
.TP
.B ModemHardFlowCmd
The command to setup hardware (s-1RTS/CTSs+1)
flow control between
.SM DTE
and
.SM DCE.
.TP
.B ModemMinSpeed
The minimum acceptable signalling rate for transmitting facsimile
page data.
Possible values are: 2400, 4800, 7200, 9600, 12200, and 14400.
.TP
.B ModemMfrQueryCmd
The command to send to the modem to get the manufacturer
identification string.
If this parameter is not set, then it is initialized
to ``s-1AT+FMFR?s+1'' for Class 2 modems, or
to ``s-1AT+FMI?s+1'' for Class 2.0 modems, or
to ``s-1ATI3s+1'' for Class 1 modems.
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.
.TP
.B ModemModelQueryCmd
The command to send to the modem to get the model identification string.
If this parameter is not set, then it is initialized to
to ``s-1AT+FMDL?s+1'' for Class 2 modems, or
to ``s-1AT+FMM?s+1'' for Class 2.0 modems, or
to ``s-1ATI0s+1'' for Class 1 modems.
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.
.TP
.B ModemNoAutoAnswerCmd
The command to stop the modem from automatically
answering when the phone rings.
.TP
.B ModemNoAutoAnswerCmdDelay
The time, in milliseconds, to pause after receiving the OK following
.B ModemNoAutoAnswerCmd
before any further commands are sent to the modem. All input from
the modem is flushed after pausing.
.TP
.B ModemNoFlowCmd
The command to disable flow control between
.SM DTE
and
.SM DCE.
.TP
.B ModemOnHookCmd
The command to place the phone ``on hook''
(i.e. hangup).
.TP
.B ModemPageDoneTimeout
The maximum time to wait, in milliseconds, for a response
from the modem after sending a page of facsimile data (e.g.
the time to wait for a response to a Class 2/2.0
.SM AT+FET
command).
.TP
.B ModemPageStartTimeout
The maximum time to wait, in milliseconds, for an initial
response from the modem when sending a page of facsimile data
(e.g. the time to wait for a response to a Class 2/2.0
.SM AT+FDR
command).
.TP
.B ModemRaiseATCommands
Indicates whether or not all configuration AT commands for the modem should
be raised to upper-case automatically. The standard is for all upper-case
to be used in AT commands, and indeed, some rare modems have been known
to malfunction with lower-case commands. However, sometimes an administrator
may want to use lower-case commands in a rare condition such as to work
around modem blacklisting of dialed numbers.
.TP
.B ModemRate
The baud rate to use for DCE-DTE communication.
This value may be one of: 115200, 76800, 57600, 38400, 19200, 9600, 4800,
2400, 1200.
The default value is 19200 because many modems lock the
rate at 19200 when sending or receiving facsimile.
Note that not all values are supported by all operating
systems and modems; consult
.IR stty (1)
for the available rates on your system.
.TP
.B ModemReadyCmds
A string of commands to issue to the modem during reception initialization.
This string is sent to the modem
.I after
the standard set of configuration commands required by the fax server. This
is done, for example, to un-busy a DID line so that calls can come through.
.TP
.B ModemRecvFillOrder
The bit order to expect for received facsimile data.
This value may be either
.SM LSB2MSB
when bits are ordered from least-significant-bit to
most-significant-bit (as in the
.SM CCITT
specification) or
.SM MSB2LSB
when bits are ordered in the reverse direction.
According to the various specifications all modems should return
data in
.SM LSB2MSB
order.
However most Class 2 modems (except maybe only Multitech) use
.SM MSB2LSB
for compatibility with modems that were built with
Rockwell hardware/firmware that included a bug
that was too widespread to correct.
.IP
If this parameter is not set, then it is autodetected and set to
.SM LSB2MSB
for Class 1 and Class 2.0 modems and
.SM MSB2LSB
for non-Multitech Class 2 modems. However this may be wrong for
your modem, so you will have to specify this parameter explicitly.
.TP
.B ModemRecvSuccessCmd
A string of commands to issue to the modem after a successful
receive session before the call is disconnected.
.TP
.B ModemResetCmds
A string of commands to issue to the modem during initialization.
This string is sent to the modem
.I before
the standard set of configuration commands required by the fax server.
Note that these commands fBshould not include normal
reset commands that are specified through other parametersfP.
For example, commands to setup flow control,
.SM DCD
handling,
.SM DTR
handling, etc. should be specified through the appropriate
configuration parameters and not through this parameter.
In addition the soft reset command (usually ``s-1ATZs+1'')
should not be included in this string; the servers issue this
command explicitly.
.TP
.B ModemResetDelay
The time, in milliseconds, to pause after setting
.SM DTR
ON, while resetting a modem.
.SM DTR
ON does not respond with ``OK'', so this parameter should
be long enough to allow the modem time to be ready for
.B ModemSoftResetCmd
successively.
.TP
.B ModemResultCodesCmd
The command to enable result codes.
.TP
.B ModemRevQueryCmd
The command to send to the modem to get a firmware revision identification
string.
If this parameter is not set, then it is initialized to
``s-1AT+FREV?s+1'' for Class 2 modems, or
to ``s-1AT+FMR?s+1'' for Class 2.0 modems.
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.
.TP
.B ModemSendBeginCmd
The command to send to the modem upon establishing carrier during
a transmit operation.
This parameter is useful for systems that are incapable of enabling
hardware flow control without
.SM DCD
asserted.
.TP
.B ModemSendFillOrder
The bit order the modem expects for transmitted facsimile data.
This value may be either
.SM LSB2MSB
or
.SM MSB2LSB
(see also
.B ModemRecvFillOrder
above.)
Virtually all modems expect transmitted facsimile data in
.SM LSB2MSB
bit order.
.TP
.B ModemSetOriginCmd
The command to use to set the call origin information before placing
a call. The command may include a single ``%d'' where the job request
``faxnumber'' string is to be substituted. The command may also include
a single ``%s'' where the job request ``faxname'' string is to be
subsituted.
.TP
.B ModemSetVolumeCmd
The commands to use to set the modem speaker volume levels.
There should be five whitespace-separated commands,
one each for setting the
volume to ``Off'', ``Quiet'', ``Low'', ``Medium'', and ``High'';
the default is ``"s-1&ATM0 ATL0M1 ATL1M1 ATL2M1 ATL3M1s+1"''.
See also
.BR SpeakerVolume .
.TP
.B ModemSetupAACmd
The command to setup
.I "adaptive answer"
support in the modem-if available.
Adaptive answer is the term used for the ability to
distinguish between calls from facsimile, voice, and
data sources.
Note that this string is the last command issued by the device
drivers during setup, so the command string
may, if necessary, switch to a different
operating mode (e.g. on some Rockwell-based modems it is necessary
to issue the ``s-1AT+FAA=1s0'' command in Class 0).
.TP
.B ModemSetupDCDCmd
The command to setup
.SM DCD
handling.
On most systems the facsimile server will enable
the s-1CLOCALs+1 flag on the tty device to which
the modem is connected.
This should ensure that the system does not close an open
file descriptor associated with the modem if carrier is dropped.
Thus, for most systems and modems
.B ModemSetupDCDCmd
should setup
.SM DCD
to reflect carrier.
.TP
.B ModemSetupDTRCmd
The command to setup
.SM DTR
handling so that the modem is reset when the
.SM DTR
signal is lowered by the host.
The facsimile server uses this facility to ensure that modems
are not left in a ``locked up'' state.
.TP
.B ModemSoftFlowCmd
The command to setup software (s-1XON/XOFFs+1)
flow control between
.SM DTE
and
.SM DCE.
.TP
.B ModemSoftResetCmd
The command to force a soft reset of the modem.
.TP
.B ModemSoftResetCmdDelay
The time, in milliseconds, to pause after receiving the OK following
.B ModemSoftResetCmd
before any further commands are sent to the modem.
.TP
.B ModemSoftRTFCC
Whether or not to enable software-driven Real-Time Fax Compression Conversion.
RTFCC allows HylaFAX to convert the image compression between MH MR and MMR
formats regardless of how faxq formatted the image file.
Note that when using RTFCC, the
compression format of the file will be ignored, thus the ``-1'', ``-2'',
and ``-3'' options for sendfax, ps2fax, and others will only influence how the
document is prepared by faxq and will not influence the
actual negotiated session parameters.
.B Class2RTFCC
takes precedence over
.B ModemSoftRTFCC
and if both are enabled, then software-driven RTFCC will not be performed
in favor of the firmware-driven RTFCC.
.TP
.B ModemType
This parameter must be set to one of: ``Class2'', ``Class2.0'',
or ``Class1'';
to indicate that the modem is a Class 2-,
Class 2.0-, or Class 1-style modem, respectively.
If this parameter is not set, then it is auto-detected and
the highest supported fax class is used.
.TP
.B ModemVerboseResultsCmd
The command to enable verbose, as opposed to numeric, result codes.
.TP
.B ModemWaitForConnect
If enabled, the facsimile server will not consider a connection
established when answering an incoming call until a
``s-1CONNECTs+1'' status string is received.
This is useful mainly for Rockwell s-1RC32ACLs+1-based
modems that send ``s-1FAXs+1'' and ``s-1DATAs+1'' status
messages before sending ``s-1CONNECTs+1''.
.TP
.B ModemWaitTimeCmd
The command to set the
number of seconds to wait for a carrier signal
when placing a call or answering the phone.
.SH "T.30 PROTOCOL CONFIGURATION PARAMETERS"
.PP
The following parameters apply to the implementation of the
.SM "CCITT T.30"
facsimile protocol in the Class 1 device driver.
They should not be changed without full understanding of the
operation of the server.
.TP
.B FaxT1Timer
The value of the
.SM T1
timer in milliseconds.
This timer is used to time out the initial session contact;
i.e. receipt of s-1DIS/DCSs+1.
.TP
.B FaxT2Timer
The value of the
.SM T2
timer in milliseconds.
This timer is used to time out receiving responses and commands.
.TP
.B FaxT4Timer
The value of the
.SM T4
timer in milliseconds.
This timer is used to time out the reception of
.SM HDLC
frames and, usually, trigger frame retransmissions.
.SH "CLASS 1 MODEM CONFIGURATION PARAMETERS"
.PP
The following parameters are specific to the configuration
of Class 1-style modems; they should not be changed lightly:
.TP
.B Class1Cmd
The command to set the modem into Class 1 operation.
.TP
.B Class1AdaptRecvCmd
The command used to enable adaptive reception support (usually
``AT+FAR=1''). This feature is new in T.31, and many modems
will not support it. This feature may reduce the number of
reception failures due to errors cascading from +FCERROR messages.
.TP
.B Class1ColorJPEGSupport
Whether or not to enable support for T.30-E full-color facsimile
with JPEG compression. Enabling this automatically enables
.B Class1GreyJPEGSupport.
.TP
.B Class1EnableV34Cmd
The command to enable V.34-fax support with at least the desired
maximum primary channel rate.
.TP
.B Class1ECMSupport
Whether or not to support T.30-A error correction protocol. Use of
ECM will require 64 kilobytes of free memory per modem in active use.
.TP
.B Class1PersistentECM
Whether or not to continue to retransmit and allow to continue to
receive image data in ECM protocol
which is not accepted as valid after four successive attempts.
.TP
.B Class1ECMFrameSize
The size in bytes of image frames to transmit during ECM protocol.
This setting will also indicate a preference in receive sessions.
The only acceptable values are 64 and 256. A setting of 64 may
be useful on high-load systems and possibly environments with
extremely poor line quality.
.TP
.B Class1ExtendedRes
Whether or not to support resolutions other than normal and fine.
This option has been deprecated by
.B Class1Resolutions.
.TP
.B Class1FrameOverhead
The number of extraneous bytes in
.SM HDLC
frames sent to the host in response to an ``s-1AT+FRHs+1'' command.
For modems that properly implement the Class 1 interface, this
number should be 4 (the default).
.TP
.B Class1GreyJPEGSupport
Whether or not to enable support for T.30-E greyscale facsimile
with JPEG compression. This is always enabled if
.B Class1ColorJPEGSupport
is enabled.
.TP
.B Class1HookSensitivity
The number of times to ignore on-hook detections and merely treat them
as command or modem errors.
.TP
.B Class1JBIGSupport
Whether or not to enable support for T.85 monochrome facsimile
with JBIG compression. Options are ``true'' for support in both
sending and receiving, ``false'' for no support, ``send'' for
support only in sending, and ``receive'' for support only in
receiving. If, during the build process a compatible JBIG library
was found then send support is enabled by default. If, during
the build process the TIFF tools are found to support JBIG then
receive support is enabled by default.
.TP
.B Class1MRSupport
Whether or not to enable support for two-dimensional Modified Read
(MR) image data format compression.
.TP
.B Class1MMRSupport
Whether or not to enable support for two-dimensional Modified Modified Read
(MMR) image data format compression. Note that MMR support requires also
ECM support to be enabled.
.TP
.B Class1HasRHConnectBug
A Class 1 modem should only report CONNECT after AT+FRH=3 when
V.21 HDLC data is detected. However, some modems will incorrectly
report CONNECT after AT+FRH=3 whenever any carrier is present. In
such cases
.B Class1HasRHConnectBug
should be set to ``true''.
.TP
.B Class1HFLOCmd
The command to setup hardware (s-1RTS/CTSs+1)
flow control between
.SM DTE
and
.SM DCE
when operating in Class 1.
This command is issued immediately after sending the
.B Class1Cmd
to switch the modem to Class 1 operation.
.TP
.B Class1NFLOCmd
The command to setup no flow control between
.SM DTE
and
.SM DCE
when operating in Class 1.
This command is issued immediately after sending the
.B Class1Cmd
to switch the modem to Class 1 operation.
.TP
.B Class1PageLengthSupport
The coded value for page lengths supported by the modem. The only
correct values and meanings are these: ``1'', A4 page length; ``3'', both
A4 and B4 page length; ``7'', unlimited page length.
.TP
.B Class1PageWidthSupport
The coded value for page widths supported by the modem. The only
correct values and meanings are these: ``1'', A4 page width; ``3'', both
A4 and B4 page width; ``7'', all of A4, B4, and A3 page widths.
.TP
.B Class1PPMWaitCmd
The command used to stop and wait before sending the post page message,
except before sending EOP, when
.B Class1EOPWaitCmd
is used instead. We must ensure that the high-speed carrier has
stopped completely.
According to T.30, Chapter 5, Note 4, this delay should be 75 +/- 20 ms.
.TP
.B Class1ResponseWaitCmd
The command used to stop and wait after sending TCF, before attempting to
receive a training response from the remote. Set this to ``AT+FTS=1'' if
the modem responds ``OK'' before actually dropping the high-speed TCF carrier.
.TP
.B Class1Resolutions
A bitmapped (bit-or'd) value indicating the resolutions to be supported during facsimile
operation. Individual resolutions follow Table 21/T.32 and are defined as follows:
.ne 1i
.sp .5
.ta w'fB131072 (0x20) fP'u +w'Modem Communications 'u
.nf
fBBit DescriptionfP
0 (0x00) R8 x 3.85 l/mm, Normal
1 (0x01) R8 x 7.7 l/mm, Fine
2 (0x02) R8 x 15.4 l/mm, Superfine
4 (0x04) R16 x 15.4 l/mm, Hyperfine
8 (0x08) 200 dpi x 100 l/inch
16 (0x10) 200 dpi x 200 l/inch
32 (0x20) 200 dpi x 400 l/inch
64 (0x40) 300 dpi x 300 l/inch
.sp .5
.fi
Thus, a value of 3 would indicate support for normal, fine, and superfine resolutions.
.TP
.B 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 remainder of the
string is taken to be the modem response and no command is issued to the modem.
.TP
.B Class1TCFWaitCmd
The command used to stop and wait before sending TCF, similar to
.B Class1PPMWaitCmd.
According to T.30, Chapter 5, Note 3, this delay should be 75 +/- 20 ms.
.TP
.B 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 remainder of the
string is taken to be the modem response and no command is issued to the modem.
.TP
.B Class1EOPWaitCmd
The command used to stop and wait before sending the post page message
similar to
.B Class1PPMWaitCmd.
We allow a different setting in the case of EOP, however, because
empirically some machines may need more time.
.TP
.B Class1ModemHasDLEBug
Used to indicate that the modem does not correctly duplicate DLE characters
in the V.21 communication to the DTE.
.TP
.B Class1MsgRecvHackCmd
If receive failures occur due to +FCERROR just prior to image data
reception, setting
.B Class1MsgRecvHackCmd
to AT+FRS=1 may help.
.TP
.B Class1RecvAbortOK
The time, in milliseconds, to wait for an ``s-1OKs+1'' result code
from the modem after aborting an
.SM HDLC
frame receive (``s-1AT+FRH=3s+1'').
If this number is zero, then the modem is assumed to not correctly
implement aborting and instead the driver will wait 200ms,
flush any input, and then send ``s-1ATens+1'' and wait
100ms for an ``s-1OKs+1'' result.
.TP
.B Class1RecvIdentTimer
The time, in milliseconds, to wait for an initial
.SM DCS
when receiving a facsimile.
.SM CCITT
recommendation
.SM T.30
specifies this as the value of the
.SM T1
timer.
However, adaptive answering schemes such as that described
above under the
.B AdaptiveAnswer
parameter may require that this timer be shortened.
.TP
.B Class1RMPersistence
The number of times that an attempt to receive the high-speed data carrier
should be made, resulting in +FCERROR, before the low-speed message carrier
reception is attempted. Some modems are quick to (perhaps incorrectly)
return +FCERROR, and for those modems a value of 2 or 3 should be used.
For modems that are not quick to return +FCERROR, a value of 1 should be used.
Proper tuning of this can provide a type of "adaptive reception control"
for modems that accurately return +FCERROR without supporting
.B Class1AdaptRecvCmd.
For those modems that support
.B Class1AdaptRecvCmd,
.B Class1RMPersistence
should probably not be set at 1, although +FCERROR should almost never occur
with such modems.
.IP
If the modem does not support the reporting of +FCERROR or adaptive reception
control, then
.B Class1RMPersistence
should probably be set at 0, which causes the timeout looking for the high-speed
data carrier to be shortened, thus increasing the likelihood of recovery from
any dissynchronization. When
.B Class1RMPersistence
is other than 0 it is assumed that the +FCERROR reporting or
.B Class1AdaptRecvCmd
is functional and therefore the timeout looking for the high-speed data carrier
is lengthened.
.TP
.B Class1SwitchingCmd
The command used to ensure that the sending facsimile device has turned
off its modulator (i.e. loss-of-carrier)
as recommended by T.31: Appendix II.1.
.TP
.B Class1SFLOCmd
The command to setup software (s-1XON/XOFFs+1) flow control between
.SM DTE
and
.SM DCE
when operating in Class 1.
This command is issued immediately after sending the
.B Class1Cmd
to switch the modem to Class 1 operation.
.TP
.B Class1TCFMaxNonZero
The maximum percentage of non-zero data bytes
permitted in an acceptable received
.SM TCF.
Note that this number does not include any leading non-zero data
in the received data.
See also
.BR Class1TCFMinRun .
.TP
.B Class1TCFMinRun
The duration, in milliseconds, of the minimum run of zero data in
an acceptable received
.SM TCF.
This value should be specified according to a 1.5 second
transmission of zero data (i.e. it should be between 0 and 1500).
See also
.B Class1TCFMaxNonZero
and
.BR Class1TCFMinRunECMMod .
.TP
.B Class1TCFMinRunECMMod
The factor by which
.B Class1TCFMinRun
should be modified in the case of an ECM session. As ECM protocol
allows retransmissions it is commonly faster to accept a lesser-quality
data stream and the subsequent retransmisisons than it is to allow
the communication speed to slow down (where the demodulation may still
not produce an ideal data stream, anyway).
.TP
.B Class1TCFRecvHackCmd
If receive failures occur due to +FCERROR just prior to TCF data
reception, setting
.B Class1TCFRecvHackCmd
to AT+FRS=1 may help.
.TP
.B Class1TCFRecvTimeout
The maximum time to wait, in milliseconds, for the first byte and
again for the entirety of
the Training Check (c
.SM TCFc
) message data that is received during the
training phase of the facsimile reception protocol.
.TP
.B Class1TMConnectDelay
The time, in milliseconds, to delay after receiving CONNECT following +FTM
before sending image data. T.31 8.3.3 requires the modem to respond with
CONNECT before the modulation training pattern. If transmission begins
before the remote has successfully completed its own modulation training
pattern then data, especially during TCF, could be lost. Many modems do
not follow T.31 in this regard, and thus the default is zero; however its
use with such modems would likely have a negligible effect.
.TP
.B 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 do not require this feature to be
enabled.
.SH "CLASS 2 AND 2.0 MODEM CONFIGURATION PARAMETERS"
.PP
The following parameters are specific to the configuration
of Class 2- and Class 2.0-style modems:
.TP
.B Class2Cmd
The command to set the modem into Class 2/2.0 operation.
.TP
.B Class2AbortCmd
The command to use to abort an established session.
After using this command to abort a session,
the fax software will send
.B ModemOnHookCmd
and then reset the modem by dropping
.SM DTR .
.TP
.B 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.
.TP
.B Class2APQueryCmd
A largely unused option for modems supporting ITU-T.32, Class 2.1,
standards. This command would be used to query the capabilities of
sending and receiving SUB, SEP, and PWD frames.
The value ``none'' may be used if the modem does not support any
.B Class2APQueryCmd.
.TP
.B Class2BORCmd
The command to setup the bit order of sent and
received facsimile data.
Usually the command ``s-1AT+FBOR=0s+1'' is used
so that data is sent and received in
.I direct
bit order (s-1LSB2MSBs+1).
Some modems, such as the Everex 24/96D,
must use reversed bit order for
Phase B and D data exchanges to avoid a bug that results in
garbage data being placed in the padding of
.SM EOL
codes.
The bit order specified by this command must correspond
to the settings of the
.B ModemSendFillOrder
and
.B ModemRecvFillOrder
parameters.
.TP
.B Class2BUGCmd
The command to use to enable or disable the tracing of
.SM HDLC
frames sent and received by the modem.
This tracing information should be returned to the host in ``s-1+FHR:s+1''
and ``s-1+FHT:s+1'' status strings.
Note that many Class 2 modems do not support this facility,
which is largely used for diagnostic purposes.
The value ``none'' may be used if the modem does not support any
.B Class2BUGCmd.
.TP
.B Class2CIGCmd
The command used to set a polling identifier.
This string is inserted into the format ``s-1%s="<id>"s+1''.
.TP
.B Class2CQCmd
The command to use to set up parameters for copy quality checking.
For example, for an Everex 24/96D modem this parameter might be set to
``s-1AT+FCQ=1enAT+FBADMUL=20enAT+FBADLIN=10s+1''.
.B Class2CQCmd
should be configured to set-up all available copy quality services
available per
.B Class2CQQueryCmd.
To disable features that are available, configure
.B Class2CQQueryCmd
with a ``!'', and then set
.B Class2CQCmd
accordingly.
.TP
.B Class2CQQueryCmd
The command to send to the modem to get the copy quality capabilities string.
If the parameter begins with a ``!'', then the remainder of the
string is taken to be the capabilities string and no command
is issued to the modem; this can be used together with the
.B Class2CQCmd
to force copy quality checking to be done in the server instead
of in the modem.
See also
.B PercentGoodLines
and
.B MaxConsecutiveBadLines
for parameters used to do server copy quality checking. If copy quality
checking is configured to be done by the modem then it is not done by the server.
.TP
.B Class2CRCmd
The command to use to enable the reception of facsimile.
.TP
.B Class2DCCCmd
The command used to set modem capabilities.
This string is inserted into the format
``s-1%s=vr,br,wd,ln,df,ec,bf,sts+1''.
.TP
.B Class2DCCQueryCmd
The command to send to the modem to get the Class 2/2.0 capabilities.
If the parameter begins with a ``!'', then the remainder of the
string is taken to be the capabilities string and no command
is issued to the modem.
.TP
.B Class2DDISCmd
The command to set session parameters before dialing.
This string is inserted into the format
``s-1%s=vr,br,wd,ln,df,ec,bf,sts+1''.
Setting this parameter enables support for Class 2 modems that do not
properly implement the ``s-1AT+FDISs+1'' command by
setting up session parameters before dialing the telephone.
.TP
.B Class2DISCmd
The command used to set the current session parameters.
This string is inserted into the format
``s-1%s=vr,br,wd,ln,df,ec,bf,sts+1''.
.TP
.B Class2ECMType
The interpretation of the EC parameter in the modem DCC response varies
between the Class 2, ``2'', and Class 2.0, ``2.0'', specifications. This
configuration parameter allows the administrator to specify which type to
use. The corresponding specification type is used by default.
.TP
.B Class2HexNSF
Whether or not to parse the NSF strings reported by the modem
using hexadecimal values. By default, they are parsed as hexadecimal values.
.TP
.B Class2HFLOCmd
The command to setup hardware (s-1RTS/CTSs+1)
flow control between
.SM DTE
and
.SM DCE
when operating in Class 2/2.0.
This command is issued immediately after sending the
.B Class2Cmd
to switch the modem to Class 2/2.0 operation.
For Class 2.0 operation the default is ``s-1AT+FLO=2s+1''.
.TP
.B Class2JBIGSupport
Whether or not to enable support for T.85 monochrome facsimile
with JBIG compression. Options are ``true'' for support in both
sending and receiving, ``false'' for no support, ``send'' for
support only in sending, and ``receive'' for support only in
receiving. If the modem supports JBIG, and during the build process
a compatible JBIG library was found then send support is enabled by
default. If the modem supports JBIG, and during the build process
the TIFF tools are found to support JBIG then receive support is
enabled by default.
.TP
.B Class2JPEGSupport
Whether or not to enable and utilize the JPEG support found in the modem.
.TP
.B Class2LIDCmd
The command used to set the local identifier string.
This string is inserted into the format ``s-1%s="<id>"s+1''
.TP
.B 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-1%s=<speed>s+1''
.TP
.B Class2NFLOCmd
The command to setup no flow control between
.SM DTE
and
.SM DCE
when operating in Class 2/2.0.
This command is issued immediately after sending the
.B Class2Cmd
to switch the modem to Class 2 operation.
For Class 2.0 operation the default is ``s-1AT+FLO=0s+1''.
.TP
.B Class2NRCmd
(fIClass 2.0 onlyfP)
The command to setup negotiation message reporting.
For the correct operation of the Class 2.0 driver
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 operation of the Class 2.0 driver.
.TP
.B Class2PACmd
A largely unused option for modems supporting ITU-T.32, Class 2.1,
standards. This command would be used to set up the polling address
string enabled by the
.BR Class2APCmd .
.TP
.B Class2PHCTOCmd
The command to use to set the Phase C timeout parameter (in seconds).
The value ``none'' may be used if the modem does not support any
.B Class2PHCTOCmd.
.TP
.B Class2PIECmd
(fIClass 2.0 onlyfP)
The command to use to control procedure interrupt handling.
Procedure interrupts should be disabled because
*(Fx does not provide a mechanism for dispatching procedure interrupts
to an administrator.
.TP
.B Class2PTSCmd
The command to use to set the received page status code.
When copy quality checking is done in the host, this command may be
used to control the post-page response delivered to the sender.
Beware that some modems do not properly implement this command
in which case the server should be configured to not do copy quality
check: see the
.B PercentGoodLines
and
.B MaxConsecutiveBadLines
parameters to understand how to defeat copy quality checking.
.TP
.B Class2PTSQueryCmd
The command to use to query the received page status code.
This command may be used to determine the post-page response returned from
the receiver.
Beware that some modems do not properly implement this command
in which case this setting should be set to ``none''.
.TP
.B Class2PWCmd
A largely unused option for modems supporting ITU-T.32, Class 2.1,
standards. This command would be used to set up the password
string enabled by the
.BR Class2APCmd .
.TP
.B Class2RecvDataTrigger
The character to send to the modem to trigger the transmission
of received data from the modem to the host.
This character is specified to be
.SM DC1
(octal 21) in the
draft specification 2388-A and
.SM DC2
(octal 22) in the 2388-B
specification.
Most Class 2 modems accept
.SM DC1
or both
.SM DC1
and
.SM DC2.
Some modems however only accept
.SM DC2.
Note that string parameters may use C-style escape sequences,
so
.SM DC2,
for example, would be specified as ``"e022"''.
.TP
.B Class2RELCmd
The command to use to enable the delivery of byte-aligned
.SM EOL
codes in received facsimile.
If this parameter is defined, then received facsimile data
will be marked to indicate that
.SM EOL
codes are byte-aligned; otherwise they will be marked as
not (necessarily) having byte-aligned codes.
.TP
.B Class2RTFCC
Whether or not to enable MultiTech's Real-Time Fax Compression Conversion
which is available in later firmware revisions for the MT5634ZBA-V92,
MT5634ZPX-PCI-V92, and other models. RTFCC allows HylaFAX to convert the
image compression between MH MR and MMR formats regardless of how faxq
formatted the image file. If RTFCC is available with your firmware, then
the response to ``AT+FFC=?'' is non-zero. Note that when using RTFCC, the
compression format of the file will be ignored, thus the ``-1'', ``-2'',
and ``-3'' options for sendfax, ps2fax, and others will not influence the
actual negotiated session parameters.
.TP
.B Class2SACmd
A largely unused option for modems supporting ITU-T.32, Class 2.1,
standards. This command would be used to set up the destination
subaddress string enabled by the
.BR Class2APCmd .
.TP
.B Class2SendRTC
Whether or not to append an explicit ``Return To Control'' (s-1RTCs+1)
signal to the page data when transmitting.
The Class 2 and Class 2.0 specs (i.e. SP-2388-A and TIA/EIA-592) state
that the modem will append
.SM RTC
when it receives the post-page message command from the host; this
parameter is provided in case the modem does not correctly implement
this.
.TP
.B Class2SFLOCmd
The command to setup software (s-1XON/XOFFs+1) flow control between
.SM DTE
and
.SM DCE
when operating in Class 2/2.0.
This command is issued immediately after sending the
.B Class2Cmd
to switch the modem to Class 2/2.0 operation.
For Class 2.0 operation the default is ``s-1AT+FLO=1s+1''.
.TP
.B Class2SPLCmd
The command to use to enable a polling request.
The value ``none'' may be used if the modem does not support any
.B Class2SPLCmd.
.TP
.B Class2TBCCmd
The command to use to enable stream-mode communication between the
host and modem.
The value ``none'' may be used if the modem does not support any
.B Class2TBCCmd.
.TP
.B Class2UseLineCount
Whether or not to use the line count reported to HylaFAX by the
modem firmware decoder.
.TP
.B Class2UseHex
Whether or not to parse the capabilities strings reported by the modem
using hexadecimal values. By default, they are parsed as decimal values.
.TP
.B Class2XmitWaitForXON
Whether or not to wait for an
.SM XON
character from the modem
before sending facsimile data to the modem for transmission.
Note that 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 receiving
.SM CONNECT
and that no
.SM XON
character will be sent to the host.
.SH "PAGER-RELATED CONFIGURATION PARAMETERS"
.PP
The following parameters are specific to the configuration
and operation of the IXO/TAP and UCP support for sending pager messages
and GSM SM. Parameter not used for UCP are marked with
``(fIIXO/TAP onlyfP)''.
.TP
.B PagerSetupCmds
The commands to send to a modem to prepare the modem for a
call to pager service provider.
Typically these commands place direct the modem to communicate
with the service provider at 300 bps using the V.21 protocol.
Per-service provider command strings can be setup in the
info database; see
.IR hylafax-info (${MANNUM4_5}).
.TP
.B PagerMaxMsgLength
The maximum length for a pager text message.
Messages longer than this number are truncated.
Per-service provider message lengths can be setup in the
info database; see
.IR hylafax-info (${MANNUM4_5}).
.TP
.B IXOService
(fIIXO/TAP onlyfP)
The service identification string transmitted as part of the
.SM IXO/TAP
protocol.
.TP
.B IXODeviceID
(fIIXO/TAP onlyfP)
The terminal device identification string transmitted as part of the
.SM IXO/TAP
protocol.
.TP
.B IXOMaxUnknown
The maximum number of unrecognized messages that will be accepted
at various stages of the
.SM IXO/TAP
protocol before the sender will abort and hang up the phone.
.TP
.B IXOIDProbe
(fIIXO/TAP onlyfP)
The time, in seconds, between sending a ``er'' during the
initial ID recognition sequence of the
.SM IXO/TAP
protocol.
.TP
.B IXOIDTimeout
(fIIXO/TAP onlyfP)
The maximum time, in seconds, to wait for the initial ID response from
the service provider.
.TP
.B IXOLoginRetries
(fIIXO/TAP onlyfP)
The maximum number of attempts to login to a service provider.
.TP
.B IXOLoginTimeout
(fIIXO/TAP onlyfP)
The maximum time, in seconds, to wait to complete the login procedure.
.TP
.B IXOGATimeout
(fIIXO/TAP onlyfP)
The maximum time, in seconds, to wait for a Go-Ahead message from the service
provider.
.TP
.B IXOXmitRetries
The maximum number of times to try sending a text message block
in a single call.
.TP
.B IXOXmitTimeout
The maximum time, in seconds, to try transmitting a text message block.
.TP
.B IXOAckTimeout
(fIIXO/TAP onlyfP)
integer s-130s+1 IXO: max time to wait for msg block ack (secs)
The maximum time, in seconds, to wait for an acknowledgement
to a transmitted message.
.SH "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
.B config
subdirectory and, by convention, have names
that identify a brand or type of modem and the
.SM DTE-DCE
flow control scheme the prototype files configures.
The
.IR faxaddmodem (${MANNUM1_8})
program that is used to configure a modem for use with
*(Fx 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
``s-1ATI0s+1''
and the response from the command
``s-1ATI3s+1''
are used to select a prototype configuration file, while for Class 2
modems the manufacturer and model as returned by
``s-1AT+FMFR?s+1'' and ``s-1AT+FMDL?s+1'', respectively, are
used (or ``s-1AT+FMI?s+1'' and ``s-1AT+FMM?s+1'' for
Class 2.0 modems).
.PP
A Class 1 prototype configuration file is identified for use by
.I faxaddmodem
by searching for a comment of the form:
.nf
.sp .5
fC# CONFIG:CLASS1:144:.*:RTSCTS: Manufacturer='AT&T' Model=DataportfR
.sp .5
.fi
In this example ``144'' is the product ID code for an s-1AT&Ts+1 DataPort
modem, ``.*'' is a regular expression matched against the result string
returned by the ``s-1ATI3s+1'' command,
and ``s-1RTSCTSs+1'' indicates the modem is configured to
use hardware flow control during fax operation.
The remainder of the line is evaluated by the
.IR 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).
.PP
Class 2 and 2.0 prototype configuration files match the string
``fImanufacturerfP-fImodelfP-fIflowcontrolfP'' against a
.IR sh (1)
glob pattern specified in the configuration file, where
.I manufacturer
and
.I model
are the strings returned by querying the modem and
.I flowcontrol
is either ``s-1RTSCTSs+1'' for hardware flow control or
``s-1XONXOFFs+1'' for software flow control.
For example:
.sp .5
fC# CONFIG: CLASS2: ZyXEL*-RTSCTSfP
.br
fC# CONFIG: CLASS2.0: USRobotics*-XONXOFFfP
.sp .5
are configuration comments that appear in the prototype file for
a s-1ZyXEL 1496Es+1 with Class 2 support, and for a US Robotics Courier
modem with Class 2.0 firmware.
.PP
The
.I faxaddmodem
program merges server-specific configuration parameters
into a prototype configuration according to comments
placed in the prototype file.
All lines between ``s-1BEGIN-SERVERs+1'' and ``s-1END-SERVERs+1''
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.
.SH "SEE ALSO"
.IR faxaddmodem (${MANNUM1_8}),
.IR faxq (${MANNUM1_8}),
.IR faxgetty (${MANNUM1_8}),
.IR faxsend (${MANNUM1_8}),
.IR hylafax-server (${MANNUM4_5})