yetangitu/recoll
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

doc

Browse source
This commit is contained in:
Jean-Francois Dockes 2013-08-11 20:54:50 +02:00
parent c75223d026
commit a99ee9d40f
7 changed files with 135 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/doc/user/usermanual.sgml
View file

@ -4649,8 +4649,21 @@ except:
to manually copy and modify one of the existing files (the new to manually copy and modify one of the existing files (the new
file name should be the output of <command>uname</command> file name should be the output of <command>uname</command>
<option>-s</option>).</para> <option>-s</option>).</para>
<sect3 id="RCL.INSTALL.BUILDING.BUILD.SOLARIS">
<title>Building on Solaris</title>
</sect2> <para>We did not test building the GUI on Solaris for recent
versions. You will need at least Qt 4.4. There are some hints
on <ulink url="http://www.recoll.org/download-1.14.html">an old
web site page</ulink>, they may still be valid.</para>
<para>Someone did test the 1.19 indexer and Python module build,
they do work, with a few minor glitches. Be sure to use
GNU <command>make</command> and <command>install</command>.</para>
</sect3>
</sect2>
<sect2 id="RCL.INSTALL.BUILDING.INSTALL"> <sect2 id="RCL.INSTALL.BUILDING.INSTALL">
<title>Installation</title> <title>Installation</title>
@ -5293,7 +5306,7 @@ metadatacmds = ; tags = tmsu tags %f; otherfield = somecmd -xx %f
stage. In practise, deep queues have not been shown to stage. In practise, deep queues have not been shown to
increase performance. A value of 0 for the first queue increase performance. A value of 0 for the first queue
tells &RCL; to perform autoconfiguration (no need for tells &RCL; to perform autoconfiguration (no need for
the two other values in this case)- this is the the two other values in this case) - this is the
default configuration.</para> default configuration.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -5335,6 +5348,14 @@ thrTCounts = 4 2 1
<programlisting> <programlisting>
thrQSizes = 2 -1 -1 thrQSizes = 2 -1 -1
thrTCounts = 6 1 1 thrTCounts = 6 1 1
</programlisting>
</para>
<para>The following example would disable
multithreading. Indexing will be performed by a single
thread.
<programlisting>
thrQSizes = -1 -1 -1
</programlisting> </programlisting>
</para> </para>

2
website/CHANGES.html
View file

