home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR36 / KEXX.ZIP / CTAGS.DOC < prev    next >
Text File  |  1992-12-30  |  3KB  |  64 lines
  1.                         CTAGS.KEX Documentation
  2.                         Version 1.0 (June 1988)
  3.  
  4. The CTAGS macro makes it possible to position the cursor on a macro or
  5. function call in a C program, press the appropriate key, and
  6. automatically find the definition of the function, even if it is in a
  7. different source file.
  8.  
  9. To use CTAGS.KEX, add the command "DEFINE ALT-F8 'MACRO CTAGS'" to
  10. your KEDIT profile. Be sure to rerun your profile before trying to use
  11. the Alt-F8 key. Then, position the cursor on a macro or function call
  12. and press the Alt-F8 key. Alternately, you can enter "MACRO CTAGS
  13. function-name" from the KEDIT command line.
  14.  
  15. CTAGS uses a data file to find macros and functions.  Use CTAGS.EXE
  16. (written by Paul Verket, and included with his permission) to create
  17. this data file.  For example, to build the data file for all C files in
  18. the current directory, issue this command from the DOS or OS/2 prompt:
  19.  
  20.     CTAGS *.C > CTAGS.DAT
  21.  
  22. The default name for the data file is CTAGS.DAT.  The file must be in the
  23. KEDIT "SET PATH" path.  This default can be changed by setting the
  24. global EDITV variable CTAGS_DAT.  For example,
  25.  
  26.     EDITV SET CTAGS_DAT KCTAGS.DAT
  27.  
  28. One way to keep your CTAGS.DAT files up to date during program
  29. development is to issue the CTAGS command for each file after each
  30. compile, and to combine these CTAGS output files at the end of your MAKE
  31. file.  For example, here is a partial MAKE file:
  32.  
  33.    # Inference rule to compile and run CTAGS.EXE when c program changes
  34.    .c.obj:
  35.        cl $@
  36.        ctags $*.c > $*.tag
  37.  
  38.    # Compile and build CTAGS.EXE output for each source file
  39.    xyz.obj: xyz.c
  40.  
  41.    etc.obj: etc.c
  42.  
  43.    # At end of MAKE file combine CTAGS.EXE output for all files in system
  44.    always:
  45.          copy *.tag ctags.dat > nul
  46.  
  47.  
  48. Disclaimer for all BBS (and other distributed) utilities/programs/macros:
  49.  
  50. The programs and macros distributed on this diskette are available
  51. strictly as aids and examples for users of Mansfield Software Group
  52. products.
  53.  
  54. Mansfield Software does not guarantee, or commit to support or maintain
  55. the programs or macros distributed on this diskette.  Also note that the
  56. programs and macros provided are not guaranteed to work with past,
  57. present, or future versions of Mansfield Software products.
  58.  
  59. Nonetheless, comments and suggestions are welcome.  Please post any
  60. comments, suggestions, or bug reports in:
  61.  
  62.   -- section 2 of the PCVENA forum on CompuServe, or
  63.   -- the Mansfield Software Group Bulletin Board, at (203) 429-3784.
  64.