tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
Jean-Francois Dockes 2013-05-12 10:23:14 +02:00
parent 21b06871c1
commit 28c86ee246
3 changed files with 105 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/doc/user/bldloop
View File

@ -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

170
src/doc/user/usermanual.sgml
View File

@ -27,7 +27,7 @@
</author> </author>
<copyright> <copyright>
<year>2005-2012</year> <year>2005-2013</year>
<holder role="mailto:jfd@recoll.org">Jean-Francois Dockes</holder> <holder role="mailto:jfd@recoll.org">Jean-Francois Dockes</holder>
</copyright> </copyright>
<abstract> <abstract>
@ -4420,43 +4420,66 @@ except:
<sect2 id="RCL.INSTALL.BUILDING.PREREQS"> <sect2 id="RCL.INSTALL.BUILDING.PREREQS">
<title>Prerequisites</title> <title>Prerequisites</title>
<para>C++ compiler. Up to &RCL; version 1.13.04, its absence can <para>If you can install any or all of the following through
manifest itself by strange messages about a missing the package manager for your system, all the
iconv_open.</para> better. Especially <application>Qt</application> is a very
big piece of software, but you will most probably be able to
find a binary package.</para>
<para>Development files for <ulink <para>You may have to compile &XAP; but this is easy.</para>
url="http://www.xapian.org"> <application>Xapian
core</application></ulink>.</para> <important><para>If you are
building Xapian for an older CPU (before Pentium 4 or Athlon
64), you need to add the <option>--disable-sse</option> flag
to the configure command. Else all Xapian application will
crash with an <literal>illegal instruction</literal>
error.</para> </important>
<para>Development files for <para>The shopping list:</para>
<ulink url="http://www.trolltech.com/products/qt/index.html"> <itemizedlist>
<application>Qt</application> </ulink>.</para>
<para>Development files for <application>X11</application> and <listitem><para>C++ compiler. Up to &RCL; version 1.13.04,
<application>zlib</application>.</para> its absence can manifest itself by strange messages
about a missing iconv_open.</para>
</listitem>
<listitem><para>Development files
for <ulink url="http://www.xapian.org"> <application>Xapian
core</application></ulink>.</para>
<important>
<para>If you are
building Xapian for an older CPU (before Pentium 4 or Athlon
64), you need to add the <option>--disable-sse</option> flag
to the configure command. Else all Xapian application will
crash with an <literal>illegal instruction</literal>
error.</para>
</important>
</listitem>
<listitem>
<para>Development files for
<ulink url="http://qt-project.org/downloads">
<application>Qt 4</application> </ulink>. &RCL; has not been
tested with <application>Qt 5</application> yet. &RCL; 1.15.9
was the last version to support <application>Qt 3</application>.
If you do not want to install or build
the <application>Qt Webkit</application> module, &RCL;
has a configuration option to disable its use (see further).
</para>
</listitem>
<listitem>
<para>Development files for <application>X11</application> and
<application>zlib</application>.</para>
</listitem>
<listitem>
<para>You may also need
<ulink url="http://www.gnu.org/software/libiconv/">
libiconv</ulink>. On <application>Linux</application>
systems, the iconv interface is part of libc and you should not
need to do anything special.</para>
</listitem>
</itemizedlist>
<para>Check the <ulink url="http://www.recoll.org/download.html"> <para>Check the <ulink url="http://www.recoll.org/download.html">
&RCL; download page</ulink> for up to date version &RCL; download page</ulink> for up to date version
information.</para> information.</para>
<para>You will most probably be able to find a binary package for
<application>Qt</application> for your system. You may have to
compile &XAP; but this is not difficult (if you are using
<application>FreeBSD</application>, there is a port).</para>
<para>You may also need
<ulink
url="http://www.gnu.org/software/libiconv/">libiconv</ulink>. &RCL;
currently uses version 1.9 (this should not be critical). On
<application>Linux</application> systems, the iconv interface
is part of libc and you should not need to do anything
special.</para>
</sect2> </sect2>
<sect2 id="RCL.INSTALL.BUILDING.BUILD"> <sect2 id="RCL.INSTALL.BUILDING.BUILD">
@ -4469,60 +4492,54 @@ except:
<ulink url="mailto:jfd@recoll.org">I would <ulink url="mailto:jfd@recoll.org">I would
very much welcome patches</ulink>.</para> very much welcome patches</ulink>.</para>
<para>Depending on the <application>Qt 3</application>
configuration on your system, you may have to set the
<envar>QTDIR</envar> and <envar>QMAKESPECS</envar>
variables in your environment:</para>
<itemizedlist>
<listitem><para><envar>QTDIR</envar> should point to the
directory above the one that holds the qt include files (ie:
if <filename>qt.h</filename> is
<filename>/usr/local/qt/include/qt.h</filename>, QTDIR
should be <filename>/usr/local/qt</filename>).</para>
</listitem>
<listitem><para><envar>QMAKESPECS</envar> should
be set to the name of one of the
<application>Qt</application> mkspecs sub-directories (ie:
<filename>linux-g++</filename>).</para>
</listitem>
</itemizedlist>
<para>On many Linux systems, <envar>QTDIR</envar> is set
by the login scripts, and <envar>QMAKESPECS</envar> is not
needed because there is a <filename>default</filename> link in
<filename>mkspecs/</filename>.</para>
<para>Neither <envar>QTDIR</envar> nor
<envar>QMAKESPECS</envar> should be needed with
<application>Qt 4</application>,
configuration details are entirely determined by
<command>qmake</command> (which is quite often installed as
<command>qmake-qt4</command>).</para>
<formalpara><title>Configure options:</title> <formalpara><title>Configure options:</title>
<para> <para>
<itemizedlist> <itemizedlist>
<listitem><para><option>--without-aspell</option> <listitem><para><option>--without-aspell</option>
will disable the code for phonetic matching of search will disable the code for phonetic matching of search
terms. </para> terms. </para></listitem>
</listitem>
<listitem><para><option>--with-fam</option> or <listitem><para><option>--with-fam</option> or
<option>--with-inotify</option> will enable the code for <option>--with-inotify</option> will enable the code for
real time indexing. Inotify support is enabled by default on real time indexing. Inotify support is enabled by default on
recent Linux systems.</para> recent Linux systems.</para></listitem>
</listitem>
<listitem><para><option>--with-qtzeitgeist</option> will
enable sending <application>Zeitgeist</application>
events about the visited search results, and needs
the <application>Qt Zeitgeist</application>
module.</para></listitem>
<listitem><para><option>--disable-webkit</option> is available <listitem><para><option>--disable-webkit</option> is available
from version 1.17 to implement the result list with a from version 1.17 to implement the result list with a
<application>Qt</application> QTextBrowser instead of a <application>Qt</application> QTextBrowser instead of a
WebKit widget if you do not or can't depend on the WebKit widget if you do not or can't depend on the
latter.</para> latter.</para></listitem>
</listitem>
<listitem><para><option>--enable-xattr</option> will enable <listitem><para><option>--disable-idxthreads</option> is available
code to fetch data from file extended attributes. This is only from version 1.19 to suppress multithreading inside the
useful is some application stores data in there, and also needs indexing process. You can also use the run-time
some simple configuration (see comments in the configuration to restrict <command>recollindex</command>
<filename>fields</filename> configuration file).</para> to using a single thread, but the compile-time option
</listitem> 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.</para></listitem>
<listitem><para><option>--disable-python-module</option> will
avoid building the <application>Python</application>
module.</para></listitem>
<listitem><para><option>--disable-xattr</option> 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 <filename>fields</filename> configuration
file).</para></listitem>
<listitem><para><option>--enable-camelcase</option> will enable <listitem><para><option>--enable-camelcase</option> will enable
splitting <replaceable>camelCase</replaceable> words. This splitting <replaceable>camelCase</replaceable> words. This
is not enabled by default as it has the unfortunate is not enabled by default as it has the unfortunate
@ -4532,12 +4549,13 @@ except:
<literal>"my sql manual"</literal> but not <literal>"mysql <literal>"my sql manual"</literal> but not <literal>"mysql
manual"</literal> (only inside phrase searches).</para> manual"</literal> (only inside phrase searches).</para>
</listitem> </listitem>
<listitem><para><option>--with-file-command</option> Specify <listitem><para><option>--with-file-command</option> Specify
the version of the 'file' command to use (ie: the version of the 'file' command to use (ie:
--with-file-command=/usr/local/bin/file). Can be useful to --with-file-command=/usr/local/bin/file). Can be useful to
enable the gnu version on systems where the native one is enable the gnu version on systems where the native one is
bad.</para> bad.</para> </listitem>
</listitem>
<listitem><para><option>--disable-qtgui</option> Disable the Qt <listitem><para><option>--disable-qtgui</option> Disable the Qt
interface. Will allow building the indexer and the command line interface. Will allow building the indexer and the command line
search program in absence of a Qt environment.</para> search program in absence of a Qt environment.</para>
@ -4550,6 +4568,12 @@ except:
<application>Qt</application> and <application>Qt</application> and
<application>X11</application>.</para> </listitem> <application>X11</application>.</para> </listitem>
<listitem><para><option>--disable-pic</option> will compile
&RCL; with position-dependant code. This is incompatible with
building the KIO or the <application>Python</application>
or <application>PHP</application> extensions, but might
yield very marginally faster code.</para></listitem>
<listitem><para>Of course the usual <listitem><para>Of course the usual
<application>autoconf</application> <command>configure</command> <application>autoconf</application> <command>configure</command>
options, like <option>--prefix</option> apply.</para> options, like <option>--prefix</option> apply.</para>

