1NCIDD.WHITELIST(5)                   NCID                   NCIDD.WHITELIST(5)
2
3
4

NAME

6       ncidd.whitelist - whitelist file for ncidd hangup
7

DESCRIPTION

9       The  ncidd.whitelist  file  contains the expressions to match against a
10       telephone call name or number.
11
12       If the hangup option is set and if there is no match in  the  whitelist
13       file,  a  match in the blacklist file will cause ncidd to automatically
14       terminate the call.
15
16       The ncidd.whitelist file understands 4 types of lines:
17
18              blank line:   skip it
19
20              comment line: skip it
21
22              entry line:   process it
23
24       Entry lines contain one or more expressions and  an  optional  comment.
25       An  expression is either a string of non-blank characters or everything
26       between double quotes.  Multiple expressions are separated  by  spaces.
27       A comment must be last.
28
29       Entry line comments are either normal comments or match name comments.
30
31       A normal comment begins with a '#' and must not be immediately followed
32       by an equals sign. Anything after the '#' is ignored.
33
34       A match name comment begins with '#=' and is followed by a name to dis‐
35       play for the caller when the entry matches either the number or name of
36       a call.  Do not use double quotes around the name.
37
38       Example:  ncidd.blacklist: ^999         #= Unwanted Area code
39                 ncidd.whitelist: 9995550000   #= WHT (999) 555-0000
40

NOTES

42       Each expression is compared to the caller name and number.
43
44       Upper and lower case letters are significant.
45
46       The number must be a string of digits as they appear  in  /var/log/cid‐
47       call.log.
48
49       A leading '1' is required if it is in /var/log/cidcall.log.
50
51       A partial name or number can match.
52
53       If POSIX regular expressions cwareis used (regex = 1):
54
55              POSIX Extended Regular Expression Syntax
56              https://en.wikipedia.org/wiki/Regular_expression
57
58              Introduction to Regular Expressions
59              http://www.regular-expressions.info/quickstart.html
60
61       If Perl Compatible Regular Expressions (PCRE) are used (regex = 2):
62
63              Perl regular expressions man page
64              https://perldoc.perl.org/perlre
65
66              pcre2syntax man page
67              https://www.pcre.org/current/doc/html/pcre2syntax.html
68
69       Simple and Regular Expressions:
70
71              A  '^'  at the beginning of an expression means it must match at
72              the start of a name or number.
73
74              A "^1?" at the beginning makes a leading 1  optional.   This  is
75              only useful for US/Canadian numbers.
76
77              If an expression is longer than the name or number field it will
78              never match.
79

EXAMPLES

81       Blacklist the unassigned 999 area code with and without  a  leading  1,
82       but allow a call from 999-555-1212:
83            ncidd.blacklist: ^1?999
84            ncidd.whitelist: 9995551212
85
86       Whitelist expression for an optional leading 1 (US/Canada only):
87            ^1?9995551212
88

SEE ALSO

90       ncidd.8, ncidd.conf.5, ncidd.alias.5, ncidd.blacklist.5
91
92
93
94NCID                               2022-11-8                NCIDD.WHITELIST(5)
Impressum