diff --git a/src/INSTALL b/src/INSTALL
index 8b4929c4..8e53770a 100644
--- a/src/INSTALL
+++ b/src/INSTALL
@@ -27,10 +27,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
At the very least, you will need to download and install the xapian core
package (Recoll currently uses version 0.9.2), and the qt runtime and
- development packages (Recoll currently uses version 3.3.3).
+ development packages (Recoll development currently uses version 3.3.5, but
+ any 3.3 version is probably ok).
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 (if you
+ system. You may have to compile Xapian but this is not difficult (if you
are using FreeBSD, there is a port).
You may also need libiconv. Recoll currently uses version 1.9 (this should
diff --git a/src/README b/src/README
index ce16f986..0171e042 100644
--- a/src/README
+++ b/src/README
@@ -142,6 +142,9 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
The resulting database can be big (roughly the size of the original
document set), but it is not a document archive. Recoll can only display
documents that still exist at the place from which they were indexed.
+ (Actually, there is a way to reconstruct a document from the information
+ in the database, but the result is not nice, as all formatting,
+ punctuation and capitalisation are lost).
Recoll stores all internal data in Unicode UTF-8 format, and it can index
files with different character sets, encodings, and languages into the
@@ -185,6 +188,15 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
interface to real time file modification monitors. The typical usage is to
have a nightly indexation run programmed into your cron file.
+ +------------------------------------------------------------------------+
+ | Side note: there is nothing in Recoll and Xapian that would prevent |
+ | interfacing with a real time file modification monitor, but this would |
+ | tend to consume significant system resources for dubious gain, because |
+ | you rarely need a full text search to find documents you just |
+ | modified. recollindex -i can be used to add individual files to the |
+ | index if you want to play with this, see the manual page. |
+ +------------------------------------------------------------------------+
+
Recoll knows about quite a few different document types. The parameters
for document types recognition and processing are set in configuration
files Most file types, like HTML or word processing files, only hold one
@@ -258,13 +270,17 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
3.1. Simple search
- Start the recoll program, then enter search term(s) in the text field at
- 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
- with any of the terms (the ones with more terms will get better scores).
- You can check the All terms checkbox to ensure that only documents with
- all the terms will be returned. Use the Tools / Advanced search dialog for
- more complex searches.
+ 1. Start the recoll program.
+
+ 2. Enter search term(s) in the text field at the top of the window.
+
+ 3. Click the Search button or hit the Enter key to start the search.
+
+ By default, this will look for documents with any of the search terms (the
+ ones with more terms will get better scores). You can check the All terms
+ checkbox to ensure that only documents with all the terms will be
+ returned. Use the Tools / Advanced 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
@@ -276,14 +292,18 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
the system estimates that the document matches the query). You can specify
a different ordering by 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
+ performed, after stem expansion and other processing.
+
----------------------------------------------------------------------
3.2. Complex/advanced search
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 fields may be combined by an implicit AND
- clause).
+ or none of the given words (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 text/html or application/pdf etc...)
@@ -294,6 +314,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Click on the Start Search button in 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.
+
----------------------------------------------------------------------
3.3. Document history
@@ -347,15 +369,46 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
It is possible to customise some aspects of the search interface by using
Query configuration entry in the Preferences menu.
- There are two tabs in the dialog, to modify the appearance of the user
- interface (result list appearance), or the parameters used for searching
- (language used for stem expansion).
+ There are two tabs in the dialog, dealing with the interface itself, and
+ with the parameters used for searching and returning results.
- The stemming language can be chosen among those that were specified in the
- configuration file, or later added with recollindex -s (See the
- recollindex manual). Stemming languages which are dynamically added will
- be deleted at the next indexation pass unless they are also added in the
- configuration file.
+ User interface parameters:
+
+ * Number of results in a result page
+
+ * Result list font: There is quite a lot of information shown in the
+ result list, and you may want to customise the font and/or font size.
+ The rest of the fonts used by Recoll are determined by your generic QT
+ config (try the qtconfig command.
+
+ * Html help browser: this will let you chose your the preferred browser
+ which will be started from the Help menu to read the user manual. You
+ can enter a simple name if the command is in your PATH, or browse for
+ a full pathname.
+
+ * Show document type icons in result list: icons in the result list can
+ be turned off. They take quite a lot of space and convey relatively
+ little useful information.
+
+ Search parameters:
+
+ * Stemming language: stemming obviously depends on the document's
+ language. This listbox will let you chose among the stemming databases
+ which were built during indexing (this is set in the main
+ configuration file), or later added with recollindex -s (See the
+ recollindex manual). Stemming languages which are dynamically added
+ will be deleted at the next indexation pass unless they are also added
+ in the configuration file.
+
+ * Dynamically build abstracts: this decides if Recoll tries to build
+ document abstracts when displaying the result list. Abstracts are
+ constructed by taking context from the document information, around
+ the search terms. This can slow down result list display significantly
+ for big documents, and you may want to turn it off.
+
+ * Replace abstracts from documents: this decides if we should synthetize
+ and display an abstract in place of an explicit abstract found within
+ the document itself.
----------------------------------------------------------------------
@@ -367,10 +420,11 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
At the very least, you will need to download and install the xapian core
package (Recoll currently uses version 0.9.2), and the qt runtime and
- development packages (Recoll currently uses version 3.3.3).
+ development packages (Recoll development currently uses version 3.3.5, but
+ any 3.3 version is probably ok).
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 (if you
+ system. You may have to compile Xapian but this is not difficult (if you
are using FreeBSD, there is a port).
You may also need libiconv. Recoll currently uses version 1.9 (this should
diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml
index 8f3a9f07..082f23e2 100644
--- a/src/doc/user/usermanual.sgml
+++ b/src/doc/user/usermanual.sgml
@@ -24,7 +24,7 @@
Dockes
- $Id: usermanual.sgml,v 1.4 2006-01-19 12:01:42 dockes Exp $
+ $Id: usermanual.sgml,v 1.5 2006-02-01 07:05:06 dockes Exp $This document introduces full text search notions
@@ -116,9 +116,12 @@
indexation. The resulting database can be big (roughly the size of the
- original document set), but it is not a document archive. &RCL;
- can only display documents that still exist at the place from which
- they were indexed.
+ original document set), but it is not a document
+ archive. &RCL; can only display documents that still exist at
+ the place from which they were indexed. (Actually, there is a
+ way to reconstruct a document from the information in the
+ database, but the result is not nice, as all formatting,
+ punctuation and capitalisation are lost).
&RCL; stores all internal data in Unicode
UTF-8 format, and it can index files with
@@ -176,7 +179,18 @@
currently no interface to real time file modification
monitors. The typical usage is to have a nightly indexation run
programmed into your
- cron file.
+ cron file.
+
+ Side note: there is nothing in &RCL; and &XAP;
+ that would prevent interfacing with a real time file
+ modification monitor, but this would tend to consume significant
+ system resources for dubious gain, because you rarely need a
+ full text search to find documents you just
+ modified. recollindex -i can be used to add
+ individual files to the index if you want to play with this, see
+ the manual page.
+
+
&RCL; knows about quite a few different document
types. The parameters for document types recognition and
@@ -278,12 +292,19 @@
Simple search
- Start the recoll program, then
- enter search term(s) in the text field at 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 with any of the terms
- (the ones with more terms will get better scores). You can
+
+ Start the recoll program.
+
+ Enter search term(s) in the text field at the top of the
+ window.
+
+ Click the Search button or
+ hit the Enter key to start the search.
+
+
+
+ By default, this will look for documents with any of the
+ search terms (the ones with more terms will get better scores). You can
check the All terms checkbox to ensure
that only documents with all the terms will be returned. Use
the Tools / Advanced
@@ -303,6 +324,11 @@
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
+ performed, after stem expansion and other processing.
+
@@ -310,8 +336,8 @@
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 fields may
- be combined by an implicit AND clause).
+ given exact phrase, or none of the given words (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
@@ -325,6 +351,9 @@
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.
+
@@ -380,9 +409,9 @@
Query explanation
- You can get an exact description of what the query
- looked for, including stem expansion, and boolean operators
- used, by clicking on the result list header.
+ You can get an exact description of what the query
+ looked for, including stem expansion, and boolean operators
+ used, by clicking on the result list header.Quitting
@@ -403,17 +432,66 @@
interface by using Query configuration entry
in the Preferences menu.
- There are two tabs in the dialog, to modify the appearance
- of the user interface (result list appearance), or the
- parameters used for searching (language used for stem
- expansion).
+ There are two tabs in the dialog, dealing with the
+ interface itself, and with the parameters used for searching and
+ returning results.
- The stemming language can be chosen among those that were
- specified in the configuration file, or later added with
+ User interface parameters:
+
+
+ Number of results in a result
+ page
+
+
+ Result list font: There
+ is quite a lot of information shown in the result list, and
+ you may want to customise the font and/or font size. The rest
+ of the fonts used by &RCL; are determined by your generic QT
+ config (try the qtconfig command.
+
+
+ Html help browser: this
+ will let you chose your the preferred browser which will be
+ started from the Help menu to read the user
+ manual. You can enter a simple name if the command is in your
+ PATH, or browse for a full pathname.
+
+ Show document type icons in result
+ list: icons in the result list can be turned
+ off. They take quite a lot of space and convey relatively
+ little useful information.
+
+
+
+ Search parameters:
+
+
+ Stemming language:
+ stemming obviously depends on the document's language. This
+ listbox will let you chose among the stemming databases which
+ were built during indexing (this is set in the main configuration
+ file), or later added with
recollindex -s (See the recollindex
manual). Stemming languages which are dynamically added will be
deleted at the next indexation pass unless they are also added in
the configuration file.
+
+
+ Dynamically build
+ abstracts: this decides if &RCL; tries to build
+ document abstracts when displaying the result list. Abstracts
+ are constructed by taking context from the document
+ information, around the search terms. This can slow down
+ result list display significantly for big documents, and you
+ may want to turn it off.
+
+ Replace abstracts from
+ documents: this decides if we should synthetize and
+ display an abstract in place of an explicit abstract found
+ within the document itself.
+
+
@@ -427,96 +505,96 @@
Building from source
- Prerequisites
+ PrerequisitesAt the very least, you will need to download and install the
- xapian core
- package (&RCL; currently uses version 0.9.2), and the qt
- runtime and development packages (&RCL; currently uses
- version 3.3.3).
+ xapian core package
+ (&RCL; currently uses version 0.9.2), and the qt
+ runtime and development packages (&RCL; development
+ currently uses version 3.3.5, but any 3.3 version is
+ probably ok).
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 (if you are using
- FreeBSD, there is a port).
+ qt for your system. You may have to
+ compile &XAP; but this is not difficult (if you are using
+ FreeBSD, there is a port).
You may also need
- libiconv. &RCL;
- currently uses version 1.9 (this should not be critical). On
- Linux systems, the iconv interface
- is part of libc and you should not need to do anything
- special.
+ libiconv. &RCL;
+ currently uses version 1.9 (this should not be critical). On
+ Linux systems, the iconv interface
+ is part of libc and you should not need to do anything
+ special.
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:
-
+ to index some file types. You need to install them for the
+ file types that you wish to have indexed:
+
- MS Word:
- antiword.
-
+ MS Word:
+ antiword.
+
- PDF: pdftotext is part of the Xpdf package.
-
+ PDF: pdftotext is part of the Xpdf package.
+
- Postscript:
- pstotext.
-
+ Postscript:
+ pstotext.
+
-
- RTF: unrtf
+
+ RTF: unrtf
-
-
-
+
+
+
- Building
+ Building&RCL; has been built on
- Linux (redhat7.3, mandriva 2005, Fedora Core 3), FreeBSD and
- Solaris 8. If you build on another system, I would very much
- welcome patches.
+ Linux (redhat7.3, mandriva 2005, Fedora Core 3), FreeBSD and
+ Solaris 8. If you build on another system, I would very much
+ welcome patches.
Depending on the qt
configuration on your system, you may have to set the
QTDIR and QMAKESPECS
variables in your environment:
-
- QTDIR should point to the
- directory above the one that holds the qt include files (ie:
- qt.h).
-
- QMAKESPECS should
- be set to the name of one of the
- qt mkspecs subdirectories (ie:
- linux-g++).
-
-
+
+ QTDIR should point to the
+ directory above the one that holds the qt include files (ie:
+ qt.h).
+
+ QMAKESPECS should
+ be set to the name of one of the
+ qt mkspecs subdirectories (ie:
+ linux-g++).
+
+
- On many Linux systems, QTDIR is set
- by the login scripts, and QMAKESPECS is not
- needed because there is a default link in
- mkspecs/.
+ On many Linux systems, QTDIR is set
+ by the login scripts, and QMAKESPECS is not
+ needed because there is a default link in
+ mkspecs/.
- The &RCL; configure script does a
- better job of checking these variables after release
- 1.1.1. Before this, unexplained errors will occur during
- compilation if the environment is not set up. Also, for 1.1.0 the
- qmake command should be in your PATH (later
- releases can also find it in
- $QTDIR/bin).
+ The &RCL; configure script does a
+ better job of checking these variables after release
+ 1.1.1. Before this, unexplained errors will occur during
+ compilation if the environment is not set up. Also, for 1.1.0 the
+ qmake command should be in your PATH (later
+ releases can also find it in
+ $QTDIR/bin).Normal procedure:
@@ -528,23 +606,23 @@
There little autoconfiguration. The
- configure script will mainly link one of
- the system-specific files in the mk
- directory to mk/sysconf. If your 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 should be the output of uname -s).
+ configure script will mainly link one of
+ the system-specific files in the mk
+ directory to mk/sysconf. If your 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 should be the output of uname -s).
- Installation
+ InstallationEither type make install or execute
recollinstall targetdir, in the root
- of the source tree. This will copy the commands to
- $targetdir/bin and the sample
- configuration files, scripts and other shared data to
- $targetdir/share/recoll.
+ of the source tree. This will copy the commands to
+ $targetdir/bin and the sample
+ configuration files, scripts and other shared data to
+ $targetdir/share/recoll.
@@ -552,32 +630,32 @@
Installing a prebuilt copy
- Installing through a package system
+ Installing through a package system
- If you are lucky enough to be using a port system or a
- prebuilt package (RPM or other), just follow the usual
- procedure, and have a look at the configuration
- section.
+ If you are lucky enough to be using a port system or a
+ prebuilt package (RPM or other), just follow the usual
+ procedure, and have a look at the configuration
+ section.
- Installing a prebuilt &RCL;
+ Installing a prebuilt &RCL;The unpackaged binary versions are just compressed tar
files of a build
- tree, where only the useful parts were kept (executables and
- sample configuration).
+ tree, where only the useful parts were kept (executables and
+ sample configuration).
The executable binary files are built with a static link to
- libxapian and libiconv, to make installation easier (no
- dependencies). However, this also means that you cannot change
- the versions which are used.
+ libxapian and libiconv, to make installation easier (no
+ dependencies). However, this also means that you cannot change
+ the versions which are used.
After extracting the tar file, you can proceed with
- installation as
- if you had built the package from source.
+ installation as
+ if you had built the package from source.
@@ -586,36 +664,36 @@
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
- chance to edit the configuration file before starting
- indexation. recollindex will
- proceed immediately.
+ 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
+ chance to edit the configuration file before starting
+ indexation. recollindex will
+ proceed immediately.
Most of the parameters specific to the
- recoll GUI are set through the
- Preferences menu and stored in the
- standard QT place
- ($HOME/.qt/recollrc). You probably do not
- want to edit this by hand.
+ recoll GUI are set through the
+ Preferences menu and stored in the
+ standard QT place
+ ($HOME/.qt/recollrc). You probably do not
+ want to edit this by hand.
For other options, &RCL; uses text configuration
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
- files, and we will just give a general overview here.
+ 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
+ files, and we will just give a general overview here.
- All configuration files share the same format. For
- exemple, a short extract of the main configuration file might
- look as follows:
-
+ All configuration files share the same format. For
+ exemple, a short extract of the main configuration file might
+ look as follows:
+
# Space-separated list of directories to index.
topdirs = ~/docs /usr/share/doc
@@ -623,215 +701,215 @@
defaultcharset = utf-8
- There are three kinds of lines:
-
- Comment (starts with
- #) or empty.
-
- Parameter affectation (name =
- value).
-
- Section definition
- ([somedirname]).
-
-
+ There are three kinds of lines:
+
+ Comment (starts with
+ #) or empty.
+
+ Parameter affectation (name =
+ value).
+
+ Section definition
+ ([somedirname]).
+
+
- Section lines allow redefining some parameters for a
- directory subtree. Some of the parameters used for indexation
- are looked up hierarchically from the more to the less
- specific. Not all parameters can be meaningfully redefined,
- this is specified for each in the next section.
+ Section lines allow redefining some parameters for a
+ directory subtree. Some of the parameters used for indexation
+ are looked up hierarchically from the more to the less
+ specific. Not all parameters can be meaningfully redefined,
+ this is specified for each in the next section.
- The tilde character (~) is expanded in file names to the
- name of the user's home directory.
-
- White space is used for separation inside lists.
+ The tilde character (~) is expanded in file names to the
+ name of the user's home directory.
+
+ White space is used for separation inside lists.
Elements with embedded spaces can be quoted using
double-quotes.
- Main configuration file
+ Main configuration file
- ~/.recoll/recoll.conf is the main
+ ~/.recoll/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
- specify it internally.
+ what to index (top directories and things to ignore), and the
+ default character set to use for document types which do not
+ specify it internally.
- The default configuration will index your home
- directory. If this is not 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.
-
- Paramers:
+ The default configuration will index your home
+ directory. If this is not 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.
+
+ Paramers:
-
+
- topdirs
- Specifies the list of directories to index
- (recursively).
-
-
+ topdirs
+ Specifies the list of directories to index
+ (recursively).
+
+
- skippedNames
-
- A space-separated list of patterns for
- names of files or directories that should be completely
- ignored. The list defined in the default file is:
+ skippedNames
+
+ A space-separated list of patterns for
+ names of files or directories that should be completely
+ ignored. The list defined in the default file is:
*~ #* bin CVS Cache caughtspam tmp
- The list can be redefined for subdirectories, but is only
+ The list can be redefined for subdirectories, but is only
actually changed for the top level ones in
topdirs.
- The top-level directories are not affected by this
- list (that is, a directory in topdirs
- might match and would still be indexed).
- The list in the default configuration does not
- exclude hidden directories (names beginning with a
- dot), which means that it may index quite a few things
- that you do not want. On the other hand, mail user
- agents like thunderbird
- usually store messages in hidden directories, and you
- probably want this indexed. One possible solution is to
- have .* in
- skippedNames, and add things like
- ~/.thunderbird or
- ~/.evolution in
- topdirs.
-
-
+ The top-level directories are not affected by this
+ list (that is, a directory in topdirs
+ might match and would still be indexed).
+ The list in the default configuration does not
+ exclude hidden directories (names beginning with a
+ dot), which means that it may index quite a few things
+ that you do not want. On the other hand, mail user
+ agents like thunderbird
+ usually store messages in hidden directories, and you
+ probably want this indexed. One possible solution is to
+ have .* in
+ skippedNames, and add things like
+ ~/.thunderbird or
+ ~/.evolution in
+ topdirs.
+
+
- loglevel
- Verbosity level for recoll and
- recollindex. A value of 4 lists quite a lot of
- debug/information messages. 2 only lists errors.
-
-
+ loglevel
+ Verbosity level for recoll and
+ recollindex. A value of 4 lists quite a lot of
+ debug/information messages. 2 only lists errors.
+
+
- logfilename
- Where should the messages go. 'stderr' can
- be used as a special value.
-
-
+ logfilename
+ Where should the messages go. 'stderr' can
+ be used as a special value.
+
+
- filtersdir
- A directory to search for the external
- filter scripts used to index some types of files. The
- value should not be changed, except if you want to modify
- one of the default scripts. The value can be redefined for
- any subdirectory.
-
-
+ filtersdir
+ A directory to search for the external
+ filter scripts used to index some types of files. The
+ value should not be changed, except if you want to modify
+ one of the default scripts. The value can be redefined for
+ any subdirectory.
+
+
- indexstemminglanguages
- A list of languages for which the stem
- expansion databases will be built. See recollindex(1) for
- possible values. You can add a stem expansion database for
- a different language by using recollindex
- -s, but it will be deleted during the next
- indexation. Only languages listed in the configuration
- file are permanent.
-
-
+ indexstemminglanguages
+ A list of languages for which the stem
+ expansion databases will be built. See recollindex(1) for
+ possible values. You can add a stem expansion database for
+ a different language by using recollindex
+ -s, but it will be deleted during the next
+ indexation. Only languages listed in the configuration
+ file are permanent.
+
+
- iconsdir
- The name of the directory where
- recoll result list icons are
- stored. You can change this if you want different
- images.
-
-
+ iconsdir
+ The name of the directory where
+ recoll result list icons are
+ stored. You can change this if you want different
+ images.
+
+
- dbdir
- The name of the Xapian database
- directory. It will be created if needed when the database
- is initialized.
-
-
-
- defaultcharset
- The name of the character set used for
- files that do not contain a character set definition (ie:
- plain text files). This can be redefined for any
- subdirectory.
+ dbdir
+ The name of the Xapian database
+ directory. It will be created if needed when the database
+ is initialized.
+
+
+
+ defaultcharset
+ The name of the character set used for
+ files that do not contain a character set definition (ie:
+ plain text files). This can be redefined for any
+ subdirectory.
- guesscharset
- Decide if we 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.
-
-
+ guesscharset
+ Decide if we 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.
+
+
- usesystemfilecommand
- Decide if we use the file -i
+ usesystemfilecommand
+ Decide if we use the file -i
system command as a final step for determining the mime
type for a file (the main procedure uses suffix
associations as defined in the mimemap
file). This can be useful for files with suffixless names,
but it will also cause the indexation of many bogus "text"
files.
-
-
+
+
-
+
- The mimemap file
+ 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).
+ ~/.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 also has a list of
- extensions which should be ignored totally (to avoid losing
- time by executing file
- for things that certainly should not be indexed).
+ mimemap also has a list of
+ extensions which should be ignored totally (to avoid losing
+ time by executing file
+ for things that certainly should not be indexed).
- The mappings can be specified on a per-subtree basis,
- which may be useful in some cases. Example:
- gaim logs have a
- .txt extension but
- should be handled specially, which is possible because they
- are usually all located in one place.
+ The mappings can be specified on a per-subtree basis,
+ which may be useful in some cases. Example:
+ gaim logs have a
+ .txt extension but
+ should be handled specially, which is possible because they
+ are usually all located in one place.
- mimemap also has a
- recoll_noindex variable which is a list of
- suffixes. Matching files will be skipped (avoids unnecessary
- decompressions or file executions). This is
- partially redundant with skippedNames in
- the main configuration file, with two differences: it will not
- affect directories, and it can be changed for any
- subdirectory.
+ mimemap also has a
+ recoll_noindex variable which is a list of
+ suffixes. Matching files will be skipped (avoids unnecessary
+ decompressions or file executions). This is
+ partially redundant with skippedNames in
+ the main configuration file, with two differences: it will not
+ affect directories, and it can be changed for any
+ subdirectory.
- The mimeconf file
+ The mimeconf file
- ~/.recoll/mimeconf specifies how the
+ ~/.recoll/mimeconf specifies how the
different mime types are handled for indexation, and for
display.
- Changing the indexation parameters is probably not a
+ Changing the indexation parameters is probably not a
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.
+ 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.
- You can also change the icons which are displayed by
+ You can also change the icons which are displayed by
recoll in the result lists (the values are
the basenames of the png images inside the
iconsdir directory (specified in
diff --git a/src/excludefile b/src/excludefile
index 3c40ff36..d2fb8e2e 100644
--- a/src/excludefile
+++ b/src/excludefile
@@ -9,6 +9,7 @@
.obj
.ui
CVS
+Makefile
TAGS
alldeps
autom4*
@@ -20,6 +21,7 @@ lib/librcl.a
makesrcdist.sh
mk/localdefs
qtgui/Makefile
+qtgui/recoll.pro
qtgui/preview/Makefile
qtgui/preview/preview.pro
qtgui/preview/pvmain.cpp
diff --git a/src/makesrcdist.sh b/src/makesrcdist.sh
index 0446eac3..77bf43c0 100644
--- a/src/makesrcdist.sh
+++ b/src/makesrcdist.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-# @(#$Id: makesrcdist.sh,v 1.8 2006-01-21 15:36:05 dockes Exp $ (C) 2005 J.F.Dockes
+# @(#$Id: makesrcdist.sh,v 1.9 2006-02-01 07:12:14 dockes Exp $ (C) 2005 J.F.Dockes
# A shell-script to make a recoll source distribution
#set -x
@@ -66,8 +66,9 @@ sed -e '/\.\/index\.html/d' -e '/\.\/book\.html/d' \
diff $topdir/doc/user/u1.html $topdir/doc/user/usermanual.html
mv -f $topdir/doc/user/u1.html $topdir/doc/user/usermanual.html
+# We tag .. as there is the 'packaging/' directory in there
CVSTAG="RECOLL-$versionforcvs"
-[ $dotag = "yes" ] && cvs tag -F $CVSTAG .
+[ $dotag = "yes" ] && (cd ..;cvs tag -F $CVSTAG .)
out=recoll-$version.tar.gz
(cd $targetdir ; \