mxdoc - Creating and viewing the mcxtrace library, component/instrument help and Manuals
Contents
Description
The mxdoc front-end generates html docpages from mcxtrace instrument and component files. A docpage is
generated for every instrument and component file, and an overview page is written and browsed. Just
type mxplot.
Examples
Show documentation
• mxdoc
Files
/usr/share/mcxtrace/resources /usr/share/mcxtrace/tools/Python/mccodelib/mccode_config.json
~/.mcxtrace/mccode_config.jsonhttp://www.mcxtrace.orgName
mxdoc - Creating and viewing the mcxtrace library, component/instrument help and Manuals
Options
searchterm
search filter or .instr/.comp file
-h,–help
show this help message and exit
–install,-i
generate installation master doc page
–dirDIR,-dDIR
add search results from this directory
–manual,-m
open the system manual
–comps,-c
open the component manual
–web,-w
open the mcxtrace website
–verbose,-v
prints a parsing log during execution
See Also
mcxtrace(1), mxdoc(1), mxplot(1), mxrun(1), mxgui(1), mxdisplay(1)
Synopsis
mxdoc [-h] [–install] [–dir DIR] [–manual] [–comps] [–web] [–verbose] [searchterm]
