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 --module 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
24              blank line:     ignored
25
26              comment line:   begins with a '#' and is ignored
27
28              shell variable: set to a value, for example: foo=bar
29
30       The current modules distributed with NCID are:
31
32       ncid-alert     Module sends NCID call or message desktop notifications.
33                      Its configuration file: ncid-alert.conf
34
35       ncid-initmodem Module  reinitializes the modem when RING is received as
36                      the number.  Does not have a configuration file.
37
38                      IMPORTANT: Module should only be  used  if  modem  stops
39                      sending CID to ncidd but continues to send RING.
40
41       ncid-kpopup    Module  popups  Caller  ID using KDE.  Its configuration
42                      file:
43
44                      ncid-kpopup.conf
45
46       ncid-mysql     Module stores NCID data in a MySQL or MariaDB  Database.
47                      Its configuration file: ncid-mysql.conf
48
49       ncid-mythtv    Module  displays Caller ID on MythTV.  Its configuration
50                      file:
51
52                      ncid-mythtv.conf
53
54       ncid-notify    Module displays Caller ID on a iOS device.  Its configu‐
55                      ration file: ncid-notify.conf
56
57                      IMPORTANT:  Register at https://www.prowlapp.com for iOS
58                      key
59
60       ncid-page      Module sends Caller ID to a cell phone  or  pager.   Its
61                      configuration file: ncid-page.conf
62
63                      IMPORTANT:  sendmail.cf  must  hide  user root when mas‐
64                      querading is used and root is sending the email
65
66       ncid-samba     Module sends Caller ID to samba to  get  a  popup.   Its
67                      configuration file: ncid-samba.conf
68
69       ncid-skel      Module just echos the input.  Modify it and its configu‐
70                      ration file to write  new  modules.   Its  configuration
71                      file: ncid-skel.conf
72
73       ncid-speak     Module sends Caller ID to a text-to-speech program.  Its
74                      configuration file: ncid-speak.cconf
75
76       ncid-wakeup    Module wakes up a X-Window system that is  using  Gnome.
77                      It  is automatically called when the ncid option is set.
78                      Does not have a configuration file.
79
80       ncid-yac       Module sends Caller ID to YAC clients.   Its  configura‐
81                      tion file: ncid-yac.conf
82

FILES

84       /usr/share/ncid/modules/ncid-<name>
85       /etc/ncid/conf.d/ncid-<name>.conf
86       /etc/ncid/ncid.conf
87

NAME

DESCRIPTION

FILES

SEE ALSO