20
website/features.html
View File

@ -255,18 +255,14 @@ application/x-tar = execm rcltar
</li> </li>
<li><span class="application">RTF</span> files with <a href= <li><span class="application">RTF</span> files with
"http://www.gnu.org/software/unrtf/unrtf.html">unrtf</a>. Please <a href="http://www.gnu.org/software/unrtf/unrtf.html">
note that up to version unrtf</a>. Please note that up to version 0.21.3,
0.21, <span class="command">unrtf</span> mostly does not work <span class="command">unrtf</span> mostly does not work
with non western-european character sets. If you have a need with non western-european character sets. If you have a need
for indexing, ie, russian or chinese RTF files, I have for indexing, e.g., russian or chinese RTF files, make sure
produced a modified version which works much better (as that you have 0.21.3 or newer. Unrtf is easy to build from
indicated by my tests and a few external ones). You can source.</li>
download the <a href="unrtf/unrtf-0.22.2beta.tar.gz">source
here</a>. The development is hosted
on <a href="http://www.bitbucket.org/medoc/unrtf-int">
bitbucket.org</a>.</li>
<li><span class="application">TeX</span> with <span class= <li><span class="application">TeX</span> with <span class=
"command">untex</span>. If there is no untex package for "command">untex</span>. If there is no untex package for