From: Frédéric Marchal <fmarchal@users.sourceforge.net>
Date: Wed, 27 Jan 2010 07:03:12 +0000 (+0000)
Subject: Update the README files
X-Git-Tag: v2_2_7~12
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=027aa6488f81504a7b6a6e568a1b57cc7c5ec065;p=thirdparty%2Fsarg.git

Update the README files
---

diff --git a/README b/README
index 265ab74..d69ce14 100644
--- a/README
+++ b/README
@@ -55,7 +55,7 @@ If you use native squid log format, the elapsed time will be in reports (emulate
                       --mandir - where the sarg man page will be saved
                                 default: /usr/local/share/man
 
-                      --enable-htmldir - where the www html root dir is
+                      --enable-sargphp - where to install sarg-php (--disable-sargphp don't install sarg-php)
                                 default: /var/www/html
 
                       --enable-languagedir - where the translation of sarg are
diff --git a/README_cmake b/README_cmake
index 42634c1..17f035b 100644
--- a/README_cmake
+++ b/README_cmake
@@ -25,12 +25,16 @@ If you intent to use both cmake and the autotools, then you MUST build sarg out
 of the source directory as it will overwrite the original stub config.h in the
 source directory and you won't be able to use the autotools afterward.
 
-To build sarg out of source, create a directory at the same level as the sources
-of sarg and cd into that directory.
+To build sarg out of source, create a build directory and cd into that directory.
+For instance, assuming your prompt is in the source directory, run
 
-Configure sarg with the command
+ mkdir build
+ cd build
 
- ccmake ../sarg
+Configure sarg with the command (assuming the case of a build directory one level
+below the sources of sarg):
+
+ ccmake ..
 
 On the first run, it will report that the cache is empty. Press 'c' to configure
 the cache. Then ccmake will display an interface to select some configuration
@@ -84,6 +88,9 @@ These configuration variables are available on the first configuration run.
    IMAGEDIR - The directory containing the images to use in the reports.
       default: share/sarg/images
 
+   SARGPHPDIR - The directory to install sarg-php.
+      default: share/sarg/sarg-php
+
    ENABLE_EXTRA_PROTECT - Compile sarg with some GCC options to increase the
               security (tolerate no compilation warning, use the stack smashing
               protection, improved printf check, and so on).
@@ -105,7 +112,7 @@ available on the second run.
    IMAGEDIR_SOURCE - The full path to the images to compile in sarg.
       default: CMAKE_INSTALL_PREFIX/IMAGEDIR
 
-They are other configuration variables whose documentation is visible during the
+There are other configuration variables whose documentation is visible during the
 configuration with ccmake.
 
 
@@ -135,16 +142,15 @@ register the new path.
 Get the sources of sarg and uncompress them in your home directory. Let's assume
 they are in a directory named "sarg".
 
-Create a separate directory at the same level as the sources of sarg and change
-to that directory. For instance, assuming your prompt is in the sarg directory,
-run the following commands:
+Create a separate build directory and change to that directory. For instance,
+assuming your prompt is in the sarg directory, run the following commands:
 
- mkdir ../bin
- cd ../bin
+ mkdir build
+ cd build
 
 Configure, compile and install sarg:
 
- cmake ../sarg -G "MSYS Makefiles"
+ cmake .. -G "MSYS Makefiles"
  make
  make install
 
@@ -180,7 +186,7 @@ Adjust and create the directories according to your configuration.
 
 You may have to adjust other options to suit your needs.
 
-If sarg complains about a missing rm or sort command, then you have to install
+If sarg complains about a missing sort command, then you have to install
 the unxtools or run sarg from msys.
 
 If you want to run sarg from a regular dos prompt, download UnxUtils.zip from