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
27                 If set to 1, data will also be formatted vertically, one line
28                 per input received.
29
30                 Default: skel_raw=0
31

REQUIREMENTS

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

FILES

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

CUSTOM MODULE

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