Convert recollindex to using getopt_long and add options to compact and burst the webcache

This commit is contained in:
Jean-Francois Dockes
2021-03-25 14:11:53 +01:00
parent bc8eee622e
commit 485a077737
4 changed files with 140 additions and 85 deletions
+24 -23
View File
@@ -8,8 +8,7 @@ recollindex \- indexing command for the Recoll full text search system
.B recollindex
[
.B \-c
<configdir>
]
<cfdir>]
[
.B \-z|\-Z
]
@@ -20,13 +19,11 @@ recollindex \- indexing command for the Recoll full text search system
.B recollindex
[
.B \-c
<cd>
]
<cfd>]
.B \-m
[
.B \-w
<secs>
]
<secs>]
[
.B \-D
]
@@ -43,8 +40,7 @@ recollindex \- indexing command for the Recoll full text search system
.B recollindex
[
.B \-c
<cd>
]
<cfdir>]
.B \-i
[
.B \-Z \-k \-f \-P
@@ -54,8 +50,7 @@ recollindex \- indexing command for the Recoll full text search system
.B recollindex
[
.B \-c
<cd>
]
<cfdir>]
.B \-r
[
.B \-Z \-K \-e \-f
@@ -69,39 +64,35 @@ pattern
.B recollindex
[
.B \-c
<configdir>
]
<cfdir>]
.B \-e
[<path [path ...]>]
.br
.B recollindex
[
.B \-c
<configdir>
]
.B \-l
<cfdir>]
.B \-l|-S|-E
.br
.B recollindex
[
.B \-c
<configdir>
]
<cfdir>]
.B \-s
<lang>
.br
.B recollindex
[
.B \-c
<configdir>
]
.B \-S
<cfdir>]
.B \--webcache-compact
.br
.B recollindex
[
.B \-c
<configdir>
]
.B \-E
<cfdir>]
.B \--webcache-burst
<destdir>
.SH DESCRIPTION
The
@@ -297,6 +288,16 @@ package, which must be installed on the system.
.B recollindex \-E
will check the configuration file for topdirs and other relevant paths
existence (to help catch typos).
.PP
.B recollindex \--webcache-compact
will recover the space wasted by erased page instances inside the Web
cache. It may temporarily need to use twice the disk space used by the Web
cache.
.PP
.B recollindex \--webcache-burst <destdir>
will extract all entries from the Web cache to files created inside
<destdir>. Each cache entry is extracted as two files, for the data and metadata.
.SH SEE ALSO
.PP
+19 -2
View File
@@ -423,7 +423,7 @@ alink="#0000FF">
<div class="list-of-tables">
<p><b>List of Tables</b></p>
<dl>
<dt>3.1. <a href="#idm1444">Keyboard shortcuts</a></dt>
<dt>3.1. <a href="#idm1453">Keyboard shortcuts</a></dt>
</dl>
</div>
<div class="chapter">
@@ -2004,6 +2004,23 @@ recollindex -c "$confdir"
tool to list and edit the contents of the Web cache.
(<span class="guimenu">Tools</span> → <span class=
"guimenuitem">Webcache editor</span>)</p>
<p>The <span class=
"command"><strong>recollindex</strong></span> command has
two options to help manage the Web cache:</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem"><code class=
"option">--webcache-compact</code> will recover the
space from erased entries. It may need to use twice the
disk space currently needed for the Web cache.</li>
<li class="listitem"><code class=
"option">--webcache-burst <em class=
"replaceable"><code>destdir</code></em></code> will
extract all current entries into pairs of metadata and
data files created inside <em class=
"replaceable"><code>destdir</code></em></li>
</ul>
</div>
<p>You can find more details on Web indexing, its usage and
configuration in a <a class="ulink" href=
"https://www.lesbonscomptes.com/recoll/faqsandhowtos/IndexWebHistory"
@@ -4000,7 +4017,7 @@ fs.inotify.max_user_watches=32768
given context (e.g. within a preview window, within the
result table).</p>
<div class="table">
<a name="idm1444" id="idm1444"></a>
<a name="idm1453" id="idm1453"></a>
<p class="title"><b>Table&nbsp;3.1.&nbsp;Keyboard
shortcuts</b></p>
<div class="table-contents">
+11
View File
@@ -1300,6 +1300,17 @@ recollindex -c "$confdir"
<para>The &RCL; GUI has a tool to list and edit the contents of the
Web cache. (<menuchoice><guimenu>Tools</guimenu><guimenuitem>Webcache
editor</guimenuitem></menuchoice>)</para>
<para>The <command>recollindex</command> command has two options to
help manage the Web cache:</para>
<itemizedlist>
<listitem><option>--webcache-compact</option> will recover
the space from erased entries. It may need to use twice the disk space
currently needed for the Web cache.</listitem>
<listitem><option>--webcache-burst <replaceable>destdir</replaceable></option>
will extract all current entries into pairs of metadata and data
files created
inside <replaceable>destdir</replaceable></listitem>
</itemizedlist>
<para>You can find more details on Web indexing, its usage and configuration
in a <ulink url="&FAQS;IndexWebHistory">Recoll 'Howto'