mxDOC(1)

📦
version 3.5+3.5.19 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute

💖 mxDOC(1) 💖

okay bestie, pull up a chair, because this is the manual for mxdoc — the lil' front-end that makes docs for mcxtrace and then shows them to you. yes it's in section 1, yes it's giving main character energy, let's go 🦋

✨ NAME ✨

mxdoc — creating and viewing the mcxtrace library, component/instrument help and Manuals. it literally does both: makes the pages, and opens the pages. multitasking queen 👑

🌸 SYNOPSIS 🌸

mxdoc [-h] [–install] [–dir DIR] [–manual] [–comps] [–web] [–verbose]
[searchterm]

🎀 DESCRIPTION 🎀

so here's the vibe: the mxdoc front-end generates html docpages from mcxtrace instrument and component files. that's the whole plot. 💅

a docpage gets generated for every single instrument and component file, no skipping, no crumbs left behind. then an overview page is written and browsed. and just type mxplot.

that's it. that's the description. short, sweet, iconic. ✨

💅 OPTIONS 💅

  • searchterm — your search filter, or a .instr / .comp file. either you're looking for something or you're pointing at a specific file, bestie, you decide 🫶
  • -h, –help — show this help message and exit. the classic escape hatch 🚪
  • –install, -i — generate the installation master doc page. the big boss page 👑
  • –dir DIR, -d DIR — add search results from this directory. point it at a DIR and it'll go looking there too 🔍
  • –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. so you can watch it cook in real time 👀

🗂️ FILES 🗂️

  • /usr/share/mcxtrace/resources
  • /usr/share/mcxtrace/tools/Python/mccodelib/mccode_config.json
  • ~/.mcxtrace/mccode_config.json
  • http://www.mcxtrace.org

those are the places it lives and the place it links, no cap ✨

🌈 EXAMPLES 🌈

show documentation:

  • mxdoc

that's it. one word. one command. ate and left no crumbs 🍓

👑 AUTHORS 👑

mcxtrace Team (mcxtrace.org) 💖

🔥 SEE ALSO 🔥

mcxtrace(1), mxdoc(1), mxplot(1), mxrun(1), mxgui(1), mxdisplay(1)

go read those too, they're all part of the friend group 🫶

💜 AUTHORS (yes, again 💜)

MCXTRACE xray Ray Tracing Team.

and that's the whole page, bestie!! this manual is straight out of the mcxtrace git (version git, dated mxDOC(1) style, you know how it is) — mwah, go generate some docpages, ily 💅✨🎀

📦 where this page comes from