Update documentation.

This commit is contained in:
Darold Gilles 2012-12-10 22:00:41 +01:00
parent 661ab48324
commit 510e831ef6
4 changed files with 44 additions and 40 deletions

23
README
View File

@ -136,6 +136,10 @@ CONFIGURATION
Where SquidAnalyzer should dump all HTML, data and images files. You Where SquidAnalyzer should dump all HTML, data and images files. You
should give a path that can be read by a Web browser. should give a path that can be read by a Web browser.
WebUrl
The URL of the SquidAnalyzer javascript, HTML and images files.
Default: /squidreport
LogFile squid_access_log_file LogFile squid_access_log_file
Set the path to the Squid log file. Set the path to the Squid log file.
@ -231,23 +235,20 @@ CONFIGURATION
file containing all string translated. See the lang directory for file containing all string translated. See the lang directory for
translation files. Default is defined internally in English. translation files. Default is defined internally in English.
HeaderFile custom_header_file DateFormat
Custom header. Must be a path to a text file containing HTML code Date format used to display date (year = %y, month = %m and day =
that will be placed just after the body tag and just before the %d) You can also use %M to replace month by its 3 letters
program name and version. Default is defined internally if this abbreviation. Default: %y-%m-%d
directive is not set to a valid file.
FooterFile custom_footer_file
Custom Footer. Must be a path to a text file containing HTML code
that will be placed at the bottom of each page just before the end
if the body tag. Default is defined internally if this directive is
not set to a valid file.
SiblingHit SiblingHit
Adds peer cache hit (CD_SIBLING_HIT) to be taken has local cache Adds peer cache hit (CD_SIBLING_HIT) to be taken has local cache
hit. Enabled by default, you must disabled it if you don't want to hit. Enabled by default, you must disabled it if you don't want to
report peer cache hit onto your stats. report peer cache hit onto your stats.
TransfertUnit
Allow to change the default unit used to display transfert size.
Default is BYTES, other possible values are KB, MB and GB.
AUTHOR AUTHOR
Gilles DAROLD <gilles@darold.net> Gilles DAROLD <gilles@darold.net>

View File

@ -143,6 +143,11 @@ Here follow the configuration directives used by Squid Analyzer.
Where SquidAnalyzer should dump all HTML, data and images files. Where SquidAnalyzer should dump all HTML, data and images files.
You should give a path that can be read by a Web browser. You should give a path that can be read by a Web browser.
=item WebUrl
The URL of the SquidAnalyzer javascript, HTML and images files.
Default: /squidreport
=item LogFile squid_access_log_file =item LogFile squid_access_log_file
Set the path to the Squid log file. Set the path to the Squid log file.
@ -250,19 +255,11 @@ Used to set the translation file to be used. Value must be set to
a file containing all string translated. See the lang directory a file containing all string translated. See the lang directory
for translation files. Default is defined internally in English. for translation files. Default is defined internally in English.
=item HeaderFile custom_header_file =item DateFormat
Custom header. Must be a path to a text file containing HTML code that Date format used to display date (year = %y, month = %m and day = %d)
will be placed just after the body tag and just before the program name You can also use %M to replace month by its 3 letters abbreviation.
and version. Default is defined internally if this directive is not set Default: %y-%m-%d
to a valid file.
=item FooterFile custom_footer_file
Custom Footer. Must be a path to a text file containing HTML code that
will be placed at the bottom of each page just before the end if the
body tag. Default is defined internally if this directive is not set
to a valid file.
=item SiblingHit =item SiblingHit
@ -270,6 +267,11 @@ Adds peer cache hit (CD_SIBLING_HIT) to be taken has local cache hit.
Enabled by default, you must disabled it if you don't want to report Enabled by default, you must disabled it if you don't want to report
peer cache hit onto your stats. peer cache hit onto your stats.
=item TransfertUnit
Allow to change the default unit used to display transfert size. Default
is BYTES, other possible values are KB, MB and GB.
=back =back

View File

