Updated the README files to reflect recent changes

2 files changed, 72 insertions, 27 deletions

diff --git a/server/README.xmlrpc b/server/README.xmlrpc
index 8e467ec..438657a 100644
--- a/server/README.xmlrpc
+++ b/server/README.xmlrpc
@@ -52,15 +52,17 @@ installing from source" further down in this file.
 **
 
 ** Setting up a new database
-All reports are saved in a database.  To create the needed database
+All reports are saved in a database.  If you have not used the
+rteval-xmlrpc interface before, you need to create the needed database
 user and database, execute the following command line:
 
-   # psql < /usr/share/doc/rteval-xmlrpc-1.1/rteval-1.1.sql
+   # psql < /usr/share/doc/rteval-xmlrpc-1.1/rteval-1.2.sql
 
-This script will first create a database user called 'xmlrpc', assign
-a default password before creating a database called 'rteval'.  The
-database will be populated with the needed tables and the 'xmlrpc'
-user will get the needed privileges to do its job.
+This script will first create a database user called 'rtevxmlrpc' and
+'rtevparser', assign default password before creating the database called
+'rteval'.  The database will be populated with the needed tables and the
+'rtevxmlrpc' and 'rtevparser' users will get the needed privileges to do
+their job.
 
 Remember to also update the pg_hba.conf file in the PostgreSQL data
 directory.  You need to allow the xmlrpc user access from the web
@@ -91,11 +93,25 @@ Or you can use the "safe mode" via the psql command:
 
 ** Update an already existing database
 If you already have an rteval database setup, you can run the delta
-which corresponds to the update the database tables to the latest
-versions.
+scripts to only do the pure database schema changes.
 
+To find out which schema version you using, do the following:
+
+   psql rteval -c "SELECT value FROM rteval_info WHERE key='sql_schema_ver'"
+   value
+   -------
+     1.1
+   (1 row)
+
+This indicates that the database is at the schema version 1.1.  If you do not
+have the rteval_info table, you are for sure on schema version 1.0.
+
+* Update from schema version 1.0 to 1.1
    psql rteval < /usr/share/doc/rteval-xmlrpc-1.1/delta-1.0_1.1.sql
 
+* Update from schema version 1.2 to 1.2
+   psql rteval < /usr/share/doc/rteval-xmlrpc-1.1/delta-1.1_1.2.sql
+
 
 **
 ** Building an installing from source
@@ -121,14 +137,14 @@ install'.  The default install prefix is /usr/local, unless you
 changed it with --prefix=<path>.  You will then find the
 rteval_parserd installed under /usr/local/bin/rteval_parserd and
 README files, the SQL scripts and an Apache config file will be found
-under /usr/local/share/doc/rteval-xmlrpc-1.1/
+under /usr/local/share/doc/rteval-parser-1.1/
 
 The Apache configuration file can be copied into the configuration
 directory Apache uses for its modules.  On RHEL/Fedora based
 distributions, the apache-rteval.conf can be copied into
 /etc/httpd/conf.d/
 
-For more information about the report parser (rteval_parserd), please
+For more information about the report parser (rteval-parserd), please
 have a look at the README.parser file.
 
 
@@ -154,9 +170,9 @@ or parameters is not set.
      db_username: xmlrpc
      db_password: rtevaldb
 
-The directory datadir parameter points at must be writable to the
+The directory the datadir parameter points at must be writable to the
 apache process.  Here copies of the received summary.xml files will be
-saved before being parsed into the the database.
+saved before the rteval-parserd process parses the reports.
 
 
 **
@@ -171,5 +187,5 @@ script:
                                  --xmlrpc-submit=localhost
 
 See --help for more info on this utility.  Usually the log files of Apache and
-PostgreSQL provides pretty good information on what's going wrong.
+PostgreSQL provides pretty good information if something goes wrong.
 
diff --git a/server/parser/README.parser b/server/parser/README.parser
index d156b96..885727c 100644
--- a/server/parser/README.parser
+++ b/server/parser/README.parser
@@ -1,5 +1,5 @@
 **
-**  rteval_parsed - the rteval XML report parser
+**  rteval-parsed - the rteval XML report parser
 **
 
 The purpose of the daemon is to off load the web server from the heavy duty
@@ -12,23 +12,50 @@ processing that file independently of the web/XML-RPC server.
 
 ** Installing the software
 
-If you install this application from source, please read the
-README.xmlrpc file for more information about the building and
-installation process.
+  !! Please install also the rteval-xmlrpc package and read the !!
+  !! README.xmlrpc file also for setting up and preparing the   !!
+  !! database which the rteval-parserd program will be using.   !!
+  !! This file will also contain information regardingupgrading !!
+  !! the database.                                              !!
 
-Please read the README.xmlrpc file also for setting up and preparing
-the database which the rteval-parserd program will be using.  This
-file will also contain information regarding upgrading the database.
-
-If you are installing this application from a binary package, like RPM
+When installing this application from a binary package, like RPM
 files on Fedora/RHEL based boxes, you should have the rteval-parserd
-in your $PATH and the needed file for the parsing (xmlparser.xsl)
-should be installed in a directory rteval-parserd where look for it by
-default.
+in your $PATH.  Otherwise, when installing from sources, the configure
+script defines the default paths.
 
 
 ** Configure rteval-parsed
 
+When starting the rteval-parserd via the init.d script (or via the 'service'
+command on RHEL/Fedora distributions) it will use the values configured in
+/etc/sysconfig/rteval-parserd.
+
+The available parameters are:
+
+    - NUM_THREADS
+      When this is not defined, the default behaviour is to use the number
+      of available CPU cores.  The init.d script will detect this
+      automatically.
+
+    - LOG
+      This defines how logging will be done.  See the rteval-parserd
+      arguments description further down in the document for more
+      information.
+
+    - LOGLEVEL
+      Defines how verbose the logging will be.  See the rteval-parserd
+      arguments description further down in the document for more
+      information.
+
+    - CONFIGFILE
+      The default configuration file rteval-parserd will try to read is
+      /etc/rteval.conf.  See the next paragraph for more information about
+      this file.  This argument let you override the default config file.
+
+    - PIDFILE
+      Defines where the init.d script will put the PID file for the
+      rteval-parserd process.  The default is /var/run/rteval-parserd.pid
+
 This daemon uses the same configuration file as the rest of the rteval program
 suite, /etc/rteval.conf.  It will parse the section named 'xmlrpc_parser'.
 
@@ -59,7 +86,9 @@ The default values are:
     Number of worker threads.  This defines how many reports you will
     process in parallel.  The recommended number here is the number
     of available CPU cores, as having a higher thread number often
-    punishes the performance.
+    punishes the performance.  The default value is 4 when rteval-parserd
+    is started directly.  When started via the init.d script, the default
+    is to start one thread per CPU core.
 
   - max_report_size: 2097152
     Maximum file size of reports which the parser will process.  The
@@ -67,7 +96,7 @@ The default values are:
     that this value is per thread, and that XML and XSLT processing can
     be quite memory hungry.  If this value is set too high or you have too
     many worker threads, your system might become unresponsive for a while
-    and the parser can be killed by the kernel (OOM).
+    and the parser might be killed by the kernel (OOM).
 
 
 ** rteval-parserd arguments