Differences between revisions 1 and 3 (spanning 2 versions)
Revision 1 as of 2004-08-03 15:52:15
Size: 191
Editor: DavidTuch
Comment: New page.
Revision 3 as of 2004-08-03 22:00:41
Size: 903
Editor: DavidTuch
Comment: Added Category, References headings. Added commented examples.
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
 command - quick summary
Line 4: Line 6:
 command argA argB -flag1 <arg1> -flag2 <arg2> -flag3 <arg3>
Line 6: Line 9:
 argA
Line 7: Line 11:
= Required Arguments =  Description
Line 9: Line 13:
= Optional Arguments =  argB

 Description

= Required Flagged Arguments =
 -flag1 <arg1>

 Description

 - flag2 <arg2>

 Description

= Optional Flagged Arguments =

 -flag3 <arg3>

 Description.
Line 12: Line 33:
 file1

 Description

 file2

 Description
Line 14: Line 42:
 command argA argB -flag1 foo -flag2 goo
Line 15: Line 44:
= Version =  Description

= Example 2 =
 command argA argB -flag1 foo -flag2 goo -flag3 hoo

 Description

= See Also =
 ["command2"]

 ["command3"]
Line 18: Line 57:
 JaneSmith

= Links =
 Command``Guide

= References =
## For example: ["Belliveau1991"]
 NameYear
Line 20: Line 67:
 Report bugs to <>
Line 21: Line 69:
= Category =
## For example: CategoryFreeSurferCommandVolumeConversion
 Category``Stream``Command

Name

  • command - quick summary

Synopsis

  • command argA argB -flag1 <arg1> -flag2 <arg2> -flag3 <arg3>

Positional Arguments

  • argA Description argB Description

Required Flagged Arguments

  • -flag1 <arg1> Description

    - flag2 <arg2> Description

Optional Flagged Arguments

  • -flag3 <arg3> Description.

Outputs

  • file1 Description file2 Description

Example 1

  • command argA argB -flag1 foo -flag2 goo Description

Example 2

  • command argA argB -flag1 foo -flag2 goo -flag3 hoo Description

See Also

  • ["command2"] ["command3"]

Author

Links

  • CommandGuide

References

Reporting Bugs

  • Report bugs to <>

Category

  • CategoryStreamCommand

CommandTemplate (last edited 2008-04-29 11:45:05 by localhost)