diff --git a/src/doc/user/docbook.css b/src/doc/user/docbook.css index 2224d7e3..d0149a2a 100644 --- a/src/doc/user/docbook.css +++ b/src/doc/user/docbook.css @@ -23,7 +23,7 @@ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * - * $FreeBSD: doc/share/misc/docbook.css,v 1.7 2004/03/22 19:17:52 ceri Exp $ + * $FreeBSD: doc/share/misc/docbook.css,v 1.11 2007/07/08 06:23:33 chinsan Exp $ */ BODY ADDRESS { @@ -68,38 +68,32 @@ DIV.PROCEDURE P B { color: #990000; } -BODY H1 { +BODY H1, BODY H2, BODY H3, BODY H4, BODY H5, BODY H6 { + line-height: 1.3; + margin-left: 0; +} + +BODY H1, BODY H2 { margin: .8em 0 0 -4%; - line-height: 1.3; } -BODY H2 { - margin: .8em 0 0 -4%; - line-height: 1.3; -} - -BODY H3 { +BODY H3, BODY H4 { margin: .8em 0 0 -3%; - line-height: 1.3; -} - -BODY H4 { - margin: .8em 0 0 -3%; - line-height: 1.3; } BODY H5 { margin: .8em 0 0 -2%; - line-height: 1.3; } BODY H6 { margin: .8em 0 0 -1%; - line-height: 1.3; } BODY HR { - margin: .6em + margin: .6em; + border-width: 0 0 1px 0; + border-style: solid; + border-color: #cecece; } BODY IMG.NAVHEADER { @@ -117,11 +111,7 @@ BODY PRE { color: #461b7e; } -BODY TD { - line-height: 1.2 -} - -BODY TH { +BODY TD, BODY TH { line-height: 1.2; } @@ -135,19 +125,18 @@ HTML { padding: 0; } +BODY P B.APPLICATION { + color: #000000; +} .FILENAME { color: #007a00; } -BODY H1, BODY H2, BODY H3, BODY H4, BODY H5, BODY H6 { - margin-left: 0 -} - .GUIMENU, .GUIMENUITEM, .GUISUBMENU, .GUILABEL, .INTERFACE, .GUIBUTTON, .SHORTCUT, .SHORTCUT .KEYCAP { - background-color: #F0F0F0; + background-color: #CFCFCF; } .ACCEL { diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 1d5f5236..3919135d 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -24,7 +24,7 @@ Dockes - $Id: usermanual.sgml,v 1.46 2007-07-09 17:21:17 dockes Exp $ + $Id: usermanual.sgml,v 1.47 2007-07-13 07:17:39 dockes Exp $ This document introduces full text search notions @@ -391,9 +391,11 @@ recoll configuration files. The configuration is documented inside the installation chapter of - this document, or in the recoll.conf(5) man page. The most - immediately useful variable you may interested in is probably installation chapter of this + document, or in the recoll.conf(5) man page, but the most + current information will most likely be the comments inside the + sample file. The most immediately useful variable you may + interested in is probably topdirs, which determines what subtrees get indexed. @@ -1095,9 +1097,13 @@ fvwm Documents that you actually view (with the internal preview or an external tool) are entered into the document history, - which is remembered. You can display the history list by using + which is remembered. + You can display the history list by using the Tools/Doc History menu entry. + You can erase the document history by using the + Erase document history entry in the + File menu. @@ -1119,6 +1125,13 @@ fvwm reset, or the program exits. An activated sort is indicated in the result list header. + Sort parameters are remembered between program + invocations, but result sorting is normally always inactive when + the program starts. It is possible to keep the sorting + activation state between program invocations by checking the + Remember sort activation state + option in the preferences. + @@ -1263,6 +1276,9 @@ fvwm %DDate + %IIcon image name + + %KKeywords (if any) @@ -1288,7 +1304,7 @@ fvwm The default value for the string is: - %R %S %L &nbsp;&nbsp;<b>%T</b><br> + <img src="%I" align="left">%R %S %L &nbsp;&nbsp;<b>%T</b><br> %M&nbsp;%D&nbsp;&nbsp;&nbsp;<i>%U</i><br> %A %K @@ -1298,7 +1314,7 @@ fvwm %A<font color=#008000>%U - %S</font> - %L Or the clean looking: - %L <font color="#900000">%R</font> + <img src="%I" align="left">%L <font color="#900000">%R</font>   <b>%T</b><br>%S  <font color="#808080"><i>%U</i></font> <table bgcolor="#e0e0e0"> @@ -1312,6 +1328,11 @@ fvwm where docnum is what %N would print. This makes the title a preview link in the above format. + Please note that, due to the way the program + handles right mouse clicks in the result list, if the custom + formatting results in multiple paragraphs per result, right + clicks will only work inside the first one. + HTML help browser: this @@ -1321,12 +1342,6 @@ fvwm PATH, or browse for a full pathname. - Show document type icons in result - list: icons in the result list can be turned - off. They take quite a lot of space and convey relatively - little useful information. - - Auto-start simple search on white space entry: if this is checked, a search will be executed each time you enter a space in the simple search @@ -1431,52 +1446,45 @@ fvwm Installing a prebuilt copy - Recoll binary installations are always linked statically - to the xapian libraries, and have no other dependencies. You - will only have to check or install - supporting - applications for the file types that you want to index - beyond text, HTML and mail files. + &RCL; binary packages from the &RCL; web site are always + linked statically to the &XAP; libraries, and have no other + dependencies. You will only have to check or install supporting applications + for the file types that you want to index beyond text, HTML and + mail files, and maybe have a look at the + configuration section + (but this may not be necessary for a quick test with default + parameters). Installing through a package system - If you use a BSD-type port system or a - prebuilt package (RPM or other), just follow the usual - procedure, and maybe have a look at the configuration - section (but this may not be necessary for a quick - test with default parameters). + If you use a BSD-type port system or a prebuilt package + (RPM or other), just follow the usual procedure for your + system. Installing a prebuilt &RCL; - The unpackaged binary versions are just compressed tar - files of a build tree, where only the useful parts were kept - (executables and sample configuration). + The unpackaged binary versions on the &RCL; web site are + just compressed tar files of a build tree, where only the + useful parts were kept (executables and sample + configuration). - The executable binary files are built with a static link to + The executable binary files are built with a static link to libxapian and libiconv, to make installation easier (no - dependencies). However, this also means that you cannot change - the versions which are used. + dependencies). - After extracting the tar file, you can proceed with + After extracting the tar file, you can proceed with installation as if you had built the package from source (that is, just type make install). The binary trees are built for installation to /usr/local. - You may then need to install external applications to process - some file types that you want indexed (ie: acrobat, - postscript ...). See next section. - - Finally, you may want to have a look at the configuration section. - - + Supporting packages @@ -1552,7 +1560,8 @@ fvwm At the very least, you will need to download and install the xapian core package - (&RCL; development currently uses version 0.9.5), and the qt run-time and development packages (&RCL; development currently uses version 3.3.5, but any 3.3 version is @@ -1575,10 +1584,11 @@ fvwm Building &RCL; has been built on - Linux (redhat7.3, mandriva 2005/6, Fedora Core 3/4/5), FreeBSD and - Solaris 8. If you build on another system, I would very much - welcome patches. + Linux (redhat7.3, mandriva 2005/6, Fedora Core 3/4/5/6), + FreeBSD 5/6, macosx, and Solaris 8. If you build on another system, and + need to modify things, + I would + very much welcome patches. Depending on the qt configuration on your system, you may have to set the @@ -1843,6 +1853,44 @@ skippedPaths = ~/somedir/*.txt + indexstemminglanguages + A list of languages for which the stem + expansion databases will be built. See recollindex(1) or + use the recollindex -l command for + 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 + indexing. Only languages listed in the configuration + file are permanent. + + + + defaultcharset + The name of the character set used for + files that do not contain a character set definition (ie: + plain text files). This can be redefined for any + sub-directory. If it is not set at all, the character set + used is the one defined by the nls environment (LC_ALL, + LC_CTYPE, LANG), or iso8859-1 if nothing is set. + + maxfsoccuppc + Maximum file system occupation before we + stop indexing. The value is a percentage, corresponding to + what the "Capacity" df output column shows. The default + value is 0, meaning no checking. + + + + idxflushmb + Threshold (megabytes of new text data) + where we flush from memory to disk index. Setting this can + help control memory usage. A value of 0 means no explicit + flushing, letting Xapian use its own default, which is + flushing every 10000 documents (memory usage depends on + average document size). The default value is 10. + + + filtersdir A directory to search for the external filter scripts used to index some types of files. The @@ -1852,26 +1900,14 @@ skippedPaths = ~/somedir/*.txt - indexstemminglanguages - A list of languages for which the stem - expansion databases will be built. See recollindex(1) for - 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 - indexing. Only languages listed in the configuration - file are permanent. + iconsdir + The name of the directory where + recoll result list icons are + stored. You can change this if you want different + images. - - defaultcharset - The name of the character set used for - files that do not contain a character set definition (ie: - plain text files). This can be redefined for any - sub-directory. If it is not set at all, the character set - used is the one defined by the nls environment (LC_ALL, - LC_CTYPE, LANG), or iso8859-1 if nothing is set. - guesscharset Decide if we try to guess the character set of files if no internal value is available (ie: for @@ -1913,14 +1949,6 @@ skippedPaths = ~/somedir/*.txt - iconsdir - The name of the directory where - recoll result list icons are - stored. You can change this if you want different - images. - - - aspellLanguage Language definitions to use when creating the aspell dictionary. The value must match a set of