diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 085804d1..8b54e0db 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
+ "#idp55120704">Document types
2.1.4. Indexing failures
+ "#idp55140304">Indexing failures
2.1.5. Recovery
+ "#idp55147760">Recovery @@ -981,8 +981,8 @@ alink="#0000FF">
-

2.1.3. Document types

+

2.1.3. Document types

@@ -1075,8 +1075,8 @@ indexedmimetypes = application/pdf
-

2.1.4. Indexing +

2.1.4. Indexing failures

@@ -1116,8 +1116,8 @@ indexedmimetypes = application/pdf
-

2.1.5. Recovery

+

2.1.5. Recovery

@@ -1701,10 +1701,9 @@ metadatacmds = ; tags = tmsu tags %f "margin-left: 0.5in; margin-right: 0.5in;">

Note

-

This is just an example. Depending on the tmsu version, you may need/want to - add options like --database=/some/db.

+

Depending on the tmsu + version, you may need/want to add options like + --database=/some/db.

You may want to restrict this processing to a subset of @@ -5719,7 +5718,7 @@ dir:recoll dir:src -dir:utils -dir:common recollindex. This latter kind will not be described here.

-

There are currently (1.18 and since 1.13) two kinds of +

There are currently (since version 1.13) two kinds of external executable input handlers:

@@ -5870,14 +5869,20 @@ dir:recoll dir:src -dir:utils -dir:common

If you can program and want to write an execm handler, it should not be too difficult to make sense of one of the existing modules. - For example, look at rclzip which uses Zip - file paths as identifiers (ipath), and rclics, which uses an - integer index. Also have a look at the comments inside - the internfile/mh_execm.h - file and possibly at the corresponding module.

+ There is a sample one with many comments, not actually + used by Recoll, which + would index a text file as one document per line. Look + for rcltxtlines.py in the + src/filters directory in + the Recoll BitBucket repository (the sample not in + the distributed release at the moment).

+ +

You can also have a look at the slightly more complex + rclzip + which uses Zip file paths as identifiers (ipath).

execm handlers sometimes need to make a choice for the nature of the If no suffix association is found for the file name, Recoll will try to - execute the file - -i command to determine a MIME type.

+ execute a system command (typically file -i or xdg-mime) to determine + a MIME type.

-

The association of file types to handlers is performed - in the The second element is the association of MIME types to + handlers in the mimeconf file. A sample will - probably be of better help than a long explanation:

+ probably be better than a long explanation:

 
 [index]
@@ -9404,18 +9411,24 @@ x-my-tag = mailmytag
           file name extension to MIME type mappings.

For file names without an extension, or with an - unknown one, the system's file -i command will be executed to determine - the MIME type (this can be switched off inside the main - configuration file).

+ "option">-i
, or xdg-mime) will be + executed to determine the MIME type (this can be switched + off, or the command changed inside the main configuration + file).

The mappings can be specified on a per-subtree basis, which may be useful in some cases. Example: gaim logs have a .txt extension but should be handled + "application">okular notes have a .xml extension but should be handled specially, which is possible because they are usually all - located in one place.

+ located in one place. Example:

+
+[~/.kde/share/apps/okular/docdata]
+.xml = application/x-okular-notes
+

The recoll_noindex mimemap variable has been diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 14cf7014..cee8e2ea 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -3877,7 +3877,7 @@ dir:recoll dir:src -dir:utils -dir:common inside recollindex. This latter kind will not be described here. - There are currently (1.18 and since 1.13) two kinds of + There are currently (since version 1.13) two kinds of external executable input handlers: Simple exec handlers @@ -3988,13 +3988,18 @@ dir:recoll dir:src -dir:utils -dir:common If you can program and want to write an execm handler, it should not be too - difficult to make sense of one of the existing modules. For - example, look at rclzip which uses Zip - file paths as identifiers (ipath), - and rclics, which uses an integer - index. Also have a look at the comments inside - the internfile/mh_execm.h file and - possibly at the corresponding module. + difficult to make sense of one of the existing modules. There is + a sample one with many comments, not actually used by &RCL;, + which would index a text file as one document per line. Look for + rcltxtlines.py in the + src/filters directory in the &RCL; BitBucket + repository (the sample + not in the distributed release at the moment). + + You can also have a look at the slightly more complex + rclzip which uses Zip + file paths as identifiers (ipath). execm handlers sometimes need to make a choice for the nature of the ipath @@ -4045,13 +4050,13 @@ dir:recoll dir:src -dir:utils -dir:common .doc = application/msword If no suffix association is found for the file name, &RCL; will try - to execute the file -i command to determine a - MIME type. + to execute a system command (typically file -i or + xdg-mime) to determine a MIME type. - The association of file types to handlers is performed in - the + The second element is the association of MIME types to handlers + in the mimeconf file. A sample will probably be - of better help than a long explanation: + better than a long explanation: [index] @@ -6543,18 +6548,20 @@ x-my-tag = mailmytag mimemap specifies the file name extension to MIME type mappings. - For file names without an extension, or with an unknown - one, the system's file - command will be - executed to determine the MIME type (this can be switched off - inside the main configuration file). + For file names without an extension, or with an unknown one, + a system command (file , or + xdg-mime) will be executed to determine the MIME + type (this can be switched off, or the command changed inside the + main configuration file). The mappings can be specified on a per-subtree basis, which may be useful in some cases. Example: - gaim logs have a - .txt extension but + okular notes have a + .xml extension but should be handled specially, which is possible because they - are usually all located in one place. + are usually all located in one place. Example: + [~/.kde/share/apps/okular/docdata] +.xml = application/x-okular-notes The recoll_noindex mimemap variable has been moved to