From b13e465de468ab25f28e22cd3317ef5b31e12106 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Sun, 3 Apr 2016 10:00:17 +0200 Subject: [PATCH] doc --- src/doc/user/usermanual.html | 80 ++++++++++++++++--- src/doc/user/usermanual.xml | 58 ++++++++++++-- .../webhelp/docs/RCL.INDEXING.CONFIG.GUI.html | 2 +- .../docs/RCL.INDEXING.CONFIG.MULTIPLE.html | 2 +- .../docs/RCL.INDEXING.CONFIG.SENS.html | 2 +- .../webhelp/docs/RCL.INDEXING.CONFIG.html | 2 +- .../webhelp/docs/RCL.INDEXING.EXTATTR.html | 2 +- .../webhelp/docs/RCL.INDEXING.EXTTAGS.html | 43 ++++++++-- .../RCL.INDEXING.INTRODUCTION.CONFIG.html | 2 +- .../docs/RCL.INDEXING.INTRODUCTION.MODES.html | 2 +- .../docs/RCL.INDEXING.INTRODUCTION.html | 2 +- .../docs/RCL.INDEXING.MONITOR.FASTFILES.html | 2 +- .../webhelp/docs/RCL.INDEXING.MONITOR.html | 2 +- .../docs/RCL.INDEXING.PERIODIC.AUTOMAT.html | 2 +- .../docs/RCL.INDEXING.PERIODIC.EXEC.html | 2 +- .../webhelp/docs/RCL.INDEXING.PERIODIC.html | 2 +- .../docs/RCL.INDEXING.STORAGE.FORMAT.html | 2 +- .../docs/RCL.INDEXING.STORAGE.SECURITY.html | 2 +- .../webhelp/docs/RCL.INDEXING.STORAGE.html | 2 +- .../webhelp/docs/RCL.INDEXING.WEBQUEUE.html | 2 +- src/doc/user/webhelp/docs/RCL.INDEXING.html | 2 +- .../user/webhelp/docs/RCL.INSTALL.BINARY.html | 2 +- .../RCL.INSTALL.BUILDING.BUILD.SOLARIS.html | 2 +- .../docs/RCL.INSTALL.BUILDING.BUILD.html | 2 +- .../docs/RCL.INSTALL.BUILDING.INSTALL.html | 2 +- .../docs/RCL.INSTALL.BUILDING.PREREQS.html | 2 +- .../webhelp/docs/RCL.INSTALL.BUILDING.html | 2 +- .../docs/RCL.INSTALL.CONFIG.ENVIR.html | 2 +- .../RCL.INSTALL.CONFIG.EXAMPLES.ADDINDEX.html | 2 +- .../RCL.INSTALL.CONFIG.EXAMPLES.ADDVIEW.html | 2 +- .../docs/RCL.INSTALL.CONFIG.EXAMPLES.html | 2 +- .../docs/RCL.INSTALL.CONFIG.FIELDS.XATTR.html | 2 +- .../docs/RCL.INSTALL.CONFIG.FIELDS.html | 2 +- .../docs/RCL.INSTALL.CONFIG.MIMECONF.html | 2 +- .../docs/RCL.INSTALL.CONFIG.MIMEMAP.html | 2 +- .../docs/RCL.INSTALL.CONFIG.MIMEVIEW.html | 2 +- .../docs/RCL.INSTALL.CONFIG.PTRANS.html | 2 +- .../RCL.INSTALL.CONFIG.RECOLLCONF.FILES.html | 2 +- ....INSTALL.CONFIG.RECOLLCONF.IDXTHREADS.html | 2 +- .../RCL.INSTALL.CONFIG.RECOLLCONF.MISC.html | 2 +- ...RCL.INSTALL.CONFIG.RECOLLCONF.STORAGE.html | 2 +- .../RCL.INSTALL.CONFIG.RECOLLCONF.TERMS.html | 2 +- .../docs/RCL.INSTALL.CONFIG.RECOLLCONF.html | 2 +- .../user/webhelp/docs/RCL.INSTALL.CONFIG.html | 2 +- .../webhelp/docs/RCL.INSTALL.EXTERNAL.html | 2 +- src/doc/user/webhelp/docs/RCL.INSTALL.html | 2 +- .../webhelp/docs/RCL.INTRODUCTION.RECOLL.html | 2 +- .../webhelp/docs/RCL.INTRODUCTION.SEARCH.html | 2 +- .../webhelp/docs/RCL.INTRODUCTION.TRYIT.html | 2 +- .../user/webhelp/docs/RCL.INTRODUCTION.html | 2 +- .../user/webhelp/docs/RCL.KICKER-APPLET.html | 2 +- .../docs/RCL.PROGRAM.API.ELEMENTS.html | 2 +- .../webhelp/docs/RCL.PROGRAM.API.PYTHON.html | 2 +- .../user/webhelp/docs/RCL.PROGRAM.API.html | 2 +- .../user/webhelp/docs/RCL.PROGRAM.FIELDS.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.ASSOCIATION.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.HTML.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.MULTIPLE.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.PAGES.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.SIMPLE.html | 2 +- .../webhelp/docs/RCL.PROGRAM.FILTERS.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.COMPAT.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.EXAMPLES.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.INTRO.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.PACKAGE.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.RCLEXTRACT.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.RECOLL.html | 2 +- src/doc/user/webhelp/docs/RCL.PROGRAM.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.ANCHOR.html | 2 +- .../webhelp/docs/RCL.SEARCH.ANCHORWILD.html | 2 +- .../webhelp/docs/RCL.SEARCH.CASEDIAC.html | 16 ++-- .../webhelp/docs/RCL.SEARCH.COMMANDLINE.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.DESKTOP.html | 2 +- .../docs/RCL.SEARCH.GUI.COMPLEX.FILTER.html | 2 +- .../docs/RCL.SEARCH.GUI.COMPLEX.HISTORY.html | 2 +- .../docs/RCL.SEARCH.GUI.COMPLEX.TERMS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.COMPLEX.html | 2 +- .../docs/RCL.SEARCH.GUI.CUSTOM.RESLIST.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.CUSTOM.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.FRAGBUTS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.HISTORY.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.MULTIDB.html | 2 +- .../docs/RCL.SEARCH.GUI.PREVIEW.SEARCH.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.PREVIEW.html | 2 +- .../docs/RCL.SEARCH.GUI.RESLIST.SUGGS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.RESLIST.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.RESTABLE.html | 2 +- .../docs/RCL.SEARCH.GUI.RESULTLIST.MENU.html | 2 +- .../docs/RCL.SEARCH.GUI.RUNSCRIPT.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.SIMPLE.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.SORT.html | 2 +- .../docs/RCL.SEARCH.GUI.TERMEXPLORER.html | 2 +- .../docs/RCL.SEARCH.GUI.THUMBNAILS.html | 2 +- .../docs/RCL.SEARCH.GUI.TIPS.MISC.html | 2 +- .../docs/RCL.SEARCH.GUI.TIPS.PHRASES.html | 2 +- .../docs/RCL.SEARCH.GUI.TIPS.TERMS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.TIPS.html | 2 +- src/doc/user/webhelp/docs/RCL.SEARCH.GUI.html | 2 +- .../webhelp/docs/RCL.SEARCH.KIO.INTRO.html | 2 +- .../docs/RCL.SEARCH.KIO.SEARCHABLEDOCS.html | 2 +- src/doc/user/webhelp/docs/RCL.SEARCH.KIO.html | 2 +- .../docs/RCL.SEARCH.LANG.MODIFIERS.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.LANG.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.PTRANS.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.SAVING.html | 2 +- .../webhelp/docs/RCL.SEARCH.SHORTCUT.html | 2 +- .../webhelp/docs/RCL.SEARCH.SYNONYMS.html | 2 +- .../docs/RCL.SEARCH.WILDCARDS.PATH.html | 2 +- .../webhelp/docs/RCL.SEARCH.WILDCARDS.html | 2 +- src/doc/user/webhelp/docs/RCL.SEARCH.html | 2 +- src/doc/user/webhelp/docs/ch02s01s03.html | 4 +- src/doc/user/webhelp/docs/ch02s01s04.html | 4 +- src/doc/user/webhelp/docs/ch02s01s05.html | 4 +- src/doc/user/webhelp/docs/index.html | 4 +- 114 files changed, 278 insertions(+), 147 deletions(-) diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index c3550cb6..949b3e34 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
+ "#idp58828400">Document types
2.1.4. Indexing failures
+ "#idp58848080">Indexing failures
2.1.5. Recovery
+ "#idp58855088">Recovery @@ -962,8 +962,8 @@ alink="#0000FF">
-

