home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Text / apps / SearchAndReplace.0.7.README < prev    next >
Encoding:
Text File  |  1994-09-18  |  3.3 KB  |  65 lines

  1. Search and Replace (Rev 0.7 -- 5/94)
  2. ---------------------------
  3.  
  4. Search and Replace is a simple (but powerful) utility which gives one the ability to search an entire directory for the occurances of a string, and replace those occurrences with another string.  Furthermore, this directory can be traversed recursively, giving you the ability to do a search and replace operation on an entire sub-tree.
  5.  
  6. Other features include:
  7.     -    The ability to include only those files with a specified extension
  8.          (file type).
  9.     -    The ability to exclude those files of a specified extension.
  10.     -    The ability to rename the files based on the search and replace criteria given.
  11.     -    The ability to make backup copies of the modified files
  12.     
  13. Use
  14. -----
  15. -    Enter the search string and the replace string in the fields provided
  16.         -     Neither string can contain the slash ('/') character
  17.         -    The search string is case sensitive
  18. -    Choose any combination of switches proveded
  19.         -    Search and Replace of File Names
  20.         -    Search and Replace of File Contents
  21.         -    Perform selected operations on the entire sub-tree
  22.         -    Make backup copies of the modified files
  23. -    Select the directory you would like to start the search from
  24.         -    Press the Search Directory button
  25.         -    Select the directory from the open panel
  26. -    If you have chosen to make backup copies, select the directory to copy to
  27.         -    Press the Copy Backups To button
  28.         -    Select the directory from the open panel
  29. -    If you want to include all files in your search
  30.         -    Select the exclude radio button
  31.         -    Leave extensions blank (This is saying that you want to exclude
  32.             nothing)
  33. -    If you want to include or exclude a group of file types
  34.         -    Select the appropriate include/exclude radio button
  35.         -    Enter the extensions that you would like to include/exclude
  36. -    Double check your settings
  37. -    Press the Execute Button
  38. -    The names of the modified files will be sent to standard output
  39.  
  40. Known Bugs:
  41. ------------------
  42. -     A slash (/) character cannot be contained within your search or replace strings.  If this is a character
  43.     you would like to search on then you can modify the code so that the searching is based on another
  44.     delimeter.  For example, to have the colon (:) character be used instead:
  45.             Replace            sed 's/%s/%s/g'
  46.             with                sed 's:%s:%s:g'
  47.     within SearchAndReplace.m.
  48.     
  49. Disclaimers:
  50. ----------------
  51. It should be immediately apparent that this can be a VERY destructive utility if care is not taken.  It is recommended that you backup any directory or sub-tree that you plan to operate on.
  52.  
  53. I haven't spent much time polishing or testing this utility, nor do I intend to.  I had only intended it for internal use within our company (NeuroDimension, Inc.), but then I figured that I might be able to save some people a little work by posting it.  If you find any bugs, send me email and I'll be glad to fix them.  If you think of enhancements that would be useful, add them in, put your name in the comments along with what you added, bump up the revision number, and re-submit it.  I realize the comments are non-existent, but the code is not very complex and there's not much of it there to figure out.
  54.  
  55. The contents of this submission are not warranted by NeuroDimension, Inc., Gary Lynn, or anyone else -- use at your own risk!!!
  56.  
  57.  
  58. Gary Lynn
  59.  
  60. Please send comments and bug reports to:
  61. gary@nd.com
  62.  
  63.  
  64. Archive Location: /pub/next/sources/util
  65.