home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / util / fdb-1.3.lha / FDB / FDB_english.doc < prev    next >
Encoding:
Text File  |  1994-04-02  |  10.4 KB  |  353 lines
  1. FDB - Documentation
  2. *******************
  3.  
  4. Copyright
  5. *********
  6.  
  7.    FDB (C) 1993-94 kMel, Klaus Melchior
  8.  
  9.    These programs are freely distributable, but copyrighted by me.  This
  10. means you may freely copy them as long as you do not charge more than a
  11. nominal fee for copying.  These programs may be put on PD disks,
  12. especially on Fred Fish's AmigaLibDisks and Fred's CDROMs.  If you want
  13. to distribute these programs you MUST keep this document with it.  The
  14. programs and documents must be distributed in their original unmodified
  15. form.
  16.  
  17.    These programs cannot be used for commercial purposes without written
  18. permission by the author.  The author can not be made responsible for
  19. any damage which is caused by using these programs.
  20.  
  21.    These programs are GiftWare.  If you like them and use them
  22. regularly, you should consider to send a small donation to the author
  23. in order to honor the work he has put into these programs.
  24.  
  25.    Send comments, suggestions or bug reports, and the gifts to:
  26.  
  27.      Klaus Melchior, Schulstrasse 17
  28.      D-52156 Monschau, Germany
  29.      Phone: +49 (0)2472 4710
  30.      
  31.      ADSP: kmel@eifel.adsp.sub.org
  32.      DE:   kmel@eifel.fido.de
  33.      FIDO: 2:242/7.2@fidonet
  34.      FIDO: 2:2452/107.2@fidonet
  35.  
  36. What is FDB ?
  37. *************
  38.  
  39.    FDB & UDB are based on find/updatedb-utilities from Larry Phillips
  40. and Martin Steppler.  If you already have installed them it is easy to
  41. use my tools, because they are compatible.  I use the same kind of
  42. database.
  43.  
  44.    - UDB generates a database in a directory "FindDB:", which you must
  45.      first assign to some place on your harddisk.  It scans all
  46.      directories and files specified in the file "FindDB:<db>.config".
  47.      This file must contain only one line; pathnames are separated by
  48.      spaces, e.g.:
  49.  
  50.           Filename                Contents
  51.           ------------------      -----------------------
  52.           FindDB:find.config  ->  Work: Sys:
  53.           FindDB:test.config  ->  RAM:
  54.           FindDB:<db>.config  ->  <path> <path> ...
  55.  
  56.      To avoid paths you can define a 'AP=AvoidPaths' pattern in this
  57.      line.  You only have to set a '~' (tilde) at the begin of the
  58.      pattern.  There should be only one in the line.
  59.  
  60.      If you would scan the "S:" and the "man:" directory, without all
  61.      "guide" drawers, generate following line:
  62.  
  63.           Filename                 Contents
  64.           -------------------      ----------------------
  65.           FindDB:test2.config  ->  S: ~(#?guide/) man:
  66.  
  67.      <db> is the name of the database.  So you can have several
  68.      databases in your "FindDB:", e.g.  one of the last Fish-CD, one of
  69.      all your Sources, ...  .  Default of <db> is "find", like Larry's
  70.      find.
  71.  
  72.      Furhermore, udb provides scanning of several paths without having
  73.      to create a <db>.config file.  You can simply specify the paths in
  74.      the command line, e.g.:
  75.  
  76.           udb db test RAM: SYS:
  77.  
  78.      This leads to the consecutive scanning of "RAM:" and "SYS:".  The
  79.      names of all files and dirs are stored in the database "test".
  80.  
  81.    - FDB finds quickly files/dirs by using these databases.
  82.  
  83.      If your are looking for a file on an already scanned CDROM, you
  84.      only have to specify the name of the database and the filename,
  85.      e.g.  you want to locate 'ToolManager' on the last
  86.      'FreshFish'-CDROM:
  87.  
  88.           fdb db fresh03 ToolManager
  89.  
  90.      If you don't know where to find 'ToolManager' in your databases,
  91.      select all databases while typing:
  92.  
  93.           fdb db #? ToolManager
  94.  
  95.    - LDB lists the files/dirs in the specified database.
  96.  
  97. CLI arguments
  98. *************
  99.  
  100. UDB
  101. ===
  102.  
  103. Paths/M
  104.      paths to scan; if no paths are specified, <db>.config is used
  105.  
  106. DB=DataBase/K
  107.      specify a database, default is "find"
  108.  
  109. AP=AvoidPaths/K
  110.      specify a pattern, which _expanded_ paths should not be scanned,
  111.      e.g.: use "#?guide/" to avoid the "3.x:s/guide/" path
  112.  
  113. FDB
  114. ===
  115.  
  116. P=Pattern/A
  117.      amiga-pattern, is used between two "#?", so a pattern like "foo" is
  118.      really "#?foo#?", seen at Larry's find.
  119.  
  120. DB=DataBase/K
  121.      specify a database, default is "find"; if here a pattern is used,
  122.      FDB look into "FindDB:" and if the pattern match, these databases
  123.      are scanned.
  124.  
  125. E=Exact/S
  126.      the pattern at 'P=Pattern/A' is used exactly the way you specified
  127.      it and is not expanded to "#?<pattern>#?".
  128.  
  129. CS=CaseSensitive/S
  130.      the pattern is handled casesensitive
  131.  
  132. D=Dirs/S
  133.      only show directories
  134.  
  135. F=Files/S
  136.      only show files
  137.  
  138. NH=NoHead/S
  139.      no headers are displayed, entries are not sorted
  140.  
  141. NP=NoPath/S
  142.      no absolute pathnames are displayed
  143.  
  144. PG=PAGES/S
  145.      the output is handled in pages, 'return' to continue, other key &
  146.      'return' to break
  147.  
  148. LDB
  149. ===
  150.  
  151. DB=DataBase/A
  152.      specify a database, default is "find"
  153.  
  154. What you need !
  155. ***************
  156.  
  157.    - Kickstart >= 2.0
  158.  
  159.    - Workbench >= 2.0
  160.  
  161. How to install
  162. **************
  163.  
  164.    You could create a drawer like "finddb" and set an assign "FindDB:"
  165. on it.  All tools of FDB are requiring this assign, so you have to
  166. create it.  Every of the <db>.config and <db>.codes files are stored
  167. there.
  168.  
  169.    You should create a line in your "user-startup" like this:
  170.  
  171.      "assign FindDB: Work:finddb/"
  172.  
  173.    Copy the "bin/" files to a place where you already have a path on,
  174. normally this is "C:" or "bin:".
  175.  
  176.      copy bin/#? C:
  177.  
  178. This is limited !
  179. *****************
  180.  
  181. UDB
  182. ===
  183.  
  184.    - commandline in "<db>.config" is limited to 1023 bytes, only one
  185.      line
  186.  
  187. FDB
  188. ===
  189.  
  190.    - found path & filename are limited to 1023 characters
  191.  
  192. LDB
  193. ===
  194.  
  195.    - path & filename are limited to 1023 characters
  196.  
  197. History of FDB
  198. **************
  199.  
  200.       1.0  12.12.93  * first public release
  201.      
  202.            31.12.93  + fdb: added 'P=PAGES' mode
  203.       1.1            * private release
  204.      
  205.            07.02.94  + fdb: rewrote find routine in assembler
  206.      
  207.            08.02.94  + fdb: mode 'E=EXACT': locating with "MatchPattern"
  208.                      - fdb: corrected bug, break wasn't recognized at
  209.                             startup (Andreas Harrenberg)
  210.                      - fdb: corrected template & doc, 'NH=NoHead'
  211.                             (Gottfried Janik)
  212.                      - fdb: corrected bug, break at mode 'P=PAGES' was
  213.                             recognized too late
  214.      
  215.            09.02.94  - doc corrected (Martin Steppler)
  216.                      - udb: corrected bug, break wasn't recognized at
  217.                             startup (Andreas Harrenberg)
  218.      
  219.       1.2  10.02.94  * release
  220.      
  221.            03.03.94  - fdb: corrected bug with ReadArgs()
  222.                      - udb: corrected bug with ReadArgs()
  223.      
  224.            08.03.94  + udb: rearranged source for better error handling
  225.                      + udb: added option 'AV=AvoidPaths', a pattern of paths
  226.                             not to scan (Thomas Kobler)
  227.                      > ldb: created
  228.      
  229.            19.03.94  + doc rewritten in texinfo
  230.                      + release contains now doc & guide file
  231.      
  232.            21.03.94  > german documentation
  233.                      + fdb: now 'DB=DataBase/K' can contain a pattern to
  234.                             select several databases (a spezi from bavaria)
  235.      
  236.            25.03.94  - german doc corrected (Andreas Harrenberg)
  237.                      - ldb: 'DB=DataBase/K' changed into 'DB=DataBase/A'
  238.                             (Andreas Harrenberg)
  239.                      + udb: 'AP=AvoidPaths' could also be set in the
  240.                             <db>.config (Andreas Harrenberg)
  241.      
  242.            27.03.94  - doc corrections (Martin Steppler)
  243.      
  244.       1.3  30.03.94  * release
  245.  
  246. What is to do in future ?
  247. *************************
  248.  
  249.    - ENV-variable "FINDDB" = default homepath of config/codes-files
  250.  
  251.    - UDB: softlinks
  252.  
  253.    - FDB: sorted lists
  254.  
  255.    - FDB: MUI-Application
  256.  
  257.    - LDB: 'P=PATH/M' - define paths, which should only be listed
  258.  
  259.    - check if 'DB=DataBase' option contains a path for databases
  260.  
  261.    - define a extended database format to store name, size, date
  262.  
  263.    - create program to convert AmiBack index files to databases
  264.  
  265.    - FDB:  only load parts of <db>.codes file in case of low memory
  266.      situations
  267.  
  268.    - installer script
  269.  
  270. Version of files
  271. ****************
  272.  
  273.      FDB 1.188    13112 Bytes
  274.      LDB 1.0       9044 Bytes
  275.      UDB 1.32     11444 Bytes
  276.  
  277. Example database
  278. ****************
  279.  
  280.    The database of the CDROM 'AMINET_0693' of June 1993 is included in
  281. this distribution.
  282.  
  283.      FindDB/Aminet.config          12 bytes
  284.      FindDB/Aminet.codes       154876 bytes
  285.  
  286.    For example, if you are looking for ToolManager on this CDROM, you
  287. only have to type in following line:
  288.  
  289.      fdb toolmanager db aminet
  290.  
  291.    And this is the answer FDB gives you:
  292.  
  293.      Directories
  294.      -----------
  295.      - No matches found -
  296.      
  297.      Files
  298.      -----
  299.      AMINET_0693:AMINET/OS20/WB/TOOLMANAGER2_0.LHA
  300.      AMINET_0693:AMINET/OS20/WB/TOOLMANAGER2_0.README
  301.  
  302. Thanks are going to ...
  303. ***********************
  304.  
  305.    - Martin Steppler, Andreas Harrenberg for testing & doc-corrections
  306.  
  307.    - Stefan Stuntz, Stefan Becker for his TM.texi
  308.  
  309.    - Gottfried Janik for testing
  310.  
  311.    - Joerg Gutzke, Thomas Kobler, Dirk Ludwig
  312.  
  313.    - OIC / M.Dillon for Dice
  314.  
  315.    - Ibi for special support
  316.  
  317.    - and all I forgot to mention ...
  318.  
  319. Index
  320. *****
  321.  
  322.  
  323.  
  324.  Arguments                              Arguments
  325.  assign                                 Installation
  326.  Authors address                        Copyright
  327.  Bug reports                            Copyright
  328.  CLI arguments                          Arguments
  329.  Comments                               Copyright
  330.  Copyright                              Copyright
  331.  Credits                                Credits
  332.  Description                            Description
  333.  Distribution                           Copyright
  334.  E-Mail                                 Copyright
  335.  Example database                       Examples
  336.  Examples                               Examples
  337.  FDB                                    Description
  338.  FDB arguments                          Arguments
  339.  FindBD:                                Installation
  340.  GiftWare                               Copyright
  341.  History                                History
  342.  Installation                           Installation
  343.  LDB                                    Description
  344.  LDB arguments                          Arguments
  345.  Limitations                            Limitations
  346.  Requirements                           Requirements
  347.  Thanks                                 Credits
  348.  ToDo                                   ToDo
  349.  UDB                                    Description
  350.  UDB arguments                          Arguments
  351.  Versions                               Versions
  352.  
  353.