Differences between revisions 1 and 4 (spanning 3 versions)
Revision 1 as of 2004-08-03 15:52:15
Size: 191
Editor: DavidTuch
Comment: New page.
Revision 4 as of 2004-08-04 11:00:17
Size: 1052
Editor: DavidTuch
Comment: Improved formatting.
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 ||
 || Description ||
Line 7: Line 12:
= Required Arguments =  || argB ||
 || Description ||
Line 9: Line 15:
= Optional Arguments = = Required Flagged Arguments =
 || -flag1 <arg1> ||
 || Description ||

 || - flag2 <arg2> ||
 || Description ||

= Optional Flagged Arguments =

 || -flag3 <arg3> ||
 || Description ||
Line 12: Line 28:
   || file1 || Description ||

 || file2 || Description ||
Line 14: Line 34:
 || command argA argB -flag1 foo -flag2 goo ||
 || Description ||
Line 15: Line 37:
= Version = = Example 2 =
 || command argA argB -flag1 foo -flag2 goo -flag3 hoo ||
 || Description ||

= See Also =
 || ["command2"] ||
 || ["command3"] ||
Line 18: Line 46:
 JaneSmith

= Links =
 Command``Guide

= References =
## For example: ["References/Belliveau1991"]
 ["References/NameYear"]
Line 20: Line 56:
 Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Line 21: Line 58:
= 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

  • ["References/NameYear"]

Reporting Bugs

Category

  • CategoryStreamCommand

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