]> git.ipfire.org Git - thirdparty/sarg.git/blobdiff - README
Use a library to read gzip access.log files
[thirdparty/sarg.git] / README
diff --git a/README b/README
index 265ab74d5539e801b78afadef5a0cf19ad8c9382..b6def549dabf6bec162a828910b3f9f5e62989ac 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,98 @@
 Sarg is a Squid Analysis Report Generator that allow you to view "where" your users
 are going to on the Internet.
-Sarg generate reports in html, with many fields, like: users, IP Addresses, bytes, sites and times.
+Sarg generates reports in html, with many fields, like: users, IP Addresses, bytes, sites and times.
+
+Source: http://sourceforge.net/projects/sarg/
+
+
+Installation
+------------
+
+1. run ./configure
+
+   Useful configure options:
+     --prefix - The root directory of the installation
+               default: /usr/local
+
+     --bindir - where sarg binary will be saved
+               default: /usr/local/bin
+
+     --sysconfdir - where the configuration directory is
+               default: /usr/local/etc
+
+     --mandir - where the sarg man page will be saved
+               default: /usr/local/share/man
+
+     --enable-sargphp - where to install sarg-php (--disable-sargphp don't install sarg-php)
+               default: /var/www/html
+
+     --enable-fontdir - where to find the fonts for the reports (--diable-fontdir don't install the fonts)
+               default: /usr/local/share/sarg/fonts
+
+     --enable-imagedir - where sarg take the images to include in the reports
+               default: /usr/local/share/sarg/images
+
+     --enable-extraprotection - compile sarg with extra GCC options for increased security
+               default: use standard compilation warnings and no protection
+
+   For a complete list of all the options, run ./configure --help.
+
+3. make
+
+4. make install
+
+5. Go to /usr/local/sarg (or file entered with --sysconfdir on configure)
+   and change sarg.conf as you need.
+
+6. Notes about sarg:
+
+   Date/Time report:
+         Every minute that a request is logged your time is incremented by the smaller
+         of 1 minute or the total time for the requests.
+
+Usage: sarg -h
+
+Sorttable.js
+------------
+
+Starting with sarg v2.3.2-pre2, a javascript is distributed along with sarg to
+dynamically sort the reports. It is sorttable.js written by Stuart Langridge
+and available at http://www.kryogenix.org/code/browser/sorttable/.  The version
+included with sarg contains some fixes and improvements over the original
+version. The patches have been reported to the author but he doesn't seem to
+support it any more.
+
+To use sorttable.js (or any other script including your own custom made
+script), simply copy it to your website and edit sarg.conf to point the
+sorttable option to the location of the script on your website. The path
+indicated in sarg.conf must be the path as seen by a client visiting your
+server.
+
+Translations
+------------
+
+As of March 14th, 2010 (sarg 2.3), the translations have been ported to gettext. This makes it easier
+to translate all the messages (the number of translated messages went from 144 to 448). Therefore, the
+old language files are obsolete. The old translated message have been converted automatically to
+gettext but due to the changes made to the strings in the program after the automatic conversion,
+it is likely that the old messages are, at best, meaningless.
+
+Translations are handled at http://translationproject.org/domain/sarg.html. If your language is
+not yet supported or the current translation is obsolete, please check with the team working
+on your language at the Translation Project to be sure nobody is assigned to sarg. If necessary,
+contact the coordinator of that team to join the team and be assigned to sarg.
+
+If no po file exists for you language, download the latest sarg.pot on this page
+http://translationproject.org/domain/sarg.html and rename it as YourLanguageCode.po. See
+http://www.gnu.org/software/gettext/manual/gettext.html#Language-Codes for the list of the
+valid languages codes.
+
+Translate YourLanguageCode.po (see http://www.gnu.org/software/gettext/manual/gettext.html for more informations).
+
+Submit the translated po file to robot@translationproject.org. You must be a member of the team
+working on the language for which you are submitting the po file or the robot will reject
+your file. It is not necessary to fill the disclaimer to translate sarg.
 
-Support to SmartFilter added - 09/02/2000
 
 Special thanks to:
 Matteo Colombo <matteo@calcol.it>                      - Italian language
@@ -36,55 +126,10 @@ Alex Deiter <tiamat@komi.mts.ru>                   - Russian UTF-8 language
 Josef Karliak <karliak@ajetaci.cz>                     - Czech UTF-8
 Igor Ageikin <iageikin@lipen.elektra.ru>               - Russian UTF-8 fix
 
-Translating
-   . Copy include/English to YourLanguage
-   . Translate YourLanguage
-   . Send YourLanguage to    pedro.orso@gmail.com to be implemented.
-
-
-If you use native squid log format, the elapsed time will be in reports (emulate_httpd_log off).
-
-1. run ./configure
-
-   configure options: --bindir=where sarg binary will be saved
-                                default: /usr/local/bin
-
-                      --sysconfdir - where the configuration directory is
-                                default: /usr/local/etc
-
-                      --mandir - where the sarg man page will be saved
-                                default: /usr/local/share/man
-
-                      --enable-htmldir - where the www html root dir is
-                                default: /var/www/html
-
-                      --enable-languagedir - where the translation of sarg are
-                                default: /usr/local/share/sarg/languages
-
-                      --enable-fontdir - where to find the fonts for the reports
-                                default: /usr/local/share/sarg/fonts
-
-                      --enable-imagedir - where sarg take the images to include in the reports
-                                default: /usr/local/share/sarg/images
-
-                      --enable-extraprotection - compile sarg with extra GCC options for increased security
-                                default: use standard compilation warnings and no protection
-
-3. make
-
-4. make install
-
-5. Go to /usr/local/sarg (or file entered with --sysconfdir on configure)
-   and change sarg.conf as you need.
-
-6. Notes about sarg:
-
-   Date/Time report:
-         Every minute that a request is logged your time is incremented by the smaller
-         of 1 minute or the total time for the requests.
-
-Usage: sarg -h
 
-Source: http://www.sarg-squid.org
+Suggestions or remarks
+----------------------
 
-Any suggests and/or comments, please:    pedro.orso@gmail.com
+Any suggests or comments may be posted on the forum
+http://sourceforge.net/projects/sarg/forums/forum/363374 or sent to Frederic Marchal
+(fmarchal@users.sourceforge.net)