diff --git a/src/doc/man/recoll.conf.5 b/src/doc/man/recoll.conf.5 index 0a070a03..2d8bc6ee 100644 --- a/src/doc/man/recoll.conf.5 +++ b/src/doc/man/recoll.conf.5 @@ -1,12 +1,16 @@ -.\" $Id: recoll.conf.5,v 1.1 2006-01-10 09:10:51 dockes Exp $ (C) 2005 J.F.Dockes\$ +.\" $Id: recoll.conf.5,v 1.2 2006-03-28 12:49:03 dockes Exp $ (C) 2005 J.F.Dockes\$ .TH RECOLL.CONF 5 "8 January 2006" .SH NAME recoll.conf \- main personal configuration file for Recoll .SH DESCRIPTION -This file, by default -.IR $HOME/.recoll/recoll.conf , -defines the indexation configuration for the full-text search system -Recoll. +This file defines the indexation configuration for the full-text search +system Recoll. +.LP +The system-wide configuration file is normally located inside +/usr/[local]/share/recoll/examples. Any parameter set in the common file +may be overriden by setting it in the personal configuration file, by default: +.IR $HOME/.recoll/recoll.conf + .LP A short extract of the file might look as follows: .IP @@ -98,6 +102,13 @@ Try to guess the character set of files if no internal value is available (ie: for plain text files). This does not work well in general, and should probably not be used. .TP +.BI "indexallfilenames = " boolean +Recoll indexes file names into a special section of the database to allow +specific file names searches using wild cards. This parameter decides if +file name indexing is performed only for files with mime types that would +qualify them for full text indexation, or for all files inside +the selected subtrees, independant of mime type. +.TP .BI "usesystemfilecommand = " boolean Decide if we use the .B "file -i" diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 19aac1f6..b52807b9 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -24,7 +24,7 @@ Dockes - $Id: usermanual.sgml,v 1.6 2006-03-04 10:09:59 dockes Exp $ + $Id: usermanual.sgml,v 1.7 2006-03-28 12:49:03 dockes Exp $ This document introduces full text search notions @@ -53,7 +53,8 @@ restrict the indexed area. Also be aware that you will need to install the - appropriate supporting applications for document types that need + appropriate + supporting applications for document types that need them (for example antiword for ms-word files), and that the default character set used to read raw text files for indexing is iso8859-1, which may not be @@ -76,7 +77,7 @@ terms, and the tool will return a list of documents where those terms are prominent. - This mode of operation has been made very familiar by www + This mode of operation has been made very familiar by internet search engines. The notion of relevance is a difficult one, as only you, the @@ -134,18 +135,23 @@ language, without reindexing. Storing documents in different languages in the same database is possible, and useful in practice, but does introduce possibilities of confusion. &RCL; - makes no attempt at automatic language recognition. + currently makes no attempt at automatic language recognition. &RCL; has many parameters which define exactly what to index, and how to classify and decode the source documents. These are kept in a configuration file. A - sample configuration is installed into the + default configuration is copied into a standard location + (usually something like + /usr/[local/]share/recoll/examples) + during installation. The default parameters from this file may + be overriden by values that you set inside your personal + configuration, found by default in the .recoll subdirectory of your home - directory when you first execute a &RCL; command. The initial - configuration will index your home directory with default - parameters and should be sufficient for giving &RCL; a try, - but you may want to adjust it later. + directory. The default configuration will index your home + directory with default parameters and should be sufficient for + giving &RCL; a try, but you may want to adjust it + later. Indexation is started automatically the first time you execute the @@ -219,17 +225,21 @@ The indexation configuration - The main configuration file is named + Values set in the system-wide configuration file (named + like + /usr/[local/]share/recoll/examples/recoll.conf) + can be overriden by those set in the personal one, named $HOME/.recoll/recoll.conf by default or $RECOLL_CONFDIR/recoll.conf if RECOLL_CONFDIR is set. The most accurate documentation for editing the file is - given by comments inside the default file that will be created - when you first start recoll. If you want to - adjust the configuration before indexation, just click + given by comments inside the central one. If you want to adjust + the configuration before indexation, just click Cancel when the program asks if it should - start initial indexation. + start initial indexation. This will have created a + .recoll directory containing empty + configuration files. The configuration is also documented inside the installation chapter of @@ -311,12 +321,12 @@ search dialog for more complex searches. After starting a search, a list of results will instantly - be displayed in the main list window. Clicking on an entry will - open an internal preview window for the - document. Double-clicking will attempt to start an external - viewer (have a look at the - ~/.recoll/mimeconf file to see how these - are configured). + be displayed in the main list window. Clicking on the + Preview link for an entry will open an + internal preview window for the document. Clicking the + Edit link will attempt to start an external + viewer (have a look at the mimeconf + configuration file to see how these are configured). By default, the document list is presented in order of relevance (how well the system estimates that the document @@ -324,11 +334,19 @@ using the Tools / Sort parameters dialog. - You can click on the first paragraph (Query - results or No results found) in the - result list to get an exact display of the query actually + You can click on the Query details link + at the top of the results page to see the query actually performed, after stem expansion and other processing. + + Filename search + If the File name checkbox at the + left of the search terms is checked, the search will only done + for file names. In this case you can use the usual shell + wildcard characters * and + ? for expanding the search (ie + *somestring*). + @@ -336,8 +354,9 @@ The advanced search dialog has fields that will allow a more refined search, looking for documents with all given words, a - given exact phrase, or none of the given words (all relevant fields - will be combined by an implicit AND clause). + given exact phrase, none of the given words, or a given file + name (with wildcard expansion). All relevant fields will be + combined by an implicit AND clause. It will let you search for documents of specific mime types (ie: only text/plain, or @@ -351,8 +370,8 @@ the advanced search dialog to start the search. The button in the main window always performs a simple search. - Click on the result list header paragraph to see the query - expansion. + Click on the Show query details link at + the top of the result page to see the query expansion. @@ -382,7 +401,8 @@ date and mime type. The sort parameters stay in effect until they are explicitely - reset, or the program exits. + reset, or the program exits. An activated sort is indicated in + the result list header. @@ -415,9 +435,12 @@ File names - All file name elements (the broken up file path) are entered - as terms during indexation, and you can specify them when - searching. + All file name elements (the broken up file path) are + entered as terms during indexation, and you can specify them + as ordinary terms in normal search fields. Alternatively, you + can use specific file name search which will + only look for file names and can use + wildcard expansion. Quitting @@ -534,19 +557,16 @@ is part of libc and you should not need to do anything special. - External file types&RCL; uses - external applications + + External file types + + &RCL; 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: - antiword. - - PDF: pdftotext is part of the Xpdf package. @@ -556,14 +576,33 @@ pstotext. + MS Word: + antiword. + + RTF: unrtf - + + + + dvi: dvips + + + + djvu: + DjVuLibre + + + Text, Html, mail folders and Openoffice files are + processed internally. + Building @@ -673,16 +712,21 @@ Configuration overview - The personal configuration files and the database are - normally kept in - the .recoll directory in your home (this - can be changed with the RECOLL_CONFDIR - environment variable, and a parameter inside the main - configuration file). If this directory does not exist when - recoll or - recollindex are started, the - directory will be created and the sample configuration files will - be copied. recoll will give you a + There are two sets of configuration files. The system-wide + files are kept in a directory named like + /usr/[local/]share/recoll/examples, + they define default values for the system. A parallel set of + files exists in the .recoll directory in + your home (this can be changed with the + RECOLL_CONFDIR environment variable. + The database is also kept in .recoll by + default, (this can be changed by a configuration + parameter). + If the .recoll directory does not + exist when recoll or + recollindex are started, it + will be created with a set of empty configuration files. + recoll will give you a chance to edit the configuration file before starting indexation. recollindex will proceed immediately. @@ -698,7 +742,7 @@ files. You will have to edit them by hand for now (there is still some hope for a GUI configuration tool in the future). The most accurate documentation for the - configuration parameters is given by comments inside the sample + configuration parameters is given by comments inside the default files, and we will just give a general overview here. All configuration files share the same format. For @@ -741,7 +785,7 @@ Main configuration file - ~/.recoll/recoll.conf is the main + recoll.conf is the main configuration file. It defines things like what to index (top directories and things to ignore), and the default character set to use for document types which do not @@ -866,6 +910,17 @@ + indexallfilenames + &RCL; indexes file names in a special + section of the database to allow specific file names + searches using wild cards. This parameter decides if + file name indexing is performed only for files with mime + types that would qualify them for full text indexation, or + for all files inside the selected subtrees, independant of + mime type. + + + @@ -873,12 +928,13 @@ The mimemap file - ~/.recoll/mimemap specifies the - file name extension to mime type mappings. For - file names without an extension, or with an unknown one, the - system's file -i command will be executed - to determine the mime type (this can be switched off inside - the main configuration file). + mimemap specifies the + file name extension to mime type mappings. + + For file names without an extension, or with an unknown + one, the system's file -i command will be + executed to determine the mime type (this can be switched off + inside the main configuration file). mimemap also has a list of extensions which should be ignored totally (to avoid losing @@ -906,7 +962,7 @@ The mimeconf file - ~/.recoll/mimeconf specifies how the + mimeconf specifies how the different mime types are handled for indexation, and for display. @@ -914,11 +970,13 @@ good idea except if you are a &RCL; developper. You may want to adjust the external viewers defined in - (ie: html is either - previewed internally or displayed using - firefox, but you may prefer - mozilla...). Look for the - [view] section. + (ie: html is either previewed internally or displayed using + firefox, but you may prefer + mozilla, your + openoffice.org + program might be named oofice instead of + openoffice ...). Look + for the [view] section. You can also change the icons which are displayed by recoll in the result lists (the values are diff --git a/src/qtgui/recoll.pro.in b/src/qtgui/recoll.pro.in index e50a7cb1..7fcc6b63 100644 --- a/src/qtgui/recoll.pro.in +++ b/src/qtgui/recoll.pro.in @@ -3,16 +3,16 @@ LANGUAGE = C++ CONFIG += qt warn_on thread release debug -HEADERS += rclmain.h +HEADERS += rclmain.h rclreslist.h SOURCES += main.cpp \ rclmain.cpp \ idxthread.cpp \ plaintorich.cpp \ - guiutils.cpp + guiutils.cpp \ + rclreslist.cpp -FORMS = reslistb.ui \ - recollmain.ui \ +FORMS = recollmain.ui \ advsearch.ui \ preview/preview.ui \ sort.ui \ @@ -46,4 +46,4 @@ contains( UNAME, [lL]inux ) { LIBS -= -liconv } -TRANSLATIONS = recoll_fr.ts +TRANSLATIONS = recoll_fr.ts recoll_ru.ts diff --git a/src/recollinstall.in b/src/recollinstall.in index 5d06bdb2..aa3f1e81 100755 --- a/src/recollinstall.in +++ b/src/recollinstall.in @@ -50,6 +50,7 @@ for d in \ ${bindir} \ ${mandir}/man1 \ ${mandir}/man5 \ + ${datadir}/applications \ ${datadir}/recoll/doc \ ${datadir}/recoll/examples \ ${datadir}/recoll/filters \ @@ -59,6 +60,7 @@ do test -d $d || mkdir -p $d || exit 1 done +${INSTALL} recoll.desktop ${datadir}/applications ${INSTALL} doc/user/usermanual.html doc/user/docbook.css ${datadir}/recoll/doc ${INSTALL} doc/man/recoll.1 doc/man/recollindex.1 ${mandir}/man1/ diff --git a/src/sampleconf/recoll.conf.in b/src/sampleconf/recoll.conf.in index 19e0bd7b..08f78611 100644 --- a/src/sampleconf/recoll.conf.in +++ b/src/sampleconf/recoll.conf.in @@ -1,4 +1,4 @@ -# @(#$Id: recoll.conf.in,v 1.6 2006-01-10 11:07:21 dockes Exp $ (C) 2004 J.F.Dockes +# @(#$Id: recoll.conf.in,v 1.7 2006-03-28 12:49:03 dockes Exp $ (C) 2004 J.F.Dockes # # Recoll default configuration file. This should be copied to # ~/.recoll/recoll.conf @@ -9,10 +9,10 @@ topdirs = ~ # Wildcard expressions for names of files and directories that we should # ignore. If you need index mozilla/thunderbird mail folders, don't put # ".*" in there (as was the case with an older sample config) -skippedNames = *~ #* bin CVS Cache caughtspam tmp +skippedNames = *~ #* bin CVS Cache cache* caughtspam tmp .thumbnails -# Debug messages. 4 is quite verbose. 3 would be errors only. -loglevel = 4 +# Debug messages. 3 is errors/warnings only. 4 would be quite verbose. +loglevel = 3 logfilename = stderr # Place to search for executable filters. If RECOLL_FILTERSDIR is set in @@ -24,11 +24,6 @@ filtersdir = @prefix@/share/recoll/filters # The flag to perform stem expansion at query time is now set from the GUI indexstemminglanguages = english french -# Name of the file suffix to mime-type map file. -mimemapfile = mimemap -# Name of the mime-type to filter type/name map file. -mimeconffile = mimeconf - # The only reason to change this would be if you want to change the icons # displayed in the result list iconsdir = @prefix@/share/recoll/images @@ -50,6 +45,11 @@ guesscharset = 0 # indexation of many bogus 'text' files usesystemfilecommand = 1 +# Should we index the file names of files with mime types we don't +# know? (we can otherwise just ignore them) +indexallfilenames = 1 + + # You could specify different parameters for a subdirectory like this: #[~/hungariandocs/plain] #defaultcharset = iso-8859-2