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-12-05 15:00:30 +00:00
parent 6b0fd3878d
commit 55df39a41b
4 changed files with 52 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
src/INSTALL
View File

@ -39,7 +39,7 @@ Installing Recoll
Recoll has been built on Linux (redhat7.3, mandriva 2005), FreeBSD and Recoll has been built on Linux (redhat7.3, mandriva 2005), FreeBSD and
Solaris 8. If you build on another system, I would very much welcome Solaris 8. If you build on another system, I would very much welcome
comments and patches. patches.
Normal procedure: Normal procedure:
@ -48,16 +48,12 @@ Installing Recoll
* make * make
* (practise your usual hardship-repelling invocations). * (practise your usual hardship-repelling invocations).
There is no real autoconfiguration. The configure script will just link There little autoconfiguration. The configure script will mainly link one
one of the system-specific files in the mk directory to mk/sysconf. If of the system-specific files in the mk directory to mk/sysconf. If your
your system is known yet, it will tell you as much, and you may want to system is not 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 manually copy and modify one of the existing files (the new file name
should be the output of uname -s). should be the output of uname -s).
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.
Using binary packages Using binary packages
The binary versions are just compressed tar files of a build tree, where The binary versions are just compressed tar files of a build tree, where
@ -77,28 +73,32 @@ Installing Recoll
Either type make install or execute recollinstall targetdir, in the root Either type make install or execute recollinstall targetdir, in the root
of the source tree. This will copy the commands to $targetdir/bin and the of the source tree. This will copy the commands to $targetdir/bin and the
sample configuration files to $targetdir/share/examples/recoll sample configuration files, scripts and other shared data to
$targetdir/share/recoll
Personal configuration Personal configuration
Either type make installme in the root of the source tree, or execute The personal configuration files and the database are kept in the .recoll
recollinstall. This will copy the configuration files to the .recoll directory in your home. If this directory does not exist when recoll or
directory in your home. recollindex are started, the directory will be created and the sample
configuration files will be copied. recoll will give you a chance to edit
the configuration file before starting indexation. recollindex will
proceed immediately.
Configuration Configuration
Recoll uses text configuration files. You will have to edit them by hand 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 for now (there is still some hope for a GUI configuration tool in the
from the GUI in the future). future).
The main configuration file is named ~/.recoll/recoll.conf. The main configuration file is named ~/.recoll/recoll.conf.
A commented sample was copied to ~/.recoll by the installation. By The default configuration will index your home directory. If this is not
default, it will index your home directory. appropriate, use recoll to copy the sample configuration, click Cancel,
and edit the configuration file before restarting the command. This will
start the initial indexation, which may take some time.
Then start recollindex, and wait for indexing to complete (this may take You are then ready to try a query, see the user manual for more detail.
some time). When it's done, you can start recoll and try a search. See the
user manual for a little more details
Depending on what is installed on your system, you may also want to adjust 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 the external viewers defined in ~/.recoll/mimeconf (ie: html is either

5
src/Makefile
View File

@ -1,4 +1,4 @@
# @(#$Id: Makefile,v 1.19 2005-11-25 08:51:47 dockes Exp $ (C) 2005 J.F.Dockes # @(#$Id: Makefile,v 1.20 2005-12-05 14:57:54 dockes Exp $ (C) 2005 J.F.Dockes
# Default values. These can be overridden on the command line ie: # Default values. These can be overridden on the command line ie:
# make prefix=/usr # make prefix=/usr
@ -46,7 +46,4 @@ distclean: clean
install: all install: all
./recollinstall ${prefix} ./recollinstall ${prefix}
installme:
./recollinstall
.PHONY: all static clean distclean install installme .PHONY: all static clean distclean install installme

29
src/README
View File

@ -117,10 +117,8 @@ Introduction: full text search.
Recoll, like most such search tools, works by remembering where terms Recoll, like most such search tools, works by remembering where terms
appear in your document files. The acquisition process is called appear in your document files. The acquisition process is called
indexation. The resulting database can be big (roughly the size of the indexation. The resulting database can be big, in practise, roughly the
original documents in practise). This used to be a big issue, but it is size of the original document set.
probably not any more, now that text documents are tiny blots among the
sea of multimedia data, especially for a personal system.
Recoll is not a document archive. It can only display data from files that Recoll is not a document archive. It can only display data from files that
still exist where they lived when they were indexed. still exist where they lived when they were indexed.
@ -130,17 +128,20 @@ Using Recoll
Indexation Indexation
By default, Recoll will index your home directory. If you want to change By default, Recoll will index your home directory. If you want to change
this, you need to edit the configuration file ($HOME/.recoll/recoll.conf). this, you need to edit the configuration file ($HOME/.recoll/recoll.conf
Follow the comments in the file to adjust the parameters. or $RECOLL_CONFDIR/recoll.conf if RECOLL_CONFDIR is set). Follow the
comments in the file to adjust the parameters.
Indexation is performed either by starting the recollindex program, or the Indexation is performed either by starting the recollindex program, or the
indexing thread inside the recoll program (use the File menu). indexing thread inside the recoll program (use the File menu).
It is best to avoid interrupting the indexation process, as this can leave It is best to avoid interrupting the indexation process, as this may
the database in a bad state. This is not a serious problem, as you then sometimes leave the database in a bad state. This is not a serious
just need to clear everything and restart the indexation. The database problem, as you then just need to clear everything and restart the
files are stored in the $RECOLL_CONFDIR/xapiandb directory, which you can indexation. The database files are normally stored in the
just delete when needed. $HOME/.recoll/xapiandb directory, which you can just delete when needed.
Alternatively, you can start recollindex -z, which will reset the database
before indexing.
Simple search Simple search
@ -148,7 +149,7 @@ Using Recoll
the top left of the window. Clicking the Search button or hitting the the top left of the window. Clicking the Search button or hitting the
Enter key will start a search. By default, this will look for documents Enter key will start a search. By default, this will look for documents
with any of the terms (the ones with more terms will get better scores). with any of the terms (the ones with more terms will get better scores).
Use the Advanced search dialog for other kinds of searches Use the Tools / Advanced search dialog for other kinds of searches
A list of results will be displayed in the main list window. Clicking on A list of results will be displayed in the main list window. Clicking on
an entry will open an internal preview window for the document. an entry will open an internal preview window for the document.
@ -159,6 +160,10 @@ Using Recoll
tool) are entered into the document history, which is remembered. You can tool) are entered into the document history, which is remembered. You can
display the history list by using the Tools / Doc History menu entry. display the history list by using the Tools / Doc History menu entry.
By default, the document list is presented in order of relevance (how well
the system estimates that the document matches the query). You can specify
a different ordering by using the Tools / Sort parameters dialog.
Search tips, shortcuts Search tips, shortcuts
Entering a capitalized word in any search field will prevent stem Entering a capitalized word in any search field will prevent stem

