From: eldy <>
Date: Sat, 8 Nov 2003 20:57:34 +0000 (+0000)
Subject: Updated documentation.
X-Git-Tag: AWSTATS_6_0_BETA~150
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c85389188e13ffa3e62ce12edde3ea840bf72319;p=thirdparty%2FAWStats.git
Updated documentation.
---
diff --git a/docs/awstats.pdf b/docs/awstats.pdf
index 7c525eca..7bab3b2d 100644
Binary files a/docs/awstats.pdf and b/docs/awstats.pdf differ
diff --git a/docs/awstats_changelog.txt b/docs/awstats_changelog.txt
index c2d17f2b..931dc4fe 100644
--- a/docs/awstats_changelog.txt
+++ b/docs/awstats_changelog.txt
@@ -2,7 +2,7 @@ AWStats Changelog
-----------------
$Revision$ - $Author$ - $Date$
-5.91
+6.0
Fixes:
- Fixed bug 816267: onedigit dayofmonth breaks syslog regex
diff --git a/docs/awstats_config.html b/docs/awstats_config.html
index 6556ac8e..0e1355b2 100644
--- a/docs/awstats_config.html
+++ b/docs/awstats_config.html
@@ -407,10 +407,11 @@ when reading it), follow the example:
DirCgi
Version : 1.0+
-
# Relative or absolute web URL of your awstats.pl directory.
+
# Relative or absolute web URL of your awstats cgi-bin directory.
# This parameter is used only when AWStats is ran from command line
# with -output option (to generate links in HTML reported page).
-
# Default: "/cgi-bin" (means awstats.pl is in "/mywwwroot/cgi-bin")
+
# Example: "/awstats"
+
# Default: "/cgi-bin" (means awstats.pl is in "/yourwwwroot/cgi-bin")
#
DirCgi="/cgi-bin"
@@ -418,11 +419,10 @@ when reading it), follow the example:
DirIcons
Version : 1.0+
-
# If AWStats used as a CGI, enter relative or absolute web URL of all icons
-
# subdirectories.
+
# Relative or absolute web URL of your awstats icon directory.
# If you build static reports ("... -output > outputpath/output.html"), enter
-
# path of icon directory relative to the directory outputpath.
-
# Example: "/icon"
+
# path of icon directory relative to the output directory 'outputpath'.
+
# Example: "/awstatsicons"
# Example: "../icon"
# Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon")
#
@@ -518,9 +518,9 @@ when reading it), follow the example:
# same time to prevent unknown conflicts problems and avoid DoS attacks when
# AllowToUpdateStatsFromBrowser is set to 1.
# Because, when you use lock file, you can experience sometimes problems in
-
# lock file not correctly removed (when process is killed for example, this
-
# requires that you remove the file manualy), this option is not enabled by
-
# default (Do not enable this option with no consol server access).
+
# lock file not correctly removed (killed process for example requires that
+
# you remove the file manualy), this option is not enabled by default (Do
+
# not enable this option with no console server access).
# Possible values: 0 or 1
# Default: 0
#
@@ -1540,6 +1540,7 @@ parameter.
# You can ask AWStats to use a particular CSS (Cascading Style Sheet) to
# change its look. To create a style sheet, you can use samples provided with
# AWStats in wwwroot/css directory.
+
# Example: "/awstatscss/awstats_bw.css"
# Example: "/css/awstats_bw.css"
# Default: ""
#
diff --git a/docs/awstats_setup.html b/docs/awstats_setup.html
index c65d5519..18e622da 100644
--- a/docs/awstats_setup.html
+++ b/docs/awstats_setup.html
@@ -47,7 +47,7 @@ AWStats common use is made in 3 steps:
A) With Apache or compatible server (on Unix/Linux, Windows, MacOS...)
* Step 1-1:
-(if you use a package provided with a Linux distribution or windows installer, this might be
+(if you use a package provided with a Linux distribution or Windows installer, this might be
already done and is not necessary)
Configure your apache web server to have NCSA combined/XLF/ELF log format (you can use your own log format but
@@ -63,7 +63,7 @@ your homepage. This is an example of records you should get then in your new log
* Step 1-2:
-(if you use a package provided with a Linux distribution or windows installer, this might be
+(if you use a package provided with a Linux distribution or Windows installer, this might be
already done and is not necessary)
Check that your Apache config file (httpd.conf) contains the following directives and add them
@@ -80,10 +80,12 @@ Alias /awstatscss "/usr/local/awstats/wwwroot/css/"
Alias /awstatsicons "/usr/local/awstats/wwwroot/icon/"
ScriptAlias /awstats/ "/usr/local/awstats/wwwroot/cgi-bin/"
+
+Note that you need to restart Apache to apply the changes.
* Step 1-3:
-(with most Perl interpreter correctly setup, this step is not required)
+(if Perl interpreter is correctly setup, this step is not required)
If necessary, edit the first (top-most) line of awstats.pl file that is
#!/usr/bin/perl
to reflect the path were your Perl interpreter is installed. Default value works for most of Unix OS, but it also might be
@@ -93,16 +95,15 @@ With Apache for Windows and ActivePerl interpreter, it might be
* Step 1-4:
-(if you use a package provided with a Linux distribution or windows installer, this might be
-already done and is not necessary)
+(if you use a package provided with a Linux distribution or Windows installer, this might not be necessary)
Move AWStats icon sub-directories and its content into a directory readable by your
-web server, for example /yourwwwroot/icon or /yourwwwroot/icons.
+web server, for example /yourwwwroot/icon.
* Step 1-5:
-(if you use a package provided with a Linux distribution, your config file might
-have been already created under /etc/awstats directory)
+(if you use a package provided with a Linux distribution or Windows installer, your config
+file might have been already created)
Create a config file by copying awstats.model.conf file into a new file named awstats.myvirtualhostname.conf.
You can use the value of your choice instead of "myvirtualhostname". This new file must be stored in
@@ -111,8 +112,9 @@ You can use the value of your choice instead of "myvirtualhostname". This new fi
* Step 1-6:
-(if you use a package provided with a Linux distribution, your config file
-might have been already edited and stored in /etc/awstats)
+(if you use a package provided with a Linux distribution or Windows installer, your config
+file already contains the right values)
+
Edit this new config file with your own setup :
- Change LogFile value with full path of your web server log file (You
can also use a relative path from your awstats.pl directory).