[thirdparty/sarg.git] / README

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.

Support to SmartFilter added - 09/02/2000

Special thanks to:
Matteo Colombo <matteo@calcol.it> 			- Italian language
Palamarchuk Eugen <eugen@cit.od.ukrtel.net> 		- Russian language
Csaba Kabai <ckabai@icnpharm.com>			- Hungarian language
Evren Yurtesen <yurtesen@ispro.net.tr>          	- Turkish language
Andreas Piek <a.piesk@gmx.net>				- German language
Fred Pacquier <fredp@dial.oleane.com>			- French language
Leonardo A. D'Angelo <ldangelo@san-cayetano.com>	- Spanish language
Seth Mos <stimpy@stimpy.multiweb.nl>			- Dutch language
Milos Prudek <prudek@nembv.cz>                          - Czech language
Dima I. Allaverdov <allav@ur.rags.ru>                   - Russian_windows1251 language
V Gatut Harijiso <gatut@student.unpar.ac.id>		- Indonesian language
Ivan Minchev <vanko@uni-svishtov.bg>			- Bulgarian_windows1251 language
Akira Kitamura <click@anet.ne.jp>			- Japanese language
Radovan Drobnjakovic <admin.rts@rts.co.yu>		- Serbian language
Pieter Kooistra <pkooistra@hr.nl>			- Dutch language fix
Andrew Okhmat <andy@crgu.com>			        - Russian Koi8 language fixed
Nikolai V. Ivanyushin <koko@infocenter.bryansk.ru>	- Russian and Bulgarian language fix
Juris Valdovskis <juris@auce.lv>			- Latvian language
Jordan Kanev <dancho@globcom.net>			- Bulgarian language fix
Wszebor Boksa <Wszebor_Boksa@koncept.pl>		- Polish language
Adi Cretu <adi@usv.ro>					- Romanian language
Roman Vynar <rvynar@icqmail.com>			- Ukrainian_windows1251 language
Andreu Sanchez <tanis@lleida.com>			- Catalan language
Antonis Maglaras <vegos@magla.gr>			- Greek language
Dusan Woletz <Dusan.WOLETZ@orange.sk>			- Slovak Language
Jose Luis Hernandez <jhdz@simbiotica.net>		- Spanish language fix
Theo kastermans <t.kastermans@zandvoort.nl>		- Dutch language fix
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

Note: as of March 14th, 2010, 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.

Translating
   . Make sure there is no file with your language code in subdirectory po. If one exists,
     expand or review it.
   . If no po file exists for you language, copy po/sarg.pot to po/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).
   . Send YourLanguageCode.po to fmarchal@users.sourceforge.net 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-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

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://sourceforge.net/projects/sarg/

Any suggests and/or comments may be posted on sarg forum
http://sourceforge.net/projects/sarg/forums/forum/363374 or to Frederic Marchal
(fmarchal@users.sourceforge.net)
Commit	Line	Data
25697a35 GS	1	Sarg is a Squid Analysis Report Generator that allow you to view "where" your users
	2	are going to on the Internet.
	3	Sarg generate reports in html, with many fields, like: users, IP Addresses, bytes, sites and times.
	4
	5	Support to SmartFilter added - 09/02/2000
	6
	7	Special thanks to:
	8	Matteo Colombo <matteo@calcol.it> - Italian language
	9	Palamarchuk Eugen <eugen@cit.od.ukrtel.net> - Russian language
	10	Csaba Kabai <ckabai@icnpharm.com> - Hungarian language
	11	Evren Yurtesen <yurtesen@ispro.net.tr> - Turkish language
	12	Andreas Piek <a.piesk@gmx.net> - German language
	13	Fred Pacquier <fredp@dial.oleane.com> - French language
	14	Leonardo A. D'Angelo <ldangelo@san-cayetano.com> - Spanish language
	15	Seth Mos <stimpy@stimpy.multiweb.nl> - Dutch language
	16	Milos Prudek <prudek@nembv.cz> - Czech language
	17	Dima I. Allaverdov <allav@ur.rags.ru> - Russian_windows1251 language
	18	V Gatut Harijiso <gatut@student.unpar.ac.id> - Indonesian language
	19	Ivan Minchev <vanko@uni-svishtov.bg> - Bulgarian_windows1251 language
	20	Akira Kitamura <click@anet.ne.jp> - Japanese language
	21	Radovan Drobnjakovic <admin.rts@rts.co.yu> - Serbian language
	22	Pieter Kooistra <pkooistra@hr.nl> - Dutch language fix
	23	Andrew Okhmat <andy@crgu.com> - Russian Koi8 language fixed
	24	Nikolai V. Ivanyushin <koko@infocenter.bryansk.ru> - Russian and Bulgarian language fix
	25	Juris Valdovskis <juris@auce.lv> - Latvian language
	26	Jordan Kanev <dancho@globcom.net> - Bulgarian language fix
	27	Wszebor Boksa <Wszebor_Boksa@koncept.pl> - Polish language
	28	Adi Cretu <adi@usv.ro> - Romanian language
	29	Roman Vynar <rvynar@icqmail.com> - Ukrainian_windows1251 language
	30	Andreu Sanchez <tanis@lleida.com> - Catalan language
	31	Antonis Maglaras <vegos@magla.gr> - Greek language
	32	Dusan Woletz <Dusan.WOLETZ@orange.sk> - Slovak Language
