|
a/src/doc/user/usermanual.xml |
|
b/src/doc/user/usermanual.xml |
| 1 |
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
1 |
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
| 2 |
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
2 |
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
| 3 |
|
3 |
|
| 4 |
<!ENTITY RCL "<application>Recoll</application>">
|
4 |
<!ENTITY RCL "<application>Recoll</application>">
|
| 5 |
<!ENTITY RCLAPPS "<ulink url='http://www.recoll.org/features.html'>http://www.recoll.org/features.html</ulink>">
|
5 |
<!ENTITY RCLAPPS "<ulink url='http://www.recoll.org/features.html'>http://www.recoll.org/features.html</ulink>">
|
| 6 |
<!ENTITY RCLVERSION "1.19">
|
6 |
<!ENTITY RCLVERSION "1.20">
|
| 7 |
<!ENTITY XAP "<application>Xapian</application>">
|
7 |
<!ENTITY XAP "<application>Xapian</application>">
|
| 8 |
<!ENTITY WIKI "http://bitbucket.org/medoc/recoll/wiki/">
|
8 |
<!ENTITY WIKI "http://bitbucket.org/medoc/recoll/wiki/">
|
| 9 |
]>
|
9 |
]>
|
| 10 |
|
10 |
|
| 11 |
<book lang="en">
|
11 |
<book lang="en">
|
|
... |
|
... |
| 20 |
<address><email>jfd@recoll.org</email></address>
|
20 |
<address><email>jfd@recoll.org</email></address>
|
| 21 |
</affiliation>
|
21 |
</affiliation>
|
| 22 |
</author>
|
22 |
</author>
|
| 23 |
|
23 |
|
| 24 |
<copyright>
|
24 |
<copyright>
|
| 25 |
<year>2005-2013</year>
|
25 |
<year>2005-2014</year>
|
| 26 |
<holder role="mailto:jfd@recoll.org">Jean-Francois Dockes</holder>
|
26 |
<holder role="mailto:jfd@recoll.org">Jean-Francois Dockes</holder>
|
| 27 |
</copyright>
|
27 |
</copyright>
|
| 28 |
<abstract>
|
28 |
<abstract>
|
| 29 |
|
29 |
|
| 30 |
<para><literal>Permission is granted to copy, distribute and/or
|
30 |
<para><literal>Permission is granted to copy, distribute and/or
|
|
... |
|
... |
| 1267 |
<para>You may also change the choice of applications by editing the
|
1267 |
<para>You may also change the choice of applications by editing the
|
| 1268 |
<link linkend="RCL.INSTALL.CONFIG.MIMEVIEW">
|
1268 |
<link linkend="RCL.INSTALL.CONFIG.MIMEVIEW">
|
| 1269 |
<filename>mimeview</filename></link> configuration file if you find
|
1269 |
<filename>mimeview</filename></link> configuration file if you find
|
| 1270 |
this more convenient.</para>
|
1270 |
this more convenient.</para>
|
| 1271 |
|
1271 |
|
|
|
1272 |
<para>Each result entry also has a right-click menu with an
|
|
|
1273 |
<guilabel>Open With</guilabel> entry. This lets you choose an
|
|
|
1274 |
application from the list of those which registered with the desktop
|
|
|
1275 |
for the document MIME type.</para>
|
|
|
1276 |
|
| 1272 |
<para>The <literal>Preview</literal> and <literal>Open</literal>
|
1277 |
<para>The <literal>Preview</literal> and <literal>Open</literal>
|
| 1273 |
edit links may not be present for all entries, meaning that
|
1278 |
edit links may not be present for all entries, meaning that
|
| 1274 |
&RCL; has no configured way to preview a given file type (which
|
1279 |
&RCL; has no configured way to preview a given file type (which
|
| 1275 |
was indexed by name only), or no configured external editor for
|
1280 |
was indexed by name only), or no configured external editor for
|
| 1276 |
the file type. This can sometimes be adjusted simply by tweaking
|
1281 |
the file type. This can sometimes be adjusted simply by tweaking
|
|
... |
|
... |
| 2027 |
right click on the table headers to activate a pop-up menu
|
2032 |
right click on the table headers to activate a pop-up menu
|
| 2028 |
which will let you adjust what columns are displayed. You can
|
2033 |
which will let you adjust what columns are displayed. You can
|
| 2029 |
drag the column headers to adjust their order. You can click
|
2034 |
drag the column headers to adjust their order. You can click
|
| 2030 |
them to sort by the field displayed in the column. You can
|
2035 |
them to sort by the field displayed in the column. You can
|
| 2031 |
also save the result list in CSV format.</para>
|
2036 |
also save the result list in CSV format.</para>
|
|
|
2037 |
</formalpara>
|
|
|
2038 |
|
|
|
2039 |
|
|
|
2040 |
<formalpara><title>Changing the GUI geometry</title>
|
|
|
2041 |
<para>It is possible to configure the GUI in wide form
|
|
|
2042 |
factor by dragging the toolbars to one of the sides (their
|
|
|
2043 |
location is remembered between sessions), and moving the
|
|
|
2044 |
category filters to a menu (can be set in the
|
|
|
2045 |
<menuchoice>
|
|
|
2046 |
<guimenu>Preferences</guimenu>
|
|
|
2047 |
<guimenuitem>GUI configuration</guimenuitem>
|
|
|
2048 |
<guimenuitem>User interface</guimenuitem>
|
|
|
2049 |
</menuchoice> panel).</para>
|
| 2032 |
</formalpara>
|
2050 |
</formalpara>
|
| 2033 |
|
2051 |
|
| 2034 |
<formalpara><title>Query explanation</title>
|
2052 |
<formalpara><title>Query explanation</title>
|
| 2035 |
<para>You can get an exact description of what the query
|
2053 |
<para>You can get an exact description of what the query
|
| 2036 |
looked for, including stem expansion, and Boolean operators
|
2054 |
looked for, including stem expansion, and Boolean operators
|
|
... |
|
... |
| 2791 |
(the order of words is significant), so that
|
2809 |
(the order of words is significant), so that
|
| 2792 |
<replaceable>title:"prejudice pride"</replaceable> is not the same as
|
2810 |
<replaceable>title:"prejudice pride"</replaceable> is not the same as
|
| 2793 |
<replaceable>title:prejudice title:pride</replaceable>, and is
|
2811 |
<replaceable>title:prejudice title:pride</replaceable>, and is
|
| 2794 |
unlikely to find a result.</para>
|
2812 |
unlikely to find a result.</para>
|
| 2795 |
|
2813 |
|
|
|
2814 |
<para>To save you some typing, recent &RCL; versions (1.20 and later)
|
|
|
2815 |
interpret a comma-separated list of terms as an AND list inside the
|
|
|
2816 |
field. Use slash characters ('/') for an OR list. No white space
|
|
|
2817 |
is allowed. So
|
|
|
2818 |
<programlisting>author:john,lennon</programlisting> will search for
|
|
|
2819 |
documents with <literal>john</literal> and <literal>lennon</literal>
|
|
|
2820 |
inside the <literal>author</literal> field (in any order), and
|
|
|
2821 |
<programlisting>author:john/ringo</programlisting> would search for
|
|
|
2822 |
<literal>john</literal> or <literal>ringo</literal>.</para>
|
|
|
2823 |
|
| 2796 |
<para>Modifiers can be set on a phrase clause, for example to specify
|
2824 |
<para>Modifiers can be set on a phrase clause, for example to specify
|
| 2797 |
a proximity search (unordered). See
|
2825 |
a proximity search (unordered). See
|
| 2798 |
<link linkend="RCL.SEARCH.LANG.MODIFIERS">the modifier
|
2826 |
<link linkend="RCL.SEARCH.LANG.MODIFIERS">the modifier
|
| 2799 |
section</link>.</para>
|
2827 |
section</link>.</para>
|
| 2800 |
|
2828 |
|
|
... |
|
... |
| 2821 |
<listitem><para><literal>keyword</literal> for searching the
|
2849 |
<listitem><para><literal>keyword</literal> for searching the
|
| 2822 |
document-specified keywords (few documents actually have
|
2850 |
document-specified keywords (few documents actually have
|
| 2823 |
any).</para>
|
2851 |
any).</para>
|
| 2824 |
</listitem>
|
2852 |
</listitem>
|
| 2825 |
|
2853 |
|
| 2826 |
<listitem><para><literal>filename</literal> for the document's
|
2854 |
<listitem><para><literal>filename</literal> for the document's
|
|
|
2855 |
file name. This is not necessarily set for all documents:
|
|
|
2856 |
internal documents contained inside a compound one (for example
|
|
|
2857 |
an EPUB section) do not inherit the container file name any more,
|
|
|
2858 |
this was replaced by an explicit field (see next). Sub-documents
|
|
|
2859 |
can still have a specific <literal>filename</literal>, if it is
|
|
|
2860 |
implied by the document format, for example the attachment file
|
|
|
2861 |
name for an email attachment.</para></listitem>
|
|
|
2862 |
|
|
|
2863 |
<listitem><para><literal>containerfilename</literal>. This is
|
|
|
2864 |
set for all documents, both top-level and contained
|
|
|
2865 |
sub-documents, and is always the name of the filesystem directory
|
|
|
2866 |
entry which contains the data. The terms from this field can
|
|
|
2867 |
only be matched by an explicit field specification (as opposed
|
|
|
2868 |
to terms from <literal>filename</literal> which are also indexed
|
|
|
2869 |
as general document content). This avoids getting matches for
|
|
|
2870 |
all the sub-documents when searching for the container file
|
| 2827 |
file name.</para></listitem>
|
2871 |
name.</para></listitem>
|
| 2828 |
|
2872 |
|
| 2829 |
<listitem><para><literal>ext</literal> specifies the file
|
2873 |
<listitem><para><literal>ext</literal> specifies the file
|
| 2830 |
name extension (Ex: <literal>ext:html</literal>)</para>
|
2874 |
name extension (Ex: <literal>ext:html</literal>)</para>
|
| 2831 |
</listitem>
|
2875 |
</listitem>
|
| 2832 |
|
2876 |
|
| 2833 |
</itemizedlist>
|
2877 |
</itemizedlist>
|
|
|
2878 |
|
|
|
2879 |
<para>&RCL; 1.20 and later have a way to specify aliases for the
|
|
|
2880 |
field names, which will save typing, for example by aliasing
|
|
|
2881 |
<literal>filename</literal> to <replaceable>fn</replaceable> or
|
|
|
2882 |
<literal>containerfilename</literal> to
|
|
|
2883 |
<replaceable>cfn</replaceable>. See the <link
|
|
|
2884 |
linkend="RCL.INSTALL.CONFIG.FIELDS">section about the
|
|
|
2885 |
<filename>fields</filename> file</link></para>
|
| 2834 |
|
2886 |
|
| 2835 |
<para>The field syntax also supports a few field-like, but
|
2887 |
<para>The field syntax also supports a few field-like, but
|
| 2836 |
special, criteria:</para>
|
2888 |
special, criteria:</para>
|
| 2837 |
|
2889 |
|
| 2838 |
<itemizedlist>
|
2890 |
<itemizedlist>
|
|
... |
|
... |
| 5086 |
MIME type.</para>
|
5138 |
MIME type.</para>
|
| 5087 |
</listitem>
|
5139 |
</listitem>
|
| 5088 |
</varlistentry>
|
5140 |
</varlistentry>
|
| 5089 |
|
5141 |
|
| 5090 |
<varlistentry><term><varname>usesystemfilecommand</varname></term>
|
5142 |
<varlistentry><term><varname>usesystemfilecommand</varname></term>
|
| 5091 |
<listitem><para>Decide if we use the
|
5143 |
<listitem><para>Decide if we execute a system command
|
| 5092 |
<command>file</command> <option>-i</option> system command
|
5144 |
(<command>file</command> <option>-i</option> by default)
|
| 5093 |
as a final step for determining the MIME type for a file
|
5145 |
as a final step for determining the MIME type for a file
|
| 5094 |
(the main procedure uses suffix associations as defined in
|
5146 |
(the main procedure uses suffix associations as defined in
|
| 5095 |
the <filename>mimemap</filename> file). This can be useful
|
5147 |
the <filename>mimemap</filename> file). This can be useful
|
| 5096 |
for files with suffix-less names, but it will also cause
|
5148 |
for files with suffix-less names, but it will also cause
|
| 5097 |
the indexing of many bogus "text" files.</para>
|
5149 |
the indexing of many bogus "text" files.</para>
|
|
|
5150 |
</listitem>
|
|
|
5151 |
</varlistentry>
|
|
|
5152 |
|
|
|
5153 |
<varlistentry><term><varname>systemfilecommand</varname></term>
|
|
|
5154 |
<listitem><para>Command to use for mime for mime type
|
|
|
5155 |
determination if <literal>usesystefilecommand</literal> is
|
|
|
5156 |
set. Recent versions of <command>xdg-mime</command> sometimes
|
|
|
5157 |
work better than <command>file</command>.</para>
|
| 5098 |
</listitem>
|
5158 |
</listitem>
|
| 5099 |
</varlistentry>
|
5159 |
</varlistentry>
|
| 5100 |
|
5160 |
|
| 5101 |
<varlistentry><term><varname>processwebqueue</varname></term>
|
5161 |
<varlistentry><term><varname>processwebqueue</varname></term>
|
| 5102 |
<listitem><para>If this is set, process the directory where
|
5162 |
<listitem><para>If this is set, process the directory where
|
|
... |
|
... |
| 5667 |
which each define an aspect of fields processing. Quite often,
|
5727 |
which each define an aspect of fields processing. Quite often,
|
| 5668 |
you'll have to modify several sections to obtain the desired
|
5728 |
you'll have to modify several sections to obtain the desired
|
| 5669 |
behaviour.</para>
|
5729 |
behaviour.</para>
|
| 5670 |
|
5730 |
|
| 5671 |
<para>We will only give a short description here, you should refer
|
5731 |
<para>We will only give a short description here, you should refer
|
| 5672 |
to the comments inside the file for more detailed information.</para>
|
5732 |
to the comments inside the default file for more detailed
|
|
|
5733 |
information.</para>
|
| 5673 |
|
5734 |
|
| 5674 |
<para>Field names should be lowercase alphabetic ASCII.</para>
|
5735 |
<para>Field names should be lowercase alphabetic ASCII.</para>
|
| 5675 |
|
5736 |
|
| 5676 |
<variablelist>
|
5737 |
<variablelist>
|
| 5677 |
|
5738 |
|
|
... |
|
... |
| 5691 |
<varlistentry>
|
5752 |
<varlistentry>
|
| 5692 |
<term>[aliases]</term>
|
5753 |
<term>[aliases]</term>
|
| 5693 |
<listitem><para>This section defines lists of synonyms for the
|
5754 |
<listitem><para>This section defines lists of synonyms for the
|
| 5694 |
canonical names used inside the <literal>[prefixes]</literal>
|
5755 |
canonical names used inside the <literal>[prefixes]</literal>
|
| 5695 |
and <literal>[stored]</literal> sections</para>
|
5756 |
and <literal>[stored]</literal> sections</para>
|
|
|
5757 |
</listitem>
|
|
|
5758 |
</varlistentry>
|
|
|
5759 |
<varlistentry>
|
|
|
5760 |
<term>[queryaliases]</term>
|
|
|
5761 |
<listitem><para>This section also defines aliases for the
|
|
|
5762 |
canonic field names, with the difference that the substitution
|
|
|
5763 |
will only be used at query time, avoiding any possibility that
|
|
|
5764 |
the value would pick-up random metadata from documents.</para>
|
| 5696 |
</listitem>
|
5765 |
</listitem>
|
| 5697 |
</varlistentry>
|
5766 |
</varlistentry>
|
| 5698 |
<varlistentry>
|
5767 |
<varlistentry>
|
| 5699 |
<term>handler-specific sections</term>
|
5768 |
<term>handler-specific sections</term>
|
| 5700 |
<listitem><para>Some input handlers may need specific
|
5769 |
<listitem><para>Some input handlers may need specific
|
|
... |
|
... |
| 5722 |
|
5791 |
|
| 5723 |
[stored]
|
5792 |
[stored]
|
| 5724 |
# Store mailmytag inside the document data record (so that it can be
|
5793 |
# Store mailmytag inside the document data record (so that it can be
|
| 5725 |
# displayed - as %(mailmytag) - in result lists).
|
5794 |
# displayed - as %(mailmytag) - in result lists).
|
| 5726 |
mailmytag =
|
5795 |
mailmytag =
|
|
|
5796 |
|
|
|
5797 |
[queryaliases]
|
|
|
5798 |
filename = fn
|
|
|
5799 |
containerfilename = cfn
|
| 5727 |
|
5800 |
|
| 5728 |
[mail]
|
5801 |
[mail]
|
| 5729 |
# Extract the X-My-Tag mail header, and use it internally with the
|
5802 |
# Extract the X-My-Tag mail header, and use it internally with the
|
| 5730 |
# mailmytag field name
|
5803 |
# mailmytag field name
|
| 5731 |
x-my-tag = mailmytag
|
5804 |
x-my-tag = mailmytag
|