mcDOC(1)

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

💖 mcDOC(1) 💖

okay bestie, welcome to the mcDOC(1) manual — yes, that's the manual for the thing that makes manuals. it's giving inception. we're doing it. 🌀✨

✨ NAME ✨

mcdoc — creating and viewing the mcstas library, component/instrument help and Manuals. that's the whole vibe. 🎀

🌸 SYNOPSIS 🌸

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

look at her. she's got options. she's got a searchterm. she's booked and busy. 💅

🦋 DESCRIPTION 🦋

so here's the tea: the mcdoc front-end generates html docpages from mcstas instrument and component files. 💖

a docpage is generated for every instrument and component file, and an overview page is written and browsed. like, the whole library gets its own little scrapbook. so organized. so iconique. 👑

and then — and I cannot stress this enough, this is genuinely what the page says — "Just type mcplot." 😭 that's it. that's the sentence. not me being confused, that's literally the manual. we move. 🫶

💜 OPTIONS 💜

  • searchterm — a search filter, or a .instr/.comp file. throw it a vibe and it'll go find it. 🔍
  • -h, –help — show this help message and exit. the classic. the people's option. 🥰
  • –install, -i — generate installation master doc page. the big boss page. 👑
  • –dir DIR, -d DIR — add search results from this directory. tell her where to look. 📂
  • –manual, -m — open the system manual. 📖
  • –comps, -c — open the component manual. 🧩
  • –web, -w — open the mcstas website. we're going online, besties. 🌐
  • –verbose, -v — prints a parsing log during execution. it's gonna yap (affectionately) and honestly? we love the transparency. 🗣️✨

🎀 FILES 🎀

the sacred texts, the paths she cares about:

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

lowkey obsessed with ~/.mcstas/mccode_config.json because it's yours. personal config energy. main character file fr fr. 💅

🌈 EXAMPLES 🌈

show documentation:

  • mcdoc

that's it. one word. she ate and left no crumbs. 🔥

⭐ AUTHORS ⭐

mcstas Team (mcstas.org) — absolute legends, no cap. 💖

🧚 SEE ALSO 🧚

mcstas(1), mcdoc(1), mcplot(1), mcrun(1), mcgui(1), mcdisplay(1)

the whole friend group. go say hi. 👯

💜 AUTHORS (yes, again) 💜

MCSTAS neutron Ray Tracing Team.

(they listed AUTHORS twice and honestly? slay. double the credit, double the respect. not me fixing it. never fixing it. 🙈)

and that's the page, bestie!! 🫶 this one came to you from git, dated under the mcDOC(1) banner — so if you ever forget any of this, the manual's got you. now go type mcdoc and let her cook. 💖✨🎀🦋🌸💅

📦 where this page comes from