@ -71,7 +71,7 @@
bugs. Release 1.14.2 fixes the help browser which was broken bugs. Release 1.14.2 fixes the help browser which was broken
by 1.14.2. Sigh ...</p> by 1.14.2. Sigh ...</p>
<ul> <ul>
<li><a href="usermanual/rcl.search.lang.html"> <li><a href="usermanual/RCL.SEARCH.LANG.html">
date selection in queries</a>.</li> date selection in queries</a>.</li>
<li>Pure negative queries (ie: <i>-someterm date:P10D/</i>.</li> <li>Pure negative queries (ie: <i>-someterm date:P10D/</i>.</li>
<li>Autosuffs: option to automatically turn words into <tt>ext:</tt> <li>Autosuffs: option to automatically turn words into <tt>ext:</tt>

2
website/custom.html
View file

@ -88,7 +88,7 @@ a:hover .PZ3cap { padding:3px 5px; }
"almost full" support for HTML capabilities, with a few "almost full" support for HTML capabilities, with a few
restrictions due to the Qt QTextBrowser object. The details restrictions due to the Qt QTextBrowser object. The details
are described in the are described in the
<a href="http://www.recoll.org/usermanual/rcl.search.html#RCL.SEARCH.GUI.CUSTOM.RESLIST"> <a href="http://www.recoll.org/usermanual/RCL.SEARCH.html#RCL.SEARCH.GUI.CUSTOM.RESLIST">
Recoll manual</a>.</p> Recoll manual</a>.</p>
<p>As of Recoll 1.17, the result list is a WebKit object by <p>As of Recoll 1.17, the result list is a WebKit object by

159
website/download.html
View file

@ -10,6 +10,19 @@
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> <meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
<meta name="robots" content="All,Index,Follow"> <meta name="robots" content="All,Index,Follow">
<link type="text/css" rel="stylesheet" href="styles/style.css"> <link type="text/css" rel="stylesheet" href="styles/style.css">
<script type="text/javascript">
function showdiv(viewid)
{
var ids = ["general", "bugs", "source", "packages", "ports", "filters",
"translations"];
for (var i = 0; i < ids.length; i++) {
document.getElementById(ids[i]).style.display = "none";
}
document.getElementById(viewid).style.display = "block";
}
</script>
</head> </head>
<body> <body>
@ -19,7 +32,7 @@
<li><a href="index.html">Home</a></li> <li><a href="index.html">Home</a></li>
<li><b>Downloads</b></li> <li><b>Downloads</b></li>
<li><a href="doc.html">Documentation</a></li> <li><a href="doc.html">Documentation</a></li>
<li><a href="usermanual/rcl.install.html">Installation</a></li> <li><a href="usermanual/RCL.INSTALL.html">Installation</a></li>
<li><a href="index.html#support">Support</a></li> <li><a href="index.html#support">Support</a></li>
</ul> </ul>
</div> </div>
@ -32,18 +45,27 @@
<table width="100%"> <table width="100%">
<tbody> <tbody>
<tr> <tr>
<td><a href="#source">Source</a></td> <td><a href="#general" onmouseover="showdiv('general')">
<td><a href="#packages">Packages (.rpm and .deb)</a></td> General</a></td>
<td><a href="BUGS.html">Known bugs</a></td> <td><a href="#source" onmouseover="showdiv('source')">
<td><a href="#ports">Mac ports</a></td> Source</a></td>
<td><a href="filters/filters.html">Filters</a> </td> <td><a href="#packages" onmouseover="showdiv('packages')">
<td><a href="#translations">Translations</a></td> Packages (.rpm and .deb)</a></td>
<td><a href="BUGS.html" onmouseover="showdiv('bugs')">
Known bugs</a></td>
<td><a href="#ports" onmouseover="showdiv('ports')">
Mac ports</a></td>
<td><a href="filters/filters.html" onmouseover="showdiv('filters')">
Updated Filters</a></td>
<td><a href="#translations" onmouseover="showdiv('translations')">
Translations</a></td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</div> </div>
<h2><a>General information</a></h2> <div id="general">
<h2><a name="general">General information</a></h2>
<p>The current version is 1.19.5. <a href="release-1.19.html">Release <p>The current version is 1.19.5. <a href="release-1.19.html">Release
notes</a>.</p> notes</a>.</p>
@ -51,16 +73,13 @@ notes</a>.</p>
<p>The download page for Recoll 1.18 is <a href="download-1.18.html">still <p>The download page for Recoll 1.18 is <a href="download-1.18.html">still
available</a>.</p> available</a>.</p>
<p>Recoll <a href="usermanual/rcl.install.html">Installation / building <p>Recoll <a href="usermanual/RCL.INSTALL.html">Installation / building
manual</a>.</p> manual</a>.</p>
<p>The indexing filters used for some document types may need external packages <p>The indexing filters used for some document types may need external
not installed on your system by default, and not installed automatically with packages not installed on your system by default, and not installed
Recoll: <a href="features.html#doctypes">take a look at the list</a> and decide automatically with Recoll: <a href="features.html#doctypes">take a
what you need to install. Also <a href="filters/filters.html">new or updated look at the list</a> and decide what you need to install.</p>
filters</a> sometimes become available after a release. As a rule, all filters
are compatible with all Recoll versions. Any compatibility problem will be
explicitely mentionned.</p>
<p>The Recoll term explorer tool in phonetic mode (marginally useful and <p>The Recoll term explorer tool in phonetic mode (marginally useful and
optional) uses the <b>aspell</b> package, version 0.60 (utf-8 support) or optional) uses the <b>aspell</b> package, version 0.60 (utf-8 support) or
@ -84,7 +103,18 @@ to X.Y.Z+u should in general involve little risk of regression. But,
<em>any</em> change can bring problems, if you are not affected by the <em>any</em> change can bring problems, if you are not affected by the
corrected bugs (check the <a href="release-1.19.html">release file</a>), there corrected bugs (check the <a href="release-1.19.html">release file</a>), there
is probably no necessity to upgrade anyway.</p> is probably no necessity to upgrade anyway.</p>
</div>
<div id="bugs">
<h2><a name="bugs">Known bugs</a></h2>
<p>There is a <a href="BUGS.html">history of known bugs</a>, sorted
by fix release. Also see
the <a href="https://bitbucket.org/medoc/recoll/issues">
issue tracker on Bitbucket</a>.
</p>
</div>
<div id="source">
<h2><a name="source">Source</a></h2> <h2><a name="source">Source</a></h2>
<h3>Current release distribution: 1.19.5:</h3> <h3>Current release distribution: 1.19.5:</h3>
@ -142,14 +172,19 @@ current <a href="release-1.16.html">1.16 release notes</a>).
trunk is usually a bit on the bleeding edge, but there is always a maintenance trunk is usually a bit on the bleeding edge, but there is always a maintenance
branch for the current production version.</p> branch for the current production version.</p>
<h3>Instructions for building</h3>
<p>Normally, it's just <tt>configure; make; make install</tt>. If a bit
more detail is needed,
<a href="http://www.recoll.org/usermanual/RCL.INSTALL.BUILDING.html">
there is some in the manual</a>.
<h3>Older recoll releases:</h3> <h3>Older recoll releases:</h3>
<p> <p>
<a href="recoll-1.19.4.tar.gz">1.19.4</a>. <a href="recoll-1.19.4.tar.gz">1.19.4</a>.
<a href="recoll-1.19.3.tar.gz">1.19.3</a>. <a href="recoll-1.19.3.tar.gz">1.19.3</a>.
<a href="recoll-1.19.2.tar.gz">1.19.2</a>. <a href="recoll-1.19.2.tar.gz">1.19.2</a>.
<a href="recoll-1.19.1.tar.gz">1.19.1</a>.
<a href="recoll-1.19.0.tar.gz">1.19.0</a>.
<a href="recoll-1.18.2.tar.gz">1.18.2</a>. <a href="recoll-1.18.2.tar.gz">1.18.2</a>.
<a href="recoll-1.17.3.tar.gz">1.17.3</a>. <a href="recoll-1.17.3.tar.gz">1.17.3</a>.
<a href="recoll-1.16.2.tar.gz">1.16.2</a>. <a href="recoll-1.16.2.tar.gz">1.16.2</a>.
@ -157,20 +192,25 @@ branch for the current production version.</p>
<a href="recoll-1.14.4.tar.gz">1.14.4</a>. <a href="recoll-1.14.4.tar.gz">1.14.4</a>.
<a href="recoll-1.13.04.tar.gz">1.13.04</a>. <a href="recoll-1.13.04.tar.gz">1.13.04</a>.
</p> </p>
</div>
<div id="packages">
<h2><a name="packages">Packages</a></h2> <h2><a name="packages">Packages</a></h2>
<p>Packages or ports for Recoll are available in the standard repositories for <p>Packages or ports for Recoll are available in the standard repositories for
many distributions.</p> many distributions.</p>
<p>However they are often a bit older or built with older Xapian releases. Here <p>However they are often a bit older or built with older Xapian releases. Here
follow a number of updated packages and instructions for a number of follow some pointers to find newer packages for some
distributions.</p> distributions. In most cases, you will just need to use an
alternate repository.</p>
<p>All binary packages on this page need a Qt 4 (4.4 at least) runtime <p>I sometimes build binary packages when no appropriate repository
environment. To make things easier, on systems where Xapian is not available exists. Any binary package directly linked from this page need a Qt
from the standard package repositories, the Recoll package will have a static 4 (4.4 at least) runtime environment. To make things easier, on
link to Xapian so that you do not need to build/install it separately.</p> systems where Xapian is not available from the standard package
repositories, the Recoll package will have a static link to Xapian
so that you do not need to build/install it separately.</p>
<h3><a name="debian">Debian</a></h3> <h3><a name="debian">Debian</a></h3>
@ -202,8 +242,8 @@ in the sense that the Python extension is included in the PPA package, but it's
a separate package in the standard repository. This can give rise to errors a separate package in the standard repository. This can give rise to errors
about overwriting the Python module when switching between versions. Typically, about overwriting the Python module when switching between versions. Typically,
the error message would be like the following:</p> the error message would be like the following:</p>
<pre><tt> <pre><tt>ErrorMessage: trying to overwrite '/usr/lib/python2.7/dist-packages/recoll.so',
ErrorMessage: trying to overwrite '/usr/lib/python2.7/dist-packages/recoll.so', which is also in package recoll 1.18.1-1~ppa1~quantal1</tt></pre> which is also in package recoll 1.18.1-1~ppa1~quantal1</tt></pre>
<p>If this happens, you just need to delete the previous package(s) before <p>If this happens, you just need to delete the previous package(s) before
installing the other one(s) instead of performing an upgrade.</p> installing the other one(s) instead of performing an upgrade.</p>
@ -239,23 +279,22 @@ more (email me if you need one).</p>
<h3>OpenSUSE</h3> <h3>OpenSUSE</h3>
<blockquote> <p>Recoll is in the KDE:Extra repository
<p>Recoll is in the KDE:Extra repository <!-- I now use the OpenSUSE build service to create Recoll <!-- I now use the OpenSUSE build service to create Recoll OpenSUSE packages. -->
OpenSUSE packages. -->You just need to add the repository to your software You just need to add the repository to your software
sources (Yast2-&gt;software-&gt;Software repositories).<br> sources (Yast2-&gt;software-&gt;Software repositories).<br>
<a href="http://download.opensuse.org/repositories/KDE:/Extra/">Repository <a href="http://download.opensuse.org/repositories/KDE:/Extra/">Repository
list (supported Suse versions)</a>. After adding the appropriate repository list (supported Suse versions)</a>. After adding the appropriate
to your software sources, you will be able to install recoll and kio_recoll repository to your software sources, you will be able to install
from the software management interface. The Xapian dependancy will also be recoll and kio_recoll from the software management interface. The
satisfied from the build service repository. Some of the older repositories Xapian dependancy will also be satisfied from the build service
do not build antiword, just tell the software manager to "break" recoll by repository. Some of the older repositories do not build antiword,
installing anyway, and get antiword somewhere else.</p> just tell the software manager to "break" recoll by installing
</blockquote> anyway, and get antiword somewhere else.</p>
<h3>Mageia</h3> <h3>Mageia</h3>
<blockquote> <p>Mageia version 2: <a
<p>Mageia version 2: <a
href="mageia2/recoll-1.18.1-1.mga2.i586.rpm">mageia2/recoll-1.18.1-1.mga2.i586.rpm, href="mageia2/recoll-1.18.1-1.mga2.i586.rpm">mageia2/recoll-1.18.1-1.mga2.i586.rpm,
</a><a </a><a
href="mageia2/recoll-debug-1.18.1-1.mga2.i586.rpm">recoll-debug-1.18.1-1.mga2.i586.rpm</a>. href="mageia2/recoll-debug-1.18.1-1.mga2.i586.rpm">recoll-debug-1.18.1-1.mga2.i586.rpm</a>.
@ -263,8 +302,10 @@ more (email me if you need one).</p>
Source: <a Source: <a
href="mageia2/recoll-1.18.1-1.mga2.src.rpm">recoll-1.18.1-1.mga2.src.rpm</a> href="mageia2/recoll-1.18.1-1.mga2.src.rpm">recoll-1.18.1-1.mga2.src.rpm</a>
</p> </p>
</blockquote>
</div> <!-- Packages -->
<div id="ports">
<h2><a name="ports">Ports</a></h2> <h2><a name="ports">Ports</a></h2>
<h3>Mac port</h3> <h3>Mac port</h3>
@ -282,16 +323,17 @@ poppler than recoll itself).</p>
<p>Recoll is then available from the command line and as an icon in the usual <p>Recoll is then available from the command line and as an icon in the usual
MacPorts applications place.</p> MacPorts applications place.</p>
</div>
<h2>Building on Solaris</h2> <div id="filters">
<h2><a name="filters">Updated filters</a></h2>
<p>I did not test building the GUI on Solaris for this version. You will need <p><a href="filters/filters.html">new or updated filters</a>
at least Qt 4.4. The old hints in <a href="download-1.14.html">the previous sometimes become available after a release. As a rule, all
page</a> may still be valid.</p> filters are compatible with all Recoll versions. Any
compatibility problem will be explicitely mentionned.</p>
<p>Someone did test the indexer and Python module build, they do work, with a </div>
few minor glitches. Be sure to use GNU <b>make</b> and <b>install</b>.</p>
<div id="translations">
<h2><a name="translations">Translations</a></h2> <h2><a name="translations">Translations</a></h2>
<p>Most of the translations for 1.19 are incomplete The source translation <p>Most of the translations for 1.19 are incomplete The source translation
@ -308,11 +350,18 @@ copied to <span class="filename">/usr/[local/]share/recoll/translations</span>
<p><a href="translations/recoll_xx.ts">recoll_xx.ts</a> is a blank Recoll 1.19 <p><a href="translations/recoll_xx.ts">recoll_xx.ts</a> is a blank Recoll 1.19
message file, handy to work on a new translation.</p> message file, handy to work on a new translation.</p>
<!--
<h3>Updated 1.18 translations that became available after the <h3>Updated 1.19 translations that became available after the
release:</h3> release:</h3>
<p>A Czech translation for 1.18, thanks to Pavel <p>German translation, thanks to Jonatan
<a href="translations/recoll_de.ts">recoll_de.ts</a>
<a href="translations/recoll_de.qm">recoll_de.qm</a>
</p>
<!--
<p>A Czech translation for 1.18, thanks to Jonatan
<a href="translations/recoll_cs.ts">recoll_cs.ts</a> <a href="translations/recoll_cs.ts">recoll_cs.ts</a>
<a href="translations/recoll_cs.qm">recoll_cs.qm</a> <a href="translations/recoll_cs.qm">recoll_cs.qm</a>
</p> </p>
@ -325,6 +374,10 @@ release:</h3>
<p>Note that, if you are running an older release, you may find updated <p>Note that, if you are running an older release, you may find updated
messages by looking inside the appropriate maintenance branch on <a messages by looking inside the appropriate maintenance branch on <a
href="https://bitbucket.org/medoc/recoll/src">bitbucket</a>.</p> href="https://bitbucket.org/medoc/recoll/src">bitbucket</a>.</p>
</div>
</div> <!-- translations -->
</div> <!-- content -->
</body> </body>
</html> </html>

