---
name: "mcdoc"
section: "1"
platform: "linux"
package: "mcstas-mcdoc"
version: "3.5+3.5.19+ds5-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mcdoc"
---

# mcdoc(1)

Creating and viewing the mcstas library, component/instrument help and Manuals

## NAME

**mcdoc** - Creating and viewing the mcstas library, component/instrument help and Manuals

## SYNOPSIS

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

## DESCRIPTION

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. Just type `mcplot`.

## OPTIONS

- **searchterm**

  search filter or .instr/.comp file

- **-h, –help**

  show this help message and exit

- **–install, -i**

  generate installation master doc page

- **–dir DIR, -d DIR**

  add search results from this directory

- **–manual, -m**

  open the system manual

- **–comps, -c**

  open the component manual

- **–web, -w**

  open the mcstas website

- **–verbose, -v**

  prints a parsing log during execution

## FILES

/usr/share/mcstas/resources /usr/share/mcstas/tools/Python/mccodelib/mccode\_config.json ~/.mcstas/mccode\_config.json http://www.mcstas.org

## EXAMPLES

- Show documentation

  - •

  `mcdoc`

## AUTHORS

mcstas Team (mcstas.org)

## SEE ALSO

[mcstas(1)](/mcstas/1.md), [mcdoc(1)](/mcdoc/1.md), [mcplot(1)](/mcplot/1.md), [mcrun(1)](/mcrun/1.md), [mcgui(1)](/mcgui/1.md), [mcdisplay(1)](/mcdisplay/1.md)

## AUTHORS

MCSTAS neutron Ray Tracing Team.