From: Frederic Marchal <fmarchal@users.sourceforge.net>
Date: Mon, 27 Jul 2015 18:10:21 +0000 (+0200)
Subject: Improve the documentation in sarg.conf
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=eaa8efdb55600939c2bba9648f0e8f2d08618084;p=thirdparty%2Fsarg.git

Improve the documentation in sarg.conf

Write a more complete documentation about exclusion and alias files.
---

diff --git a/sarg.conf b/sarg.conf
index ee755d4..acb0734 100644
--- a/sarg.conf
+++ b/sarg.conf
@@ -203,8 +203,8 @@
 #user_sort_field BYTES reverse
 
 # TAG:  exclude_users file
-#       users within the file will be excluded from reports.
-#       you can use indexonly to have only index.html file.
+#       Users within the file will be excluded from reports.
+#       Write one user per line. Lines beginning with # are ignored.
 #
 #exclude_users none
 
@@ -836,21 +836,33 @@
 
 # TAG: hostalias
 #      The name of a text file containing the host names one per line and the
-#      optional alias to use in the report instead of that host name.
+#      optional alias to use in the report instead of that host name. If the
+#      alias is missing, the host name is replaced by the matching pattern
+#      (that is, including the wildcard). For instance, in the example below,
+#      any host matching *.gstatic.com is grouped, in the report, under the
+#      text "*.gstatic.com".
+#
 #      Host names may contain up to one wildcard denoted by a *. The wildcard
 #      must not end the host name.
+#
 #      The host name may be followed by an optional alias but if no alias is
 #      provided, the host name, including the wildcard, replaces any matching
 #      host name found in the log.
+#
 #      Host names replaced by identical aliases are grouped together in the
 #      reports.
+#
 #      IP addresses are supported and accept the CIDR notation both for IPv4 and
 #      IPv6 addresses.
+#
 #      Regular expressions can also be used if sarg was compiled with libpcre.
 #      A regular expression is formated as re:/regexp/ alias
 #      The regexp is a perl regular expression (see man perlre).
 #      Subpatterns are allowed in the alias. Sarg recognizes sed (\1) or perl ($1)
 #      subpatterns. Only 9 subpatterns are allowed in the replacement string.
+#      Regex are case sensitive by default. To have a case insensitive regex,
+#      defined it like this: re:/regexp/i alias
+#      The option "i" must be written with a lower case.
 #
 #      Example:
 #      *.gstatic.com
@@ -867,19 +879,13 @@
 # TAG: useralias
 #      The name of a text file containing the user names one per line and the
 #      optional alias to use in the report instead of that user name.
-#      User names may contain wildcards denoted by a *.
-#      The user name may be followed by an optional alias but if no alias is
-#      provided, the user name, including the wildcard, replaces any matching
-#      user name found in the log.
-#      User names replaced by identical aliases are grouped together in the
-#      reports.
-#      IP addresses are supported and accept the CIDR notation both for IPv4 and
-#      IPv6 addresses.
-#      Regular expressions can also be used if sarg was compiled with libpcre.
-#      A regular expression is formated as re:/regexp/ alias
-#      The regexp is a perl regular expression (see man perlre).
-#      Subpatterns are allowed in the alias. Sarg recognizes sed (\1) or perl ($1)
-#      subpatterns. Only 9 subpatterns are allowed in the replacement string.
+#      See the description of hostalias. It uses the same file format as the
+#      useralias option.
+#
+#      Example:
+#      user454 John
+#      admin* Administrator
+#      re:/^(.*)@example.com$/i \1
 #useralias /usr/local/sarg/useralias
 
 # TAG: keep_temp_log yes|no