2.1.3. Document types

+

2.1.3. Document types

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

2.1.4. Indexing +

2.1.4. Indexing failures

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

2.1.5. Recovery

+

2.1.5. Recovery

@@ -1665,7 +1665,63 @@ recoll -c ~/.indexes-email

See the section about the metadatacmds field in - the main configuration chapter for more detail.

+ the main configuration chapter for a description of the + configuration syntax.

+ +

As an example, if you would want Recoll to use tags managed by + tmsu, you would add the + following to the configuration file:

+ 
+[/some/area/of/the/fs]
+metadatacmds = ; tags = tmsu tags %f
+      
+
+ +

You may want to restrict this processing to a subset of + the directory tree, because it may slow down indexing a bit + ([some/area/of/the/fs]).

+ +

Note the initial semi-colon after the equal sign.

+ +

In the example above, the output of tmsu is used to set a + field named tags. The field + name is arbitrary and could be tmsu or myfield just the same, but tags is an alias for the standard + Recoll keywords field, and the tmsu output will just + augment its contents. This will avoid the need to extend + the field + configuration.

+ +

Once re-indexing is performed (you'll need to force the + file reindexing, Recoll + will not detect the need by itself), you will be able to + search from the query language, through any of its aliases: + tags:some/alternate/values or + tags:all,these,values (the + compact field search syntax is supported for recoll 1.20 + and later. For older versions, you would need to repeat the + tags: specifier for each term, + e.g. tags:some OR + tags:alternate).

+ +

You should be aware that tags changes will not be + detected by the indexer if the file itself did not change. + One possible workaround would be to update the file + ctime when you modify the + tags, which would be consistent with how extended + attributes function. A pair of chmod commands could + accomplish this, or a touch -a + . Alternatively, just couple the tag update with a + recollindex -e -i + filename.

diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 1801607f..b706fdae 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -907,16 +907,60 @@ indexedmimetypes = application/pdf Importing external tags During indexing, it is possible to import metadata for - each file by executing commands. For example, this could - extract user tag data for the file and store it in a field for - indexing. + each file by executing commands. For example, this could + extract user tag data for the file and store it in a field for + indexing. See the - section - about the metadatacmds field in - the main configuration chapter for more detail. + section + about the metadatacmds field in + the main configuration chapter for a description of the + configuration syntax. + + As an example, if you would want &RCL; to use tags managed by + tmsu, you would add the following to the + configuration file: + + [/some/area/of/the/fs] +metadatacmds = ; tags = tmsu tags %f + + + You may want to restrict this processing to a subset of + the directory tree, because it may slow down indexing a bit + ([some/area/of/the/fs]). + Note the initial semi-colon after the equal sign. + + In the example above, the output of tmsu is + used to set a field named tags. The field name is + arbitrary and could be tmsu or + myfield just the same, but tags + is an alias for the standard &RCL; keywords field, + and the tmsu output will just augment its + contents. This will avoid the need to extend the field configuration. + + Once re-indexing is performed (you'll need to force the file + reindexing, &RCL; will not detect the need by itself), you will + be able to search from the query language, through any of its + aliases: tags:some/alternate/values or + tags:all,these,values (the compact field search + syntax is supported for recoll 1.20 and later. For + older versions, you would need to repeat the tags: + specifier for each term, e.g. tags:some OR + tags:alternate). + + You should be aware that tags changes will not be detected by + the indexer if the file itself did not change. One possible + workaround would be to update the file ctime when + you modify the tags, which + would be consistent with how extended attributes function. A pair of + chmod commands could accomplish this, or a + touch -a . Alternatively, just + couple the tag update with a recollindex -e -i + filename. + + - Periodic indexing diff --git a/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html b/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html index 539517a9..87828b2a 100644 --- a/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html +++ b/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html @@ -4,7 +4,7 @@ The index configuration GUI - - Recoll user manual
Prev Up Next
 Home