From cbd72938333a159345cccac565e5ef443907642a Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Wed, 10 May 2017 11:25:39 +0200 Subject: [PATCH] doc --- src/doc/user/recoll.conf.xml | 16 ++++---- src/doc/user/usermanual.html | 72 ++++++++++++++++++++---------------- src/doc/user/usermanual.xml | 34 ++++++++++------- 3 files changed, 71 insertions(+), 51 deletions(-) diff --git a/src/doc/user/recoll.conf.xml b/src/doc/user/recoll.conf.xml index e8d379ed..f40b3c51 100644 --- a/src/doc/user/recoll.conf.xml +++ b/src/doc/user/recoll.conf.xml @@ -98,16 +98,18 @@ followed. indexedmimetypes Restrictive list of indexed mime types. Normally not set (in which case all -supported types are indexed). If it is set, -only the types from the list will have their contents indexed. The names -will be indexed anyway if indexallfilenames is set (default). MIME -type names should be taken from the mimemap file. Can be redefined for -subtrees. +supported types are indexed). If it is set, only the types from the list +will have their contents indexed. The names will be indexed anyway if +indexallfilenames is set (default). MIME type names should be taken from +the mimemap file (the values may be different from xdg-mime or file -i +output in some cases). Can be redefined for subtrees. excludedmimetypes List of excluded MIME -types. Lets you exclude some types from indexing. Can be -redefined for subtrees. +types. Lets you exclude some types from indexing. MIME type +names should be taken from the mimemap file (the values may be different +from xdg-mime or file -i output in some cases) Can be redefined for +subtrees. nomd5mimetypes Don't compute md5 for diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 48498312..c372ac63 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -20,8 +20,8 @@ alink="#0000FF">
-

Recoll user manual

+

Recoll user manual

@@ -109,13 +109,13 @@ alink="#0000FF"> multiple indexes
2.1.3. Document types
+ "#idp43099712">Document types
2.1.4. Indexing failures
+ "#idp43124208">Indexing failures
2.1.5. Recovery
+ "#idp43131216">Recovery @@ -997,8 +997,8 @@ alink="#0000FF">
-

2.1.3. Document types

+

2.1.3. Document types

@@ -1048,17 +1048,37 @@ alink="#0000FF"> latter case, any type not in the list will be ignored.

+
+

Note about MIME types

+ +

When editing the indexedmimetypes or excludedmimetypes lists, you should + use the MIME values listed in the mimemap file or in Recoll result + lists in preference to file + -i output: there are a number of differences. + The file -i output should + only be used for files without extensions, or for which + the extension is not listed in mimemap

+
+

Excluding types can be done by adding wildcard name - patterns to the skippedNames + patterns to the skippedNames list, which can be done from the GUI Index configuration menu. For versions 1.20 and later, you can alternatively - set the excludedmimetypes + set the excludedmimetypes list in the configuration file. This can be redefined for subdirectories.

You can also define an exclusive list of MIME types to be indexed (no others will be indexed), by settting the - indexedmimetypes + indexedmimetypes configuration variable. Example:

 indexedmimetypes = text/html application/pdf
@@ -1085,28 +1105,14 @@ indexedmimetypes = application/pdf
           main configuration file (recoll.conf), or from the GUI index
           configuration tool.

-
-          

-            
Note

-
-            
When editing the indexedmimetypes or excludedmimetypes lists, you should
-            use the MIME values listed in the mimemap file or in Recoll result
-            lists in preference to file
-            -i output: there are a number of
-            differences.

-
-

2.1.4. Indexing +

2.1.4. Indexing failures

@@ -1146,8 +1152,8 @@ indexedmimetypes = application/pdf
-

2.1.5. Recovery

+

2.1.5. Recovery

@@ -8832,7 +8838,9 @@ thesame = "some string with spaces" list will have their contents indexed. The names will be indexed anyway if indexallfilenames is set (default). MIME type names should be taken from the - mimemap file. Can be redefined for subtrees.

+ mimemap file (the values may be different from + xdg-mime or file -i output in some cases). Can be + redefined for subtrees.

List of excluded MIME types. Lets you exclude - some types from indexing. Can be redefined for - subtrees.

+ some types from indexing. MIME type names should be + taken from the mimemap file (the values may be + different from xdg-mime or file -i output in some + cases) Can be redefined for subtrees.

- Excluding types can be done by adding wildcard name - patterns to the skippedNames list, which + Note about MIME types + When editing the indexedmimetypes + or excludedmimetypes lists, you should use the + MIME values listed in the mimemap file + or in Recoll result lists in preference to file -i + output: there are a number of differences. The + file -i output should only be used for files + without extensions, or for which the extension is not listed in + mimemap + + Excluding types can be done by adding wildcard name + patterns to the + + skippedNames list, which can be done from the GUI Index configuration menu. For versions 1.20 and later, you can alternatively set the - excludedmimetypes list in the - configuration file. This can be redefined for - subdirectories. + + excludedmimetypes list in the configuration file. This + can be redefined for subdirectories. - You can also define an exclusive list of MIME types to be indexed (no others will be indexed), by settting - the indexedmimetypes configuration - variable. Example: + You can also define an exclusive list of MIME types to be + indexed (no others will be indexed), by settting + the + indexedmimetypes configuration variable. Example: indexedmimetypes = text/html application/pdf It is possible to redefine this parameter for @@ -484,11 +497,6 @@ indexedmimetypes = application/pdf (recoll.conf), or from the GUI index configuration tool. - When editing the indexedmimetypes - or excludedmimetypes lists, you should use the - MIME values listed in the mimemap file - or in Recoll result lists in preference to file -i - output: there are a number of differences.