home *** CD-ROM | disk | FTP | other *** search
/ In'side Shareware 1995 March / ish0395.iso / win_util / dtsearch / options.doc < prev    next >
Text File  |  1994-06-01  |  9KB  |  254 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                      dtSearch 3.0
  7.  
  8.                                   OPTIONS.DAT Manual
  9.  
  10.           Introduction
  11.           ============
  12.  
  13.               dtSearch stores user-specified options in a file called
  14.           OPTIONS.DAT. Most options can be changed directly using dialog
  15.           boxes in dtSearch.   Therefore, MOST USERS DO NOT NEED TO KNOW
  16.           ABOUT THE CONTENTS OF OPTIONS.DAT. This information is provided
  17.           for users who need access to a few advanced options that can only
  18.           be changed by editing OPTIONS.DAT.   Also, in unusual
  19.           circumstances some users may need to edit the OPTIONS.DAT  file
  20.           directly.
  21.  
  22.               OPTIONS.DAT is the same for dtSearch for Windows and dtSearch
  23.           for DOS. The two versions of dtSearch can share a common
  24.           OPTIONS.DAT file.
  25.  
  26.           How dtSearch Uses OPTIONS.DAT
  27.           =============================
  28.  
  29.               dtSearch writes user-specified options to OPTIONS.DAT each
  30.           time you change an option in dtSearch and at the end of the
  31.           program.  Therefore, if you want to edit OPTIONS.DAT, you should
  32.           make sure that you are not running dtSearch while you are editing
  33.           the file.  Otherwise, when you exit dtSearch the program will
  34.           write a new OPTIONS.DAT file and your edits will be lost.
  35.  
  36.                On a network, dtSearch looks for OPTIONS.DAT in the user's
  37.           private dtSearch directory and, if the file is not present, looks
  38.           for it in the shared dtSearch directory on the server.  Changes
  39.           are always written to the user's private dtSearch directory. 
  40.           (The private dtSearch directory is the directory on a network
  41.           where a user's individual setup files are stored.)
  42.  
  43.           Format of the OPTIONS.DAT File
  44.           ==============================
  45.  
  46.               OPTIONS.DAT begins with a line containing the words "dtSearch
  47.           Options".  It is followed by a series of lines having the format 
  48.  
  49.                       ParamName = value
  50.                       
  51.           There is no way to insert comments into an OPTIONS.DAT file.
  52.  
  53.               Filenames in an OPTIONS.DAT file can be full pathnames (such
  54.           as c:\dtsearch\x.dat) or they can be relative (such as ..\x.dat). 
  55.           If a relative path is supplied, dtSearch looks for the file first
  56.           in the user's private dtSearch directory and, if the file does
  57.           not exist there, dtSearch looks in the directory containing the
  58.           dtSearch executable program.
  59.  
  60.  
  61.  
  62.                                         - 2 -
  63.  
  64.                If you delete an item from OPTIONS.DAT, dtSearch will write
  65.           the default value for the item to OPTIONS.DAT the next time you
  66.           run it.  If you delete the OPTIONS.DAT file, dtSearch will create
  67.           a new default OPTIONS.DAT file the next time you run it.
  68.  
  69.           Content of the OPTIONS.DAT File
  70.           ===============================
  71.  
  72.           The following is an explanation of the items in OPTIONS.DAT:
  73.  
  74.           User = %USER%
  75.  
  76.                     Specifies the name of the user.  This value can be an   
  77.                     environment variable for ease of use on networks, and
  78.                     defaults to %USER%.
  79.  
  80.           IndexLibrary = ixlib.ilb
  81.  
  82.                     Name of the file containing the index library.
  83.  
  84.           NoiseList = DTSEARCH.NOI
  85.  
  86.                    Name of the file containing the noise word list.
  87.               
  88.           Alphabet = english.abc
  89.  
  90.                    Name of the file containing the alphabet definition.
  91.               
  92.           StemRules = stemming.dat
  93.  
  94.                     Name of the file containing the stemming rules to use
  95.                     in searches.  STEMMING.DAT contains documentation
  96.                     explaining how to customize the stemming rules.
  97.  
  98.           Request = apple and pear
  99.  
  100.                     Last search request.
  101.               
  102.           Inc = *.DOC
  103.  
  104.                     Last filename filter used in an unindexed search.
  105.  
  106.           Exc = *.EXE
  107.  
  108.                     Last filter used in an unindexed search to exclude
  109.                     files from the search.
  110.  
  111.  
  112.  
  113.                                         - 3 -
  114.  
  115.           SkipSummaries = No
  116.  
  117.                     If Yes, dtSearch will ignore WordPerfect document
  118.                     summaries when indexing and searching WordPerfect
  119.                     documents.  NOTE: If you change this value, you should
  120.                     reindex any WordPerfect documents you have previously
  121.                     indexed.
  122.               
  123.           AutoStem = Yes
  124.  
  125.                     If Yes, apply stemming rules in all searches. 
  126.                     (Stemming can also be applied selectively using the ~
  127.                     character.)
  128.               
  129.           Phonic = No
  130.  
  131.                     If Yes, make all searches phonic.  (Phonic searching
  132.                     can also be done selectively using the # character.)
  133.               
  134.           FuzzySearching = No
  135.  
  136.                     If Yes, make all searches fuzzy.  (Fuzzy searching can
  137.                     also be done selectively using the % character.)
  138.               
  139.           Fuzziness = 0
  140.  
  141.                     Level of fuzziness to apply in fuzzy searches (0-10).
  142.               
  143.           SearchSkipBinary = No
  144.  
  145.                     If Yes, skip binary files in unindexed searches, 
  146.  
  147.           AccSenSearch = No
  148.  
  149.                     If Yes, unindexed searches are "accent sensitive,"
  150.                     meaning that accents are considered significant in
  151.                     searching for words.
  152.  
  153.           CaseSenSearch = No
  154.  
  155.                     If Yes, unindexed searches are "case sensitive,"
  156.                     meaning that whether letters are upper or lower case is
  157.                     considered significant in searching for words.
  158.  
  159.           TabSize = 4
  160.  
  161.                     When displaying plain text files (not files created
  162.                     with a word processor), this is the number of spaces
  163.                     used to expand each tab character.
  164.               
  165.  
  166.  
  167.  
  168.                                         - 4 -
  169.  
  170.           LineLen = 78
  171.  
  172.                     Maximum number of characters to display on a line when
  173.                     viewing files.
  174.               
  175.           IndexSkipBinary = No
  176.  
  177.                    If Yes, skip binary files when building indexes.
  178.               
  179.           Quiet = Yes
  180.  
  181.                    If Yes, do not beep on error messages.
  182.               
  183.           EnterOK = No
  184.               
  185.                     If Yes, in dtSearch for DOS pressing the "ENTER" key in
  186.                     a dialog box will cause the OK button to be pressed.
  187.  
  188.           RelativePaths = Yes
  189.  
  190.                     If Yes, dtSearch will store relative, rather than
  191.                     absolute, path information in indexes and index
  192.                     libraries.  The distinction between relative and
  193.                     absolute paths is discussed in detail in the User's
  194.                     Manual.
  195.  
  196.           ShowHits = Yes
  197.           ShowName = Yes
  198.           ShowTitle = Yes
  199.           ShowDate = Yes
  200.           ShowTime = No
  201.           ShowDir = Yes
  202.               
  203.                     These values determine how search results appear in a
  204.                     search results window.
  205.  
  206.           SearchLimit = 1000
  207.  
  208.                    Maximum number of files to retrieve in a search.
  209.               
  210.           ContextWords = 30
  211.  
  212.                    Number of words of context for search reports.
  213.               
  214.           ResultsToKeep = 25
  215.  
  216.                    Number of previous searches to keep (minimum = 5).
  217.               
  218.           ReportsToKeep = 25
  219.  
  220.                    Number of previous search reports to keep (minimum = 5).
  221.  
  222.  
  223.  
  224.                                         - 5 -
  225.  
  226.           MacroChar = @
  227.           FuzzyChar = %
  228.           PhoneticChar = #
  229.           StemmingChar = ~
  230.  
  231.                     These options allow you to redefine the characters used
  232.                     to specify stemming, fuzzy, and phonic searches or to
  233.                     identify macros in search requets.  The ability to
  234.                     redefine these characters is useful for users who need
  235.                     to be able to make @, %, #, or ~ searchable.
  236.  
  237.           ColorInit = Yes
  238.           Colors1 = (...
  239.           Colors2 = (...
  240.           Colors3 = (...
  241.           Prt = (...
  242.           FontLen = 50
  243.           FontData = (...
  244.           Rsct = 17
  245.           KwicCt = 0
  246.           RptCt = 1
  247.           Srt = 16
  248.           SrtA = No
  249.           MT = 0
  250.           SPS = 1
  251.           StrCopy = 66c70ac2
  252.  
  253.                     These options should not be edited.
  254.