Switch to unified view

a/src/INSTALL b/src/INSTALL
...
...
662
   localfields
662
   localfields
663
663
664
           This allows setting fields for all documents under a given
664
           This allows setting fields for all documents under a given
665
           directory. Typical usage would be to set an "rclaptg" field, to be
665
           directory. Typical usage would be to set an "rclaptg" field, to be
666
           used in mimeview to select a specific viewer. If several fields
666
           used in mimeview to select a specific viewer. If several fields
667
           are to be set, they should be separated with a colon (':')
667
           are to be set, they should be separated with a semi-colon (';')
668
           character (which there is currently no way to escape). Ie:
668
           character, which there is currently no way to escape. Also note
669
           localfields= rclaptg=gnus:other = val, then select specifier
669
           the initial semi-colon. Example: localfields= ;rclaptg=gnus;other
670
           viewer with mimetype|tag=... in mimeview.
670
           = val, then select specifier viewer with mimetype|tag=... in
671
           mimeview.
672
673
   metadatacmds
674
675
           This allows executing external commands for each file and storing
676
           the output in a Recoll field. This could be used for example to
677
           index external tag data. The value is a list of field names and
678
           commands, don't forget an initial semi-colon. Example:
679
680
 [/some/area/of/the/fs]
681
 metadatacmds = ; tags = tmsu tags %f; otherfield = somecmd -xx %f
682
                
671
683
672
    5.4.1.3. Parameters affecting where and how we store things:
684
    5.4.1.3. Parameters affecting where and how we store things:
673
685
674
   dbdir
686
   dbdir
675
687
...
...
895
 [mail]
907
 [mail]
896
 # Extract the X-My-Tag mail header, and use it internally with the
908
 # Extract the X-My-Tag mail header, and use it internally with the
897
 # mailmytag field name
909
 # mailmytag field name
898
 x-my-tag = mailmytag
910
 x-my-tag = mailmytag
899
911
912
    5.4.2.1. Extended attributes in the fields file
913
914
   Recoll versions 1.19 and later process user extended file attributes as
915
   documents fields by default.
916
917
   Attributes are processed as fields of the same name, after removing the
918
   user prefix on Linux.
919
920
   The [xattrtofields] section of the fields file allows specifying
921
   translations from extended attributes names to Recoll field names. An
922
   empty translation disables use of the corresponding attribute data.
923
900
  5.4.3. The mimemap file
924
  5.4.3. The mimemap file
901
925
902
   mimemap specifies the file name extension to mime type mappings.
926
   mimemap specifies the file name extension to mime type mappings.
903
927
904
   For file names without an extension, or with an unknown one, the system's
928
   For file names without an extension, or with an unknown one, the system's
...
...
1002
   In addition to the predefined values above, all strings like %(fieldname)
1026
   In addition to the predefined values above, all strings like %(fieldname)
1003
   will be replaced by the value of the field named fieldname for the
1027
   will be replaced by the value of the field named fieldname for the
1004
   document. This could be used in combination with field customisation to
1028
   document. This could be used in combination with field customisation to
1005
   help with opening the document.
1029
   help with opening the document.
1006
1030
1031
  5.4.6. The ptrans file
1032
1033
   ptrans specifies query-time path translations. These can be useful in
1034
   multiple cases.
1035
1036
   The file has a section for any index which needs translations, either the
1037
   main one or additional query indexes. The sections are named with the
1038
   Xapian index directory names. No slash character should exist at the end
1039
   of the paths (all comparisons are textual). An exemple should make things
1040
   sufficiently clear
1041
1042
           [/home/me/.recoll/xapiandb]
1043
           /this/directory/moved = /to/this/place
1044
1045
           [/path/to/additional/xapiandb]
1046
           /server/volume1/docdir = /net/server/volume1/docdir
1047
           /server/volume2/docdir = /net/server/volume2/docdir
1048
        
1049
1007
  5.4.6. Examples of configuration adjustments
1050
  5.4.7. Examples of configuration adjustments
1008
1051
1009
    5.4.6.1. Adding an external viewer for an non-indexed type
1052
    5.4.7.1. Adding an external viewer for an non-indexed type
1010
1053
1011
   Imagine that you have some kind of file which does not have indexable
1054
   Imagine that you have some kind of file which does not have indexable
1012
   content, but for which you would like to have a functional Open link in
1055
   content, but for which you would like to have a functional Open link in
1013
   the result list (when found by file name). The file names end in .blob and
1056
   the result list (when found by file name). The file names end in .blob and
1014
   can be displayed by application blobviewer.
1057
   can be displayed by application blobviewer.
...
...
1034
   mime type which it already knows, you would just need to edit mimeview.
1077
   mime type which it already knows, you would just need to edit mimeview.
1035
   The entries you add in your personal file override those in the central
1078
   The entries you add in your personal file override those in the central
1036
   configuration, which you do not need to alter. mimeview can also be
1079
   configuration, which you do not need to alter. mimeview can also be
1037
   modified from the Gui.
1080
   modified from the Gui.
1038
1081
1039
    5.4.6.2. Adding indexing support for a new file type
1082
    5.4.7.2. Adding indexing support for a new file type
1040
1083
1041
   Let us now imagine that the above .blob files actually contain indexable
1084
   Let us now imagine that the above .blob files actually contain indexable
1042
   text and that you know how to extract it with a command line program.
1085
   text and that you know how to extract it with a command line program.
1043
   Getting Recoll to index the files is easy. You need to perform the above
1086
   Getting Recoll to index the files is easy. You need to perform the above
1044
   alteration, and also to add data to the mimeconf file (typically in
1087
   alteration, and also to add data to the mimeconf file (typically in