From 7a34d422624e059eb0052cd4a25f49ae6d0fa9b0 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Sat, 26 Jul 2014 19:36:25 +0200 Subject: [PATCH] doc --- src/doc/man/recoll.conf.5 | 3 +- src/doc/user/usermanual.xml | 89 +++++++++++++++++++++++++++++++++---- website/download.html | 8 +++- website/release-1.20.html | 55 ++++++++++++++++++++--- 4 files changed, 137 insertions(+), 18 deletions(-) diff --git a/src/doc/man/recoll.conf.5 b/src/doc/man/recoll.conf.5 index 53d3acaf..7cdc8216 100644 --- a/src/doc/man/recoll.conf.5 +++ b/src/doc/man/recoll.conf.5 @@ -1,5 +1,4 @@ -.\" $Id: recoll.conf.5,v 1.5 2007-07-13 10:18:49 dockes Exp $ (C) 2005 J.F.Dockes\$ -.TH RECOLL.CONF 5 "8 January 2006" +.TH RECOLL.CONF 5 "14 November 2012" .SH NAME recoll.conf \- main personal configuration file for Recoll .SH DESCRIPTION diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index b10d87c5..8b15ad02 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -3,7 +3,7 @@ Recoll"> http://www.recoll.org/features.html"> - + Xapian"> ]> @@ -22,7 +22,7 @@ - 2005-2013 + 2005-2014 Jean-Francois Dockes @@ -1269,6 +1269,11 @@ fs.inotify.max_user_watches=32768 mimeview configuration file if you find this more convenient. + Each result entry also has a right-click menu with an + Open With entry. This lets you choose an + application from the list of those which registered with the desktop + for the document MIME type. + The Preview and Open edit links may not be present for all entries, meaning that &RCL; has no configured way to preview a given file type (which @@ -2031,6 +2036,19 @@ fs.inotify.max_user_watches=32768 also save the result list in CSV format. + + Changing the GUI geometry + It is possible to configure the GUI in wide form + factor by dragging the toolbars to one of the sides (their + location is remembered between sessions), and moving the + category filters to a menu (can be set in the + + Preferences + GUI configuration + User interface + panel). + + Query explanation You can get an exact description of what the query looked for, including stem expansion, and Boolean operators @@ -2793,6 +2811,16 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r title:prejudice title:pride, and is unlikely to find a result. + To save you some typing, recent &RCL; versions (1.20 and later) + interpret a comma-separated list of terms as an AND list inside the + field. Use slash characters ('/') for an OR list. No white space + is allowed. So + author:john,lennon will search for + documents with john and lennon + inside the author field (in any order), and + author:john/ringo would search for + john or ringo. + Modifiers can be set on a phrase clause, for example to specify a proximity search (unordered). See the modifier @@ -2823,14 +2851,38 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r any). - filename for the document's - file name. + filename for the document's + file name. This is not necessarily set for all documents: + internal documents contained inside a compound one (for example + an EPUB section) do not inherit the container file name any more, + this was replaced by an explicit field (see next). Sub-documents + can still have a specific filename, if it is + implied by the document format, for example the attachment file + name for an email attachment. + containerfilename. This is + set for all documents, both top-level and contained + sub-documents, and is always the name of the filesystem directory + entry which contains the data. The terms from this field can + only be matched by an explicit field specification (as opposed + to terms from filename which are also indexed + as general document content). This avoids getting matches for + all the sub-documents when searching for the container file + name. + ext specifies the file name extension (Ex: ext:html) - + + + &RCL; 1.20 and later have a way to specify aliases for the + field names, which will save typing, for example by aliasing + filename to fn or + containerfilename to + cfn. See the section about the + fields file The field syntax also supports a few field-like, but special, criteria: @@ -5088,8 +5140,8 @@ skippedPaths = ~/somedir/*.txt usesystemfilecommand - Decide if we use the - file system command + Decide if we execute a system command + (file by default) as a final step for determining the MIME type for a file (the main procedure uses suffix associations as defined in the mimemap file). This can be useful @@ -5098,6 +5150,14 @@ skippedPaths = ~/somedir/*.txt + systemfilecommand + Command to use for mime for mime type + determination if usesystefilecommand is + set. Recent versions of xdg-mime sometimes + work better than file. + + + processwebqueue If this is set, process the directory where Web browser plugins copy visited pages for indexing. @@ -5669,7 +5729,8 @@ mondelaypatterns = *.log:20 "this one has spaces*:10" behaviour. We will only give a short description here, you should refer - to the comments inside the file for more detailed information. + to the comments inside the default file for more detailed + information. Field names should be lowercase alphabetic ASCII. @@ -5695,6 +5756,14 @@ mondelaypatterns = *.log:20 "this one has spaces*:10" and [stored] sections + + [queryaliases] + This section also defines aliases for the + canonic field names, with the difference that the substitution + will only be used at query time, avoiding any possibility that + the value would pick-up random metadata from documents. + + handler-specific sections Some input handlers may need specific @@ -5725,6 +5794,10 @@ mailmytag = XMTAG # displayed - as %(mailmytag) - in result lists). mailmytag = +[queryaliases] +filename = fn +containerfilename = cfn + [mail] # Extract the X-My-Tag mail header, and use it internally with the # mailmytag field name diff --git a/website/download.html b/website/download.html index 30a0a6c8..d22a4a6f 100644 --- a/website/download.html +++ b/website/download.html @@ -126,8 +126,12 @@ subdirectory, because of all the places they're referred from

1.20 preview

-

See the release notes.

-

recoll-1.20.0.tar.gz.

+

Recoll 1.20 will contain no revolutionary changes, but a set of +useful adjustments. 1.20.0 will be released in a set of incremental +snapshots. The current snapshot is 1.20.0p1. See +the release notes for what's in +there.

+

recoll-1.20.0p1.tar.gz.