From 87256b6a69292c0e51d2831902c6c2c933ba5714 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Sun, 2 Oct 2022 09:05:33 +0200 Subject: [PATCH] doc --- src/doc/user/usermanual.html | 29 +++++++++++++--- src/doc/user/usermanual.xml | 65 ++++++++++++++++++++---------------- 2 files changed, 62 insertions(+), 32 deletions(-) diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 856e012c..c1cf0a13 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -421,7 +421,7 @@ alink="#0000FF">

List of Tables

-
3.1. Keyboard shortcuts
+
3.1. Keyboard shortcuts
@@ -2076,9 +2076,30 @@ recollindex -c "$confdir" is removed from the name.

The name translation can be configured more precisely, also inside the fields configuration file.

+
+

Setting the document + modification/creation date

+

Date fields are processed specially by Recoll. For obscure and + uninteresting reasons, you should use modificationdate as extended attribute + name for setting this value. Also, the date string should + be an ASCII integer representing the Unix time (seconds + since the epoch). An example Linux command line for + setting this particular field follow. The substituted + date prints + the example date parameter in Unix time format (seconds + since the epoch).

+ 
+            setfattr -n user.modificationdate -v `date -d '2022-09-30 08:30:00' +%s` /some/file
+
The date substitution will then be automatic, you +do not need to customize the fields +file. +
@@ -4198,7 +4219,7 @@ fs.inotify.max_user_watches=32768 Shortcut column, and type the desired sequence.

- +

Table 3.1. Keyboard shortcuts

diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 4c409764..a8f540fa 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -1312,18 +1312,18 @@ recollindex -c "$confdir" &LIN;: using extended attributes - User extended attributes are named pieces of information - that most modern file systems can attach to any file. + User extended attributes are named pieces of information that most modern file systems + can attach to any file. &RCL; processes all extended attributes as document fields. Note that most fields are not indexed by default, you need to activate them by defining a prefix in the fields configuration file. - A - - freedesktop standard defines a few special - attributes, which are handled as such by &RCL;: + A + freedesktop standard defines a few special attributes, which are handled as such by + &RCL;: + mime_type @@ -1343,18 +1343,32 @@ recollindex -c "$confdir" On Linux, the user prefix is removed from the name. The name translation can be configured more precisely, also inside the - fields configuration + fields configuration file. + Setting the document modification/creation date + Date fields are processed specially by &RCL;. For obscure and uninteresting reasons, + you should use modificationdate as extended attribute name for setting + this value. Also, the date string should be an ASCII integer representing the Unix time + (seconds since the epoch). An example Linux command line for setting this particular field + follow. The substituted date prints the example date parameter in Unix + time format (seconds since the epoch). + + setfattr -n user.modificationdate -v `date -d '2022-09-30 08:30:00' +%s` /some/file + + + The date substitution will then be automatic, you do not need to customize + the fields file. + + &LIN;: importing external tags - During indexing, it is possible to import metadata for each - file by executing commands. This allows, for example, extracting tag - data from an external application and storing it in a field for - indexing. + During indexing, it is possible to import metadata for each file by executing + commands. This allows, for example, extracting tag data from an external application and + storing it in a field for indexing. See the section about the metadatacmds field @@ -6827,13 +6841,11 @@ hasextract = False - Here follows a small example of a personal - fields - file. This would extract a specific email header and - use it as a searchable field, with data displayable inside result - lists. (Side note: as the email handler does no decoding on the values, - only plain ascii headers can be indexed, and only the - first occurrence will be used for headers that occur several times). + Here follows a small example of a personal fields file. This + would extract a specific email header and use it as a searchable field, with data + displayable inside result lists. (Side note: as the email handler does no decoding on the + values, only plain ascii headers can be indexed, and only the first occurrence will be used + for headers that occur several times). [prefixes] # Index mailmytag contents (with the given prefix) @@ -6859,18 +6871,15 @@ hasextract = False Extended attributes in the fields file - &RCL; versions 1.19 and later process user extended - file attributes as documents fields by default. + &RCL; versions 1.19 and later process user extended file attributes as documents + fields by default. - Attributes are processed as fields of the same name, - after removing the user prefix on - Linux. + Attributes are processed as fields of the same name, after removing + the user prefix on Linux. - The [xattrtofields] - section of the fields file allows - specifying translations from extended attributes names to - &RCL; field names. An empty translation disables use of the - corresponding attribute data. + The [xattrtofields] section of the fields + file allows specifying translations from extended attributes names to &RCL; field + names. An empty translation disables use of the corresponding attribute data.