logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Authors

       MCSTAS neutron Ray Tracing Team.

                                                       git                                              mcDOC(1)

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.

Examples

       Show documentation

       • mcdoc

Files

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

Name

mcdoc - Creating and viewing the mcstas 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 mcstas website

       –verbose,-v
              prints a parsing log during execution

See Also

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

Synopsis

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

See Also