home *** CD-ROM | disk | FTP | other *** search
/ Boston 2 / boston-2.iso / DOS / PROGRAM / C / GETF / BLDFUNCS.DOC < prev    next >
Text File  |  1993-12-01  |  2KB  |  59 lines
  1. NAME:    bldfuncs - construct a table of C source file names together with
  2.         a list of the names of all functions defined in these source files.
  3.  
  4. USAGE:    bldfuncs sour_file_1  source_file_2 ...
  5.         (wildcard characters are allowed)
  6.  
  7. DESCRIPTION:
  8.     bldfuncs is used to construct the list file needed by getf. 
  9.     The out file is names "funcs.txt", and has the format:
  10.  
  11.                 source_file_1.c:
  12.                     function_1      lineno_1
  13.                     function_2      lineno_2
  14.                     ...
  15.                     function_n      lineno_n;
  16.  
  17.                 source_file_2.c:
  18.                     ...
  19.  
  20.     Of course, this file could be constructed or modified using a
  21.     text editor, but bldfuncs is designed to automate this process. 
  22.     Bldfuncs is run a relatively infrequent intervals to update the
  23.     list file, whereas getf is run frequently to locate functions.
  24.  
  25. OPTIONS:
  26.     -a    the new data is appended to the output file, rather
  27.         than replacing it.
  28.  
  29. EXAMPLES:
  30.  
  31.         bldfuncs prog1.c prog2.c prog3.c
  32.                 This will construct a funcs.txt file in
  33.                 the current directory which will
  34.                 contain a list of the specified files
  35.                 in the current directory together with
  36.                 a list of the functions defined in
  37.                 those files.
  38.  
  39.         bldfuncs *.c
  40.                 This will construct a funcs.txt file
  41.                 for the all the C source files in the
  42.                 current directory.
  43.  
  44.         bldfuncs *.c \source1\*.c d:\*.c
  45.                 This will construct a funcs.txt file in
  46.                 the current directory which will
  47.                 contain the above information for the
  48.                 current directory, \source1, and d:\
  49.                 combined.
  50.  
  51.  
  52. AUTHOR:
  53.     Marvin Hymowech, "Find That Function", Dr.  Dobb's Journal of
  54.     Software Tools, #142 (August 1988).
  55.  
  56.     transcribed and modestly enhanced by James R. Van Zandt,
  57.     jrv@mitre-bedford.arpa.
  58.     
  59.