diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 2da218ac..d5432611 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -1,5 +1,10 @@ + + + Recoll"> Recoll helper applications page"> @@ -58,7 +63,8 @@ applications for document types that need them (for example antiword for ms-word files). - + + Full text search @@ -220,7 +226,7 @@ indexes (ie: use periodic indexing on a big documentation directory, and real time indexing on a small home directory). Monitoring a big file system tree can consume - significant system resources. + significant system resources. &RCL; knows about quite a few different document types. The parameters for document types recognition and @@ -297,7 +303,8 @@ recoll stored in ~/.indexes-email/ and, (unless specified otherwise in recoll.conf) would look for - the index in ~/.indexes-email/xapiandb/. + the index in + ~/.indexes-email/xapiandb/. Using multiple configuration directories and configuration @@ -560,10 +567,10 @@ recoll 3:30AM (supposing recollindex is in your PATH): - 30 3 * * * recollindex > /some/tmp/dir/recolltrace 2>&1 + 30 3 * * * recollindex > /some/tmp/dir/recolltrace 2>&1 Or, using anacron: -1 15 su mylogin -c "recollindex recollindex > /tmp/rcltraceme 2>&1" +1 15 su mylogin -c "recollindex recollindex > /tmp/rcltraceme 2>&1" As of version 1.17 the &RCL; GUI has dialogs to manage @@ -878,7 +885,7 @@ fvwm The format of the result list entries is entirely configurable by using the preference dialog to edit an HTML - fragment. + fragment. You can click on the Query details link at the top of the results page to see the query actually @@ -1122,7 +1129,8 @@ fvwm a slack of 1 it will match the latter, but not fox quick. A proximity search for quick fox with the default slack will match the - latter, and also a fox is a cunning and quick animal. + latter, and also a fox is a cunning and quick + animal. @@ -1330,7 +1338,7 @@ fvwm entry. You can erase the document history by using the Erase document history entry in the - File menu. + File menu. @@ -1457,6 +1465,7 @@ fvwm virtual or reality or both appear, but those which contain virtual reality should appear sooner in the list. + Phrase searches can strongly slow down a query if most of the terms in the phrase are common. This is why the @@ -1474,7 +1483,7 @@ fvwm match the dotted abrreviation if you increase the phrase slack (using the advanced search panel control, or the o query language modifier). Literal occurences of the word will be matched - normally. + normally. @@ -1671,14 +1680,14 @@ fvwm config (try the qtconfig command). - + Edit result list paragraph format string: allows you to change the presentation of each result list entry. See the result list customisation section. - + Edit result page html header insert: allows you to define text inserted at the end of the result page html header. @@ -1692,7 +1701,7 @@ fvwm should be specified as an strftime() string (man strftime). - + Abstract snippet separator: for synthetic abstracts built from index data, which are usually made of several snippets from different parts of the @@ -1782,6 +1791,7 @@ fvwm their database directory (ie: /home/someothergui/.recoll/xapiandb, /usr/local/recollglobal/xapiandb). + Once entered, the indexes will appear in the External indexes list, and you can @@ -1926,6 +1936,7 @@ fvwm define the value of the snippet separator inside the abstract section. + @@ -2174,7 +2185,7 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r document-specified keywords (few documents actually have any). filename for the document's - file name. + file name. ext specifies the file name extension (Ex: ext:html) @@ -2199,10 +2210,10 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r size for filtering the results on file size. Exemple: - size<10000. You can use + size<10000. You can use <, > or = as operators. You can specify a range like the - following: size>100 size<1000. The usual + following: size>100 size<1000. The usual k/K, m/M, g/G, t/T can be used as (decimal) multipliers. Ex: size>1k to search for files bigger than 1000 bytes. @@ -2319,6 +2330,8 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r modifiers. Example: "Important"2.5. + + @@ -2627,7 +2640,7 @@ application/x-chm = execm rclchm <html><head> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> -</head> +</head> <body>some text content</body></html> @@ -2816,7 +2829,7 @@ application/x-chm = execm rclchm Interface manual - + NAME recoll - This is an interface to the Recoll full text indexer. @@ -3002,7 +3015,7 @@ FUNCTIONS writable decides if we can index new data through this connection - + @@ -3014,7 +3027,7 @@ FUNCTIONS #!/usr/bin/env python - += 0 and query.next < nres: print - +]]> - + @@ -3164,7 +3177,7 @@ while query.next >= 0 and query.next < nres: Postscript files need pstotext. The original version has an issue with shell character in file names, which is corrected in recent - packages. See the the &RCLAPPS; for more detail. + packages. See the the &RCLAPPS; for more detail. MS Word needs @@ -3303,7 +3316,9 @@ while query.next >= 0 and query.next < nres: Linux systems, the iconv interface is part of libc and you should not need to do anything special. - + + + Building @@ -3335,7 +3350,7 @@ while query.next >= 0 and query.next < nres: On many Linux systems, QTDIR is set by the login scripts, and QMAKESPECS is not needed because there is a default link in - mkspecs/. + mkspecs/. Neither QTDIR nor QMAKESPECS should be needed with @@ -3360,6 +3375,7 @@ while query.next >= 0 and query.next < nres: Qt QTextBrowser instead of a WebKit widget if you do not or can't depend on the latter. + --enable-xattr will enable code to fetch data from file extended attributes. This is only useful is some application stores data in there, and also needs @@ -4017,7 +4033,7 @@ mondelaypatterns = *.log:20 "this one has spaces*:10" - + @@ -4045,14 +4061,14 @@ mondelaypatterns = *.log:20 "this one has spaces*:10" [prefixes] A field becomes indexed (searchable) by having - a prefix defined in this section. + a prefix defined in this section. [stored] A field becomes stored (displayable inside results) by having its name listed in this section (typically - with an empty value). + with an empty value).