ncid-skel(1)

1NCID-SKEL(1)                         NCID                         NCID-SKEL(1)
2
3
4

NAME

6       ncid-skel - shell script output module template
7

SYNOPSIS

9       ncid --no-gui --module ncid-skel
10

DESCRIPTION

12       The  ncid-skel  output module is used as a template for writing a shell
13       script output module.  All it does is send the Caller ID data to  stan‐
14       dard output.  This makes it useful for troubleshooting.
15

CONFIGURATION

17       The ncid-skel output module is configured in ncid-skel.conf.
18
19       allowed_types
20                 This  sets  the NCID call and/or message types ncid-skel will
21                 send.  See ncid-skel.conf for a complete list.
22
23                 Default: allowed_types="ALLTYPES"
24
25       skel_raw  If set to 0, data will be shown as a single horizontal  line.
26                 If set to 1, data will also be formatted vertically, one line
27                 per input received.
28
29                 Default: skel_raw=0
30

REQUIREMENTS

32       run ncid-skel with ncid in a terminal window to view output:
33       ncid --no-gui --module ncid-skel
34

FILES

36       /etc/ncid/conf.d/ncid-skel.conf
37       /usr/share/ncid/modules/ncid-skel
38

CUSTOM MODULE

40       Modify ncid-skel as required and rename it to create a  custom  module.
41       There are three ways to test the custom module.
42
43       If you have source you can use ncid/test/test-client.  This is the pre‐
44       ferred method.
45
46       If you do not have source, the custom module can be tested by executing
47       the shell script directly and inputting data.
48
49       The command line for a new custom module called ncid-custom:
50              /usr/share/ncid/modules/ncid-custom
51
52       The module expects 7 lines of input:
53              DATE
54              TIME
55              NMBR
56              NAME
57              LINE
58              TYPE
59              MESG
60              MTYPE
61              FNMBR
62              NTYPE
63              CTRY
64              LOCA
65              CARI
66
67       TYPE must be a valid, but all others can have any input or no input.
68
69       Valid TYPES:
70              BLK - blocked incoming call
71              CID - incoming call
72              HUP - blacklisted hangup
73              MWI - message waiting
74              OUT - outgoing call
75              PID - Caller ID from a smart phone
76              PUT - smart phone outgoing call
77              RID - ring back when called number available
78              WID - incoming call waiting
79
80       The last method is execute "ncid --no-gui -m ncid-custom" and make a call.
81