This is part of the cltools module

gen_example is a tool that you can use to construct an example for the manual that users can interact with to understand

The example 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 an example based on the contents of the plumed file plumed.dat

plumed gen_example --plumed plumed.dat --status working

Glossary of keywords and components

Compulsory keywords

`--plumed`	( default=plumed.dat ) convert the input in this file to the html manual
`--out`	( default=example.html ) the file on which to output the example in html
`--name`	( default=ppp ) the name to use for this particular input
`--status`	( default=nobadge ) whether or not the input file works
`--multi`	( default=0 ) set number of replicas for multi environment (needs MPI)

Options

--help/-h

( default=off ) print this help