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 2012-06-01 16:11:45 +02:00
parent df91cff95f
commit 42378d05e3
6 changed files with 85 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
website/download.html
View File

@ -34,7 +34,7 @@
<h1>Recoll downloads</h1> <h1>Recoll downloads</h1>
<p> <div class="intrapage">
<table width=100%> <table width=100%>
<tbody> <tbody>
<tr> <tr>
@ -47,7 +47,7 @@
</tr> </tr>
</tbody> </tbody>
</table> </table>
</p> </div>
<h2><a>General information</a></h2> <h2><a>General information</a></h2>
@ -62,10 +62,9 @@
<p>The indexing filters for some document types may need <p>The indexing filters for some document types may need
external packages not installed on your system by default, and external packages not installed on your system by default, and
not installed automatically with Recoll: not installed automatically with Recoll: <a
<a href="usermanual/usermanual.html#RCL.INSTALL.EXTERNAL"> href="features.html#doctypes"> take a look at the list</a> and
take a look at the list</a> and decide what you need to decide what you need to install.</p>
install.</p>
<p>The Recoll term explorer tool in phonetic mode (marginally <p>The Recoll term explorer tool in phonetic mode (marginally
useful and optional) uses the <b>aspell</b> package, version useful and optional) uses the <b>aspell</b> package, version
@ -104,8 +103,9 @@
older Recoll packages and gain new file type support without older Recoll packages and gain new file type support without
destabilizing your search setup.</p> destabilizing your search setup.</p>
<p>You may be interested by the new XML filter that appeared <p>You may be interested by the new XML and TAR filters, and an
after the 1.17.2 release.</p> updated Open Office filter that appeared after the 1.17.3
release.</p>
<h2><a name="source">Source</a></h2> <h2><a name="source">Source</a></h2>
@ -224,7 +224,6 @@
<h3><a name="ubuntu">Ubuntu</a></h3> <h3><a name="ubuntu">Ubuntu</a></h3>
<blockquote>
<p>There are Personal Package Archives on launchpad.net for <p>There are Personal Package Archives on launchpad.net for
<a href="http://www.launchpad.net/~xapian-backports/+archive/xapian-1.2"> <a href="http://www.launchpad.net/~xapian-backports/+archive/xapian-1.2">
Xapian</a>, Xapian</a>,
@ -233,37 +232,14 @@
latest versions, for a set of Ubuntu series.</p> latest versions, for a set of Ubuntu series.</p>
<p>Ubuntu 10.04 (lucid) and later versions just need the Recoll <p>Ubuntu 10.04 (lucid) and later versions just need the Recoll
PPA. Older versions also needed a backport for Xapian PPA.</p>
(xapian-backports/xapian-1.2).</p>
<p>Just add the PPA to your system software sources (the <p>I am not producing packages for older versions any more,
instructions are on the PPA page or but some are still stored on Launchpad, and you'll find some
<a href="https://help.launchpad.net/Packaging/PPA/InstallingSoftware"> instructions to install them in
here</a>), and you can then use the normal package the <a href="download-1.14.html">older download page</a>.
manager to install or update Recoll.
<pre><tt>
sudo add-apt-repository ppa:recoll-backports/recoll-1.15-on
</tt></pre>
</p> </p>
<p>Only for Ubuntu versions before 9.10 (Karmic):
<pre><tt>
sudo add-apt-repository ppa:recoll-backports/recoll-1.15-on
sudo add-apt-repository ppa:xapian-backports/xapian-1.2
</tt></pre>
</p>
<p>For Ubuntu 9.04 (Jaunty) and older, you may also have to
explicitely import the Recoll and Xapian public keys:
<pre><tt>
gpg --keyserver keyserver.ubuntu.com --recv 9DA85604
gpg --export --armor 9DA85604 | sudo apt-key add -
gpg --keyserver keyserver.ubuntu.com --recv A0735AD0
gpg --export --armor A0735AD0 | sudo apt-key add -
</tt></pre>
</p>
</blockquote>
<h3>RPMS</h3> <h3>RPMS</h3>
@ -278,25 +254,6 @@ gpg --export --armor A0735AD0 | sudo apt-key add -
repositories starting from F-12. The new versions are tracked quite repositories starting from F-12. The new versions are tracked quite
closely, so I don't build the rpms any more (email me if you need closely, so I don't build the rpms any more (email me if you need
one).</p> one).</p>
<!--
<blockquote>
<p>These builds depend on the
regular Xapian and zlib rpms from the Fedora repositories.
<br>Fedora 14
<a href="fc14/recoll-1.16.1-1.fc14.i586.rpm">
recoll-1.16.1-1.fc14.i586.rpm</a>.
Source:
<a href="fc14/recoll-1.16.1-1.fc14.src.rpm">
recoll-1.16.1-1.fc14.src.rpm</a>
<br>Fedora 15
<a href="fc15/recoll-1.16.1-1.fc15.i586.rpm">
recoll-1.16.1-1.fc15.i586.rpm</a>.
Source:
<a href="fc15/recoll-1.16.1-1.fc15.src.rpm">
recoll-1.16.1-1.fc15.src.rpm</a>
</p>
</blockquote>
-->
<h3>OpenSUSE</h3> <h3>OpenSUSE</h3>
<blockquote> <blockquote>
@ -333,30 +290,6 @@ I now use the OpenSUSE build service to create Recoll OpenSUSE packages.
</p> </p>
</blockquote> </blockquote>
<h2><a name="otherbinary">Binary bundles</a></h2>
<p><i>There are currently no more binary bundles. Section kept as
placeholder</i>.</p>
<p>These are just prebuilt trees (without the source files).
Xapian is statically linked. They still depend on Qt. For
Solaris, you should be able to find a Qt package on
<a href="http://www.sunfreeware.com/">sunfreeware</a>.</p>
<p><a href="usermanual/rcl.install.html">Installation
instructions here</a>.</p>
<h3>Solaris</h3>
<blockquote>
<p>I did not test building the GUI on Solaris for this version. You
will need at least Qt 4.4. The old hints
in <a href="download-1.14.html">the previous page</a> may
still be valid.</p>
<p>Someone did test the indexer and Python module build, they
do work, with a few minor glitches. Be sure to use
GNU <b>make</b> and <b>install</b>.</p>
</blockquote>
<h2><a name="ports">Ports</a></h2> <h2><a name="ports">Ports</a></h2>
<h3>Mac port</h3> <h3>Mac port</h3>
@ -374,6 +307,15 @@ I now use the OpenSUSE build service to create Recoll OpenSUSE packages.
<p>Recoll is then available from the command line and as an icon in <p>Recoll is then available from the command line and as an icon in
the usual MacPorts applications place.</p> the usual MacPorts applications place.</p>
<h2>Building on Solaris</h2>
<p>I did not test building the GUI on Solaris for this version. You
will need at least Qt 4.4. The old hints
in <a href="download-1.14.html">the previous page</a> may
still be valid.</p>
<p>Someone did test the indexer and Python module build, they
do work, with a few minor glitches. Be sure to use
GNU <b>make</b> and <b>install</b>.</p>
<h2><a name="translations">Translations</a></h2> <h2><a name="translations">Translations</a></h2>
<p>Most of the translations for 1.17 are incomplete <p>Most of the translations for 1.17 are incomplete