2
website/features.html
View file

@ -368,7 +368,7 @@ application/x-tar = execm rcltar
Web UI</a> lets you query a Recoll index from a web browser</li> Web UI</a> lets you query a Recoll index from a web browser</li>
</ul> </ul>
<p>Recoll also has <p>Recoll also has
<a href="usermanual/rcl.program.api.html#RCL.PROGRAM.API.PYTHON"> <a href="usermanual/RCL.PROGRAM.API.html#RCL.PROGRAM.API.PYTHON">
<span class="application">Python</span></a> and <span class="application">Python</span></a> and
<span class="application">PHP</span> modules which can allow <span class="application">PHP</span> modules which can allow
easy integration with web or other applications.</p> easy integration with web or other applications.</p>

2
website/index.html.en
View file

@ -77,7 +77,7 @@
<p><b><i>Recoll user ?</i></b> Maybe there are still a few useful <p><b><i>Recoll user ?</i></b> Maybe there are still a few useful
search tricks that you don't know about. A quick look at search tricks that you don't know about. A quick look at
the <a href="usermanual/rcl.search.html#RCL.SEARCH.GUI.TIPS">search the <a href="usermanual/RCL.SEARCH.html#RCL.SEARCH.GUI.TIPS">search
tips</a> might prove useful ! Also the tips</a> might prove useful ! Also the
<a href="http://bitbucket.org/medoc/recoll/wiki/FaqsAndHowTos"> <a href="http://bitbucket.org/medoc/recoll/wiki/FaqsAndHowTos">
Faqs and Howtos</a> on bitbucket.org, and some contributed Faqs and Howtos</a> on bitbucket.org, and some contributed

4
website/styles/style.css
View file

@ -1,6 +1,6 @@
/*--General-----------------------------------------------*/ /*--General-----------------------------------------------*/
html { html {
margin 0; margin: 0;
} }
body { body {
position: relative; position: relative;
@ -110,6 +110,6 @@ a.weak {
table { empty-cells:show; } table { empty-cells:show; }
div.intrapage { div.intrapage {
background: #ccccff; background: #ccccff;
padding-left: 2em; padding-left: 1em;
margin-left: -2em; margin-left: -2em;
} }