Sarg.conf with the topuser_fields documentation

The default configuration file now describes the accepted columns for the
top user report.

diff --git a/sarg.conf b/sarg.conf
index faee314340d8e727749d76ea6e093a6d21924f32..f56d0fa1f3b07bd720dd81346a02501069a35260 100644 (file)
--- a/sarg.conf
+++ b/sarg.conf
@@ -515,6 +515,20 @@
 # TAG: topuser_fields
 #      Which fields must be in Topuser report.
 #
+# Valid columns are
+#    NUM           Report line number.
+#    DATE_TIME     Icons to display the date and time reports.
+#    USERID        Display the user's ID. It may be a name or the IP address depending on other settings.
+#    USERIP        Display the user's IP address.
+#    CONNECT       Number of connections made by the user.
+#    BYTES         Number of bytes downloaded by the user.
+#    %BYTES        Percent of the total downloaded volume.
+#    IN-CACHE-OUT  Percent of cache hit and miss.
+#    USED_TIME     How long it took to process the requests from that user.
+#    MILISEC       The same in milliseconds
+#    %TIME         Percent of the total processing time of the reported users.
+#    TOTAL         Add a line to the report with the total of every column.
+#    AVERAGE       Add a line to the report with the average of every column.
 #topuser_fields NUM DATE_TIME USERID CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
 
 # TAG: user_report_fields