From bb1820222f03311c3c008a558da099d221c8cc3c Mon Sep 17 00:00:00 2001
From: "Christian P. MOMON" <christian.momon@devinsy.fr>
Date: Tue, 9 May 2023 11:26:21 +0200
Subject: [PATCH] Updated documentation.

---
 README.md | 46 ++++++++++++++++++++++++----------------------
 1 file changed, 24 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 2ebc629..92d2cc9 100644
--- a/README.md
+++ b/README.md
@@ -82,19 +82,21 @@ Usage:
     statoolinfos build                       <configurationfile>     build property files from conf and input
     statoolinfos clear                       <configurationfile>     remove property files from conf
     statoolinfos crawl                       <configurationfile>     crawl all file from conf and input
+    statoolinfos format                      <fileordirectory>       format property files in tiny way
     statoolinfos htmlize                     <configurationfile>     generate web pages from conf
     statoolinfos probe   OPTION [<directory>|<configurationfile>]    generate metrics files from conf
            OPTION = [-full|-today|-previousday|-NN] with NN a day count
+    statoolinfos tagdate                     <fileordirectory>       update the file.datetime file
     statoolinfos uptime                      <configurationfile>     update uptime journal
 
-    statoolinfos format                      <fileordirectory>       format property files in tiny way
-    statoolinfos list ip       [-bot|-nobot] <fileordirectory>       generate ip list from log file
-    statoolinfos list ua       [-bot|-nobot] <fileordirectory>       generate user agent list from log file
-    statoolinfos list visitors [-bot|-nobot] <fileordirectory>       generate visitors (ip+ua) list from log file
-    statoolinfos stat ip       [-bot|-nobot] <fileordirectory>       generate stats about ip from log file
-    statoolinfos stat ua       [-bot|-nobot] <fileordirectory>       generate stats about user agent from log file
-    statoolinfos stat visitors [-bot|-nobot] <fileordirectory>       generate stats about visitors (ip+ua) from log file
-    statoolinfos tagdate                     <fileordirectory>       update the file.datetime file
+    statoolinfos list file                   <logfilesorconfigfile>  display http access log files
+    statoolinfos list log      [-bot|-nobot] <logfilesorconfigfile>  display http access log lines
+    statoolinfos list ip       [-bot|-nobot] <logfiles>              generate ip list from http log file
+    statoolinfos list ua       [-bot|-nobot] <logfiles>              generate user agent list from http log file
+    statoolinfos list visitor  [-bot|-nobot] <logfiles>              generate visitors (ip+ua) list from http log file
+    statoolinfos stat ip       [-bot|-nobot] <logfiles>              generate stats about ip from http log file
+    statoolinfos stat ua       [-bot|-nobot] <logfiles>              generate stats about user agent from http log file
+    statoolinfos stat visitor  [-bot|-nobot] <logfiles>              generate stats about visitor (ip+ua) from http log file
 ```
 
 
@@ -139,7 +141,7 @@ Configuration template:
 conf.probe.types=Etherpad
 conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
 conf.probe.httpaccesslog.pattern=
-conf.probe.httpaccesslog.filepath=
+conf.probe.httpaccesslog.pathfilter=
 # This parameter requires real ip proxy setting and log output setting.
 conf.probe.etherpad.logs=/var/log/etherpad/output.log
 # Database URL. Example of the most frequent cases:
@@ -170,7 +172,7 @@ Configuration template:
 conf.probe.types=Gitea
 conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
 conf.probe.httpaccesslog.pattern=
-conf.probe.httpaccesslog.filepath=
+conf.probe.httpaccesslog.pathfilter=
 conf.probe.gitea.data=/opt/gitea/data
 conf.probe.gitea.api.url=https://forge.libre-service.eu/
 conf.probe.gitea.token=b6598c616b1cd350b834258205da4e5e8b951005
@@ -202,7 +204,7 @@ Configuration template:
 conf.probe.types=LibreQR
 conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
 conf.probe.httpaccesslog.pattern=
-conf.probe.httpaccesslog.filepath=
+conf.probe.httpaccesslog.pathfilter=
 conf.probe.libreqr.datafiles=/var/www/foo.bar.org/temp/
 conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
 ```
@@ -245,7 +247,7 @@ Configuration template:
 conf.probe.types=Nextcloud
 conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
 conf.probe.httpaccesslog.pattern=
-conf.probe.httpaccesslog.filepath=
+conf.probe.httpaccesslog.pathfilter=
 conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
 ```
 
@@ -259,7 +261,7 @@ Configuration template:
 conf.probe.types=PrivateBin
 conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
 conf.probe.httpaccesslog.pattern=
-conf.probe.httpaccesslog.filepath=
+conf.probe.httpaccesslog.pathfilter=
 conf.probe.privatebin.data=/var/www/paste.libre-service.eu/data/
 conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
 ```
@@ -270,30 +272,30 @@ Configuration template:
 
 ```
 conf.probe.types=HttpAccessLog, HttpErrorLog
-conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
-conf.probe.httperrorlog.file=/var/log/apache2/foo.bar.org-error.log*
+conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*,/var/log/apache2/foo.bar.org-extraaccess.log*
+conf.probe.httperrorlog.file=/var/log/apache2/foo.bar.org-error.log*,/var/log/apache2/foo.bar.org-extraerror.log*
 conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
 
 # Custom access log pattern with Java regex.
 # Default: ^(?<remoteAddress>[a-fA-F0-9\:\.]+) - (?<remoteUser>[^\[]+) \[(?<time>[^\]]+)\] "(?<request>.*)" (?<status>\d+) (?<bodyBytesSent>\d+) "(?<referer>.*)" "(?<userAgent>[^"]*)".*$ 
 conf.probe.httpaccesslog.pattern=
 
-# Filter request with Java regex (without the initial '^' and without the final '$').
-# Example: filterpath=/.*well-known.*
+# Filter request with Java regex (without the initial '^' and without the final '$', see https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html).
+# Example: pathfilter=/.*well-known.*
 conf.probe.httpaccesslog.pathfilter=
 ```
 
 Warning: to have month metric values, you have to set **retention log to 7 weeks or 50 days** in Nginx or Apache logrotate configuration.
 
-Pour Nginx, éditer le fichier `/etc/logrotate.d/nginx` :
+For Nginx, éditer le fichier `/etc/logrotate.d/nginx` :
 ```
 /var/log/nginx/*.log {
-        weekly
-        missingok
-        rotate 7
+    weekly
+    missingok
+    rotate 7
 ```
 
-Pour Apache, éditer le fichier `/etc/logrotate.d/apache2` :
+For Apache, éditer le fichier `/etc/logrotate.d/apache2` :
 ```
 /var/log/apache2/*.log {
     weekly