c-icap(8)

1c-icap(8)                   System Manager's Manual                  c-icap(8)
2
3
4

NAME

6       c-icap - ICAP filtering server
7

SYNOPSIS

9       c-icap  [ -V ] [ -VV ] [ -f  config-file ] [ -N ] [ -d  debug-level ] [
10       -D ]
11

DESCRIPTION

13       c-icap is an implementation of an ICAP server. It can be used with HTTP
14       proxies  that  support  the  ICAP  protocol. Most of the comercial HTTP
15       proxies must support ICAP pcotocol.
16

OPTIONS

18       -V     Print version
19
20       -VV    Print build informations
21
22       -f config-file
23              Specify the configuration file
24
25       -N     Do not run as daemon
26
27       -d level
28              Specify the debug level
29
30       -D     Print debug info to stdout
31

FILES

33       /etc/c-icap/c-icap.conf
34              The main configuration file
35       /etc/c-icap/c-icap.magic
36               In this file defined the types of files and the groups of  file
37              types.
38       /var/run/c-icap.pid
39              By  default c-icap writes its pid in this file. The path of this
40              file can changed using the PidFile  configuration  parameter  in
41              the c-icap.conf file
42       /var/run/c-icap.ctl
43              The commands socket. This file used to send commands to the icap
44              server from command line. For information about implemented com‐
45              mands look below in the "Implemented commands" sub-section
46

NOTES

48   Implemented commands
49       Currently the following commands are implemented:
50
51       stop
52              The c-icap will shutdown
53
54       reconfigure
55              The service will reread the config file without the need to stop
56              and restart the c-icap server. The services will  be  reinitial‐
57              ized
58
59       relog
60              This  command  causes  c-icap to close and reopen the log files.
61              This is very useful for log rotation.
62
63       Services and modules can define their own commands.
64
65       Examples:
66
67       To reconfigure c-icap:
68                    echo -n "reconfigure" > /var/run/c-icap.ctl
69
70       To rotate access log:
71                    mv /var/log/c-icap/access.log /var/log/c-icap/access.log.1
72                    echo -n "relog" > /var/run/c-icap.ctl
73
74   Lookup tables
75       Lookup tables are simple read-only databases.  A lookup table  can  de‐
76       fined in c-icap.conf file using the form:
77            type:path
78       where the type is the type of lookup table and path is the extra infor‐
79       mation required to use the table (e.g. file path). Currently  the  fol‐
80       lowing lookup table types defined internally by c-icap:
81
82       file   Simple  text  file databases. The database records are stored in
83              text files in the form:
84               key[: value1, value2 ...]
85
86              example path definition:
87                     file:/path/to/the/file.txt
88
89       hash   Similar to file lookup tables but c-icap uses  fast  hashes  for
90              searching.
91
92              example path definition:
93                     hash:/path/to/the/file.txt
94
95       regex  Similar  to  the file lookup tables but the keys are regular ex‐
96              pressions in the form /regex/flags . For possible  flags  values
97              please read 'Regex expressions' paragraph in this manual.
98
99              example regex lookup table data:
100                          /^[a-m].*/i: group1
101                          /^[n-z].*/i: group2
102
103       example path definition:
104              regex:/path/to/the/file.txt
105
106   Regex expressions
107       The  c-icap  regex  expressions  have  the form /regex_definition/flags
108       where "flags" is one or more letters, its of them express a flag.
109
110       Common flags
111              g This flag forces the score multiplied by the number of regex
112                expression matches. For example if the expression matches 5
113                times and the devined score value is 10 then the final score
114                will be 50.
115              i Do caseless matching
116              m Match-any-character operators don't match a newline
117                and ^$ operators does not match newlines within data
118
119       If the module compiled using the pcre library the following  flags  can
120       be used
121              s (PCRE_DOTALL)  matches anything including NL
122              x (PCRE_EXTENDED) Ignore whitespace and # comments
123              A (PCRE_ANCHORED) Force pattern anchoring
124              D (PCRE_DOLLAR_ENDONLY) $ not to match newline at end
125              U (PCRE_UNGREEDY) Invert greediness of quantifiers
126              X (PCRE_EXTRA) PCRE extra features
127              u (PCRE_UTF8) Run in UTF-8 mode
128
129
130   Runtime information
131       Someone  can  retrieve  runtime information using the info service. The
132       information includes bytes received and  transmited,  active  services,
133       information  about  service  usage and many other. The information pro‐
134       vided in HTML and text format.
135
136       Example:
137
138       Retrieve runtime information from command line:
139              c-icap-client -i localhost -s "info?view=text" -req "a_url"
140

BUGS

146       Many...
147

AUTHOR

149       Tsantilas Christos
150
151
152
153                                 c_icap 0.6.0                        c-icap(8)