McXtrace - An X-ray ray-trace simulation package

8  The component library: Abstract

This chapter presents an abstract of the McXtrace component library’s structure and categories. It intentionally does not attempt to enumerate every component with its parameter list – the library is large and changes between releases, so any hand-maintained table here would inevitably drift out of date (as earlier editions of this manual did). Instead, each component category chapter that follows (Sources, Optics, Samples, Monitors, …) documents a curated selection of representative components in depth, with their full, current parameter lists pulled directly from the component source’s McDoc header at build time (see section 6.7 for the McDoc comment format). For the complete, authoritative, always-current list of every component and its parameters, use the mxdoc front-end:

1mxdoc 
2mxdoc searchterm 
3mxdoc file.comp

The first form generates and opens a browsable index.html catalog of the whole library (both the standard installation and any local/custom components); the second searches for and displays documentation for all components matching searchterm; the third displays the documentation of one specific component file. See section 5.4.7 in the User Manual for the full mxdoc reference.