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

1.3.1pre1

Browse Source
This commit is contained in:
dockes 2006-03-28 12:49:03 +00:00
parent aacd7d4c22
commit d47f70c595
5 changed files with 153 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/doc/man/recoll.conf.5
View File

@ -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" .TH RECOLL.CONF 5 "8 January 2006"
.SH NAME .SH NAME
recoll.conf \- main personal configuration file for Recoll recoll.conf \- main personal configuration file for Recoll
.SH DESCRIPTION .SH DESCRIPTION
This file, by default This file defines the indexation configuration for the full-text search
.IR $HOME/.recoll/recoll.conf , system Recoll.
defines the indexation configuration for the full-text search system .LP
Recoll. 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 .LP
A short extract of the file might look as follows: A short extract of the file might look as follows:
.IP .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 (ie: for plain text files). This does not work well in general, and should
probably not be used. probably not be used.
.TP .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 .BI "usesystemfilecommand = " boolean
Decide if we use the Decide if we use the
.B "file -i" .B "file -i"

184
src/doc/user/usermanual.sgml
View File

@ -24,7 +24,7 @@
Dockes</holder> Dockes</holder>
</copyright> </copyright>
<releaseinfo>$Id: usermanual.sgml,v 1.6 2006-03-04 10:09:59 dockes Exp $</releaseinfo> <releaseinfo>$Id: usermanual.sgml,v 1.7 2006-03-28 12:49:03 dockes Exp $</releaseinfo>
<abstract> <abstract>
<para>This document introduces full text search notions <para>This document introduces full text search notions
@ -53,7 +53,8 @@
restrict the indexed area.</para> restrict the indexed area.</para>
<para>Also be aware that you will need to install the <para>Also be aware that you will need to install the
appropriate supporting applications for document types that need appropriate <link linkend="rcl.install.building.prereqs.external">
supporting applications</link> for document types that need
them (for example <application>antiword</application> for them (for example <application>antiword</application> for
ms-word files), and that the default character set used to read ms-word files), and that the default character set used to read
raw text files for indexing is iso8859-1, which may not be 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 terms, and the tool will return a list of documents where
those terms are prominent.</para> those terms are prominent.</para>
<para>This mode of operation has been made very familiar by www <para>This mode of operation has been made very familiar by internet
search engines.</para> search engines.</para>
<para>The notion of relevance is a difficult one, as only you, the <para>The notion of relevance is a difficult one, as only you, the
@ -134,18 +135,23 @@
language, without reindexing. Storing documents in different language, without reindexing. Storing documents in different
languages in the same database is possible, and useful in languages in the same database is possible, and useful in
practice, but does introduce possibilities of confusion. &RCL; practice, but does introduce possibilities of confusion. &RCL;
makes no attempt at automatic language recognition.</para> currently makes no attempt at automatic language recognition.</para>
<para>&RCL; has many parameters which define exactly what to <para>&RCL; has many parameters which define exactly what to
index, and how to classify and decode the source index, and how to classify and decode the source
documents. These are kept in a <link documents. These are kept in a <link
linkend="rcl.indexing.config">configuration file</link>. A linkend="rcl.indexing.config">configuration file</link>. A
sample configuration is installed into the default configuration is copied into a standard location
(usually something like
<filename>/usr/[local/]share/recoll/examples</filename>)
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
<filename>.recoll</filename> subdirectory of your home <filename>.recoll</filename> subdirectory of your home
directory when you first execute a &RCL; command. The initial directory. The default configuration will index your home
configuration will index your home directory with default directory with default parameters and should be sufficient for
parameters and should be sufficient for giving &RCL; a try, giving &RCL; a try, but you may want to adjust it
but you may want to adjust it later.</para> later.</para>
<para><link linkend="rcl.indexing.exec">Indexation</link> is started <para><link linkend="rcl.indexing.exec">Indexation</link> is started
automatically the first time you execute the automatically the first time you execute the
@ -219,17 +225,21 @@
<sect1 id="rcl.indexing.config"> <sect1 id="rcl.indexing.config">
<title>The indexation configuration</title> <title>The indexation configuration</title>
<para>The main configuration file is named <para>Values set in the system-wide configuration file (named
like
<filename>/usr/[local/]share/recoll/examples/recoll.conf</filename>)
can be overriden by those set in the personal one, named
<filename>$HOME/.recoll/recoll.conf</filename> by default or <filename>$HOME/.recoll/recoll.conf</filename> by default or
<filename>$RECOLL_CONFDIR/recoll.conf</filename> if <filename>$RECOLL_CONFDIR/recoll.conf</filename> if
RECOLL_CONFDIR is set.</para> RECOLL_CONFDIR is set.</para>
<para>The most accurate documentation for editing the file is <para>The most accurate documentation for editing the file is
given by comments inside the default file that will be created given by comments inside the central one. If you want to adjust
when you first start <command>recoll</command>. If you want to the configuration before indexation, just click
adjust the configuration before indexation, just click
<guilabel>Cancel</guilabel> when the program asks if it should <guilabel>Cancel</guilabel> when the program asks if it should
start initial indexation.</para> start initial indexation. This will have created a
<filename>.recoll</filename> directory containing empty
configuration files.</para>
<para>The configuration is also documented inside the <link <para>The configuration is also documented inside the <link
linkend="rcl.install.config.recollconf">installation chapter</link> of linkend="rcl.install.config.recollconf">installation chapter</link> of
@ -311,12 +321,12 @@
search</guilabel> dialog for more complex searches.</para> search</guilabel> dialog for more complex searches.</para>
<para>After starting a search, a list of results will instantly <para>After starting a search, a list of results will instantly
be displayed in the main list window. Clicking on an entry will be displayed in the main list window. Clicking on the
open an internal preview window for the <literal>Preview</literal> link for an entry will open an
document. Double-clicking will attempt to start an external internal preview window for the document. Clicking the
viewer (have a look at the <literal>Edit</literal> link will attempt to start an external
<filename>~/.recoll/mimeconf</filename> file to see how these viewer (have a look at the <filename>mimeconf</filename>
are configured).</para> configuration file to see how these are configured).</para>
<para>By default, the document list is presented in order of <para>By default, the document list is presented in order of
relevance (how well the system estimates that the document relevance (how well the system estimates that the document
@ -324,11 +334,19 @@
using the <link linkend="rcl.search.sort"><guilabel>Tools</guilabel> using the <link linkend="rcl.search.sort"><guilabel>Tools</guilabel>
/ <guilabel>Sort parameters</guilabel></link> dialog.</para> / <guilabel>Sort parameters</guilabel></link> dialog.</para>
<para>You can click on the first paragraph (<literal>Query <para>You can click on the <literal>Query details</literal> link
results</literal> or <literal>No results found</literal>) in the at the top of the results page to see the query actually
result list to get an exact display of the query actually
performed, after stem expansion and other processing.</para> performed, after stem expansion and other processing.</para>
<sect2 id="rcl.search.simple.filename">
<title>Filename search</title>
<para>If the <guilabel>File name</guilabel> 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 <literal>*</literal> and
<literal>?</literal> for expanding the search (ie
<literal>*somestring*</literal>).
</para>
</sect1> </sect1>
<sect1 id="rcl.search.complex"> <sect1 id="rcl.search.complex">
@ -336,8 +354,9 @@
<para>The advanced search dialog has fields that will allow a more <para>The advanced search dialog has fields that will allow a more
refined search, looking for documents with all given words, a refined search, looking for documents with all given words, a
given exact phrase, or none of the given words (all relevant fields given exact phrase, none of the given words, or a given file
will be combined by an implicit AND clause).</para> name (with wildcard expansion). All relevant fields will be
combined by an implicit AND clause.</para>
<para>It will let you search for documents of specific mime <para>It will let you search for documents of specific mime
types (ie: only <literal>text/plain</literal>, or types (ie: only <literal>text/plain</literal>, or
@ -351,8 +370,8 @@
the advanced search dialog to start the search. The button in the advanced search dialog to start the search. The button in
the main window always performs a simple search.</para> the main window always performs a simple search.</para>
<para>Click on the result list header paragraph to see the query <para>Click on the <literal>Show query details</literal> link at
expansion.</para> the top of the result page to see the query expansion.</para>
</sect1> </sect1>
@ -382,7 +401,8 @@
<emphasis>date</emphasis> and <emphasis>mime type</emphasis>.</para> <emphasis>date</emphasis> and <emphasis>mime type</emphasis>.</para>
<para>The sort parameters stay in effect until they are explicitely <para>The sort parameters stay in effect until they are explicitely
reset, or the program exits.</para> reset, or the program exits. An activated sort is indicated in
the result list header.</para>
</sect1> </sect1>
@ -415,9 +435,12 @@
</formalpara> </formalpara>
<formalpara><title>File names</title> <formalpara><title>File names</title>
<para>All file name elements (the broken up file path) are entered <para>All file name elements (the broken up file path) are
as terms during indexation, and you can specify them when entered as terms during indexation, and you can specify them
searching.</para> as ordinary terms in normal search fields. Alternatively, you
can use specific file name search which will
<emphasis>only</emphasis> look for file names and can use
wildcard expansion.</para>
</formalpara> </formalpara>
<formalpara><title>Quitting</title> <formalpara><title>Quitting</title>
@ -534,19 +557,16 @@
is part of libc and you should not need to do anything is part of libc and you should not need to do anything
special.</para> special.</para>
<formalpara><title>External file types</title><para>&RCL; uses <formalpara id="rcl.install.building.prereqs.external">
external applications <title>External file types</title>
<para>&RCL; uses external applications
to index some file types. You need to install them for the to index some file types. You need to install them for the
file types that you wish to have indexed:</para> file types that you wish to have indexed:</para>
</formalpara> </formalpara>
<itemizedlist> <itemizedlist>
<listitem><para>MS Word: <ulink
url="http://www.winfield.demon.nl">
antiword</ulink>.</para>
</listitem>
<listitem><para>PDF: pdftotext is part of the <ulink <listitem><para>PDF: pdftotext is part of the <ulink
url="http://www.foolabs.com/xpdf/">Xpdf</ulink> package.</para> url="http://www.foolabs.com/xpdf/">Xpdf</ulink> package.</para>
</listitem> </listitem>
@ -556,14 +576,33 @@
pstotext</ulink>.</para> pstotext</ulink>.</para>
</listitem> </listitem>
<listitem><para>MS Word: <ulink url="http://www.winfield.demon.nl">
antiword</ulink>.</para>
</listitem>
<listitem> <listitem>
<para>RTF: <ulink <para>RTF: <ulink
url="http://www.gnu.org/software/unrtf/unrtf.html">unrtf</ulink> url="http://www.gnu.org/software/unrtf/unrtf.html">unrtf</ulink>
</para> </para>
</listitem> </listitem>
<listitem>
<para>dvi: <ulink
url="http://www.radicaleye.com/dvips.html">dvips</ulink></para>
</listitem>
<listitem>
<para>djvu:
<ulink
url="http://djvulibre.djvuzone.org/doc/index.html">DjVuLibre
</ulink></para>
</listitem>
</itemizedlist> </itemizedlist>
<para>Text, Html, mail folders and Openoffice files are
processed internally.</para>
<sect2 id="rcl.install.building.build"> <sect2 id="rcl.install.building.build">
<title>Building</title> <title>Building</title>
@ -673,16 +712,21 @@
<sect1 id="rcl.install.config"> <sect1 id="rcl.install.config">
<title>Configuration overview</title> <title>Configuration overview</title>
<para>The personal configuration files and the database are <para>There are two sets of configuration files. The system-wide
normally kept in files are kept in a directory named like
the <filename>.recoll</filename> directory in your home (this <filename>/usr/[local/]share/recoll/examples</filename>,
can be changed with the <literal>RECOLL_CONFDIR</literal> they define default values for the system. A parallel set of
environment variable, and a parameter inside the main files exists in the <filename>.recoll</filename> directory in
configuration file). If this directory does not exist when your home (this can be changed with the
<command>recoll</command> or <literal>RECOLL_CONFDIR</literal> environment variable.
<command>recollindex</command> are started, the The database is also kept in <filename>.recoll</filename> by
directory will be created and the sample configuration files will default, (this can be changed by a configuration
be copied. <command>recoll</command> will give you a parameter).</para>
<para>If the <filename>.recoll</filename> directory does not
exist when <command>recoll</command> or
<command>recollindex</command> are started, it
will be created with a set of empty configuration files.
<command>recoll</command> will give you a
chance to edit the configuration file before starting chance to edit the configuration file before starting
indexation. <command>recollindex</command> will indexation. <command>recollindex</command> will
proceed immediately.</para> proceed immediately.</para>
@ -698,7 +742,7 @@
files. You will have to edit them by hand for files. You will have to edit them by hand for
now (there is still some hope for a GUI configuration tool now (there is still some hope for a GUI configuration tool
in the future). The most accurate documentation for the 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.</para> files, and we will just give a general overview here.</para>
<para>All configuration files share the same format. For <para>All configuration files share the same format. For
@ -741,7 +785,7 @@
<sect2 id="rcl.install.config.recollconf"> <sect2 id="rcl.install.config.recollconf">
<title>Main configuration file</title> <title>Main configuration file</title>
<para><filename>~/.recoll/recoll.conf</filename> is the main <para><filename>recoll.conf</filename> is the main
configuration file. It defines things like configuration file. It defines things like
what to index (top directories and things to ignore), and the what to index (top directories and things to ignore), and the
default character set to use for document types which do not default character set to use for document types which do not
@ -866,6 +910,17 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry><term><literal>indexallfilenames</literal></term>
<listitem><para>&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.</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</sect2> </sect2>
@ -873,12 +928,13 @@
<sect2 id="rclinstall.config.mimemap"> <sect2 id="rclinstall.config.mimemap">
<title>The mimemap file</title> <title>The mimemap file</title>
<para><filename>~/.recoll/mimemap</filename> specifies the <para><filename>mimemap</filename> specifies the
file name extension to mime type mappings.</para> <para>For file name extension to mime type mappings.</para>
file names without an extension, or with an unknown one, the
system's <command>file -i</command> command will be executed <para>For file names without an extension, or with an unknown
to determine the mime type (this can be switched off inside one, the system's <command>file -i</command> command will be
the main configuration file).</para> executed to determine the mime type (this can be switched off
inside the main configuration file).</para>
<para><filename>mimemap</filename> also has a list of <para><filename>mimemap</filename> also has a list of
extensions which should be ignored totally (to avoid losing extensions which should be ignored totally (to avoid losing
@ -906,7 +962,7 @@
<sect2 id="rclinstall.config.mimeconf"> <sect2 id="rclinstall.config.mimeconf">
<title>The mimeconf file</title> <title>The mimeconf file</title>
<para><filename>~/.recoll/mimeconf</filename> specifies how the <para><filename>mimeconf</filename> specifies how the
different mime types are handled for indexation, and for different mime types are handled for indexation, and for
display.</para> display.</para>
@ -914,11 +970,13 @@
good idea except if you are a &RCL; developper.</para> good idea except if you are a &RCL; developper.</para>
<para>You may want to adjust the external viewers defined in <para>You may want to adjust the external viewers defined in
(ie: html is either (ie: html is either previewed internally or displayed using
previewed internally or displayed using <application>firefox</application>, but you may prefer
<application>firefox</application>, but you may prefer <application>mozilla</application>, your
<application>mozilla</application>...). Look for the <application>openoffice.org</application>
<literal>[view]</literal> section.</para> program might be named <command>oofice</command> instead of
<command>openoffice</command> ...). Look
for the <literal>[view]</literal> section.</para>
<para>You can also change the icons which are displayed by <para>You can also change the icons which are displayed by
<command>recoll</command> in the result lists (the values are <command>recoll</command> in the result lists (the values are

10
src/qtgui/recoll.pro.in
View File

@ -3,16 +3,16 @@ LANGUAGE = C++
CONFIG += qt warn_on thread release debug CONFIG += qt warn_on thread release debug
HEADERS += rclmain.h HEADERS += rclmain.h rclreslist.h
SOURCES += main.cpp \ SOURCES += main.cpp \
rclmain.cpp \ rclmain.cpp \
idxthread.cpp \ idxthread.cpp \
plaintorich.cpp \ plaintorich.cpp \
guiutils.cpp guiutils.cpp \
rclreslist.cpp
FORMS = reslistb.ui \ FORMS = recollmain.ui \
recollmain.ui \
advsearch.ui \ advsearch.ui \
preview/preview.ui \ preview/preview.ui \
sort.ui \ sort.ui \
@ -46,4 +46,4 @@ contains( UNAME, [lL]inux ) {
LIBS -= -liconv LIBS -= -liconv
} }
TRANSLATIONS = recoll_fr.ts TRANSLATIONS = recoll_fr.ts recoll_ru.ts

2
src/recollinstall.in
View File

@ -50,6 +50,7 @@ for d in \
${bindir} \ ${bindir} \
${mandir}/man1 \ ${mandir}/man1 \
${mandir}/man5 \ ${mandir}/man5 \
${datadir}/applications \
${datadir}/recoll/doc \ ${datadir}/recoll/doc \
${datadir}/recoll/examples \ ${datadir}/recoll/examples \
${datadir}/recoll/filters \ ${datadir}/recoll/filters \
@ -59,6 +60,7 @@ do
test -d $d || mkdir -p $d || exit 1 test -d $d || mkdir -p $d || exit 1
done done
${INSTALL} recoll.desktop ${datadir}/applications
${INSTALL} doc/user/usermanual.html doc/user/docbook.css ${datadir}/recoll/doc ${INSTALL} doc/user/usermanual.html doc/user/docbook.css ${datadir}/recoll/doc
${INSTALL} doc/man/recoll.1 doc/man/recollindex.1 ${mandir}/man1/ ${INSTALL} doc/man/recoll.1 doc/man/recollindex.1 ${mandir}/man1/

18
src/sampleconf/recoll.conf.in
View File

@ -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 default configuration file. This should be copied to
# ~/.recoll/recoll.conf # ~/.recoll/recoll.conf
@ -9,10 +9,10 @@ topdirs = ~
# Wildcard expressions for names of files and directories that we should # Wildcard expressions for names of files and directories that we should
# ignore. If you need index mozilla/thunderbird mail folders, don't put # ignore. If you need index mozilla/thunderbird mail folders, don't put
# ".*" in there (as was the case with an older sample config) # ".*" 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. # Debug messages. 3 is errors/warnings only. 4 would be quite verbose.
loglevel = 4 loglevel = 3
logfilename = stderr logfilename = stderr
# Place to search for executable filters. If RECOLL_FILTERSDIR is set in # 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 # The flag to perform stem expansion at query time is now set from the GUI
indexstemminglanguages = english french 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 # The only reason to change this would be if you want to change the icons
# displayed in the result list # displayed in the result list
iconsdir = @prefix@/share/recoll/images iconsdir = @prefix@/share/recoll/images
@ -50,6 +45,11 @@ guesscharset = 0
# indexation of many bogus 'text' files # indexation of many bogus 'text' files
usesystemfilecommand = 1 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: # You could specify different parameters for a subdirectory like this:
#[~/hungariandocs/plain] #[~/hungariandocs/plain]
#defaultcharset = iso-8859-2 #defaultcharset = iso-8859-2