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-02-08 17:35:37 +00:00
parent 86572d94fa
commit 8f376bbe37
2 changed files with 88 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/INSTALL
View File

@ -47,8 +47,8 @@ hardship-repelling invocations.
Installation:
------------
- Copy all files in src/sampleconf to ~/.recoll
- Copy all files in src/filters to ~/.recoll.
- 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 there).
@ -63,24 +63,10 @@ By default, the configuration file should be named ~/.recoll/recoll.conf
There is a sample in the 'sampleconf' src/ subdirectory, you copied it to
~/.recoll at the step before, take a look and possibly edit it.
- Then start 'recoll', and select the "file->start indexing" menu
entry. When it's done, you can play with the search
Usage:
======
- I think you will guess that query terms are to be entered in the text
field up left... There is no query language right now, the search only
understand probabilistic terms (just words...), and double-quote
enclosed phrases.
- You can turn stemming on (this only affects querying) in the
configuration file. There is quite a huge performance impact for this
right now, but it might be ok if your db is small.
- Clicking on an entry in the result list displays a preview in the right
window.
- Double-clicking will try to launch an external viewer. These are
configured inside the $HOME/.recoll/mimeconf file, please adjust to
taste.
Then start 'recoll', and select the "file->start indexing" menu
entry. When it's done, you can play with the search
Usage: see README

151
src/README
View File

@ -1,91 +1,106 @@
@(#$Id: README,v 1.5 2005-02-08 15:08:11 dockes Exp $ (C) 2004 J.F.Dockes
Back to top
Hello.
This is Recoll, a personal full text indexing system.
* Screenshots
* Downloads
* Credits
* User guide
* Installation
[IMG]
Recoll is free and copyrighted under the GPL license, see COPYING
Recoll
Recoll is still in infancy, but it is based on a very strong backend, and
it can actually be useful right now, which is why I release it so early.
Introduction
See INSTALL for compiling and installing (very much by hand for now)
This is Recoll, a personal full text indexing system.
It will become much better in the near future.
Recoll is free and copyrighted under the GPL license, see COPYING inside
the distribution. A lot of the code is imported from other packages, see
the Credits.
What it has:
Recoll is still in infancy, but it is based on a very strong backend
(Xapian), and it can actually be useful right now, which is why I release
it so early.
- Easy installation. No db, web server or exotic language necessary.
The idea is that EVERYBODY should index their files because it
makes life easier.
- Indexes text, pdf, html, postscript. Deals with compressed versions of
same.
- Support for multiple charsets. Internal processing and storage uses
Unicode UTF-8.
- An ugly GUI, qt-based, written with qt Designer.
- An indexer which runs either as a thread inside the GUI or as an
external, cron'able program.
See INSTALL inside the distribution for compiling and installing, very
much by hand for now, I hope it will become better in the near future.
What it doesn't have, but will have in the not too far future:
Features:
- A more sophisticated query interface: the current one has no boolean
capabilities, and performance problems with stemming
- A pretty GUI (see above)
- Mail folder indexing. This would be quite easy to add for single message
folders right now, more complicated for concatenated ones, I intend to
do it.
- An interactive configuration tool. You need to edit files by hand for now.
- Packages, rpm or other. It' all tar files currently.
- Documentation and help.
- A build system, autoconf et al.
- etc. etc.
* Easy installation. No database daemon, web server or exotic language
necessary. The idea is that EVERYBODY should index their files because
it makes life easier.
* Indexes text, pdf, html, postscript. Deals with compressed versions of
same.
* Support for multiple charsets. Internal processing and storage uses
Unicode UTF-8.
* An ugly GUI, qt-based, written with qt Designer.
* An indexer which runs either as a thread inside the GUI or as an
external, cron'able program.
USING:
Things lacking, coming in the not too far future:
- Enter search terms, 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.
- Use File->Index to rebuild the database.
* A more sophisticated query interface: the current one has no boolean
capabilities, and performance problems with stemming.
* A pretty GUI (see above)
* Mail folder indexing. It would be quite easy to add for single message
folders right now, more complicated for concatenated ones, I intend to
do it.
* An interactive configuration tool. You need to edit files by hand for
now.
* Packages, rpm or other. It's all tar files currently.
* A build system, autoconf et al.
* Documentation and help.
* More filters for other file types (MS, openoffice), this is coming
too, this is not hard as it will rely on external packages like the
existing filters.
I very much welcome suggestions or (gasp) code:
jean-francois.dockes@wanadoo.fr
Using recoll
Cheers,
Jean-Francois
* Use File->Index to build/rebuild the database.
* 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
DOWNLOAD:
<a href="recoll-0.5.tar.gz">Version 0.5 (tar.gz)</a>
In hope that this can be useful to somebody, it already is for me.
INSTALLATION
See the INSTALL file.
Downloads
Version 0.5 (tar.gz)
CREDITS:
Installation
Recoll is mainly a little glue code, and most of the intelligent work uses
code from external projects (xapian, estraier, unac, iconv).
See the INSTALL file.
Recoll borrows (steals?) heavily from the following projects. I tried to
include the relevant copyright attributions with the code. Any omission
is unintentional and will be fixed as soon as notified.
Credits
- Xapian (http://www.xapian.org). The database module (core) is used
unmodified, and quite a lot of code has been borrowed from Omega, the
web-based search application (ie: the html parser, plus miscellaneous
bits and ideas).
- Estraier (http://estraier.sourceforge.net/). Miscellaneous bits of codes
and ideas, especially for charset handling, and code from external
filters.
- Unac (http://www.senga.org/) for accent removal. This is a relatively small
package, not that easy to find, it has been integrated almost unmodified
in the Recoll package.
- Iconv (http://www.gnu.org/software/libiconv/), for character set
conversion.
Recoll is mainly a little glue code, and most of the intelligent work uses
code from external projects (xapian, estraier, unac, iconv).
Recoll borrows (steals?) heavily from the following projects. I tried to
include the relevant copyright attributions with the code. Any omission is
unintentional and will be fixed as soon as notified.
* Xapian: The database module (core) is used unmodified, and quite a lot
of code has been borrowed from Omega, the web-based search application
(ie: the html parser, plus miscellaneous bits and ideas).
* Estraier: Miscellaneous bits of codes and ideas, especially for
charset handling, and code from external filters.
* Unac: for accent removal. This is a relatively small package, not that
easy to find, it has been integrated almost unmodified in the Recoll
package.
* Iconv, for character set conversion.
jean-francois.dockes@wanadoo.fr