tools/cxref/query/README.man

   1 .TH cxref-query 1 "July 5, 1997"
   2 .SH NAME
   3 cxref-query - A program to query the cross reference database from cxref.
   4
   5 .SH SYNOPSIS
   6 .B  cxref-query
   7 .I  [name \ [ \ ... \ name]]
   8 .BI [\-O dirname ]
   9 .BI [\-N basename ]
  10 .B  [\-xref[\-all][\-file][\-func][\-var][\-type]]
  11
  12 .SH DESCRIPTION
  13 A very simple program to query the cross-reference database that is created by
  14 the cxref program. This is intended to be an example of the information that is
  15 in the database and how to use it rather than a fully featured tool.
  16
  17 .SH OPTIONS
  18
  19 .TP
  20 .BR name
  21 Names of objects to query.
  22 The names that it looks up are the names of:
  23 Files,
  24 Variables,
  25 Functions,
  26 Typedefs
  27
  28 If there are no names on the command line then the program
  29 enters interactive mode and prompts for names until an end of
  30 file (^D) is seen.
  31 .TP
  32 .BR \-Odirname
  33 Use dirname as the input directory
  34 .TP
  35 .BR \-Nbasename
  36 Use basename.* as the input filenames
  37 .TP
  38 .BR \-xref
  39 Produce cross referencing information (see below).
  40  -all    All cross references.
  41  -file   Cross references for files.
  42  -func   Cross references for functions.
  43  -var    Cross references for variables.
  44  -type   Cross references for types.
  45
  46 .LP
  47 The output depends on the -xref options but basically gives what is seen in the
  48 section of the document for the named object.
  49
  50 .SH SEE ALSO
  51
  52 cxref(1)
  53
  54 .SH BUGS
  55 If you wish to submit bug reports or other comments about the program then email
  56 the author amb@gedanken.demon.co.uk and put cxref in the subject line.
  57
  58 .SH AUTHOR
  59 The cxref-query program is copyright Andrew M. Bishop 1995,96,97.