diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index e658a932..cae8004c 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -30,8 +30,17 @@ 2005-2012 Jean-Francois Dockes - + + Permission is granted to copy, distribute and/or + modify this document under the terms of the GNU Free Documentation + License, Version 1.3 or any later version published by the Free + Software Foundation; with no Invariant Sections, no Front-Cover + Texts, and no Back-Cover Texts. A copy of the license can be + found at the following + location: GNU + web site. + This document introduces full text search notions and describes the installation and use of the &RCL; application. It currently describes &RCL; &RCLVERSION;. @@ -171,8 +180,8 @@ consequence, it was impossible to search for a particular capitalization of a term (US / us), or to discriminate two terms based on - diacritics (sake / saké, - mate / maté). + diacritics (sake / saké, + mate / maté). As of version 1.18, &RCL; can optionally store the raw terms, without accent stripping or case conversion. In this configuration, @@ -634,9 +643,9 @@ recoll As of &RCL; version 1.18 you have a choice of building an index with terms stripped of character case and diacritics, or one with raw terms. For a source term of - Résumé, the former will store + Résumé, the former will store resume, the latter - Résumé. + Résumé. Each type of index allows performing searches insensitive to case and diacritics: with a raw index, the user entry will be @@ -648,7 +657,7 @@ recoll index cannot offer: using case and diacritics to discriminate between terms, returning different results when searching for US and us or - resume and résumé. + resume and résumé. Read the section about search case and diacritics sensitivity for more details. @@ -2900,7 +2909,7 @@ dir:recoll dir:src -dir:utils -dir:common The general default is that searches are insensitive to case and diacritics. An entry of resume will match any of Resume, RESUME, - résumé, Résumé etc. + résumé, Résumé etc. Two configuration variables can automate switching on sensitivity: @@ -2912,7 +2921,7 @@ dir:recoll dir:src -dir:utils -dir:common sensitivity to diacritics will be turned on as soon as an accented character exists in a search term. When the variable is set to true, resume will start a - diacritics-unsensitive search, but résumé + diacritics-unsensitive search, but résumé will be matched exactly. The default value is false. @@ -2951,7 +2960,7 @@ dir:recoll dir:src -dir:utils -dir:common "resume"D will search for the term resume exactly - (résumé will not be a match). + (résumé will not be a match). When either case or diacritics sensitivity is activated, stem @@ -4926,12 +4935,12 @@ skippedPaths = ~/somedir/∗.txt the list will turn-off both standard accent and case processing. Example for Swedish: -unac_except_trans = åå Åå ää Ää öö Öö +unac_except_trans = åå Ã…Ã¥ ää Ää öö Öö Note that the translation is not limited to a single character, you could very well have something like - üue in the list. + üue in the list. The default value set for unac_except_trans can't be listed here