tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
Jean-Francois Dockes 2022-10-02 09:05:33 +02:00
parent 04335a11d7
commit 87256b6a69
2 changed files with 62 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/doc/user/usermanual.html
View File

@ -421,7 +421,7 @@ alink="#0000FF">
<div class="list-of-tables"> <div class="list-of-tables">
<p><b>List of Tables</b></p> <p><b>List of Tables</b></p>
<dl> <dl>
<dt>3.1. <a href="#idm1532">Keyboard shortcuts</a></dt> <dt>3.1. <a href="#idm1540">Keyboard shortcuts</a></dt>
</dl> </dl>
</div> </div>
<div class="chapter"> <div class="chapter">
@ -2076,9 +2076,30 @@ recollindex -c "$confdir"
is removed from the name.</p> is removed from the name.</p>
<p>The name translation can be configured more precisely, <p>The name translation can be configured more precisely,
also inside the <a class="link" href= also inside the <a class="link" href=
"#RCL.INSTALL.CONFIG.FIELDS" title= "#RCL.INSTALL.CONFIG.FIELDS.XATTR" title=
"5.4.3.&nbsp;The fields file"><code class= "Extended attributes in the fields file"><code class=
"filename">fields</code> configuration file</a>.</p> "filename">fields</code> configuration file</a>.</p>
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Setting the document
modification/creation date</h3>
<p>Date fields are processed specially by <span class=
"application">Recoll</span>. For obscure and
uninteresting reasons, you should use <code class=
"literal">modificationdate</code> 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
<span class="command"><strong>date</strong></span> prints
the example date parameter in Unix time format (seconds
since the epoch).</p>
<pre class="programlisting">
setfattr -n user.modificationdate -v `date -d '2022-09-30 08:30:00' +%s` /some/file
</pre>The date substitution will then be automatic, you
do not need to customize the <code class="filename">fields</code>
file.
</div>
</div> </div>
<div class="sect1"> <div class="sect1">
<div class="titlepage"> <div class="titlepage">
@ -4198,7 +4219,7 @@ fs.inotify.max_user_watches=32768
<span class="guilabel">Shortcut</span> column, and type <span class="guilabel">Shortcut</span> column, and type
the desired sequence.</p> the desired sequence.</p>
<div class="table"> <div class="table">
<a name="idm1532" id="idm1532"></a> <a name="idm1540" id="idm1540"></a>
<p class="title"><b>Table&nbsp;3.1.&nbsp;Keyboard <p class="title"><b>Table&nbsp;3.1.&nbsp;Keyboard
shortcuts</b></p> shortcuts</b></p>
<div class="table-contents"> <div class="table-contents">

65
src/doc/user/usermanual.xml
View File

