SCUD(8)

NAME
scud - Selected Caller and Unavailable Deterrent

SYNOPSIS
scud [-NORc] [-ACTion [Answer|Hangup]] [-CONsole] [-DBLbyte] [-DELay seconds] [-DEVice modem-device] [-HANGUPDuration seconds] [-HEARTbeat seconds] [-INItcid modem-init-string] [-LOG log-file] [-MODEMDuration seconds] [-NAMe regular-expression ...] [-PHOne | -NUMber regular-expression ...] [-PRIVate] [-UNAVailable] [-VERBose level]

DESCRIPTION
The scud program provides a facility to tell your caller id capable modem to automatically answer certain calls. scud can answer "unavailable", "private" and other selected calls.

The following options are available (the minimum abbrevation is given in CAPITAL letters):

-NORc
    Do not read the config file for options

-ACTion [Answer|Hangup]
    Have the modem send the sync signal ( Answer ) or politely Hangup. The default is 'Answer'.

-CONsole
    Print activity to stdout in addition to log file

-DBLbyte
    Some modems will send two bytes (printable ascii) for each caller id data byte. Use this as a last resort when scud doesn't recognize your modem (Conexant HCF V90 for example)

-DELay seconds
    Delay seconds seconds after an action, to allow all calls thru scud. This may be handy if you expect any calls from a name or phone number that you normally intercept. The default is 0 seconds (no delay).

-DEVice modem-device
    Use the given modem-device as the modem. The default is /dev/cuaa1

-HANGUPDuration seconds
    pause seconds seconds between off-hook, on-hook. The default is 1 second.

-HEARTbeat seconds
    re-send modem-init-string every seconds seconds. Some modems tend to forget their job.

-INItcid modem-init-string
    Use the given modem-init-string to enable caller id support for the modem. The default is to try AT#CID=2 first then if that fails, try AT+VCID=2

-LOG log-file
    Log activity to log-file. The default is /var/log/scud.log

-MODEMDuration seconds
    Let the modem sync for seconds seconds before hanging up. The default is 10 seconds.

-NAMe regular-expression ...
    Perform an action if the caller's Name matches regular-expression(s) This comparison is case-insensitive.

-PHOne | -NUMber regular-expression ...
    Perform an action if the caller's Phone number matches regular-expression(s)

-PRIVate
    Peform an action if the caller's phone number is PRIVATE

-UNAVailable
    Peform an action if the caller's phone number is UNAVAILABLE

-VERBose level
    Set the verbosity level to level (1-2). -verb 2 is good for debugging output.

All options can be saved in the file /usr/local/etc/scud.conf which is always read unless the -NORc option is given on the command line. The syntax of the config file is freeform. All options must begin with the - character.

IMPLEMENTATION NOTES
scud will interfere with any other process that needs the modem. You should terminate scud to use the modem for another reason.

scud was developed to be compatible only with the caller id standard in the United States.

FILES
/usr/local/etc/scud.conf
    Configuration file.
/usr/local/etc/rc.d/scud.sh
    Startup script

EXAMPLES
A sample /usr/local/etc/scud.conf that uses /dev/cuaa0 as the modem, that will answer unavailable and private callers and will also answer any call from any caller with abc in their name follows.

-device /dev/cuaa0

-unavailable

-private

-name abc

AUTHORS
R. David Quattlebaum <drq@bsdwins.com>

BUGS
Please send bug reports to drq@bsdwins.com.