ncid-speak

NCID-SPEAK(1)               General Commands Manual              NCID-SPEAK(1)



NAME
       ncid-speak - send Caller ID to a text-to-speech program

SYNOPSIS
       ncid --no-gui --program ncid-speak

DESCRIPTION
       The ncid-speak output module speaks the Caller ID using festival.

CONFIGURATION
       The ncid-speak output module is configured in ncid-speak.conf.

       allowed_types
                 This sets the NCID call and/or message types ncid-speak will
                 send.  See ncid-speak.conf for a complete list.

                 Default: allowed_types="CID PID MSG NOT"

       SpeakThis What to say, '$NAME' or '$NMBR' or '$NMBR $NAME' or '$NAME
                 $NMBR'.  Must be inside single quotes.

                 Default: SpeakThis='$NAME'

       SpeakInput
                 Test-to-speech program.  Default uses festival.
                 If using the Macintosh:
                 SpeakInput="say $SpeakThis"
                 If you want a specific voice for the Macintosh:
                 SpeakInput="say -v Vicki $SpeakThis"

                 Default: SpeakInput="echo $SpeakThis | festival --tts"

       SpeakTimes
                 The number of times to speak the same input.

                 Default: SpeakTimes=1

       SpeakDelay
                 If SpeakTimes is greater than 1, SpeakDelay is the delay in
                 seconds between repeating the input.

                 Default: SpeakDelay=2

       AreaCodeLength
                 If non-zero, a name value of "NO NAME" will be replaced with
                 the string "Area Code " followed by the requested number of
                 area code digits separated by spaces.

                 If set to the number of digits in phone number, a name value
                 of "NO NAME" will be replaced with the digits of the phone
                 number separated by spaces.

                 A leading "1" for the CID number is always ignored.

                 Default: AreaCodeLength=3

REQUIREMENTS
       festival text-to-speech software

FILES
       /etc/ncid/conf.d/ncid-speak.conf
       /usr/share/ncid/modules/ncid-speak

SEE ALSO
       ncidd.8, ncid_modules.7, ncid.1, ncid.conf.5



                                                                 NCID-SPEAK(1)