home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 3: Developer Tools / Linux Cubed Series 3 - Developer Tools.iso / devel / lang / c / cxref-1.001 / cxref-1~ / cxref / query / README < prev   
Encoding:
Text File  |  1996-02-13  |  1.7 KB  |  48 lines
  1.              C Cross Referencing & Documenting tool. Version 1.0
  2.              ===================================================
  3.  
  4. cxref-query - A very simple program to query the cross-reference
  5. database that is created by the cxref program.
  6.  
  7. Usage: cxref-query [name [ ... name]]
  8.                    [-Odirname]
  9.                    [-Nbasename]
  10.                    [-xref[-all][-file][-func][-var][-type]]
  11.  
  12. name            Names of objects to query.
  13.                 The names that it looks up are the names of:
  14.                         Files
  15.                         Variables
  16.                         Functions
  17.                         Typedefs
  18.  
  19.                 If there are no names on the command line then the
  20.                 program enters an interactive mode and prompts for
  21.                 names until an end of file (^D) is seen.
  22.  
  23. -Odirname       Use dirname as the input directory
  24.  
  25. -Nbasename      Use basename.* as the input filenames
  26.  
  27. -xref           Produce cross referencing information (see below).
  28.                 -all    All cross references.
  29.                 -file   Cross references for files.
  30.                 -func   Cross references for functions.
  31.                 -var    Cross references for variables.
  32.                 -type   Cross references for types.
  33.  
  34. The output depends on the -xref options but basically gives what is
  35. seen in the section of the document for the named object.
  36.  
  37. AUTHOR and Copyright
  38. --------------------
  39.  
  40. The cxref-query program was written by Andrew M. Bishop in 1995,96.
  41.  
  42. The cxref-query program is copyright Andrew M. Bishop 1995,96.
  43.  
  44. email: amb@gedanken.demon.co.uk [Please put cxref in the subject line]
  45.  
  46. The cxref-query program can be freely distributed according to the
  47. terms of the GNU General Public License (see the file `COPYING').
  48.