home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / f / filematch / !FileMatch / !Help next >
Text File  |  1997-02-10  |  11KB  |  255 lines
  1.   Title: FileMatch
  2. Purpose: Intelligent File Finding
  3.  Author: © Sanjay Pattni 1989-1996
  4. Version: 1.01 (20-03-96)
  5.  
  6. ********************************************************************************
  7. *                                                                              *
  8. *                                    Licence                                   *
  9. *                                    ~~~~~~~                                   *
  10. *     A personal licence is granted as follows:                                *
  11. *                                                                              *
  12. *     Definitions                                                              *
  13. *     ===========                                                              *
  14. *     Software: Software means all parts of FileMatch and it's resource        *
  15. *               files                                                          *
  16. *                                                                              *
  17. *     Conditions                                                               *
  18. *     ==========                                                               *
  19. *                                                                              *
  20. *     This software is Copyright Sanjay Pattni 1989 - 1996.                    *
  21. *     All rights reserved.                                                     *
  22. *                                                                              *
  23. *     (1) You may not incorporate any part of the software into any            *
  24. *         other programs.                                                      *
  25. *                                                                              *
  26. *     (2) You may not disassemble, reverse engineer, decompile or make         *
  27. *         any attempt to discover the source code of the software.             *
  28. *                                                                              *
  29. *     (3) You may freely distribute this software if:                          *
  30. *         (a) you do not make any profit from doing this.                      *
  31. *         (b) you are a software library and you do not make a profit          *
  32. *             of more than 25% of the price that you charge.                   *
  33. *                                                                              *
  34. *         In all other circumstances you may distribute this software          *
  35. *         if, and only if, you have Sanjay Pattni's explicit permission        *
  36. *         to distribute this software.                                         *
  37. *                                                                              *
  38. *     (4) All copies and installations of this software contain this           *
  39. *         file (unedited).                                                     *
  40. *                                                                              *
  41. *     (5) Ownership of this software remains with Sanjay Pattni at all         *
  42. *         times.                                                               *
  43. *                                                                              *
  44. *     (6) This software is provided with no explicit nor implicit              *
  45. *         warranty. Sanjay Pattni does not recommend its fitness for           *
  46. *         for any purpose.                                                     *
  47. *                                                                              *
  48. *     If you do not accept these licence conditions, you must delete all       *
  49. *     your copies of this software.                                            *
  50. *                                                                              *
  51. ********************************************************************************
  52.  
  53.  
  54.   Abstract:
  55.   =========
  56.     FileMatch is an intelligent file finding utility. It will search a
  57.     directory and try to match file characteristics according to a very
  58.     extensive user specified template. The utility can be used directly
  59.     from the command line or via a WIMP front end.
  60.  
  61.  
  62.   Requirements:
  63.   =============
  64.     1MByte or more memory.
  65.  
  66.     Risc OS 3 or above.
  67.  
  68.     Risc OS prior to 3.6 requires various Toolbox modules to be soft-loaded:
  69.  
  70.         Toolbox     1.36
  71.         Window      1.31
  72.         Menu        0.24
  73.         Iconbar     1.12
  74.         ProgInfo    0.09
  75.  
  76.     Note 1: They are only required by the WIMP based front end, ie. for pure
  77.             command line usage, they are not needed.
  78.     Note 2: They are not supplied with this distribution.
  79.  
  80.  
  81.  
  82.   Front end:
  83.   ==========
  84.     Run !FileMatch for a RISC OS compliant frontend to FileMatch.
  85.     Use Interactive Help for instructions.
  86.  
  87.  
  88.   Command Line Syntax:
  89.   ====================
  90.         FileMatch [flag options]^
  91.  
  92.  
  93.   Flag Options:
  94.   =============
  95.     (Default is shown in brackets after description)
  96.  
  97.     -a <Access string>
  98.         <Access string> is a string specifying what access attributes
  99.         should be matched. The format is something like:
  100.             "PlwR/wR"
  101.         The characters to the left of the "/" are owner access attributes.
  102.         The characters to the right of the "/" are public access attributes.
  103.         An upper-case letter specifies that the attribute is ON. A lower-case
  104.         letter specifies that the attribute is OFF. If the attribute is not
  105.         present, it's state will not be matched.
  106.             "P" = Privatised - used on SJ Research MDFS networks
  107.             "L" = Locked
  108.             "W" = Write Access
  109.             "R" = Read Access
  110.  
  111.     -cs
  112.         Make the wild card search name case sensitive. (default=OFF)
  113.  
  114.     -d < <min time[ <max time>]> | <relative time string> >
  115.         Match date stamp or date stamp range or relative time range.
  116.         Format of <min/max time> is five bytes of hex, eg. "1a2b3c4d5e"
  117.         where the most significant byte is given first.
  118.  
  119.         A relative time string is used to specify a time range relative to
  120.         the current time, eg. "thisday".
  121.  
  122.         There are 5 suffixes, ie. time units:
  123.             "hour"
  124.             "day"
  125.             "week"      My weeks start on a Monday!
  126.             "month"
  127.             "year"
  128.  
  129.         There are 3 prefixes:
  130.             "this" = the current time unit
  131.             "last" = the previous time unit
  132.             "past" = current time - one time unit
  133.         eg. the current time is 17:47
  134.             "thishour" = 17:00:00.00 -> 17:59:59.59
  135.             "lasthour" = 16:00:00.00 -> 16:59:59.59
  136.             "pasthour" = 16:47:00.00 -> 17:46:59.59
  137.  
  138.     -e <min address>[ <max address>]
  139.         Match execution address. See note [1], [2].
  140.  
  141.     -l <min address>[ <max address>]
  142.         Match load address. See note [1], [2].
  143.  
  144.     -m <file>
  145.         <file> specifies a file which is to used as a template. Note that
  146.         this will override any preceding match parameters.
  147.  
  148.     -n <wildcarded name>
  149.         <wildcarded name> specifies a wildcarded name to match (default="*")
  150.         "#" = matches any single character
  151.         "*" = matches 0 or more characters
  152.  
  153.     -o <value>
  154.         Output: (Default = Output nothing)
  155.         Bit 1 = Filename
  156.         Bit 2 = File information
  157.  
  158.     -ot <object types>
  159.         <object types> is integer specifying objects to match (default=1)
  160.         Bit 0 = Files
  161.         Bit 1 = Directories
  162.         Bit 2 = Image Files
  163.  
  164.     -p <path>
  165.         <path> specifies directory to start search from. (default=CSD)
  166.  
  167.     -r
  168.         Recursively search directories (Default = OFF)
  169.  
  170.     -ri
  171.         Recursively search image files (Default = OFF)
  172.  
  173.     -s <min size>[ <max size>]
  174.         Match files of given size or size range. See note [1], [2].
  175.  
  176.     -t <filetype string>
  177.         <filetype string> is filetype to match
  178.  
  179.     -v
  180.         Verbose (Default = OFF)
  181.  
  182.     -x "<command>"
  183.         Command to eXecute on matched files - very useful and also very
  184.         dangerous if abused.
  185.  
  186.         Command Macros:
  187.           "\p" = Path of file,
  188.           "\n" = Name of file,
  189.           "\\" = single "\"
  190.  
  191.  
  192.   Examples:
  193.   =========
  194.   * List all files with date stamp of sometime today from CSD and below:
  195.  
  196.       FileMatch -o 1 -d thisday -r -ri