Rename www-cgi to ucgi (in nearly all places)
[userv-utils] / ucgi / README.custom-env-filter
CommitLineData
d083b489 1Allow customization of the environment filters.
ee8748e6 2
d083b489
IJ
3Sites can configure ucgi's environment filters, and end users can
4configure ucgitarget's filters.
ee8748e6 5
d083b489
IJ
6By default, ucgi will look in /etc/userv/ucgi.env-filter, but if
7UCGI_ENV_FILTER is set in its environment, it will look there
ee8748e6
IJ
8instead. The filter may contain wildcards and so on.
9
d083b489
IJ
10By default, ucgitarget looks in .userv/ucgitarget.env-filter, or
11/etc/userv/ucgitarget.env-filter, if the former doesn't exist; but if
ee8748e6
IJ
12passed a `-e FILTER' option on its command line, it will look in the
13file FILTER instead. This filter may /not/ contain wildcards.
14
15In both cases, if an explicitly named filter file can't be found then
16the program fails; if the default filter files can't be found then they
17fall back to built-in lists.
18
19The reason for the asymmetry in interfaces is: it's hard to pass
20command-line options to CGI scripts from webservers, but pretty easy to
21set environment variables; whereas it's hard to pass environment
22variables to a service program in a Userv configuration file, but easy
23to pass command-line arguments.
2c62631d
IJ
24
25
d083b489
IJ
26The `?DEFAULTS' pattern can be specified to match the default set
27(which is different in `ucgi' and `ucgitarget').