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

*** empty log message ***

Browse Source
This commit is contained in:
dockes 2005-10-20 12:12:39 +00:00
parent 09302bb48f
commit 69d147dcd0
2 changed files with 71 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
src/INSTALL
View File

@ -1,101 +1,89 @@
Installation instructions: * Home
========================= * Screenshots
* Downloads
* Credits
* User manual
* Installation
[IMG]
Recoll is a very young package, and installation will probably more painful Installing Recoll
than necessary, please excuse me for this until I have time to work on
it. I should probably not release this at all, except that I would like
feedback.
If you have problems, please don't renounce, ask me instead There are currently no binary packages, so you will need to build Recoll
(jean-francois.dockes@wanadoo.fr) from source before installing it.
Building from source Prerequisites
===================
Prerequisites: At the very least, you will need to download and install the xapian core
------------- package (I am currently using xapian version 0.8.5), and the qt runtime
To build from source, you need the following packages. Except if you're and development packages (I am currently using qt 3.3.3).
using a really strange system, you can probably easily find, or already
have, a precompiled version of iconv, and maybe qt.
- qt and qt-devel (www.trolltech.com). Currently using 3.3.3 You will most probably be able to find a binary package for qt for your
- xapian-core (www.xapian.org). Currently using 0.8.5 system. You may have to compile Xapian, but this is not difficult.
- libiconv (http://www.gnu.org/software/libiconv/). Currently using
1.9. On Linux it's part of the libc, you should have nothing special
to install.
Building: You also need libiconv. I am currently using version 1.9. The iconv
-------- interface is part of libc on Linux systems, you shouldn't need to do
anything there.
I have only built on Linux (redhat7.3, mandriva 2005), FreeBSD and Solaris8 External file types: recoll uses external applications to index some file
for now, if you build on another system, I would very much welcome types. You need to install them for the file types that you wish to have
comments and patches (jean-francois.dockes@wanadoo.fr). indexed:
There is no autoconf for now. You need to chose a file in the mk directory, * MS Word documents: antiword.
and link it into a file named 'sysconf' there. If your system is not * PDF files: pdftotext is part of the Xpdf package.
supported by the supplied files, it should be easy enough to build a new * Postscript files: pstotext.
one from the examples (then send it to me please).
You also need to adjust the recoll.pro file inside the qtgui directory to Building
fix the "-L/usr/local/lib -lxapian -liconv" piece, depending on where your
libs are installed. Then run 'qmake recoll.pro' in there.
Then cd to the top directory, type make, and practise your usual Recoll has been built on Linux (redhat7.3, mandriva 2005), FreeBSD and
hardship-repelling invocations. Solaris 8. If you build on another system, I would very much welcome
comments and patches.
Installation: Normal procedure:
------------
- Copy all files from sampleconf/* to ~/.recoll
- Copy all files from filters/* to ~/.recoll.
- Copy qtgui/recoll to a place in your PATH (if you want. You can also
execute it from its build directory).
Configuration * cd recoll-xxx
============= * configure
* make
* (practise your usual hardship-repelling invocations).
Recoll uses a text configuration file. There will be dialogs to build it There is no real autoconfiguration. The configure script will just link
from the GUI in the future, but you'll have to edit it by hand for now. one of the system-specific files in the mk directory to mk/sysconf. If
your system is known yet, it will tell you as much, and you may want to
manually copy and modify one of the existing files (the new file name
should be the output of uname -s).
By default, the configuration file should be named ~/.recoll/recoll.conf You may also need to adjust the recoll.pro file inside the qtgui directory
to fix the "-L/usr/local/lib -lxapian -liconv" piece, depending on where
your libs are installed. Then run 'qmake recoll.pro' in there.
There is a sample in the 'sampleconf' src/ subdirectory, you copied it to Installation
~/.recoll at the step before, take a look and possibly edit it.
Then start 'recoll', and select the "file->start indexing" menu Execute installrecoll targetdir, in the root of the source tree. This
entry. When it's done, you can play with the search will:
Usage * Copy qtgui/recoll and index/recollindex to targetdir/bin (but you
===== could also execute them from their build directories).
The very simple Gui should be easy enough to use. Clicking on a search * Check if ~/.recoll exists, and if it does not:
result entry in the left column will display it in the left * Copy all files from sampleconf/* to ~/.recoll
part. Double-clicking will start an external viewer (look at the * Copy all files from filters/* to ~/.recoll.
~/.recoll/mimeconf file to see how these are configured).
Configuration
Recoll uses text configuration files. You will have to edit them by hand
for now (all hope is not lost that there will be dialogs to build them
from the GUI in the future).
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> The main configuration file is named ~/.recoll/recoll.conf.
Future from here on, there are currently no binary packages ...
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
Installing a binary package:
----------------------------
There are no rpm or other managed packages for now. There is a commented sample in the sampleconf subdirectory, it was copied
to ~/.recoll at the previous step, take a look and possibly edit it. By
- Unpack the tar file. Will create a recoll-x.y directory default, it will index your home directory.
- Arrange to have the recoll-x.y/bin directory in your PATH, or copy/link the
'recoll' executable where it will be found.
- Copy the files from the sampleconf directory somewhere. The default
location is $HOME/.recoll/ If you choose another location, you will have
to set the RECOLL_CONFDIR environment variable.
- Possibly adjust the recoll.conf file. The default should be fine for
trying in most cases.
- Possibly adjust the mimeconf file, especially the external viewer
section, depending on what you are using (ie acrobat vs xpdf, etc...)
- Start the 'recoll' program. After displaying a dialog, it will normally
begin to index the directories specified in recoll.conf.
Then start recollindex, and wait for indexing to complete (this may take
some time). When it's done, you can start recoll and try a search
Depending on what is installed on your system, you may also want to adjust
the external viewers defined in ~/.recoll/mimeconf (ie: html is either
previewed internally or displayed using firefox, but you may prefer
mozilla...). Look for the [view] section.
jean-francois.dockes@wanadoo.fr

66
src/README
View File

@ -1,7 +1,8 @@
* Home
* Screenshots * Screenshots
* Downloads * Downloads
* Credits * Credits
* User guide * User manual
* Installation * Installation
[IMG] [IMG]
@ -24,10 +25,10 @@ Recoll
Features: Features:
* Supports the following document types: text, html, pdf (with xpdf's * Document types: text, html, pdf (with xpdf's pdftotext), postscript
pdftotext), postscript (with ghostscript's pstotext), msword (with (with ghostscript's pstotext), msword (with antiword), openoffice
antiword), openoffice files, maildir and mailbox mail folders (mozilla files, maildir and mailbox mail folders (mozilla and thunderbird mail
and thunderbird mail ok). Deals with compressed versions of same. ok). Deals with compressed versions of same.
* Relatively powerful query facilities, with boolean searches, phrases, * Relatively powerful query facilities, with boolean searches, phrases,
filter on file types and directory tree. filter on file types and directory tree.
* Support for multiple charsets. Internal processing and storage uses * Support for multiple charsets. Internal processing and storage uses
@ -47,8 +48,6 @@ Recoll
Things lacking, coming in the not too far future: Things lacking, coming in the not too far future:
* A better GUI. So many things are badly done or missing that I won't
try to list them here.
* An interactive configuration tool. You need to edit files by hand for * An interactive configuration tool. You need to edit files by hand for
now. now.
* Packages, rpm or other. It's all tar files currently. * Packages, rpm or other. It's all tar files currently.
@ -56,65 +55,12 @@ Recoll
* Documentation and help. * Documentation and help.
* A few more filters for less common file types. * A few more filters for less common file types.
Using recoll
* Use File->Index to build/rebuild the database (what to index is
defined in the configuration file, see the install doc).
* Enter search terms in the upper left text field. There is no query
language right now, the search only understand probabilistic terms
(just words...), and double-quote enclosed phrases. Click Search or
type CR
* A result list should appear in the left pane. You can use the
Next/Prev buttons to paginate.
* Clicking on an entry in the list will display a preview in the right
pane -- This can take some time for big postscript or pdf files, as
the file is converted on the fly for preview --
* Double-clicking on an entry should launch an external viewer, as
specified in the mimeconf file (see INSTALL). This doesn't work for
compressed files for now.
I very much welcome suggestions or (gasp) code I very much welcome suggestions or (gasp) code
In hope that this can be useful to somebody, it already is for me. In hope that this can be useful to somebody, it already is for me.
Downloads
Current version: 1.0 (tar.gz)
Older: 0.7
Installation
Prerequisites
At the very least, you will need to download and install the xapian core
package (I am currently using xapian version 0.8.5), and the qt runtime
and development packages (I am currently using qt 3.3.3).
You will most probably be able to find a binary package for qt for your
system. You may have to compile xapian, but this is not difficult.
You also need libiconv. I am currently using version 1.9. The iconv
interface is part of libc on Linux systems, you shouldn't need to do
anything there.
External file types: recoll uses external applications to index some file
types. You need to install them for the file types that you wish to have
indexed:
* MS Word documents: antiword.
* PDF files: pdftotext is part of the Xpdf package.
* Postscript files: pstotext.
Compiling, installing, using
See the INSTALL file.
Credits Credits
Recoll is mainly glue code, and most of the intelligent parts use code
from external projects.
Recoll borrows (steals?) heavily from the following projects. I tried to Recoll borrows (steals?) heavily from the following projects. I tried to
include the relevant copyright attributions with the code. Any omission is include the relevant copyright attributions with the code. Any omission is
unintentional and will be fixed as soon as notified. unintentional and will be fixed as soon as notified.