diff --git a/README b/README index fe0551c..9e61d46 100644 --- a/README +++ b/README @@ -303,6 +303,30 @@ CONFIGURATION you can have multiple line of the same exclusion type. + Include inclusion_file + Used to set client ip addresses, network addresses or auth login to + include into the report. All others will not be included. It works + as the opposite of the Include parameter. + + You can define one by line inclusion by specifying first the type of + the inclusion (USER or CLIENT) and a space separated list of valid + regex. + + You can also use the NETWORK type to define network address with + netmask using the CIDR notation: xxx.xxx.xxx.xxx/n + + See example bellow: + + NETWORK 192.168.1.0/24 10.10.0.0/16 + CLIENT 192\.168\.1\.2 + CLIENT 10\.169\.1\.\d+ 192\.168\.10\..* + USER myloginstr + USER guestlogin\d+ guestdemo + URI http:\/\/myinternetdomain.dom.* + URI .*\.webmail\.com\/.*\/login\.php.* + + you can have multiple line of the same inclusion type. + Lang language_file Used to set the translation file to be used. Value must be set to a file containing all string translated. See the lang directory for diff --git a/doc/SquidAnalyzer.pod b/doc/SquidAnalyzer.pod index d960c8e..09b1b5b 100644 --- a/doc/SquidAnalyzer.pod +++ b/doc/SquidAnalyzer.pod @@ -324,6 +324,30 @@ See example bellow: you can have multiple line of the same exclusion type. +=item Include inclusion_file + +Used to set client ip addresses, network addresses or auth login +to include into the report. All others will not be included. It +works as the opposite of the Include parameter. + +You can define one by line inclusion by specifying first the type of the +inclusion (USER or CLIENT) and a space separated list of valid regex. + +You can also use the NETWORK type to define network address with netmask +using the CIDR notation: xxx.xxx.xxx.xxx/n + +See example bellow: + + NETWORK 192.168.1.0/24 10.10.0.0/16 + CLIENT 192\.168\.1\.2 + CLIENT 10\.169\.1\.\d+ 192\.168\.10\..* + USER myloginstr + USER guestlogin\d+ guestdemo + URI http:\/\/myinternetdomain.dom.* + URI .*\.webmail\.com\/.*\/login\.php.* + +you can have multiple line of the same inclusion type. + =item Lang language_file Used to set the translation file to be used. Value must be set to diff --git a/doc/squidanalyzer.3 b/doc/squidanalyzer.3 index b816447..7e60c38 100644 --- a/doc/squidanalyzer.3 +++ b/doc/squidanalyzer.3 @@ -124,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "SQUIDANALYZER 1" -.TH SQUIDANALYZER 1 "2013-12-23" "perl v5.14.2" "User Contributed Perl Documentation" +.TH SQUIDANALYZER 1 "2014-01-31" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -455,6 +455,31 @@ See example bellow: .Ve .Sp you can have multiple line of the same exclusion type. +.IP "Include inclusion_file" 4 +.IX Item "Include inclusion_file" +Used to set client ip addresses, network addresses or auth login +to include into the report. All others will not be included. It +works as the opposite of the Include parameter. +.Sp +You can define one by line inclusion by specifying first the type of the +inclusion (\s-1USER\s0 or \s-1CLIENT\s0) and a space separated list of valid regex. +.Sp +You can also use the \s-1NETWORK\s0 type to define network address with netmask +using the \s-1CIDR\s0 notation: xxx.xxx.xxx.xxx/n +.Sp +See example bellow: +.Sp +.Vb 7 +\& NETWORK 192.168.1.0/24 10.10.0.0/16 +\& CLIENT 192\e.168\e.1\e.2 +\& CLIENT 10\e.169\e.1\e.\ed+ 192\e.168\e.10\e..* +\& USER myloginstr +\& USER guestlogin\ed+ guestdemo +\& URI http:\e/\e/myinternetdomain.dom.* +\& URI .*\e.webmail\e.com\e/.*\e/login\e.php.* +.Ve +.Sp +you can have multiple line of the same inclusion type. .IP "Lang language_file" 4 .IX Item "Lang language_file" Used to set the translation file to be used. Value must be set to