Fixed the pdf manual build (needed fix to confxml which generated incorrect data for the configuration section)
This commit is contained in:
Jean-Francois Dockes
parent
944076da54
commit
2443533703
@ -45,7 +45,7 @@ index.html: usermanual.xml
|
||||
"${XSLDIR}/html/chunk.xsl" $<
|
||||
|
||||
usermanual.pdf: usermanual.xml
|
||||
dblatex $<
|
||||
dblatex --xslt-opts="--xinclude" -tpdf $<
|
||||
|
||||
UTILBUILDS=/home/dockes/tmp/builds/medocutils/
|
||||
recoll-conf-xml:
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<sect2 id="RCL.INSTALL.CONFIG.RECOLLCONF">
|
||||
<title>Recoll main configuration file, recoll.conf </title>
|
||||
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.WHATDOCS">
|
||||
<title>Parameters affecting what documents we index </title>
|
||||
<title>Parameters affecting what documents we index </title><variablelist>
|
||||
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS">
|
||||
<term><varname>topdirs</varname></term>
|
||||
<listitem><para>Space-separated list of files or
|
||||
@ -172,9 +172,9 @@ compressedfilemaxkbs.</para></listitem></varlistentry>
|
||||
<listitem><para>Size limit for archive
|
||||
members. This is passed to the filters in the environment
|
||||
as RECOLL_FILTER_MAXMEMBERKB.</para></listitem></varlistentry>
|
||||
</sect3>
|
||||
</variablelist></sect3>
|
||||
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.TERMS">
|
||||
<title>Parameters affecting how we generate terms </title>
|
||||
<title>Parameters affecting how we generate terms </title><variablelist>
|
||||
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTRIPCHARS">
|
||||
<term><varname>indexStripChars</varname></term>
|
||||
<listitem><para>Decide if we store
|
||||
@ -306,9 +306,9 @@ configuration file ("fieldname = fieldvalue" lines). The rclmultixx name
|
||||
will be ignored, and field names and values will be parsed from the data.
|
||||
Example: metadatacmds = ; tags = tmsu tags %f; rclmulti1 = cmdOutputsConf %f
|
||||
</para></listitem></varlistentry>
|
||||
</sect3>
|
||||
</variablelist></sect3>
|
||||
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.STORE">
|
||||
<title>Parameters affecting where and how we store things </title>
|
||||
<title>Parameters affecting where and how we store things </title><variablelist>
|
||||
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.CACHEDIR">
|
||||
<term><varname>cachedir</varname></term>
|
||||
<listitem><para>Top directory for Recoll data. Recoll data
|
||||
@ -390,9 +390,9 @@ subdirectories.</para></listitem></varlistentry>
|
||||
<listitem><para>Directory location for icons. The only reason to
|
||||
change this would be if you want to change the icons displayed in the
|
||||
result list. Defaults to $prefix/share/recoll/images</para></listitem></varlistentry>
|
||||
</sect3>
|
||||
</variablelist></sect3>
|
||||
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.PERFS">
|
||||
<title>Parameters affecting indexing performance and resource usage </title>
|
||||
<title>Parameters affecting indexing performance and resource usage </title><variablelist>
|
||||
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.IDXFLUSHMB">
|
||||
<term><varname>idxflushmb</varname></term>
|
||||
<listitem><para>Threshold (megabytes of new data) where we flush from memory to
|
||||
@ -443,9 +443,9 @@ in thrQSizes: if the first queue depth is 0, all counts are ignored
|
||||
corresponding thread count is ignored. It makes no sense to use a value
|
||||
other than 1 for the last stage because updating the Xapian index is
|
||||
necessarily single-threaded (and protected by a mutex).</para></listitem></varlistentry>
|
||||
</sect3>
|
||||
</variablelist></sect3>
|
||||
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.MISC">
|
||||
<title>Miscellaneous parameters </title>
|
||||
<title>Miscellaneous parameters </title><variablelist>
|
||||
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.LOGLEVEL">
|
||||
<term><varname>loglevel</varname></term>
|
||||
<listitem><para>Log file verbosity 1-6. A value of 2 will print
|
||||
@ -563,9 +563,9 @@ Example: mondelaypatterns = *.log:20 "*with spaces.*:30"</para></listitem></varl
|
||||
<term><varname>monioniceclassdata</varname></term>
|
||||
<listitem><para>ionice class parameter for the real time indexing process. On platforms where this is supported. The default is
|
||||
empty.</para></listitem></varlistentry>
|
||||
</sect3>
|
||||
</variablelist></sect3>
|
||||
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.QUERY">
|
||||
<title>Query-time parameters (no impact on the index) </title>
|
||||
<title>Query-time parameters (no impact on the index) </title><variablelist>
|
||||
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.AUTODIACSENS">
|
||||
<term><varname>autodiacsens</varname></term>
|
||||
<listitem><para>auto-trigger diacritics sensitivity (raw index only). IF the index is not stripped, decide if we automatically trigger
|
||||
@ -600,9 +600,9 @@ multiplicative, and we want to avoid eating all the memory. Default
|
||||
the result list. The default of 1,000,000 may be
|
||||
insufficient for very big documents, the consequence would be snippets
|
||||
with possibly meaning-altering missing words.</para></listitem></varlistentry>
|
||||
</sect3>
|
||||
</variablelist></sect3>
|
||||
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.PDF">
|
||||
<title>Parameters for the PDF input script </title>
|
||||
<title>Parameters for the PDF input script </title><variablelist>
|
||||
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.PDFOCR">
|
||||
<term><varname>pdfocr</varname></term>
|
||||
<listitem><para>Attempt OCR of PDF files with no text content if both tesseract and
|
||||
@ -631,12 +631,12 @@ method which will be called with the qualified tag name and value of each
|
||||
selected field, for editing or erasing. A new instance is created for
|
||||
each document, so that the object can keep state for, e.g. eliminating
|
||||
duplicate values.</para></listitem></varlistentry>
|
||||
</sect3>
|
||||
</variablelist></sect3>
|
||||
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.SPECLOCATIONS">
|
||||
<title>Parameters set for specific locations </title>
|
||||
<title>Parameters set for specific locations </title><variablelist>
|
||||
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.MHMBOXQUIRKS">
|
||||
<term><varname>mhmboxquirks</varname></term>
|
||||
<listitem><para>Enable thunderbird/mozilla-seamonkey mbox format quirks Set this for the directory where the email mbox files are
|
||||
stored.</para></listitem></varlistentry>
|
||||
</sect3>
|
||||
</variablelist></sect3>
|
||||
</sect2>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -865,12 +865,13 @@ indexedmimetypes = application/pdf
|
||||
to index files is divided in several stages and some of the
|
||||
stages can be executed by multiple threads. The stages are:
|
||||
<orderedlist>
|
||||
<listitem>File system walking: this is always performed by
|
||||
the main thread.</listitem>
|
||||
<listitem>File conversion and data extraction.</listitem>
|
||||
<listitem>Text processing (splitting, stemming,
|
||||
etc.)</listitem>
|
||||
<listitem>&XAP; index update.</listitem>
|
||||
<listitem><para>File system walking: this is always performed by
|
||||
the main thread.</para></listitem>
|
||||
<listitem><para>File conversion and data
|
||||
extraction.</para></listitem>
|
||||
<listitem><para>Text processing (splitting, stemming,
|
||||
etc.).</para></listitem>
|
||||
<listitem><para>&XAP; index update.</para></listitem>
|
||||
</orderedlist>
|
||||
</para>
|
||||
<para>You can also read a
|
||||
@ -2350,8 +2351,8 @@ MimeType=*/*
|
||||
scan, which can be quite long.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Stem expansion</term>
|
||||
<listitem><para>This mode will perform the usual stem expansion
|
||||
normally done as part user input processing. As such it is
|
||||
@ -4698,9 +4699,8 @@ for doc in results:
|
||||
|
||||
<variablelist>
|
||||
|
||||
<varlistentry id="RCL.PROGRAM.PYTHONAPI.ELEMENTS.IPATH">>
|
||||
<varlistentry id="RCL.PROGRAM.PYTHONAPI.ELEMENTS.IPATH">
|
||||
<term>ipath</term>
|
||||
|
||||
<listitem><para>This data value (set as a field in the Doc
|
||||
object) is stored, along with the URL, but not indexed by
|
||||
&RCL;. Its contents are not interpreted by the index layer, and
|
||||
@ -4725,7 +4725,6 @@ for doc in results:
|
||||
|
||||
<varlistentry id="RCL.PROGRAM.PYTHONAPI.ELEMENTS.UDI">
|
||||
<term>udi</term>
|
||||
|
||||
<listitem><para>An <literal>udi</literal> (unique document
|
||||
identifier) identifies a document. Because of limitations inside
|
||||
the index engine, it is restricted in length (to 200 bytes),
|
||||
@ -4742,7 +4741,6 @@ for doc in results:
|
||||
|
||||
<varlistentry id="RCL.PROGRAM.PYTHONAPI.ELEMENTS.PARENTUDI">
|
||||
<term>parent_udi</term>
|
||||
|
||||
<listitem><para>If this attribute is set on a document when
|
||||
entering it in the index, it designates its physical container
|
||||
document. In a multilevel hierarchy, this may not be the
|
||||
@ -4765,7 +4763,6 @@ for doc in results:
|
||||
|
||||
<varlistentry>
|
||||
<term>Stored and indexed fields</term>
|
||||
|
||||
<listitem><para>The <filename>fields</filename> file inside
|
||||
the &RCL; configuration defines which document fields are
|
||||
either "indexed" (searchable), "stored" (retrievable with
|
||||
@ -6021,7 +6018,7 @@ thesame = "some string with spaces"
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
|
||||
<sect2 id="RCL.INSTALL.CONFIG.ENVIR">
|
||||
<title>Environment variables</title>
|
||||
|
||||
@ -6091,7 +6088,7 @@ thesame = "some string with spaces"
|
||||
|
||||
<!-- <sect2 id="RCL.INSTALL.CONFIG.RECOLLCONF"> -->
|
||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
href="recoll.conf.xml" />
|
||||
href="recoll.conf.xml" />
|
||||
|
||||
|
||||
<sect2 id="RCL.INSTALL.CONFIG.FIELDS">
|
||||
@ -6488,12 +6485,8 @@ application/x-blobapp = exec rclblob
|
||||
to write an input handler.</para>
|
||||
|
||||
</sect3>
|
||||
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
</chapter>
|
||||
|
||||
</book>
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user