tools/cxref/query/README

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