home *** CD-ROM | disk | FTP | other *** search
/ Oakland CPM Archive / oakcpm.iso / cpm / pascal-p / xrefc26.lbr / XREFC.DZC / XREFC.DOC
Encoding:
Text File  |  1987-01-15  |  2.6 KB  |  56 lines
  1. XREFC is copyright (c) 1980, 1986 by C.B. Falconer.  It may be freely dis-
  2. tributed and used, but may not be sold, nor included in other packages for
  3. sale, without the express written permission of C.B. Falconer.
  4.  
  5.  
  6. XREFC is a utility program to cross-referance C programs.   As an option it
  7. can list the source file on input.   All reserved words are ignored, as are
  8. identifiers within comments or  strings.   The  standard  indentation  code
  9. (dle, space+N) is expanded if present.
  10.  
  11. To execute, enter:
  12.  
  13.      B>xrefc (inputfile, listfile)
  14.  
  15. which will use the default settings, i.e. list a source file which does not
  16. contain  line-numbers  (defined  as "the first 8 characters on  a line  are
  17. numeric"), and not list a line-numbered source file.
  18.  
  19. "PARM" values,  in the command below, of 2 or 4 unconditionally suppress or
  20. force source file listing respectively.  Commas, parentheses  and  brackets
  21. are all significant, and should be used as shown.
  22.  
  23.      B>xref (inputfile, listfile) [PARM]
  24.  
  25. Note that an initial field of 8 numeric characters is always considered  to
  26. be a line-number,  and that the 1st five of these are then used as the line
  27. identification no. in the cross-referance.
  28.  
  29. Additional "PARM" options are:
  30.  
  31.    10  Restrict the initial characters of identifiers cross-referanced.
  32.        This allows a cross-referance of a large program to be broken up
  33.        into two or more portions.  XREFC will ask for the range, etc.
  34.    20  Include all numeric values.  Very useful in uncovering anonymous
  35.        constants that really should be named constants.
  36.    40  Include all C reserved words (otherwise ignored)
  37.   100  Follow include files specified by "#include filename" construct.
  38.        '#include "filename"' and "#include <filename>" are also followed.
  39.  
  40. For multiple options use the sum.
  41.  
  42. XREFC uses lexical, NOT Ascii, character order. i.e. the collation sequence
  43. is 0...9, AaBb...Zz and "_".   This allows  the output table to be examined
  44. for inadverdant misentry of characters in names.   These are the ONLY char-
  45. cters allowed in identifiers, and the first character  must not be a digit.
  46.  
  47. Input files (also included files) are searched on the default, and then the
  48. A: drive if no drive is  specified.  "listfile" may  be  CON, LST,  or  PUN
  49. for output to those devices, or any disk file.  No final colon is required.
  50. If CON is the input file then input can be  entered interactively,  e.g.  a
  51. "#include fn.ft" include command.
  52.  
  53. To use the .PCD version, replace "xrefc" by "runpcd xrefc".
  54.  
  55. C.B. Falconer, 680 Hartford Tpk., Hamden, Conn. 06517.   (203) 281-1438
  56. e