ncid_modules(7)

1NCID_MODULES(7)        Miscellaneous Information Manual        NCID_MODULES(7)
2
3
4

NAME

6       ncid_modules - NCID client output modules overview
7

DESCRIPTION

9       NCID output modules are used to extend the functionality of the client.
10       They are mostly simple shell scripts.
11
12       Module names are of the format: ncid-<name>.
13
14       Modules are normally called by the client using the command line:
15                  ncid --no-gui --program ncid-<name>
16
17       The client can only call one module at a time, but multiple clients can
18       each have a different output module.
19
20       Each module may have a configuration file called ncid-<name>.conf>.
21
22       The ncid-<name>.conf> file understands three line types:
23              blank line:     ignored
24              comment line:   begins with a '#' and is ignored
25              shell variable: set to a value, for example: foo=bar
26
27       The current modules distributed with NCID are:
28
29       ncid-alert
30              Module sends NCID call or message desktop notifications.
31              Its configuration file: ncid-alert.conf
32
33       ncid-initmodem
34              Module reinitializes the modem when RING is received as the num‐
35              ber.  Does not have a configuration file.
36
37              IMPORTANT:
38                     Module should only be used if modem stops sending CID  to
39                     ncidd but continues to send RING.
40
41       ncid-kpopup
42              Module popups Caller ID using KDE.  Its configuration file:
43              ncid-kpopup.conf
44
45       ncid-mysql
46              Module  stores  NCID  data  in a MySQL or MariaDB Database.  Its
47              configuration file: ncid-mysql.conf
48
49       ncid-mythtv
50              Module displays Caller ID on MythTV.  Its configuration file:
51              ncid-mythtv.conf
52
53       ncid-notify
54              Module displays Caller ID on a iOS or Android device.  Its  con‐
55              figuration file: ncid-notify.conf
56
57              IMPORTANT:
58                     Register at https://www.prowlapp.com/ for iOS key
59                     Register  at https://www.notifymyandroid.com/ for Android
60                     key
61
62       ncid-page
63              Module sends Caller ID to a cell phone or pager.  Its configura‐
64              tion file: ncid-page.conf
65
66              IMPORTANT:
67                     sendmail.cf must hide user root when masquerading is used
68                     and root is sending the email
69
70       ncid-samba
71              Module sends Caller ID to samba to get a popup.  Its  configura‐
72              tion file: ncid-samba.conf
73
74       ncid-skel
75              Module  just  echos  the input.  Modify it and its configuration
76              file to  write  new  modules.   Its  configuration  file:  ncid-
77              skel.conf
78
79       ncid-speak
80              Module sends Caller ID to a text-to-speech program.  Its config‐
81              uration file: ncid-speak.cconf
82
83       ncid-wakeup
84              Module wakes up a X-Window system that is using  Gnome.   It  is
85              automatically called when the ncid option is set.  Does not have
86              a configuration file.
87
88       ncid-yac
89              Module sends Caller ID to YAC clients.  Its configuration  file:
90              ncid-yac.conf
91

FILES

93       /usr/share/ncid/modules/ncid-<name>
94       /etc/ncid/conf.d/ncid-<name>.conf
95       /etc/ncid/ncid.conf
96

NAME

DESCRIPTION

FILES

SEE ALSO