Next: , Up: The Cross-Referencing Tools gnatxref and gnatfind

12.1 gnatxref Switches

The command lines for gnatxref is:

     $ gnatxref [switches] sourcefile1 [sourcefile2 ...]


sourcefile1, sourcefile2
identifies the source files for which a report is to be generated. The 'with'ed units will be processed too. You must provide at least one file.

These file names are considered to be regular expressions, so for instance specifying 'source*.adb' is the same as giving every file in the current directory whose name starts with 'source' and whose extension is 'adb'.

The switches can be :

If this switch is present, gnatfind and gnatxref will parse the read-only files found in the library search path. Otherwise, these files will be ignored. This option can be used to protect Gnat sources or your own libraries from being parsed, thus making gnatfind and gnatxref much faster, and their output much smaller.
When looking for source files also look in directory DIR. The order in which source file search is undertaken is the same as for gnatmake.
When searching for library and object files, look in directory DIR. The order in which library files are searched is the same as for gnatmake.
Do not look for sources in the system default directory.
Do not look for library files in the system default directory.
Specifies the default location of the runtime library. Same meaning as the equivalent gnatmake flag (see Switches for gnatmake).
If this switch is set gnatxref will output the parent type reference for each matching derived types.
If this switch is set, the output file names will be preceded by their directory (if the file was found in the search path). If this switch is not set, the directory will not be printed.
If this switch is set, information is output only for library-level entities, ignoring local entities. The use of this switch may accelerate gnatfind and gnatxref.
Equivalent to `-aODIR -aIDIR'.
Specify a project file to use See Project Files. By default, gnatxref and gnatfind will try to locate a project file in the current directory.

If a project file is either specified or found by the tools, then the content of the source directory and object directory lines are added as if they had been specified respectively by `-aI' and `-aO'.

Output only unused symbols. This may be really useful if you give your main compilation unit on the command line, as gnatxref will then display every unused entity and 'with'ed package.
Instead of producing the default output, gnatxref will generate a tags file that can be used by vi. For examples how to use this feature, see See Examples of gnatxref Usage. The tags file is output to the standard output, thus you will have to redirect it to a file.

All these switches may be in any order on the command line, and may even appear after the file names. They need not be separated by spaces, thus you can say `gnatxref -ag' instead of `gnatxref -a -g'.