From faac5c87311b264219043556d6565ba279c3bc52 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Wed, 1 Mar 2017 10:07:11 +0100 Subject: [PATCH] update build section in manual --- src/doc/user/usermanual.html | 74 ++++++++++++++---------------------- src/doc/user/usermanual.xml | 55 +++++++++++---------------- 2 files changed, 50 insertions(+), 79 deletions(-) diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 64d39e38..48498312 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -20,8 +20,8 @@ alink="#0000FF">
-

Recoll user manual

+

Recoll user manual

@@ -109,13 +109,13 @@ alink="#0000FF"> multiple indexes
2.1.3. Document types
+ "#idp69806816">Document types
2.1.4. Indexing failures
+ "#idp69829680">Indexing failures
2.1.5. Recovery
+ "#idp69836688">Recovery @@ -997,8 +997,8 @@ alink="#0000FF">
-

2.1.3. Document types

+

2.1.3. Document types

@@ -1105,8 +1105,8 @@ indexedmimetypes = application/pdf
-

2.1.4. Indexing +

2.1.4. Indexing failures

@@ -1146,8 +1146,8 @@ indexedmimetypes = application/pdf
-

2.1.5. Recovery

+

2.1.5. Recovery

@@ -8013,8 +8013,12 @@ except: big piece of software, but you will most probably be able to find a binary package.

-

You may have to compile Xapian but this is easy.

+

If you are building for an exotic or older system, it + may be useful to note that functional improvements in + Recoll have been + relatively marginal in recent versions, and that you may + make your life easier by using an older release, without + losing major function.

The shopping list:

@@ -8025,16 +8029,14 @@ except:

The autoconf, automake and libtool triad. Only - autoconf is needed up - to Recoll - 1.21.

+ autoconf is needed + before Recoll and + including 1.21.

  • -

    C++ compiler. Up to Recoll version 1.13.04, its - absence can manifest itself by strange messages - about a missing iconv_open.

    +

    C++ compiler. Recent versions require C++11 + compatibility (1.23 and later).

  • @@ -8075,10 +8077,8 @@ except:

  • Development files for Qt 4 . - Recoll has not - been tested with Qt - 5 yet. Qt 4 or Qt + 5 . Recoll 1.15.9 was the last version to support Qt 3. If you do not want to install or build @@ -8330,32 +8330,14 @@ except:

    • -

    Either type make - install or execute recollinstall prefix, - in the root of the source tree. This will copy the - commands to Use make + install in the root of the source tree. + This will copy the commands to prefix/bin and the sample configuration files, scripts and other shared data to prefix/share/recoll.

    - -

    If the installation prefix given to recollinstall is - different from either the system default or the value - which was specified when executing configure (as in - configure --prefix - /some/path), you will have to set the - RECOLL_DATADIR environment - variable to indicate where the shared data is to be found - (ie for (ba)sh: export - RECOLL_DATADIR=/some/path/share/recoll).

    - -

    You can then proceed to configuration.

    diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index eac83e39..df667e0a 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -5455,19 +5455,22 @@ except: big piece of software, but you will most probably be able to find a binary package. - You may have to compile &XAP; but this is easy. - + If you are building for an exotic or older system, it may + be useful to note that functional improvements in &RCL; + have been relatively marginal in recent versions, + and that you may make your life easier by using an older + release, without losing major function. + The shopping list: The autoconf, automake and libtool - triad. Only autoconf is needed up to &RCL; - 1.21. + triad. Only autoconf is needed before &RCL; + and including 1.21. - C++ compiler. Up to &RCL; version 1.13.04, - its absence can manifest itself by strange messages - about a missing iconv_open. + C++ compiler. Recent versions require C++11 + compatibility (1.23 and later). bison command (for &RCL; 1.21 @@ -5497,12 +5500,11 @@ except: Development files for - - Qt 4 . &RCL; has not been - tested with Qt 5 yet. &RCL; 1.15.9 + + Qt 4 or Qt 5 . &RCL; 1.15.9 was the last version to support Qt 3. - If you do not want to install or build - the Qt Webkit module, &RCL; + If you do not want to install or build the + Qt Webkit module, &RCL; has a configuration option to disable its use (see further). @@ -5673,27 +5675,14 @@ except: Installation - Either type make install or execute - recollinstall - prefix, in the root - of the source tree. This will copy the commands to - prefix/bin - and the sample configuration files, scripts and other shared - data to - prefix/share/recoll. - If the installation prefix given to - recollinstall is different from either the - system default or the value which was - specified when executing configure (as in - configure --prefix /some/path), you - will have to set the RECOLL_DATADIR - environment variable to indicate where the shared data is to - be found (ie for (ba)sh: - export RECOLL_DATADIR=/some/path/share/recoll). - - - You can then proceed to configuration. + Use make install + in the root + of the source tree. This will copy the commands to + prefix/bin + and the sample configuration files, scripts and other shared + data to + prefix/share/recoll. +