McXtrace - An X-ray ray-trace simulation package

1.6  Documentation

As a complement to this Component Manual, we encourage users to use the mxdoc front-end which enables to display both the catalog of the McXtrace library, e.g using:

mxdoc

as well as the documentation of specific components, e.g with:

mxdoc --text name
mxdoc file.comp

The first line will search for all components matching the name, and display their help section as text. For instance, mxdoc .laz will list all available Lazy data files, whereas mxdoc --text Monitor will list most Monitors. The second example will display the help corresponding to the file.comp component, using your BROWSER setting, or as text if unset. The --help option will display the command help, as usual.

An overview of the component library is also given at the McXtrace home page [Mcx] and in the User Manual [Knu+14].