home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / f.lbr / FF.HZP / FF.HLP
Encoding:
Text File  |  1991-11-18  |  10.3 KB  |  210 lines
  1. ;
  2.                                      FF.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                4k (31)   A609  2.4        Al Hawley 1/91           Z3COM3 
  6.  
  7.   1- Syntax  2- Configuration  3- Notes                                       
  8.  
  9.  
  10.    FF is  a File-Find utility derived  from FINDF version 2.6.   It finds  all
  11. files matching a list of file specs on all drives, a specific drive, or a list
  12. of drives.  All file specs are automatically made wild (that is, "A.B" becomes
  13. "A*.B*").  
  14.  
  15.    Version 2.4 adds several new  options,  and  makes all options configurable
  16. with ZCNFG.   Uses SYSLIB4C routines,  including  the sort routines to make FF
  17. noticeably faster.  Source code revised for brevity, clarity, and code optimi-
  18. zation.  Command  line  syntax  relaxed.  Still  compatible  with  Z3PLUS  and
  19. DosDisk. 
  20. :1
  21.  
  22.    Syntax   FF [D: or DIR:]afn[,afn]... [d...][/o...]
  23.  
  24.  
  25.   Options   (d) before slash:
  26.  
  27.             list of drivers to scan
  28.  
  29.  
  30.   Options   (o) after slash:
  31.  
  32.             E - Exact matches only (no auto wildcarding)
  33.  
  34.             P - No Paging of output
  35.  
  36.             S - Toggle inclusion of System files based on default
  37.                 configuration (see below).  System files are never
  38.                 included unless the Wheel byte is set.
  39.  Usage - 2/2 
  40.   
  41.    Error flag is set to 0ffh if no  matching files  are found,  or to 1 if the 
  42. program is aborted by the user.  The number of matching files found  is put in
  43. a register (By default, register 0 is used, but the register to be used can be
  44. configured.  See "Configuration").
  45.  
  46.    If a drive or drive list is not  included  on  the command line, the drives
  47. set in the drive vector are automatically scanned.  The first  drive,  DU:, or
  48. DIR: reference in the list of files to seek restricts the search to that drive
  49. only. Others, including the  optional  drive  list,  are  ignored.   The drive
  50. specification may be part of ANY of the file specifications and is NOT limited
  51. to being part of the first file listed as  implied by the  Syntax description.
  52.  
  53.    The '/' before the non-drive options may be preceded by spaces,  and may be
  54. replaced with  a  space.  Spaces  may  also  be  present  around the non-drive
  55. options.
  56.  
  57.    Output  can  be  paged a line at a time by hitting the space bar or  can be 
  58. aborted at a page break by hitting CTRL-C.
  59. :2
  60.  Configuration 
  61.  
  62.    FF24 is configurable with ZCNFG V1.7.   Defaults for the three command line
  63. non-drive options may be  configured.   The  command  line options then toggle
  64. these defaults for the duration of a single execution of FF.
  65.  
  66.    The list of drives (drive vector) is also configurable with ZCNFG,  a major
  67. improvement over the former patching method.
  68.  
  69.    Two new default drive search vectors may be  configured,  one  based on the
  70. currently logged drives and the second  based on drives represented by entries
  71. in the current NDR  (named directories).   The use of named directories may be
  72. subject to wheel byte status.   These  configuration  options  are  useful for
  73. ensuring system security in a  RAS  environment,  and  for  helping to prevent
  74. access to empty floppy drives.
  75.  
  76.    Help screens in the configuration file give more details of the options and 
  77. their configuration.
  78. :3
  79.  FF Notes - 1/7 
  80.  
  81.    a. Version 2.4x3 updates (1/19/91, Al Hawley):
  82.       - Added configuration option to restrict search to named directories for
  83.         non-wheels and within drive  map  constraints.  Passworded directories
  84.         are not searched.
  85.       - Modified pagination algorithm so that the 'more' message is not issued
  86.         when there is no more to display.   This happened in previous versions
  87.         when the display exactly filled the screen.
  88.       - Added option to remove display of "DISC --" title lines.
  89.       - Revised drive select option logic for  functional modularity & logical
  90.         conciseness.
  91.       - Revised memory allocation so that the FN table and the ORDER table are
  92.         dynamically sized to minimize memory usage.
  93.       - Replaced filename parsing code in  GETFN  with  a  call to ZFNAME from
  94.         Z3LIB.   Removed unneccessary code and  optimized  code in a number of
  95.         places.   Moved all code for console display  from other routines into
  96.         the PRFILES routine.   Simplified  memory  allocation  by using Z3LIBs
  97.         GZMTOP routine.
  98.  FF Notes - 2/7 
  99.  
  100.    b Version 2.4x2 updates (1/3/91, Joe Wright):
  101.       - Provided code for Type 1 or  Type 3  header.   Removed  code  to save/
  102.         restore current drive (not needed).  Use ANDHD and ORHD from SYSLIB in
  103.         a couple of places.  Help screen to show drives like AB_D_. instead of
  104.         ABD.
  105.  
  106.   c. Version 2.4x1 updates (12/30/90, Al Hawley; x1 means Beta version 1):
  107.       - FF24 has been made configurable with ZCNFG.  The current configuration
  108.         option settings are reflected in the  HELP screen.   Changed the drive
  109.         vector back to the structure used by BDOS and the ZCPR3x extended env.
  110.         The 'human' oriented structure is  no  longer  needed  now  that ZCNFG
  111.         makes it easy and natural to modify the drive vector.
  112.       - Most of the sorting code has been  removed and  replaced with calls to
  113.         the sort routines in SYSLIB4C.  These  new  syslib  routines  are MUCH
  114.         faster than the old ones.
  115.       - The source has been  extensively  edited,  with  a  view toward better
  116.         readability.  Archaic comments were  removed,  and some new ones added
  117.         where comprehension could be enhanced.
  118.  FF Notes - 3/7 
  119.  
  120.       - The command line syntax  has  been  relaxed a bit to allow white space
  121.         AFTER the drive list,  and  the  '/'  before  the  option field may be
  122.         replaced with white space. 
  123.       - Included Z3PLUS code  optimization  from  the  unreleased  version 2.3
  124.         which deletes unnecessary BIOS selects.
  125.  
  126.    d. Version 2.2 updates (1/12/90, Howard Goldstein):
  127.       - Exit logic modified so that nr of files found is placed in the 
  128.       register even when the program is aborted by the user.  The error flag
  129.       is set to 1 on user abort.
  130.       - Further code crunching to get program back down to 3k.  
  131.       - Logic fixed to allow one more line on first screen of paged output. 
  132.  
  133.    c. Version 2.1 updates (12/30/89, Gene Pizzetta):
  134.       - Adds configuration  byte to include or  exclude  SYStem  files  as the
  135.       default.   A non-zero  value  causes files  to be included, but the byte 
  136.       will be ignored  if the  wheel byte is  off).   "S" option  now  toggles 
  137.       current default.   Help screen modified to reflect default setting.  New
  138.       doc file includes revision history from source.
  139.  FF Notes - 4/7 
  140.  
  141.    d. Version 2.0 updates (11/26/89, Howard Goldstein):
  142.       - Fixes bug which caused  duplicate  listing  of  files  larger  than 32
  143.       32 extents.
  144.  
  145.    e. Version 1.9 updates (03/18/89, Carson Wilson):
  146.       - Release version.  Result of general code cleanup.
  147.  
  148.    f. Version 1.8 updates (03/09/89, Carson Wilson):
  149.       - Corrects check  against MAXDRV byte  in  the  environment  descriptor.  
  150.       Previous code  allowed one  drive  beyond  MAXDRV.   Extracts  new  MASK 
  151.       routine from INIT so that it  can  be called after any drive options are 
  152.       processed.   This enforces the  valid  drive vector from the environment 
  153.       descriptor regardless of the setting of the MAXDRV byte.
  154.   
  155.    g. Version 1.7 updates (03/04/89, Carson Wilson):  
  156.       - Fixes bug which caused 'FF /' command to list all files.  Only 'FF' or
  157.       'FF,<one or  more  spaces>//'  (exactly)  now  gives  help.   'FF /'  or 
  158.       'FF // ' are intrepreted as filespecs.
  159.  FF Notes - 5/7 
  160.  
  161.    h. Version 1.6 updates (03/02/89, Carson Wilson): 
  162.       - Changes page prompt to reflect multiple abort keys (says 'RETURN=page'
  163.       instead  of 'OTHER=page').   Help is  no  longer  generated  by a single 
  164.       slash as a parameter,  allowing files  beginning with '/' to be searched 
  165.       for.
  166.  
  167.    i. Version 1.5 updates (02/26/89, Carson Wilson):
  168.       - Adds REG# ASCII pointer to  the patch  byte controlling which register 
  169.       is used to store the  number  of matches found.   The  default  is zero.  
  170.       Register is changed  by substituting  a BINARY value from 1 to 9 at this 
  171.       storage location.
  172.  
  173.    j. Version 1.4 updates (02/23/89, Carson Wilson):
  174.       - Allows abort with  ^c, c, C, ^k, k, K, ^x, x, or X  between  pages  of 
  175.       paged output.  System valid drive vector is now logically ANDed with the 
  176.       table in the program.
  177.  FF Notes - 6/7 
  178.  
  179.    k. Version 1.41x updates (2/1/89, Howard Goldstein):
  180.       - Fixed use of  system  valid  drive  vector.  It is now logically ANDed
  181.         with the table in the program.
  182.  
  183.    l. Version 1.3 updates (07/04/88, Bridger Mitchell):
  184.       - Exits with BIOS, then BDOS drive-select.
  185.  
  186.    m. Version 1.2 updates (02/29/88, Bridger Mitchell):
  187.       - Adds extended environment valid-drive vector.
  188.  
  189.    n. Version 1.1 updates (11/14/87, Bridger Mitchell):
  190.       - Adds compatibility with CPM/3 and DosDisk.  
  191.       - Converts directory searches  to  BDOS  calls,  for  compatibility with 
  192.       DosDisk and other BDOS emulators.   
  193.       - Removes IX register use, for compatibility  with BIOS/DOS systems that 
  194.       mistakenly fail to preserve Z80 registers.  
  195.       - Adds check for presence of external environment.   
  196.       - Uses full TPA if CCP is protected.   Search  every  valid  BIOS  drive 
  197.       whose bit is  set  in  the  DRVTBL (previous  versions  aborted on first 
  198.       invalid drive).
  199.  FF Notes - 7/7 
  200.  
  201.    o. Version 1.0 (03/14/88,, Jay Sage):
  202.       - Adds DRVTBL configuration word at  beginning of code which contains  a
  203.       byte for each possible drive in a system.   As distributed, FF has FFFFh 
  204.       in this word so that all drives up to  the  max drive specified  in  the 
  205.       environment will be scanned.  
  206.       - Output can now be paged a line at  a time  by hitting the space bar or 
  207.       can be aborted at a page break by hitting ^C.
  208.       - Enhanced syntax allows specifying  a list  of drives to  be scanned in 
  209.       the option field.
  210.