XREF writes a cross-reference for a text file. The cross-reference lists each non-keyword MAINSAIL identifier along with each page and line on which it occurs. Identifiers within STRING quotes and in comments, and characters after single quotes, are ignored. The case of identifiers is ignored; e.g., abc is the same as ABC and aBc.

XREF prompts for the keyword option to be used when scanning the input files (keywords are omitted from the cross-reference listing). Table 36–1 lists the available responses. Only enough of the option to make it uniquely identifiable need be typed.

Options include specifying MAINSAIL keywords, those in a user file, both MAINSAIL keywords and those in a user file, and no keywords. The keyword file is assumed to consist of keywords separated by any mixture of blanks, tabs, eols or eops. MAINSAIL keywords (reserved identifiers) are listed in Appendix G of the MAINSAIL Language Manual.

After the keyword option has been specified, XREF prompts for the start and stop columns, startCol and stopCol, for the page.line information for each identifier. The cross-referenced identifiers are output in alphabetic order, beginning in column 0. The page.line information is listed in ascending order beginning with column startCol and not exceeding column stopCol (startCol and stopCol are 0-origin). The default startCol is column 20; the default stopCol is 71.

When startCol and stopCol have been read, XREF prompts for input-output file pairs. To exit, type <eol> in response to the Next input file prompt.

Example 36–2 shows a sample use of XREF. User responses are underlined. A cross-reference listing for the file sample is written to the file sample-xrf. MAINSAIL keywords are not included in the list. XREF prints the number of identifiers in the file and the total number of occurrences.

Example 36–3 gives the XREF output for the file sample.

For information on cross-reference information available directly from the MAINSAIL compiler, see the descriptions of the utility XRFMRG in Chapter 6 of the MAINSAIL Compiler User's Guide and of the ITFXRF and FLDXRF compiler subcommands in Sections 4.18 and 4.10 of the MAINSAIL Compiler User's Guide.