From 9a4d7de7f9306fe7a2068e6f4ac1f2bf3acfd22f Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Mon, 11 Apr 2016 18:39:26 +0200 Subject: [PATCH] doc --- src/doc/user/usermanual.html | 68 ++++++++++++++++--- src/doc/user/usermanual.xml | 15 ++++ .../webhelp/docs/RCL.INDEXING.CONFIG.GUI.html | 2 +- .../docs/RCL.INDEXING.CONFIG.MULTIPLE.html | 2 +- .../docs/RCL.INDEXING.CONFIG.SENS.html | 2 +- .../webhelp/docs/RCL.INDEXING.CONFIG.html | 2 +- .../webhelp/docs/RCL.INDEXING.EXTATTR.html | 2 +- .../webhelp/docs/RCL.INDEXING.EXTTAGS.html | 2 +- .../RCL.INDEXING.INTRODUCTION.CONFIG.html | 2 +- .../docs/RCL.INDEXING.INTRODUCTION.MODES.html | 13 +++- .../docs/RCL.INDEXING.INTRODUCTION.html | 2 +- .../docs/RCL.INDEXING.MONITOR.FASTFILES.html | 2 +- .../webhelp/docs/RCL.INDEXING.MONITOR.html | 2 +- .../docs/RCL.INDEXING.PERIODIC.AUTOMAT.html | 2 +- .../docs/RCL.INDEXING.PERIODIC.EXEC.html | 2 +- .../webhelp/docs/RCL.INDEXING.PERIODIC.html | 2 +- .../docs/RCL.INDEXING.STORAGE.FORMAT.html | 2 +- .../docs/RCL.INDEXING.STORAGE.SECURITY.html | 2 +- .../webhelp/docs/RCL.INDEXING.STORAGE.html | 2 +- .../webhelp/docs/RCL.INDEXING.WEBQUEUE.html | 2 +- src/doc/user/webhelp/docs/RCL.INDEXING.html | 2 +- .../user/webhelp/docs/RCL.INSTALL.BINARY.html | 2 +- .../RCL.INSTALL.BUILDING.BUILD.SOLARIS.html | 2 +- .../docs/RCL.INSTALL.BUILDING.BUILD.html | 2 +- .../docs/RCL.INSTALL.BUILDING.INSTALL.html | 2 +- .../docs/RCL.INSTALL.BUILDING.PREREQS.html | 2 +- .../webhelp/docs/RCL.INSTALL.BUILDING.html | 2 +- .../docs/RCL.INSTALL.CONFIG.ENVIR.html | 2 +- .../RCL.INSTALL.CONFIG.EXAMPLES.ADDINDEX.html | 2 +- .../RCL.INSTALL.CONFIG.EXAMPLES.ADDVIEW.html | 2 +- .../docs/RCL.INSTALL.CONFIG.EXAMPLES.html | 2 +- .../docs/RCL.INSTALL.CONFIG.FIELDS.XATTR.html | 2 +- .../docs/RCL.INSTALL.CONFIG.FIELDS.html | 2 +- .../docs/RCL.INSTALL.CONFIG.MIMECONF.html | 2 +- .../docs/RCL.INSTALL.CONFIG.MIMEMAP.html | 2 +- .../docs/RCL.INSTALL.CONFIG.MIMEVIEW.html | 2 +- .../docs/RCL.INSTALL.CONFIG.PTRANS.html | 2 +- .../RCL.INSTALL.CONFIG.RECOLLCONF.FILES.html | 2 +- ....INSTALL.CONFIG.RECOLLCONF.IDXTHREADS.html | 2 +- .../RCL.INSTALL.CONFIG.RECOLLCONF.MISC.html | 2 +- ...RCL.INSTALL.CONFIG.RECOLLCONF.STORAGE.html | 20 +++++- .../RCL.INSTALL.CONFIG.RECOLLCONF.TERMS.html | 2 +- .../docs/RCL.INSTALL.CONFIG.RECOLLCONF.html | 2 +- .../user/webhelp/docs/RCL.INSTALL.CONFIG.html | 2 +- .../webhelp/docs/RCL.INSTALL.EXTERNAL.html | 2 +- src/doc/user/webhelp/docs/RCL.INSTALL.html | 2 +- .../webhelp/docs/RCL.INTRODUCTION.RECOLL.html | 2 +- .../webhelp/docs/RCL.INTRODUCTION.SEARCH.html | 2 +- .../webhelp/docs/RCL.INTRODUCTION.TRYIT.html | 2 +- .../user/webhelp/docs/RCL.INTRODUCTION.html | 2 +- .../user/webhelp/docs/RCL.KICKER-APPLET.html | 2 +- .../docs/RCL.PROGRAM.API.ELEMENTS.html | 2 +- .../webhelp/docs/RCL.PROGRAM.API.PYTHON.html | 2 +- .../user/webhelp/docs/RCL.PROGRAM.API.html | 2 +- .../user/webhelp/docs/RCL.PROGRAM.FIELDS.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.ASSOCIATION.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.HTML.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.MULTIPLE.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.PAGES.html | 2 +- .../docs/RCL.PROGRAM.FILTERS.SIMPLE.html | 2 +- .../webhelp/docs/RCL.PROGRAM.FILTERS.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.COMPAT.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.EXAMPLES.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.INTRO.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.PACKAGE.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.RCLEXTRACT.html | 2 +- .../docs/RCL.PROGRAM.PYTHON.RECOLL.html | 2 +- src/doc/user/webhelp/docs/RCL.PROGRAM.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.ANCHOR.html | 2 +- .../webhelp/docs/RCL.SEARCH.ANCHORWILD.html | 2 +- .../webhelp/docs/RCL.SEARCH.CASEDIAC.html | 2 +- .../webhelp/docs/RCL.SEARCH.COMMANDLINE.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.DESKTOP.html | 2 +- .../docs/RCL.SEARCH.GUI.COMPLEX.FILTER.html | 2 +- .../docs/RCL.SEARCH.GUI.COMPLEX.HISTORY.html | 2 +- .../docs/RCL.SEARCH.GUI.COMPLEX.TERMS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.COMPLEX.html | 2 +- .../docs/RCL.SEARCH.GUI.CUSTOM.RESLIST.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.CUSTOM.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.FRAGBUTS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.HISTORY.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.MULTIDB.html | 2 +- .../docs/RCL.SEARCH.GUI.PREVIEW.SEARCH.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.PREVIEW.html | 2 +- .../docs/RCL.SEARCH.GUI.RESLIST.SUGGS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.RESLIST.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.RESTABLE.html | 2 +- .../docs/RCL.SEARCH.GUI.RESULTLIST.MENU.html | 2 +- .../docs/RCL.SEARCH.GUI.RUNSCRIPT.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.SIMPLE.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.SORT.html | 2 +- .../docs/RCL.SEARCH.GUI.TERMEXPLORER.html | 2 +- .../docs/RCL.SEARCH.GUI.THUMBNAILS.html | 2 +- .../docs/RCL.SEARCH.GUI.TIPS.MISC.html | 2 +- .../docs/RCL.SEARCH.GUI.TIPS.PHRASES.html | 2 +- .../docs/RCL.SEARCH.GUI.TIPS.TERMS.html | 2 +- .../webhelp/docs/RCL.SEARCH.GUI.TIPS.html | 2 +- src/doc/user/webhelp/docs/RCL.SEARCH.GUI.html | 2 +- .../webhelp/docs/RCL.SEARCH.KIO.INTRO.html | 2 +- .../docs/RCL.SEARCH.KIO.SEARCHABLEDOCS.html | 2 +- src/doc/user/webhelp/docs/RCL.SEARCH.KIO.html | 2 +- .../docs/RCL.SEARCH.LANG.MODIFIERS.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.LANG.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.PTRANS.html | 2 +- .../user/webhelp/docs/RCL.SEARCH.SAVING.html | 2 +- .../webhelp/docs/RCL.SEARCH.SHORTCUT.html | 2 +- .../webhelp/docs/RCL.SEARCH.SYNONYMS.html | 2 +- .../docs/RCL.SEARCH.WILDCARDS.PATH.html | 2 +- .../webhelp/docs/RCL.SEARCH.WILDCARDS.html | 2 +- src/doc/user/webhelp/docs/RCL.SEARCH.html | 2 +- src/doc/user/webhelp/docs/ch02s01s03.html | 4 +- src/doc/user/webhelp/docs/ch02s01s04.html | 4 +- src/doc/user/webhelp/docs/ch02s01s05.html | 4 +- src/doc/user/webhelp/docs/index.html | 4 +- 114 files changed, 215 insertions(+), 129 deletions(-) diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 949b3e34..a61e0c1f 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -20,8 +20,8 @@ alink="#0000FF">
-