22
website/features.html
View File

@ -35,8 +35,9 @@
</div> </div>
<div class="content"> <div class="content">
<h1 class="intro">Recoll features</h1> <h1>Recoll features</h1>
<div class="intrapage">
<table width=100%> <table width=100%>
<tbody> <tbody>
<tr> <tr>
@ -48,13 +49,16 @@
</tr> </tr>
</tbody> </tbody>
</table> </table>
</div>
<h2><a name="general">General features</a></h2>
<ul> <ul>
<li>Easy installation, few dependancies. No database daemon, <li>Easy installation, few dependancies. No database daemon,
web server, desktop environment or exotic language necessary.</li> web server, desktop environment or exotic language necessary.</li>
<li>Will run on most Unix-based <a href="features.html#systems"> <li>Will run on most Unix-based <a href="features.html#systems">
systems</a></li> systems</a></li>
<li>Qt 4 GUI, plus command line, KIO and krunner interfaces.</li> <li>Qt 4 GUI, plus command line, Unity Lens, KIO and krunner
interfaces.</li>
<li>Searches most common <li>Searches most common
<a href="features.html#doctypes">document types</a>, emails and <a href="features.html#doctypes">document types</a>, emails and
@ -77,7 +81,7 @@
<h2><a name="systems">Supported systems</a></h2> <h2><a name="systems">Supported systems</a></h2>
<p><span class="application">Recoll</span> has been compiled and <p><span class="application">Recoll</span> has been compiled and
tested on Linux, Darwin and Solaris (initial versions Redhat 7, tested on Linux, MacOS X and Solaris (initial versions Redhat 7,
Fedora Core 5, Suse 10, Gentoo, Debian 3.1, Solaris 8). It Fedora Core 5, Suse 10, Gentoo, Debian 3.1, Solaris 8). It
should compile and run on all subsequent releases of these should compile and run on all subsequent releases of these
systems and probably a few others too.</p> systems and probably a few others too.</p>
@ -86,12 +90,12 @@
<h2><a name="doctypes">Document types</a></h2> <h2><a name="doctypes">Document types</a></h2>
<p>Recoll can index many document types (along with their <p><span class="application">Recoll</span> can index many document
compressed versions). Some types are handled internally (no types (along with their compressed versions). Some types are
external application needed). Other types need a separate handled internally (no external application needed). Other types
application to be installed to extract the text. Types that need a separate application to be installed to extract the
only need very common utilities (awk/sed/groff/Python etc.) text. Types that only need very common utilities
are listed in the native section.</p> (awk/sed/groff/Python etc.) are listed in the native section.</p>
<h4>File types indexed natively</h4> <h4>File types indexed natively</h4>

