1NCIDMODULES(1) General Commands Manual NCIDMODULES(1)
2
6 ncid-hangup - hangup calls based on Caller ID using minicom
7 ncid-initmodem - use ncidd to reinitialize modem to Caller ID mode
9 ncid-kpopup - popup Caller ID using KDE
11 ncid-page - send Caller ID to a pager or cell phone using mail
13 ncid-samba - send Caller ID to samba to create a popup
15 ncid-speak - send Caller ID to a text-to-speach program
17 ncid-mythtv - display Caller ID on MythTV using mythtvosd
19 ncid-skel - display Caller ID on stdout in a terminal window
21 ncid-tivo - display Caller ID on TiVo using text2osd
23 ncid-yac - Send Caller ID to YAC listeners
25
27 ncid --no-gui --call-prog --program ncid-hangup
28 ncid --no-gui --call-prog --program ncid-initmodem
30 ncid --no-gui --call-prog --program ncid-kpopup
32 ncid --no-gui [--message] [--ring #] --call-prog --program ncid-page
34 ncid --no-gui [--message] --call-prog --program ncid-samba
36 ncid --no-gui --call-prog --program ncid-speak
38 ncid --no-gui [--message] --call-prog --program ncid-mythtv
40 ncid --no-gui [--message] --call-prog --program ncid-skel
42 ncid --no-gui [--message] --call-prog --program ncid-tivo
44 ncid --no-gui [--message] --call-prog --program ncid-yac
46
48 These are ncid output modules and are normally located in the
49 /usr/share/ncid directory.
50 The client, ncid, can be configured to call any one module. It cannot
52 call multiple modules, but multiple clients can be used, each calling a
53 different output module.
54 The ncid-hangup module uses a modem to hang up on a phone call. It
56 works with either a modem or gateway providing the Caller ID informa‐
57 tion. The module uses minicom and runscript to talk to the modem.
58 The ncid-initmodem module reinitializes the modem obtaining the Caller
60 ID for the server. It can only be used if the modem supports Caller ID
61 and sends "RING" at each ringing signal. If the server indicates a
62 non-CID call, ncid-initmodem will cause ncidd to re-initialize the
63 modem for CID. Never use this module with a modem that does not sup‐
64 port Caller ID. The module can be used with TiVo modems that drop out
65 of Caller ID mode.
66 The ncid-page module is used to send a call message to a cell phone,
68 pager, or email address. It normally sends the message as soon as the
69 Caller ID is received. It can be configured to wait until a specific
70 number of rings before sending the message when using a modem that
71 indicates RING, or it can send the message if the call was unanswered
72 or at the completion of the call when using a SIP gateway. The module
73 requires PageTo in ncidmodules.conf to be set to the SMS gateway for
74 your cell phone carrier.
75 The ncid-skel output module is used as a template for writing a shell
77 script output module. All it does is send the Caller ID data to stan‐
78 dard output. This makes it useful for troubleshooting.
79 Each output module can be independently configured using the module
81 configuration file: ncidmodules.conf
82
84 Before using a module, review ncidmodules.conf to see if the module has
85 a variable that must be configured. The ncid-page modules requires the
86 PageTo variable to be set.
87 ncid command line options to call ncid-page at ring number 4
89 ncid --no-gui --call-prog --program ncid-page --ring 4
90 Messages are normally excluded, to include messages:
92 ncid --no-gui --message --call-prog --program ncid-page --ring 4
93
95 /etc/ncid/ncidmodules.conf
96 http://en.wikipedia.org/wiki/List_of_carriers_providing_SMS_transit
97
99 ncid.1, ncidmodules.conf.5, ncidd.8,
100 minicom.1, runscript.1
101 NCIDMODULES(1)