Recoll user manual

+

Recoll user manual

@@ -109,13 +109,13 @@ alink="#0000FF"> multiple indexes
2.1.3. Document types
+ "#idp54428144">Document types
2.1.4. Indexing failures
+ "#idp54447824">Indexing failures
2.1.5. Recovery
+ "#idp48768496">Recovery @@ -900,6 +900,22 @@ alink="#0000FF"> "command">recoll GUI: PreferencesIndexing schedule

+ +

The File menu also has + entries to start or stop the current indexing operation. + Stopping indexing is performed by killing the + recollindex + process, which will checkpoint its state and exit. A + later restart of indexing will mostly resume from where + things stopped (the file tree walk has to be restarted + from the beginning).

+ +

When the real time indexer is running, only a stop + operation is available from the menu. When no indexing is + running, you have a choice of updating the index or + rebuilding it (the first choice only processes changed + files, the second one zeroes the index before starting so + that all files are processed).

@@ -962,8 +978,8 @@ alink="#0000FF">
-

2.1.3. Document types

+

2.1.3. Document types

@@ -1056,8 +1072,8 @@ indexedmimetypes = application/pdf
-

2.1.4. Indexing +

2.1.4. Indexing failures

@@ -1097,8 +1113,8 @@ indexedmimetypes = application/pdf
-

