Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{alias:help}
h2. Name

*help* — Show online help

h2. Syntax
{panel:|borderStyle=solid|borderWidth=1|bgColor=#FFFFAA}
*help* \[*help* | _command_]

{panel}

h2. Description

The *help* command shows the online help for a given command. If no arguments are provided the help frontpage is shown. The command is self documenting, so you can provide *help* as a command argument. 


h2. Arguments
*help* 
{indent}Shows this page, ie the documentation for the *help* command.{indent} 
_command_ 
{indent}Providing a command name will show the help page for that command.{indent} 

h2. Examples

h3.  Using the help command

{noformat:|borderWidth=1|bgColor=#eeeeee}
help          ; # Show help frontpage
help workflow ; # Show the help page for the workflow command

{noformat}

{pagebreak}