Command line tool: gen_example

Module	cltools
Description	Input
construct an example for the manual that users can interact with	command line args

Details

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.

THIS COMMAND WILL LIKELY BE DELETED SOON AS IT HAS BEEN SUPERCEDED BY PLUMEDTOHTML.

Examples

The following generates an example based on the contents of the plumed file plumed.dat

plumed gen_exampleconstruct an example for the manual that users can interact with This action has hidden defaults. More details --plumed convert the input in this file to the html manual plumed.dat --status whether or not the input file works working

The gen_example action with label plumed calculates somethingplumed gen_exampleconstruct an example for the manual that users can interact with This action uses the defaults shown here. More details --plumed convert the input in this file to the html manual plumed.dat --status whether or not the input file works working
 --out the file on which to output the example in html example.html --name the name to use for this particular input ppp --multi set number of replicas for multi environment (needs MPI) 0 

Syntax

The following table describes the command line options that are available for this tool

Keyword	Description
--help/-h	print this help
--plumed	convert the input in this file to the html manual
--out	the file on which to output the example in html
--name	the name to use for this particular input
--status	whether or not the input file works
--multi	set number of replicas for multi environment (needs MPI)