@ -1312,18 +1312,18 @@ recollindex -c "$confdir"
<sect1 id="RCL.INDEXING.EXTATTR"> <sect1 id="RCL.INDEXING.EXTATTR">
<title>&LIN;: using extended attributes</title> <title>&LIN;: using extended attributes</title>
<para>User extended attributes are named pieces of information <para>User extended attributes are named pieces of information that most modern file systems
that most modern file systems can attach to any file.</para> can attach to any file.</para>
<para>&RCL; processes all extended attributes as document fields. Note that most <para>&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 fields are not indexed by default, you need to activate them by defining a prefix in
the <link linkend="RCL.INSTALL.CONFIG.FIELDS"><filename>fields</filename> the <link linkend="RCL.INSTALL.CONFIG.FIELDS"><filename>fields</filename>
configuration file</link>.</para> configuration file</link>.</para>
<para>A <para>A <ulink url="http://www.freedesktop.org/wiki/CommonExtendedAttributes">
<ulink url="http://www.freedesktop.org/wiki/CommonExtendedAttributes"> freedesktop standard</ulink> defines a few special attributes, which are handled as such by
freedesktop standard</ulink> defines a few special &RCL;:
attributes, which are handled as such by &RCL;:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>mime_type</term> <term>mime_type</term>
@ -1343,18 +1343,32 @@ recollindex -c "$confdir"
<para>On Linux, the <literal>user</literal> prefix is removed from the name.</para> <para>On Linux, the <literal>user</literal> prefix is removed from the name.</para>
<para>The name translation can be configured more precisely, also inside the <para>The name translation can be configured more precisely, also inside the
<link linkend="RCL.INSTALL.CONFIG.FIELDS"><filename>fields</filename> configuration <link linkend="RCL.INSTALL.CONFIG.FIELDS.XATTR"><filename>fields</filename> configuration
file</link>.</para> file</link>.</para>
<note><title>Setting the document modification/creation date</title>
<para>Date fields are processed specially by &RCL;. For obscure and uninteresting reasons,
you should use <literal>modificationdate</literal> 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 <command>date</command> prints the example date parameter in Unix
time format (seconds since the epoch).
<programlisting>
setfattr -n user.modificationdate -v `date -d '2022-09-30 08:30:00' +%s` /some/file
</programlisting>
</para>
The date substitution will then be automatic, you do not need to customize
the <filename>fields</filename> file.
</note>
</sect1> </sect1>
<sect1 id="RCL.INDEXING.EXTTAGS"> <sect1 id="RCL.INDEXING.EXTTAGS">
<title>&LIN;: importing external tags</title> <title>&LIN;: importing external tags</title>
<para>During indexing, it is possible to import metadata for each <para>During indexing, it is possible to import metadata for each file by executing
file by executing commands. This allows, for example, extracting tag commands. This allows, for example, extracting tag data from an external application and
data from an external application and storing it in a field for storing it in a field for indexing.</para>
indexing.</para>
<para>See the <para>See the
<link linkend="RCL.INSTALL.CONFIG.RECOLLCONF.METADATACMDS">section about the <literal>metadatacmds</literal> field</link> <link linkend="RCL.INSTALL.CONFIG.RECOLLCONF.METADATACMDS">section about the <literal>metadatacmds</literal> field</link>
@ -6827,13 +6841,11 @@ hasextract = False
</variablelist> </variablelist>
<para>Here follows a small example of a personal <para>Here follows a small example of a personal <filename>fields</filename> file. This
<filename>fields</filename> would extract a specific email header and use it as a searchable field, with data
file. This would extract a specific email header and displayable inside result lists. (Side note: as the email handler does no decoding on the
use it as a searchable field, with data displayable inside result values, only plain ascii headers can be indexed, and only the first occurrence will be used
lists. (Side note: as the email handler does no decoding on the values, for headers that occur several times).
only plain ascii headers can be indexed, and only the
first occurrence will be used for headers that occur several times).
<programlisting>[prefixes] <programlisting>[prefixes]
# Index mailmytag contents (with the given prefix) # Index mailmytag contents (with the given prefix)
@ -6859,18 +6871,15 @@ hasextract = False
<sect3 id="RCL.INSTALL.CONFIG.FIELDS.XATTR"> <sect3 id="RCL.INSTALL.CONFIG.FIELDS.XATTR">
<title>Extended attributes in the fields file</title> <title>Extended attributes in the fields file</title>
<para>&RCL; versions 1.19 and later process user extended <para>&RCL; versions 1.19 and later process user extended file attributes as documents
file attributes as documents fields by default.</para> fields by default.</para>
<para>Attributes are processed as fields of the same name, <para>Attributes are processed as fields of the same name, after removing
after removing the <literal>user</literal> prefix on the <literal>user</literal> prefix on Linux.</para>
Linux.</para>
<para>The <literal>[xattrtofields]</literal> <para>The <literal>[xattrtofields]</literal> section of the <filename>fields</filename>
section of the <filename>fields</filename> file allows file allows specifying translations from extended attributes names to &RCL; field
specifying translations from extended attributes names to names. An empty translation disables use of the corresponding attribute data.</para>
&RCL; field names. An empty translation disables use of the
corresponding attribute data.</para>
</sect3> </sect3>