@ -133,7 +133,7 @@
.\" ======================================================================== .\" ========================================================================
.\" .\"
.IX Title "SQUIDANALYZER 1" .IX Title "SQUIDANALYZER 1"
.TH SQUIDANALYZER 1 "2012-12-03" "perl v5.10.1" "User Contributed Perl Documentation" .TH SQUIDANALYZER 1 "2012-12-10" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents. .\" way too many mistakes in technical documents.
.if n .ad l .if n .ad l
@ -284,6 +284,10 @@ Here follow the configuration directives used by Squid Analyzer.
.IX Item "Output output_directory" .IX Item "Output output_directory"
Where SquidAnalyzer should dump all \s-1HTML\s0, data and images files. Where SquidAnalyzer should dump all \s-1HTML\s0, data and images files.
You should give a path that can be read by a Web browser. You should give a path that can be read by a Web browser.
.IP "WebUrl" 4
.IX Item "WebUrl"
The \s-1URL\s0 of the SquidAnalyzer javascript, \s-1HTML\s0 and images files.
Default: /squidreport
.IP "LogFile squid_access_log_file" 4 .IP "LogFile squid_access_log_file" 4
.IX Item "LogFile squid_access_log_file" .IX Item "LogFile squid_access_log_file"
Set the path to the Squid log file. Set the path to the Squid log file.
@ -388,23 +392,20 @@ you can have multiple line of the same exclusion type.
Used to set the translation file to be used. Value must be set to Used to set the translation file to be used. Value must be set to
a file containing all string translated. See the lang directory a file containing all string translated. See the lang directory
for translation files. Default is defined internally in English. for translation files. Default is defined internally in English.
.IP "HeaderFile custom_header_file" 4 .IP "DateFormat" 4
.IX Item "HeaderFile custom_header_file" .IX Item "DateFormat"
Custom header. Must be a path to a text file containing \s-1HTML\s0 code that Date format used to display date (year = \f(CW%y\fR, month = \f(CW%m\fR and day = \f(CW%d\fR)
will be placed just after the body tag and just before the program name You can also use \f(CW%M\fR to replace month by its 3 letters abbreviation.
and version. Default is defined internally if this directive is not set Default: \f(CW%y\fR\-%m\-%d
to a valid file.
.IP "FooterFile custom_footer_file" 4
.IX Item "FooterFile custom_footer_file"
Custom Footer. Must be a path to a text file containing \s-1HTML\s0 code that
will be placed at the bottom of each page just before the end if the
body tag. Default is defined internally if this directive is not set
to a valid file.
.IP "SiblingHit" 4 .IP "SiblingHit" 4
.IX Item "SiblingHit" .IX Item "SiblingHit"
Adds peer cache hit (\s-1CD_SIBLING_HIT\s0) to be taken has local cache hit. Adds peer cache hit (\s-1CD_SIBLING_HIT\s0) to be taken has local cache hit.
Enabled by default, you must disabled it if you don't want to report Enabled by default, you must disabled it if you don't want to report
peer cache hit onto your stats. peer cache hit onto your stats.
.IP "TransfertUnit" 4
.IX Item "TransfertUnit"
Allow to change the default unit used to display transfert size. Default
is \s-1BYTES\s0, other possible values are \s-1KB\s0, \s-1MB\s0 and \s-1GB\s0.
.SH "AUTHOR" .SH "AUTHOR"
.IX Header "AUTHOR" .IX Header "AUTHOR"
Gilles \s-1DAROLD\s0 <gilles@darold.net> Gilles \s-1DAROLD\s0 <gilles@darold.net>

View File

@ -62,7 +62,7 @@ Exclude /etc/squidanalyzer/excluded
# Default to en_US.txt # Default to en_US.txt
#Lang /etc/squidanalyzer/lang/fr_FR.txt #Lang /etc/squidanalyzer/lang/fr_FR.txt
# Date format use to display date (year = %y, month = %m and day = %d) # Date format used to display date (year = %y, month = %m and day = %d)
# You can also use %M to replace month by its 3 letters abbreviation. # You can also use %M to replace month by its 3 letters abbreviation.
DateFormat %y-%m-%d DateFormat %y-%m-%d
@ -76,6 +76,6 @@ AnonymizeLogin 0
# peer cache hit onto your stats. # peer cache hit onto your stats.
SiblingHit 1 SiblingHit 1
# Set the image format that should be used in graphics download. Values # Set the default unit for transfert size. Default is BYTES, other possible
# can be png or jpg. Default is png. # values are KB, MB and GB
ImgFormat png TransfertUnit BYTES