Prev Next stdout

Standard Output Information

Purpose
Version Identification
Input File
Cross Reference Tags
Error Messages
Warning Message
Redirect
Include
Example

Purpose
OMhelp prints a trace of its activity on standard output to show that processing is proceeding and to help in debugging.

Version Identification
The first output line contains the date corresponding to the version of OMhelp that is being run.

Input File
A line of trace information is printed for each input file. The line begins with the name of the file that is being processed. The file being processed appeared in a contents, childtable, or children command of one of the previous files (see Specifying Children in Contents Tree). The level of indentation for each file is one space greater than the level of indentation for the file that contained the command causing it to be processed.

Cross Reference Tags
The cross reference tag for each of the sections that are defined in the file are printed following the file name and on the same line.

Error Messages
OMhelp error messages begin on a separate line with the text OMhelp Error:. These errors cause OMhelp to terminate with a non-zero exit status .

Warning Message
OMhelp warning messages begin on a separate line with the text OMhelp Warning:.

Redirect
It is often useful to redirect standard output to a file so that you can review the input tree, warnings, and the error messages.

Include
The include command does not cause the name of the corresponding file to be printed on standard output.

Example
The file omhelp.xam.log contains the output corresponding to one of the get_started examples and is included below: 
OMhelp: Version=20200131, ndebug=false, win32=false

index_example.omh: index_example:
 index_children.omh: index_child_1: index_child_2:
Begin Second Pass

Input File: omh/stdout.omh