diff --git a/src/doc/user/bldloop b/src/doc/user/bldloop deleted file mode 100644 index 3b005359..00000000 --- a/src/doc/user/bldloop +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/sh - -while true;do - make FORMATS="html html-split" - cp *.html /usr/local/www/lesbonscomptes/recoll/usermanual/ - sleep 1 -done diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 532006a9..15a00419 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -27,7 +27,7 @@ - 2005-2012 + 2005-2013 Jean-Francois Dockes @@ -4420,43 +4420,66 @@ except: Prerequisites - C++ compiler. Up to &RCL; version 1.13.04, its absence can - manifest itself by strange messages about a missing - iconv_open. + If you can install any or all of the following through + the package manager for your system, all the + better. Especially Qt is a very + big piece of software, but you will most probably be able to + find a binary package. - Development files for Xapian - core. If you are - building Xapian for an older CPU (before Pentium 4 or Athlon - 64), you need to add the flag - to the configure command. Else all Xapian application will - crash with an illegal instruction - error. + You may have to compile &XAP; but this is easy. - Development files for - - Qt . + The shopping list: + - Development files for X11 and - zlib. + C++ compiler. Up to &RCL; version 1.13.04, + its absence can manifest itself by strange messages + about a missing iconv_open. + + + Development files + for Xapian + core. + + If you are + building Xapian for an older CPU (before Pentium 4 or Athlon + 64), you need to add the flag + to the configure command. Else all Xapian application will + crash with an illegal instruction + error. + + + + + Development files for + + Qt 4 . &RCL; has not been + tested with Qt 5 yet. &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; + has a configuration option to disable its use (see further). + + + + + Development files for X11 and + zlib. + + + + You may also need + + libiconv. On Linux + systems, the iconv interface is part of libc and you should not + need to do anything special. + + + Check the &RCL; download page for up to date version information. - You will most probably be able to find a binary package for - Qt for your system. You may have to - compile &XAP; but this is not difficult (if you are using - FreeBSD, there is a port). - - You may also need - libiconv. &RCL; - currently uses version 1.9 (this should not be critical). On - Linux systems, the iconv interface - is part of libc and you should not need to do anything - special. - @@ -4469,60 +4492,54 @@ except: I would very much welcome patches. - Depending on the Qt 3 - configuration on your system, you may have to set the - QTDIR and QMAKESPECS - variables in your environment: - - QTDIR should point to the - directory above the one that holds the qt include files (ie: - if qt.h is - /usr/local/qt/include/qt.h, QTDIR - should be /usr/local/qt). - - QMAKESPECS should - be set to the name of one of the - Qt mkspecs sub-directories (ie: - linux-g++). - - - - On many Linux systems, QTDIR is set - by the login scripts, and QMAKESPECS is not - needed because there is a default link in - mkspecs/. - - Neither QTDIR nor - QMAKESPECS should be needed with - Qt 4, - configuration details are entirely determined by - qmake (which is quite often installed as - qmake-qt4). Configure options: + will disable the code for phonetic matching of search - terms. - + terms. + or will enable the code for real time indexing. Inotify support is enabled by default on - recent Linux systems. - + recent Linux systems. + + will + enable sending Zeitgeist + events about the visited search results, and needs + the Qt Zeitgeist + module. + is available from version 1.17 to implement the result list with a Qt QTextBrowser instead of a WebKit widget if you do not or can't depend on the - latter. - - will enable - code to fetch data from file extended attributes. This is only - useful is some application stores data in there, and also needs - some simple configuration (see comments in the - fields configuration file). - + latter. + + is available + from version 1.19 to suppress multithreading inside the + indexing process. You can also use the run-time + configuration to restrict recollindex + to using a single thread, but the compile-time option + may disable a few more unused locks. This only applies + to the use of multithreading for the core index + processing (data input). The &RCL; monitor mode always + uses at least two threads of execution. + + will + avoid building the Python + module. + + will prevent + fetching data from file extended attributes. Beyond a + few standard attributes, fetching extended attributes + data can only be useful is some application stores data + in there, and also needs some simple configuration (see + comments in the fields configuration + file). + will enable splitting camelCase words. This is not enabled by default as it has the unfortunate @@ -4532,12 +4549,13 @@ except: "my sql manual" but not "mysql manual" (only inside phrase searches). + Specify the version of the 'file' command to use (ie: --with-file-command=/usr/local/bin/file). Can be useful to enable the gnu version on systems where the native one is - bad. - + bad. + Disable the Qt interface. Will allow building the indexer and the command line search program in absence of a Qt environment. @@ -4550,6 +4568,12 @@ except: Qt and X11. + will compile + &RCL; with position-dependant code. This is incompatible with + building the KIO or the Python + or PHP extensions, but might + yield very marginally faster code. + Of course the usual autoconf configure options, like apply. diff --git a/website/features.html b/website/features.html index e01f7016..a18aad34 100644 --- a/website/features.html +++ b/website/features.html @@ -255,18 +255,14 @@ application/x-tar = execm rcltar -
  • RTF files with unrtf. Please - note that up to version - 0.21, unrtf mostly does not work - with non western-european character sets. If you have a need - for indexing, ie, russian or chinese RTF files, I have - produced a modified version which works much better (as - indicated by my tests and a few external ones). You can - download the source - here. The development is hosted - on - bitbucket.org.
    • +
  • RTF files with + + unrtf. Please note that up to version 0.21.3, + unrtf mostly does not work + with non western-european character sets. If you have a need + for indexing, e.g., russian or chinese RTF files, make sure + that you have 0.21.3 or newer. Unrtf is easy to build from + source.
  • TeX with untex. If there is no untex package for