diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 04b57d70..a2f495d7 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -24,7 +24,7 @@ Dockes - $Id: usermanual.sgml,v 1.10 2006-04-05 13:30:00 dockes Exp $ + $Id: usermanual.sgml,v 1.11 2006-04-07 13:07:34 dockes Exp $ This document introduces full text search notions @@ -108,11 +108,11 @@ mature package using a sophisticated probabilistic ranking model. &RCL; provides the interface - to get data into (indexation) and out (searching) of the system. + to get data into (indexing) and out (searching) of the system. In practice, &XAP; works by remembering where terms appear in your document files. The acquisition process is called - indexation. + indexing. The resulting database can be big (roughly the size of the original document set), but it is not a document @@ -151,7 +151,7 @@ giving &RCL; a try, but you may want to adjust it later. - Indexation is started + Indexing is started automatically the first time you execute the recoll search graphical user interface, or by executing the recollindex command. @@ -166,22 +166,22 @@ - Indexation + Indexing Introduction - Indexation is the process by which the set of documents is - analyzed and the data entered into the database. &RCL; indexation + Indexing is the process by which the set of documents is + analyzed and the data entered into the database. &RCL; indexing is normally incremental: documents will only be processed if they have been modified. On the first execution, of course, all documents will need processing. A full index build can be forced - later on by specifying an option to the indexation command + later on by specifying an option to the indexing command (recollindex -z). - &RCL; indexation takes place at discrete times. There is + &RCL; indexing takes place at discrete times. There is currently no interface to real time file modification - monitors. The typical usage is to have a nightly indexation run + monitors. The typical usage is to have a nightly indexing run programmed into your cron file. @@ -205,7 +205,7 @@ many individually indexed documents. - &RCL; indexation processes plain text, HTML, openoffice + &RCL; indexing processes plain text, HTML, openoffice and e-mail files internally. Other types (ie: postscript, pdf, ms-word, rtf) need external applications for preprocessing. The list is in the - The indexation configuration + The indexing configuration Values set in the system-wide configuration file (named like @@ -231,9 +231,9 @@ The most accurate documentation for editing the file is given by comments inside the central one. If you want to adjust - the configuration before indexation, just click + the configuration before indexing, just click Cancel when the program asks if it should - start initial indexation. This will have created a + start initial indexing. This will have created a .recoll directory containing empty configuration files. @@ -244,34 +244,34 @@ - Starting indexation + Starting indexing - Indexation is performed either by the + Indexing is performed either by the recollindex program, or by the - indexation thread inside the recoll + indexing thread inside the recoll program (use the File menu). If the recoll program finds no database - when it starts, it will automatically start indexation (except + when it starts, it will automatically start indexing (except if cancelled). - It is best to avoid interrupting the indexation process, as + It is best to avoid interrupting the indexing process, as this may sometimes leave the database in a bad state. This is not a serious problem, as you then just need to clear - everything and restart the indexation: the database files are + everything and restart the indexing: the database files are normally stored in the $HOME/.recoll/xapiandb directory, which you can just delete if needed. Alternatively, you can start recollindex -z, which will - reset the database before indexation. + reset the database before indexing. Using <command>cron</command> to automate - indexation + indexing - The most common way to set up indexation is to have a cron + The most common way to set up indexing is to have a cron task execute it every night. For example the following crontab entry would do it every day at 3:30AM (supposing recollindex is in your PATH): @@ -443,7 +443,7 @@ File names All file name elements (the broken up file path) are - entered as terms during indexation, and you can specify them + entered as terms during indexing, and you can specify them as ordinary terms in normal search fields. Alternatively, you can use specific file name search which will only look for file names and can use @@ -510,7 +510,7 @@ file), or later added with recollindex -s (See the recollindex manual). Stemming languages which are dynamically added will be - deleted at the next indexation pass unless they are also added in + deleted at the next indexing pass unless they are also added in the configuration file. @@ -745,7 +745,7 @@ will be created with a set of empty configuration files. recoll will give you a chance to edit the configuration file before starting - indexation. recollindex will + indexing. recollindex will proceed immediately. Most of the parameters specific to the @@ -787,7 +787,7 @@ Section lines allow redefining some parameters for a - directory subtree. Some of the parameters used for indexation + directory subtree. Some of the parameters used for indexing are looked up hierarchically from the more to the less specific. Not all parameters can be meaningfully redefined, this is specified for each in the next section. @@ -813,7 +813,7 @@ recoll to copy the sample configuration, click Cancel, and edit the configuration file before restarting the command. This - will start the initial indexation, which may take some time. + will start the initial indexing, which may take some time. Paramers: @@ -824,7 +824,7 @@ index (recursively for directories). The indexer will not follow symbolic links inside the indexed trees. If an entry in the topdirs list is a symbolic link, - indexation will not start and will generate an error. + indexing will not start and will generate an error. @@ -885,7 +885,7 @@ possible values. You can add a stem expansion database for a different language by using recollindex -s, but it will be deleted during the next - indexation. Only languages listed in the configuration + indexing. Only languages listed in the configuration file are permanent. @@ -927,7 +927,7 @@ type for a file (the main procedure uses suffix associations as defined in the mimemap file). This can be useful for files with suffixless names, - but it will also cause the indexation of many bogus "text" + but it will also cause the indexing of many bogus "text" files. @@ -937,7 +937,7 @@ section of the database to allow specific file names searches using wild cards. This parameter decides if file name indexing is performed only for files with mime - types that would qualify them for full text indexation, or + types that would qualify them for full text indexing, or for all files inside the selected subtrees, independant of mime type. @@ -985,10 +985,10 @@ The mimeconf file mimeconf specifies how the - different mime types are handled for indexation, and for + different mime types are handled for indexing, and for display. - Changing the indexation parameters is probably not a + Changing the indexing parameters is probably not a good idea except if you are a &RCL; developper. You may want to adjust the external viewers defined in