1<page id="xiphos-23-modules-maintenance" type="topic" 2 xmlns="http://projectmallard.org/1.0/" 3 xmlns:its="http://www.w3.org/2005/11/its"> 4 5 <info> 6 <desc>Removal, Archival and Indexing tasks.</desc> 7 8 <link type="guide" xref="index#module-manager"/> 9 10 <revision pkgversion="4.1.0" date="2018-04-24" status="draft"/> 11 <revision pkgversion="4.1.0" date="2018-05-28" status="candidate"/> 12 13 <title type='link' role="trail"></title> 14 <title type='text'>Xiphos</title> 15 16 <credit type="author" its:translate="no"> 17 <name>Andy Piper</name> 18 </credit> 19 <credit type="author" its:translate="no"> 20 <name>Pierre Benz</name> 21 </credit> 22 <credit type="author" its:translate="no"> 23 <name>Dr Peter von Kaehne</name> 24 </credit> 25 <credit type="author" its:translate="no"> 26 <name>Karl Kleinpaste</name> 27 </credit> 28 <credit type="author" its:translate="no"> 29 <name>Matthew Talbert</name> 30 </credit> 31 32 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> 33 34 </info> 35 36 <!-- Maintaining Modules --> 37 38 <title>Sword Modules Maintenance</title> 39 40 <media style="image" mime="image/png" src="figures/sword_remove.png" /> 41 42 <p>Several maintenance functions are available: Removal, archival, index, and 43 index deletion.</p> 44 45 <p>Removal disposes of a module entirely. There is no recovery of the module 46 unless you have previously archived a copy of it.</p> 47 48 <p>Archival is available for any module, although it is provided with personal 49 commentaries specifically in mind. A *.zip of the module is left in the 50 directory ~/.sword/zip. Archival prior to removal of personal commentaries is 51 recommended, in order to be available for future re-install if the subject 52 matter of the personal commentary becomes important again.</p> 53 54 <p>Indexing is provided so that the underlying Sword search support can create 55 the index needed for the "lucene" fast-search functions. If the index is not 56 created, plain multi-word search will still be available, but it will be much 57 slower. With the index in place, searches through an entire Bible can take 58 just a few seconds.</p> 59 60 <p>Indexes may be deleted as well.</p> 61</page> 62