diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index b52807b9..52c8d8b1 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -24,7 +24,7 @@ Dockes - $Id: usermanual.sgml,v 1.7 2006-03-28 12:49:03 dockes Exp $ + $Id: usermanual.sgml,v 1.8 2006-03-30 10:31:03 dockes Exp $ This document introduces full text search notions @@ -56,9 +56,7 @@ 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 - appropriate for you. + ms-word files). Full text search @@ -216,9 +214,7 @@ Without further configuration, &RCL; will index all appropriate files from your home directory, with a reasonable - set of defaults, if you live in western Europe or the USA. If - your normal character set is not iso8859-1, you almost certainly - need to adjust the configuration. + set of defaults. @@ -305,6 +301,10 @@ Start the recoll program. + Possibly choose a search mode: Any + term or All terms or + File name. + Enter search term(s) in the text field at the top of the window. @@ -313,11 +313,17 @@ - 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 + The initial default search mode is Any + term. This will look for documents with any of the + search terms (the ones with more terms will get better scores). + All terms will ensure + that only documents with all the terms will be + returned. File name will specifically + look for file names, and allows using wildcards + (*, ? , + []). + + You can use the Tools / Advanced search dialog for more complex searches. After starting a search, a list of results will instantly @@ -334,19 +340,20 @@ using the Tools / Sort parameters dialog. + The Preview and Edit + edit links may not be present for all entries, meaning that + &RCL; has no configured way to preview a given file type (which + was indexed by name only), or no configured external viewer for + the file type. This can sometimes be adjusted simply by tweaking + the + mimemap and + + mimeconf configuration files. + 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*). - @@ -562,7 +569,8 @@ &RCL; uses external applications to index some file types. You need to install them for the - file types that you wish to have indexed: + file types that you wish to have indexed (these are run-time + dependencies. None is needed for building &RCL;): @@ -598,6 +606,12 @@ + MP3: &RCL; will use the + id3info command from the id3lib package to + extract tag information. Without it, only the filenames will + be indexed. + Text, Html, mail folders and Openoffice files are @@ -889,7 +903,9 @@ 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. + subdirectory. If it is not set at all, the character set + used is the one defined by the nls environment (LC_ALL, + LC_CTYPE, LANG), or iso8859-1 if nothing is set. guesscharset Decide if we try to guess the character