Switch to unified view

a/src/README b/src/README
...
...
14
14
15
   Recoll is a personal full text search package for Linux, FreeBSD and other
15
   Recoll is a personal full text search package for Linux, FreeBSD and other
16
   Unix systems.
16
   Unix systems.
17
17
18
   Recoll is based on a very strong backend (Xapian), for which it provides
18
   Recoll is based on a very strong backend (Xapian), for which it provides
19
   an easy to use, feature-rich, easy-administration interface.
19
   an easy to use, feature-rich, easy administration interface.
20
20
21
   Recoll is free and copyrighted under the GPL license, see COPYING inside
21
   Recoll is free and copyrighted under the GPL license, see COPYING inside
22
   the distribution. A lot of the code is imported from other packages, see
22
   the distribution. A lot of the code is imported from other packages, see
23
   the Credits.
23
   the Credits.
24
24
25
  Features:
25
  Features:
26
26
27
     * Document types: text, html, pdf (with pdftotext), postscript (with
27
     * QT-based GUI.
28
       ghostscript's pstotext), msword (with antiword), openoffice files,
28
     * Supports the following document types:
29
          * text.
30
          * html.
31
          * OpenOffice files.
29
       maildir and mailbox mail folders (Mozilla and thunderbird mail ok).
32
          * maildir and mailbox mail folders (Mozilla and Thunderbird mail
33
            ok).
34
          * pdf (with pdftotext).
35
          * postscript (with ghostscript's pstotext).
36
          * msword (with antiword).
30
       Deals with compressed versions of same.
37
       along with their compressed versions.
31
     * Relatively powerful query facilities, with boolean searches, phrases,
38
     * Powerful query facilities, with boolean searches, phrases, filter on
32
       filter on file types and directory tree.
39
       file types and directory tree.
33
     * Support for multiple charsets. Internal processing and storage uses
40
     * Support for multiple charsets. Internal processing and storage uses
34
       Unicode UTF-8.
41
       Unicode UTF-8.
35
     * Stemming performed at query time (can switch stemming language after
42
     * Stemming performed at query time (can switch stemming language after
36
       indexing)
43
       indexing)
37
     * Easy installation. No database daemon, web server or exotic language
44
     * Easy installation. No database daemon, web server or exotic language
38
       necessary. The idea is that everybody should index their files because
45
       necessary.
39
       it makes life easier.
40
     * GUI based on qt, written with qt Designer.
41
     * An indexer which runs either as a thread inside the GUI or as an
46
     * An indexer which runs either as a thread inside the GUI or as an
42
       external, cron'able program.
47
       external, cron'able program.
43
48
44
   Recoll has been compiled and tested on FreeBSD, Linux, Darwin and Solaris
49
   Recoll has been compiled and tested on FreeBSD, Linux, Darwin and Solaris
45
   (versions FreeBSD 5.3, Redhat 7.3, Solaris 8, but other not too distant
50
   (versions FreeBSD 5.3, Redhat 7.3, Solaris 8, but other not too distant
46
   releases should be ok too). You can download the source code here.
51
   releases should be ok too). You can download the source code here.
47
52
48
  Things lacking, coming in the not too far future:
53
  Future evolutions
49
54
55
   Things hopefully coming in the not too far future (especially with some
56
   help):
57
58
     * Support for the more advanced Xapian concepts like relevance feedback.
50
     * An interactive configuration tool. You need to edit files by hand for
59
     * An interactive configuration tool. You need to edit files by hand for
51
       now.
60
       now.
52
     * Packages, rpm or other. It's all tar files currently.
61
     * Packages, rpm or other. It's all tar files currently.
53
     * More documentation and help.
62
     * A more polished user interface with online help and better
63
       documentation.
54
     * Translations for the user interface.
64
     * Translations for the user interface.
55
     * A few more filters for less common file types.
65
     * A few more filters for less common file types.
66
     * An history tool for queries and documents.
67
     * Integration with the KDE desktop.
56
68
57
   I very much welcome suggestions or (gasp) code.
69
   I very much welcome suggestions or (gasp) code.
58
70
59
   In hope that this can be useful to somebody, it already is for me.
71
   In hope that this can be useful to somebody, it already is for me.
60
     * Home
72
     * Home
...
...
78
     * Unac: for accent removal. This is a relatively small package, not that
90
     * Unac: for accent removal. This is a relatively small package, not that
79
       easy to find, it has been integrated almost unmodified in the Recoll
91
       easy to find, it has been integrated almost unmodified in the Recoll
80
       package.
92
       package.
81
     * Iconv, for character set conversion.
93
     * Iconv, for character set conversion.
82
     * Binc IMAP for MIME parsing code.
94
     * Binc IMAP for MIME parsing code.
83
     * I fear the rest of the bugs to be mostly mine:
95
     * I fear that bugs found elsewhere are mostly mine:
84
       jean-francois.dockes@wanadoo.fr
96
       jean-francois.dockes@wanadoo.fr
85
     * Home
97
     * Home
86
     * Screenshots
98
     * Screenshots
87
     * Credits
99
     * Credits
88
     * Downloads
100
     * Downloads
...
...
130
142
131
  Complex/advanced search
143
  Complex/advanced search
132
144
133
   The advanced search dialog has fields that will allow a more refined
145
   The advanced search dialog has fields that will allow a more refined
134
   search, looking for documents with all given words, a given exact phrase,
146
   search, looking for documents with all given words, a given exact phrase,
135
   or none of the given words (all fields may be combined by a default AND
147
   or none of the given words (all fields may be combined by an implicit AND
136
   clause).
148
   clause).
137
149
138
   It will let you search for documents of specific mime types (ie: only
150
   It will let you search for documents of specific mime types (ie: only
139
   text/plain, or text/html or application/pdf etc...)
151
   text/plain, or text/html or application/pdf etc...)
140
152
141
   It will let you restrict the search results to a subtree of the indexed
153
   It will let you restrict the search results to a subtree of the indexed
142
   area.
154
   area.
143
155
144
   In other respects, it works as the simple search.
156
   In other respects, it works like the simple search.