2.1.5. Recovery

+

2.1.5. Recovery

@@ -8667,6 +8683,36 @@ field2 = value for field2
+
cachedir
+ +
+

When not explicitly specified, the + Recoll data + directories are stored relative to the + configuration directory. If cachedir is set, the directories + are stored under the specified value instead + (e.g. if cachedir is + set to ~/.cache/recoll, the default + dbdir would be + ~/.cache/recoll/xapiandb + instead of ~/.recoll/xapiandb ). This + affects the default values for dbdir, webcachedir, mboxcachedir, and aspellDicDir, which can still be + individually specified to override cachedir. Note that if you have + multiple configurations, each must have a + different cachedir.

+
+
dbdir
diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 75252cd9..5acf607c 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -352,6 +352,21 @@ Indexing schedule + + The File + menu also has entries to start or stop + the current indexing operation. Stopping indexing is performed by + killing the recollindex process, which will + checkpoint its state and exit. A later restart of indexing will + mostly resume from where things stopped (the file tree walk has to + be restarted from the beginning). + + When the real time indexer is running, only a stop operation + is available from the menu. When no indexing is running, you have + a choice of updating the index or rebuilding it (the first choice + only processes changed files, the second one zeroes the index + before starting so that all files are processed). + diff --git a/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html b/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html index 87828b2a..32262c65 100644 --- a/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html +++ b/src/doc/user/webhelp/docs/RCL.INDEXING.CONFIG.GUI.html @@ -4,7 +4,7 @@ The index configuration GUI - - Recoll user manual