94ff9470 GS	33	Jose Luis Hernandez <jhdz@simbiotica.net> - Spanish language fix
94ff9470 GS	34	Theo kastermans <t.kastermans@zandvoort.nl> - Dutch language fix
d6e703cc FM	35	Alex Deiter <tiamat@komi.mts.ru> - Russian UTF-8 language
	36	Josef Karliak <karliak@ajetaci.cz> - Czech UTF-8
	37	Igor Ageikin <iageikin@lipen.elektra.ru> - Russian UTF-8 fix
25697a35	38
fcdc0918 FM	39	Note: as of March 14th, 2010, the translations have been ported to gettext. This makes it easier to
	40	translate all the messages (the number of translated messages went from 144 to 448). Therefore, the
	41	old language files are obsolete. The old translated message have been converted automatically to
	42	gettext but due to the changes made to the strings in the program after the automatic conversion,
	43	it is likely that the old messages are, at best, meaningless.
	44
25697a35	45	Translating
fcdc0918 FM	46	. Make sure there is no file with your language code in subdirectory po. If one exists,
	47	expand or review it.
	48	. If no po file exists for you language, copy po/sarg.pot to po/YourLanguageCode.po. See
	49	http://www.gnu.org/software/gettext/manual/gettext.html#Language-Codes for the list of the
	50	valid languages codes.
	51	. Translate YourLanguageCode.po (see http://www.gnu.org/software/gettext/manual/gettext.html for more informations).
	52	. Send YourLanguageCode.po to fmarchal@users.sourceforge.net to be implemented.
25697a35 GS	53
	54
	55	If you use native squid log format, the elapsed time will be in reports (emulate_httpd_log off).
	56
	57	1. run ./configure
	58
b3695c67 FM	59	configure options: --bindir=where sarg binary will be saved
b3695c67 FM	60	default: /usr/local/bin
25697a35	61
b3695c67 FM	62	--sysconfdir - where the configuration directory is
	63	default: /usr/local/etc
	64
	65	--mandir - where the sarg man page will be saved
	66	default: /usr/local/share/man
25697a35	67
027aa648	68	--enable-sargphp - where to install sarg-php (--disable-sargphp don't install sarg-php)
25697a35 GS	69	default: /var/www/html
25697a35 GS	70
3becf85c	71	--enable-fontdir - where to find the fonts for the reports (--diable-fontdir don't install the fonts)
b3695c67 FM	72	default: /usr/local/share/sarg/fonts
	73
	74	--enable-imagedir - where sarg take the images to include in the reports
	75	default: /usr/local/share/sarg/images
25697a35	76
05b90947 FM	77	--enable-extraprotection - compile sarg with extra GCC options for increased security
05b90947 FM	78	default: use standard compilation warnings and no protection
25697a35 GS	79
	80	3. make
	81
	82	4. make install
	83
	84	5. Go to /usr/local/sarg (or file entered with --sysconfdir on configure)
	85	and change sarg.conf as you need.
	86
	87	6. Notes about sarg:
	88
	89	Date/Time report:
	90	Every minute that a request is logged your time is incremented by the smaller
	91	of 1 minute or the total time for the requests.
	92
	93	Usage: sarg -h
	94
1164c474	95	Source: http://sourceforge.net/projects/sarg/
25697a35	96
1164c474 FM	97	Any suggests and/or comments may be posted on sarg forum
	98	http://sourceforge.net/projects/sarg/forums/forum/363374 or to Frederic Marchal
	99	(fmarchal@users.sourceforge.net)