~ubuntu-branches/ubuntu/quantal/recoll/quantal

« back to all changes in this revision

Viewing changes to doc/user/rcl.indexing.periodic.html

  • Committer: Package Import Robot
  • Author(s): Kartik Mistry
  • Date: 2012-05-18 10:59:21 UTC
  • mfrom: (1.3.9)
  • Revision ID: package-import@ubuntu.com-20120518105921-6eefevywd67qe3wj
Tags: 1.17.2-1
* New upstream release:
  + Dropped patches: fix-kFreeBSD-ftbfs.patch, recoll_ionice_getpid.patch.
    These are merged with upstream.
  + Refreshed patch: fix-python-install.patch.
* debian/rules, debian/control:
  + Added hardening support.
* debian/copyright:
  + Fixed duplicate Copyright sections.

Show diffs side-by-side

added added

removed removed

Lines of Context:
42
42
"GUIMENU">File</span> menu in the <tt class="COMMAND">recoll</tt> GUI program. When
43
43
started from the GUI, the indexing will run on the same configuration <tt class=
44
44
"COMMAND">recoll</tt> was started on. When started from the command line, <tt class=
45
 
"COMMAND">recollindex</tt> will use the <tt class="LITERAL">RECOLL_CONFDIR</tt> variable
46
 
or accept a <tt class="LITERAL">-c</tt> <tt class="REPLACEABLE"><i>confdir</i></tt>
 
45
"COMMAND">recollindex</tt> will use the <tt class="ENVAR">RECOLL_CONFDIR</tt> variable or
 
46
accept a <code class="OPTION">-c</code> <tt class="REPLACEABLE"><i>confdir</i></tt>
47
47
option to specify a non-default configuration directory.</p>
48
48
<p>If the <tt class="COMMAND">recoll</tt> program finds no index when it starts, it will
49
49
automatically start indexing (except if canceled).</p>
50
50
<p>The <tt class="COMMAND">recollindex</tt> indexing process can be interrupted by
51
 
sending an interrupt (^C, SIGINT) or terminate (SIGTERM) signal. Some time may elapse
52
 
before the process exits, because it needs to properly flush and close the index. The
53
 
indexing thread can be equivalently stopped from the menu.</p>
 
51
sending an interrupt (Ctrl-C, SIGINT) or terminate (SIGTERM) signal. Some time may elapse
 
52
before the process exits, because it needs to properly flush and close the index. This
 
53
can also be done from the <tt class="COMMAND">recoll</tt> GUI <span class=
 
54
"GUILABEL">File</span>-&gt;<span class="GUILABEL">Stop Indexing</span> menu entry.</p>
54
55
<p>After such an interruption, the index will be somewhat inconsistent because some
55
56
operations which are normally performed at the end of the indexing pass will have been
56
 
skipped (for exemple, the stemming and spelling databases will be inexistant or out of
 
57
skipped (for example, the stemming and spelling databases will be inexistant or out of
57
58
date). You just need to restart indexing at a later time to restore consistency. The
58
59
indexing will restart at the interruption point (the full file tree will be traversed,
59
60
but files that were indexed up to the interruption and are still up to date will not need
60
61
to be reindexed).</p>
61
62
<p><tt class="COMMAND">recollindex</tt> has a number of other options which are described
62
63
in its man page.</p>
63
 
<p>Of special interest maybe are the <tt class="LITERAL">-i</tt> and <tt class=
64
 
"LITERAL">-f</tt> options. <tt class="LITERAL">-i</tt> allows indexing an explicit list
65
 
of files (given as command line parameters or read on stdin). <tt class="LITERAL">-f</tt>
66
 
tells <tt class="COMMAND">recollindex</tt> to ignore file selection parameters from the
67
 
configuration. Together, these options allow building a custom file selection process for
68
 
some area of the file system, by adding the top directory to the <tt class=
69
 
"LITERAL">skippedPaths</tt> list and using an appropriate file selection method to build
70
 
the file list to be fed to <tt class="LITERAL">recollindex�-if</tt> .</p>
 
64
<p>Of special interest maybe are the <code class="OPTION">-i</code> and <code class=
 
65
"OPTION">-f</code> options. <code class="OPTION">-i</code> allows indexing an explicit
 
66
list of files (given as command line parameters or read on stdin). <code class=
 
67
"OPTION">-f</code> tells <tt class="COMMAND">recollindex</tt> to ignore file selection
 
68
parameters from the configuration. Together, these options allow building a custom file
 
69
selection process for some area of the file system, by adding the top directory to the
 
70
<code class="VARNAME">skippedPaths</code> list and using an appropriate file selection
 
71
method to build the file list to be fed to <tt class="LITERAL">recollindex�-if</tt> .</p>
71
72
<p><tt class="LITERAL">recollindex�-i</tt> will not descend into directory parameters,
72
73
but just add them as index entries. It is up to the external file selection method to
73
74
build the complete file list.</p>
88
89
</pre>
89
90
<p>As of version 1.17 the <b class="APPLICATION">Recoll</b> GUI has dialogs to manage
90
91
<tt class="FILENAME">crontab</tt> entries for <tt class="COMMAND">recollindex</tt>. You
91
 
can reach them from the <span class="GUIMENU">Preferences-&gt;Indexing Schedule</span>
92
 
menu. They only work with the good old <tt class="COMMAND">cron</tt>, and do not give
93
 
access to all features of <tt class="COMMAND">cron</tt> scheduling.</p>
 
92
can reach them from the <span class="GUILABEL">Preferences</span>-&gt;<span class=
 
93
"GUILABEL">Indexing Schedule</span> menu. They only work with the good old <tt class=
 
94
"COMMAND">cron</tt>, and do not give access to all features of <tt class=
 
95
"COMMAND">cron</tt> scheduling.</p>
94
96
<p>The usual command to edit your <tt class="FILENAME">crontab</tt> is <kbd class=
95
97
"USERINPUT">crontab -e</kbd> (which will usually start the <tt class="COMMAND">vi</tt>
96
98
editor to edit the file). You may have more sophisticated tools available on your