Specifications

HYLAFAX-CONFIG(5F) HYLAFAX-CONFIG(5F)
NAME
config − HylaFA X configuration database
DESCRIPTION
HylaFA X 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 howthe HylaFAX server processes
that service these modem should operate. Configuration files are located in the etc subdirectory.The con-
figuration file for the faxq(8C) program is named config.The per-modem configuration files used by the
faxgetty(8C), faxsend(8C), and pagesend(8C) programs have names of the form config.devid, where devid
is an identifier derivedfrom the name of the modem’sdevice file; for example ttym2 for /dev/ttym2,
term_10 for /dev/term/10.
Configuration files have a simple format and are entirely ASCII. Aconfiguration parameter is of the form
tag: value
where a tag identifies a parameter and a value is either a string, number,orboolean 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,ifwhitespace 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. ‘‘\n’’for a newline character and ‘‘\xxx’’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 fewparameters, such as RecvFileMode,whose
value is interpreted strictly as an octal number and 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. Forafalse value, use ‘‘No’’or‘‘Off’’.
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 HylaFAX scheduler process and should appear only in the
file named config.Parameters marked with a ² are used by both the scheduler and the per-device applica-
tions and so should appear in all appropriate configuration files (i.e. config and anyper-device files that
makesense). Parameters not otherwise marked should appear only in per-device configuration files. More
detailed information about each item is givenfollowing the table.
TagType Default Description
AdaptiveAnswer boolean No enable adaptive answer of inbound calls
AdminGroup string faxadmin System user group for administration (if PAM enabled)
AnswerRotary string Any alternativesfor 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 RTN-SAVE bad page receivedhandling method
BatchLogs¹ boolean Yes keep all session logs of a batch in a single log
CallIDAnswerLength integer − answer call when CallIDPattern received
CallIDPattern strint −call identification pattern string
CIDName string −equivalent to CallIDPattern (2)
CIDNameAnswerLength integer 0 equivalent to CallIDAnswerLength (2)
CIDNumber string −equivalent to CallIDPattern (1)
CIDNumberAnswerLength integer 0 equivalent to CallIDAnswerLength (1)
ClocalAsRoot boolean No set CLOCAL using root UID
ContCoverCmd¹ string bin/mkcover continuation coverpage generation script
ContCoverPage¹ string −continuation coverpage template filename
CountryCode² string −local country code
CountSkippedPages boolean Yes Count skipped pages in the page counts/totals when sending
DestControls¹ obsolete −Obsoleted by JobControl
DeviceMode octal 0600 protection mode to use for modem device
DialStringRules² string −dial string rules file
$Date$ 1