Command line tool: manual

Module	cltools
Description	Input
print out a description of the keywords for an action in html	command line args

Details

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 was within the scripts that generate the old html manual for PLUMED.

WE WILL POSSIBILY DELETE THIS COMMAND SOON AS IT IS NO LONGER USED TO CONSTRUCT THE MANUAL

Examples

The following generates the html manual for the action DISTANCE.

plumed manualprint out a description of the keywords for an action in html More details --actionprint the manual for this particular action DISTANCE
The manual action with label plumed calculates something

Syntax

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

Keyword	Description
--help/-h	print this help
--action	print the manual for this particular action
--vim	print the keywords in vim syntax
--spelling	print a list of the keywords and component names for the spell checker