8
website/filters/filters.html
View File

@ -75,6 +75,14 @@
should upgrade.</p> should upgrade.</p>
</blockquote> </blockquote>
<h2>Updated Open Document filter</h2>
<p>The <a href="rclsoff">new filter</a> will correctly handle
exported Google Docs
documents and also Open/LibreOffice ones in some cases. The
previous filters concatenated all the text inside the exported
Google docs without any spacing...</p>
<h2>TAR archives</h2> <h2>TAR archives</h2>
<p>New <a href="rcltar">rcltar</a> filter for tar archives. The <p>New <a href="rcltar">rcltar</a> filter for tar archives. The

55
website/index.html.en
View File

@ -1,15 +1,17 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<title>RECOLL: a personal text search system for Unix/Linux</title> <title>Recoll text search finds your documents</title>
<meta name="generator" content="HTML Tidy, see www.w3.org"> <meta name="generator" content="HTML Tidy, see www.w3.org">
<meta name="Author" content="Jean-Francois Dockes"> <meta name="Author" content="Jean-Francois Dockes">
<meta name="Description" content="Recoll is a personal desktop full text search application for Unix, Linux and Mac OS X, based on the Xapian search engine library."> <meta name="Description" content="Recoll is a desktop text search application for Unix, Linux and Mac OS X, based on the Xapian search engine library.">
<meta name="Keywords" content="full text search,fulltext,full text,search,desktop search,unix,linux,open source,free"> <meta name="Keywords" content="text search, full-text search, desktop search,open source,free">
<meta http-equiv="Content-language" content="en"> <meta http-equiv="Content-language" content="en">
<meta http-equiv="content-type" content="text/html; charset=utf-8"> <meta http-equiv="content-type" content="text/html; charset=utf-8">
<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() { var s = document.createElement('script'); s.type = 'text/javascript'; s.async = true; s.src = ('https:' == document.location.protocol ? 'https://' : 'http://' )+'s3.amazonaws.com/actionside-project/AS-2312575.js'; var x = document.getElementsByTagName('script')[0]; x.parentNode.insertBefore(s, x); })();</script>
</head> </head>
<body> <body>
@ -34,30 +36,45 @@
<div class="content"> <div class="content">
<h1><a href="http://www.recoll.org/">Recoll</a> is <h1><a href="http://www.recoll.org/">Recoll</a> is
a personal full text search tool for Unix/Linux.</h1> a text search tool for Unix and Linux desktops.</h1>
<p>It is based on the very strong <a href= <p><span class="application">Recoll</span> finds keywords
"http://www.xapian.org">Xapian</a> search engine library, for inside documents as well as file names.</p>
which it provides a powerful text extraction layer and a <ul>
complete, yet easy to use, Qt graphical interface.</p> <li>It can search
any <a href="features.html#doctypes">document format</a>.</li>
<p><span class="application">Recoll</span> is free, open source, <li>It can reach any storage place: files,
and licensed under the GPL. The current version is archive members, email attachments, transparently
handling decompression.</li>
<li>One click will open the document inside a native editor or
display an even quicker text preview.</li>
<li>The software is free, open source,
and licensed under the GPL.</li>
<li><a href="features.html">Detailed features</a>.
</ul>
<p>The current <span class="application">Recoll</span> version is
<a href="download.html">1.17.3</a> <a href="download.html">1.17.3</a>
(<a href="release-1.17.html">Release notes</a>).</p> (<a href="release-1.17.html">Release notes</a>).</p>
<p class="remark">Recoll will index an <b>MS-Word</b> document stored as <p><span class="application">Recoll</span> is based on the very
an <b>attachment</b> to an <b>e-mail message</b> inside strong <a href="http://www.xapian.org">Xapian</a> search
engine library, for which it provides a powerful text
extraction layer and a complete, yet easy to use, Qt graphical
interface.</p>
<p class="remark">Recoll will index an <b>MS-Word</b> document
stored as an <b>attachment</b> to an <b>e-mail message</b> inside
a <b>Thunderbird folder</b> archived in a <b>Zip file</b> a <b>Thunderbird folder</b> archived in a <b>Zip file</b>
(and more...). It will also help you search for it with a (and more...). It will also help you search for it with a
friendly and powerful interface, and let you open a copy of the file friendly and powerful interface, and let you open a copy of
without much fuss. There is little that will remain hidden on the file with a single mouse click. There is little that
your disk. will remain hidden on your disk.
<a class="important" href="features.html">More details &hellip;</a></p> <a class="important" href="features.html">More details &hellip;</a></p>
<p>If you have problems with <p>If you have problems with Recoll, <a href="doc.html">
Recoll, <a href="doc.html">documentation</a> documentation</a> and <a href="support.html">
and <a href="support.html">support</a> are available.</p> support</a> are available.</p>
<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

2
website/perfs.html
View File

@ -30,7 +30,7 @@
<div class="content"> <div class="content">
<h1 class="intro">Recoll: Indexing performance and index sizes</h1> <h1>Recoll: Indexing performance and index sizes</h1>
<p>The time needed to index a given set of documents, and the <p>The time needed to index a given set of documents, and the
resulting index size depend of many factors, such as file size resulting index size depend of many factors, such as file size

5
website/styles/style.css
View File

@ -107,3 +107,8 @@ a.weak {
} }
table { empty-cells:show; } table { empty-cells:show; }
div.intrapage {
background: #ccccff;
padding-left: 2em;
margin-left: -2em;
}