This is part of the cltools module

manual is a tool that you can use to construct the manual page for a particular action

The manual constructed by this action is in html. In all probability you will never need to use this tool. However, it is used within the scripts that generate the html manual for PLUMED. If you need to use this tool outside those scripts the input is specified using the following command line arguments.

Examples

The following generates the html manual for the action DISTANCE.

plumed manual --action DISTANCE

Glossary of keywords and components

Compulsory keywords

--action print the manual for this particular action

Options

--help/-h ( default=off ) print this help

--vim ( default=off ) print the keywords in vim syntax

--spelling

( default=off ) print a list of the keywords and component names for the spell checker