22
src/qtgui/main.cpp
View File

@ -1,5 +1,5 @@
#ifndef lint #ifndef lint
static char rcsid[] = "@(#$Id: main.cpp,v 1.20 2005-11-28 15:31:01 dockes Exp $ (C) 2005 J.F.Dockes"; static char rcsid[] = "@(#$Id: main.cpp,v 1.21 2005-12-05 14:57:54 dockes Exp $ (C) 2005 J.F.Dockes";
#endif #endif
#include <unistd.h> #include <unistd.h>
@ -186,12 +186,20 @@ int main( int argc, char ** argv )
if (!rcldb || !rcldb->open(dbdir, Rcl::Db::DbRO)) { if (!rcldb || !rcldb->open(dbdir, Rcl::Db::DbRO)) {
startindexing = 1; startindexing = 1;
QMessageBox::information(0, "Recoll", switch (QMessageBox::
a.translate("Main", question(0, "Recoll",
"Could not open database in ") + a.translate("Main", "Could not open database in ")+
QString(dbdir) + QString(dbdir) +
a.translate("Main", a.translate("Main",
". Starting indexation")); ".\n"
"Click Cancel if you want to edit the configuration file before indexation starts, or Ok to let it proceed."),
"Ok",
"Cancel", 0, 0, 1 )) {
case 0: // Ok
break;
case 1: // Cancel
exit(0);
}
} }
start_idxthread(rclconfig); start_idxthread(rclconfig);