diff --git a/src/INSTALL b/src/INSTALL index 338ed54c..88cadabb 100644 --- a/src/INSTALL +++ b/src/INSTALL @@ -2,106 +2,3 @@ A more complete version of this document can be found at http://www.recoll.org - * Home - * Screenshots - * Credits - * Downloads - * Installation - * User manual - -Installing Recoll - - Building from source - - Prerequisites - - At the very least, you will need to download and install the xapian core - package (I am currently using xapian version 0.8.5), and the qt runtime - and development packages (I am currently using qt 3.3.3). - - 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. - - You also need libiconv. I am currently using version 1.9. The iconv - interface is part of libc on Linux systems, you shouldn't need to do - anything there. - - External file types: recoll 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 documents: antiword. - * PDF files: pdftotext is part of the Xpdf package. - * Postscript files: pstotext. - - Building - - 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 - comments and patches. - - Normal procedure: - - * cd recoll-xxx - * configure - * make - * (practise your usual hardship-repelling invocations). - - There is no real autoconfiguration. The configure script will just link - one of the system-specific files in the mk directory to mk/sysconf. If - your system is 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). - - 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 - - The binary versions are just compressed tar files of a build 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 can't change the versions of xapian and iconv which - are used. - - After extracting the tar file, you can proceed with installation as if you - had built the package from source. - - Installation - - Execute installrecoll targetdir, in the root of the source tree. This - will: - - * Only if you have write access on targetdir/bin, copy qtgui/recoll and - index/recollindex to targetdir/bin (but you could also execute them - from their build directories). - * Only if you are not root check if ~/.recoll exists, and if it does - not: - * Copy all files from sampleconf/* to ~/.recoll - * Copy all files from filters/* to ~/.recoll. - - Typically, you would execute the script once as root to install the - programs to /usr/local, and once as yourself to create the configuration. - - Configuration - - 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 - from the GUI in the future). - - The main configuration file is named ~/.recoll/recoll.conf. - - There is a commented sample in the sampleconf subdirectory, it was copied - to ~/.recoll at the previous step, take a look and possibly edit it. By - default, it will index your home directory. - - Then start recollindex, and wait for indexing to complete (this may take - some time). When it's done, you can start recoll and try a search. - - 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 - previewed internally or displayed using firefox, but you may prefer - mozilla...). Look for the [view] section. diff --git a/src/README b/src/README index 50838157..88cadabb 100644 --- a/src/README +++ b/src/README @@ -2,143 +2,3 @@ A more complete version of this document can be found at http://www.recoll.org - * Home - * Screenshots - * Credits - * Downloads - * Installation - * User manual - [IMG] - -Recoll - - Recoll is a personal full text indexing package for Linux and other Unix - systems. - - Recoll is based on a very strong backend (Xapian), for which it provides - an easy to use, feature-rich, zero-administration interface. - - Recoll is free and copyrighted under the GPL license, see COPYING inside - the distribution. A lot of the code is imported from other packages, see - the Credits. - - Features: - - * Document types: text, html, pdf (with pdftotext), postscript (with - ghostscript's pstotext), msword (with antiword), openoffice files, - maildir and mailbox mail folders (Mozilla and thunderbird mail ok). - Deals with compressed versions of same. - * Relatively powerful query facilities, with boolean searches, phrases, - filter on file types and directory tree. - * Support for multiple charsets. Internal processing and storage uses - Unicode UTF-8. - * Stemming performed at query time (can switch stemming language after - indexing) - * Easy installation. No database daemon, web server or exotic language - necessary. The idea is that everybody should index their files because - it makes life easier. - * GUI based on qt, written with qt Designer. - * An indexer which runs either as a thread inside the GUI or as an - external, cron'able program. - - Recoll has been compiled and tested on FreeBSD, Linux and Solaris - (versions FreeBSD 5.3, Redhat 7.3, Solaris 8, but other not too distant - releases should be ok too). You can download the source code here. - - Things lacking, coming in the not too far future: - - * An interactive configuration tool. You need to edit files by hand for - now. - * Packages, rpm or other. It's all tar files currently. - * Documentation and help. - * Translations for the user interface. - * A few more filters for less common file types. - - I very much welcome suggestions or (gasp) code. - - In hope that this can be useful to somebody, it already is for me. - * Home - * Screenshots - * Credits - * Downloads - * Installation - * User manual - - Credits - - Recoll borrows (steals?) heavily from the following projects. I tried to - include the relevant copyright attributions with the code. Any omission is - unintentional and will be fixed as soon as notified. - - * Xapian: The database module (core) is used unmodified, and quite a lot - of code has been borrowed from Omega, the web-based search application - (ie: the html parser, plus miscellaneous bits and ideas). - * Estraier: Miscellaneous pieces of code and ideas, especially for - charset handling, and code from external filters. - * Unac: for accent removal. This is a relatively small package, not that - easy to find, it has been integrated almost unmodified in the Recoll - package. - * Iconv, for character set conversion. - * Binc IMAP for MIME parsing code. - * I fear the rest of the bugs to be mostly mine: - jean-francois.dockes@wanadoo.fr - * Home - * Screenshots - * Credits - * Downloads - * Installation - * User manual - -Using Recoll - - Indexation - - 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). - Follow the comments in the file to adjust the parameters. - - Indexing is performed either by starting the recollindex program, or by - the indexing thread inside the recoll program (use the File menu). - - Simple search - - Enter search term(s) in the text field at the top left. 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). Use the Advanced search dialog for other - kinds of searches - - 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. - Double-clicking will attempt to start an external viewer (have a look at - the ~/.recoll/mimeconf file to see how these are configured). - - Search tips, shortcuts - - Entering a capitalized word in any search field will prevent stem - expansion (example: Recoll will not look for gardening if you enter Garden - instead of garden). - - A phrase can be looked for by enclosing it in double quotes. Example: - "user manual" will look only for occurrences of user immediately followed - by manual. - - Entering ^Q almost anywhere will close the application. - - Entering ^W in a preview tab will close it (and, for the last tab, close - the preview window). - - 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 a default AND - clause). - - It will let you search for documents of specific mime types (ie: only - text/plain, or text/html or application/pdf etc...) - - It will let you restrict the search results to a subtree of the indexed - area. - - In other respects, it works as the simple search. diff --git a/src/VERSION b/src/VERSION index f1ad6a77..11a84add 100644 --- a/src/VERSION +++ b/src/VERSION @@ -1 +1 @@ -1.03 +1.04