1 rizwank 1.1 
  2             ------------- AWStats --------------
  3             	 Advanced Web Statistics
  4             ------------------------------------
  5             
  6             AWStats (Advanced Web Statistics) is a powerful, full-featured web server
  7             logfile analyzer which shows you all your Web statistics including: visitors,
  8             pages, hits, hours, search engines, keywords used to find your site, broken
  9             links, robots and many more...
 10             
 11             It works with IIS 5.0+, Apache and all major web, wap, proxy, streaming
 12             server log files (and even ftp servers or mail logs) on all Operating Systems.
 13             
 14             License: GNU GPL (GNU General Public License. See LICENSE file),
 15                      OSI Certified Open Source Software license.
 16             Version: 6.3
 17             Release date: January 2005
 18             Platforms: All (Linux, NT, BSD, Solaris and other *NIX's, BeOS, OS/2...)
 19             Author: Laurent Destailleur <eldy@users.sourceforge.net>
 20             AWStats official web site and latest version: http://awstats.sourceforge.net
 21             
 22 rizwank 1.1 I   - Features and requirements of AWStats
 23             	  I - 1) Features, what AWStats can show you
 24             	  I - 2) Requirements for using AWStats
 25             	  I - 3) Files
 26             II  - Install, Setup and Use AWStats
 27             III - Benchmark
 28             IV  - About the author, license and support
 29             
 30             
 31             
 32             I - FEATURES AND REQUIREMENTS
 33             ------------------------------------
 34             
 35             I - 1) Features
 36             
 37             	A full log analysis enables AWStats to show you the following information:
 38             	* Number of VISITS and UNIQUE VISITORS
 39             	* Visits duration and last visits
 40             	* Authenticated users, and last authenticated visits
 41             	* Days of week and rush hours (pages, hits, KB for each day and hour)
 42             	* Domains/countries of hosts visitors (pages, hits, KB)
 43 rizwank 1.1 	* Hosts list, last visits and unresolved IP addresses list
 44             	* Most viewed, entry and exit pages
 45             	* File types
 46             	* Web compression statistics (for mod_gzip or mod_deflate)
 47             	* Browsers used (pages, hits, kb for each browser)
 48             	* OS used (pages, hits, KB for each OS)
 49             	* Robot visits
 50             	* Worm attacks
 51             	* Search engines, keyphrases and keywords used to find your site
 52             	* HTTP errors (Page not found with last referer, etc,)
 53             	* Screen size report
 54             	* Number of times your site is "added to favourites bookmarks"
 55             	* Ratio of Browsers that support: Java, Flash, RealG2 reader,
 56             	  Quicktime reader, WMA reader, PDF reader
 57             	* Cluster report for load balanced servers ratio
 58             	* Other personalized reports...
 59             
 60             	It supports the following features as well:
 61             	* Can analyze all log formats
 62             	* Works from command line and from a browser as a CGI (with dynamic
 63             	  filters capabilities for some charts)
 64 rizwank 1.1 	* Update of statistics can be made on demand from the web interface and
 65             	  not only from your scheduler
 66             	* Unlimited log file size, support split log files (load balancing system)
 67             	* Support 'nearly sorted' log files even for entry and exit pages
 68             	* Reverse DNS lookup before or during analysis, supports DNS cache files
 69             	* Country detection from IP location or domain name
 70             	* WhoIS links
 71             	* A lot of options/filters and plugins can be used
 72             	* Multi-named web sites supported (virtual servers)
 73             	* Cross Site Scripting Attacks protection
 74             	* Several languages
 75             	* No need of rare perl libraries
 76             	* Dynamic reports as CGI output
 77             	* Static reports in one or framed HTML or XHTML pages
 78             	* Experimental PDF export
 79             	* Look and colors can match your site design (CSS)
 80             	* Help and tooltips on HTML reported pages
 81             	* Easy to use (Just one configuration file to edit)
 82             	* Analysis database can be stored in XML format (for XSLT processing, ...)
 83             	* A Webmin module
 84             	* Free (GNU GPL) with sources (perl scripts)
 85 rizwank 1.1 	* Available on all platforms
 86             
 87             
 88             I - 2) Requirements
 89             
 90             	To use AWStats CGI script, you need the following requirements:
 91             	* Your server must log web access in a log file you can read.
 92             	* To run awstats, from command line, your operating system must be able
 93             	  to run perl scripts (.pl files).
 94             	  
 95             	To run awstats as a CGI (for real-time
 96             	  statistics), your web server must also be able to run such scripts.
 97             	  If not, you can solve this by downloading last Perl version at:
 98             	  http://www.activestate.com/ActivePerl/ (Windows)
 99             	  http://www.perl.com/pub/language/info/software.html (All OS)
100             
101             
102             I - 3) Files
103             
104             	The distribution of AWStats package includes the following files:
105             	README.TXT                          This file
106 rizwank 1.1 	docs/LICENSE                        GNU General Public Licence
107             	docs/*                              AWStats documentation (setup/usage...)
108             	wwwroot/cgi-bin/awstats.pl          THE MAIN AWSTATS PROGRAM (CLI/CGI)
109             	wwwroot/cgi-bin/awredir.pl          A tool to track exit clicks
110             	wwwroot/cgi-bin/awstats.model.conf  An model configuration file
111             	wwwroot/cgi-bin/lang                Directory with languages files
112             	wwwroot/cgi-bin/lib                 Directory with awstats reference info
113             	wwwroot/cgi-bin/plugins             Directory with optional plugins
114             	wwwroot/icon/browser                Directory with browsers icons
115             	wwwroot/icon/clock                  Directory with clock icons
116             	wwwroot/icon/cpu                    Directory with cpu icons
117             	wwwroot/icon/flags                  Directory with country flag icons
118             	wwwroot/icon/os                     Directory with OS icons
119             	wwwroot/icon/other                  Directory with all others icons
120             	wwwroot/classes                     Java applet for graphapplet plugin
121             	wwwroot/css                         Samples of CSS files
122             	wwwroot/js                          Javascript sources for "Misc" feature
123             	tools/*                             Other provided tools
124             	tools/webmin/awstats-x.x.wbm        A Webmin module for AWStats
125             	tools/xslt/awstats61.xsd            AWStats XML database schema descriptor
126             	tools/xslt/*                        Demo to manipulate AWStats XML database
127 rizwank 1.1 
128             
129             
130             II - INSTALL, SETUP AND USE AWSTATS
131             -----------------------------------
132             
133             The documentation available for this release in HTML format is
134             in the docs/ directory.
135             
136             You can find a most up-to-date documentation at:
137             http://awstats.sourceforge.net
138             
139             
140             
141             III - BENCHMARK
142             -----------------------------------
143             
144             Tests and results are available in AWStats documentation, in docs/ directory.
145             
146             
147             
148 rizwank 1.1 IV - ABOUT THE AUTHOR, LICENSE AND SUPPORT
149             -----------------------------------------
150             Copyright (C) 2000-2005 - Laurent Destailleur - eldy@users.sourceforge.net
151             
152             This program is free software; you can redistribute it and/or
153             modify it under the terms of the GNU General Public License
154             version 2 as published by the Free Software Foundation.
155             
156             This program is distributed in the hope that it will be useful,
157             but WITHOUT ANY WARRANTY; without even the implied warranty of
158             MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
159             GNU General Public License for more details, in COPYING.TXT file.
160             
161             If you have not received a copy of this file along with this program, write to
162             the Free Software Foundation, Inc.,
163             59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.