HylaFAX Home
Download HylaFAX
About HylaFAX
HylaFAX Howto
HylaFAX Setup
HylaFAX Links
HylaFAX Frequently Asked Questions
HylaFAX Mailing List
HylaFAX Search
HylaFAX Troubleshooting


Section: Misc. Reference Manual Pages (5F)
Updated: May 28, 2001
Index Return to Main Contents


cid - Caller-ID access control list  


The HylaFAX configuration parameter QualifyCID specifies whether or not the identity of an inbound call should be checked against an access control list before the telephone is answered. If a modem is attached to a phone line that has Caller-ID service, and QualifyCID is non-null, then only the callers identified in the file specified by the string (typically etc/cid) will be answered.

Patterns are specified one per line and must conform to the regular expressions syntax specified by POSIX 1003.2; see re_format(7). Comments may be included; they are introduced with the ``#'' character and extend to the end of the line. Any trailing white space on a line is ignored (for convenience when comments are used).

If a line begins with ``!'', then the regular expression identifies callers that should be rejected; otherwise regular expressions identify clients whose calls should be accepted. The order of patterns in a CID file is important. When a call is to be answered, the faxgetty process will compare the phone number presented by the modem against the patterns in the access control list in the order in which they appear in the file. The first pattern that matches the client's number is used to decide whether to accept or reject the call. If no patterns match the phone number then the call is not answered. Thus if you want to accept all but a restricted set of calls, the last line in the file should be ``^.*$''.

Note that regular expression patterns should be written to match a phone number exactly. That is, patterns should be of the form:


where the ``^'' and ``$'' characters are used to specify the start and end of the matching phone number. Additionally, regular expression patterns should handle white space that may appear in known locations. For example,

      ^([+]1){1}[ .-]*415[ .-]*555[ .-]*1212.*$

matches the following phone number strings:

+1.415.555.1212 415 555 1212 1-415-555-1212

Finally, note that regular expressions can be used to specify many numbers with one pattern.  


The caller's telephone number is recognized by using the CIDNumber configuration parameter described in hylafax-config(5F). This parameter must be present in the per-modem configuration file for Caller-ID screening to function properly. If QualifyCID is defined, but no CIDNumber is specified, then no phone numbers will be recognized and all incoming calls will be ignored.

Caller-ID data is only sent once by the telco, and the timing of its arrival varies upon the telco and the type of line. If HylaFAX is configured to answer via RingsBeforeAnswer prior to the arrival of the caller-ID data, then all CIDNumber and CIDName values will be null. For example, on US analog lines, caller-ID data is usually sent between RINGs 1 and 2. In this situation, RingsBeforeAnswer should be set to ``2'' or greater.  


faxgetty(8C), hylafax-config(5F), re_format(7).




This document was created by man2html, using the manual pages.
Time: 09:07:10 GMT, June 23, 2001
VirtuALL Private Host Services
Report any problems to webmaster@hylafax.org

HylaFAX is a trademark of Silicon Graphics Corporation.
Internet connectivity for hylafax.org is provided by:
VirtuALL Private Host Services