home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / wp / bmacs.zip / READ_ME < prev    next >
Text File  |  1987-04-12  |  3KB  |  84 lines
  1. ;**************************************************************************;
  2. ;*                                                                        *;
  3. ;*      DONATED TO PUBLIC DOMAIN                                          *;
  4. ;*    Multifile Editing `tag' support                                   *;
  5. ;*      Version 1.0 - April 12, 1987                                      *;
  6. ;*      Richard O. Parker - CIS: 76556, 1132                              *;
  7. ;*                                                                        *;
  8. ;**************************************************************************;
  9. This archive contains three files:
  10.  
  11.     1) tags.exe    Creates a `tags' file consisting of
  12.  
  13.                 a) function or macro names
  14.                 b) filenames
  15.                 c) search-patterns
  16.                 
  17.             for editing multiple `.m' or `.c' files in
  18.             a single directory using BRIEF.
  19.             
  20.     2) tag.m    A BRIEF macro which implements searching
  21.             the `tags' file for a function-name (or 
  22.             macro-name), editing the corresponding
  23.             file and positioning the cursor at the
  24.             beginning of the named function.
  25.             
  26.     3) tag.cm    Compiled version of `tag.m'.
  27.             
  28. The `tags' and `tag' facility are nearly identical to the corresponding
  29. capability under Unix, using the `vi' editor---and I implemented this to
  30. add to the `vi' macros for that purpose.
  31.  
  32. The `tags' program takes the following command-line:
  33.  
  34.     tags [-t] [-f <tag file>] filename.[mc] ...
  35.     
  36. The `-t' flag allows for generation of tags for `typedef' statements in `C',
  37. while the `-f <tag file>' option allows you to generate a `tags' file with
  38. a different name than `tags'---although, `tag.m' doesn't recognize anything
  39. except `tags'.
  40.  
  41. To use the facility, at the DOS prompt, enter the command to generate your
  42. `tags' file.  For example, if you are editing a bunch of `C' programs, enter
  43.  
  44.     tags *.c
  45.     
  46. and a `tags' file will be built to address all of the `C' functions in all
  47. of the modules.  Since `main()' functions may occur in more than one module,
  48. the tag generated for these is composed of the letter `M', followed by the
  49. name of the module.  For example, if you have a module called `test.c', the
  50. `main()' function will be tagged as `Mtest'.  All other functions are tagged
  51. with their actual names.
  52.  
  53. Then, edit one of your files and invoke the `tag' macro, which will prompt
  54. for a ``tag-name'' as follows:
  55.  
  56.     tag:  
  57.  
  58. At the prompt, enter the name of one of your functions, e.g.:
  59.  
  60.     tag: generate_code
  61.     
  62. The `tag' macro will search the `tags' file for this function-name and
  63. automatically edit the corresponding file, positioning the cursor at the
  64. beginning of the function.  If the function-name isn't present in the `tags'
  65. file you will be notified of that fact.
  66.  
  67. You may choose to integrate this function with your favorite keyboard
  68. emulation and have an automatic way of jumping from function to function
  69. in your program-files.  To test this macro, I assigned it to the ALT-T
  70. key and you may decide to integrate the macro in a similar fashion.
  71.  
  72. If you have any suggestions for improvement of performance or correction of
  73. errors, please let me know.  This is my first ``commercial'' BRIEF macro
  74. and I probably have a lot to learn.  If you notice an error in generation
  75. of tags with `tags.exe', also let me know and I'll correct it.
  76.  
  77.                 Enjoy!
  78.                 
  79.                 Rich Parker
  80.                 CIS 76556,1132
  81.  
  82.             
  83.             
  84.