|
Size: 903
Comment: Added Category, References headings. Added commented examples.
|
Size: 1155
Comment: added Examples heading
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## See HelpOnCommandTemplate for description of formatting ## ## Note: If you are modifying this page please refer to the ## CommandTemplate page and confirm that this page has the latest ## CommandTemplate formatting |
|
| Line 2: | Line 8: |
command - quick summary |
command - 1/2 sentence summary |
| Line 6: | Line 11: |
| command argA argB -flag1 <arg1> -flag2 <arg2> -flag3 <arg3> | command [argA] -flag1 [arg2] -flag2 [arg3] [<options>] |
| Line 9: | Line 14: |
| argA Description argB Description |
|| [argA] || description || |
| Line 18: | Line 17: |
| -flag1 <arg1> Description - flag2 <arg2> Description |
|| -flag1 [arg1] || description || || -flag2 [arg2] || description || |
| Line 27: | Line 21: |
| || -flag3 [arg3] || description || || -flag4 [arg4] || description || = Outputs = || volume1 || description || || volume2 || description || |
|
| Line 28: | Line 28: |
| -flag3 <arg3> | = Description = description |
| Line 30: | Line 31: |
| Description. | = Examples = == Example 1 == command foo -i f -o out |
| Line 32: | Line 35: |
| = Outputs = file1 |
description |
| Line 35: | Line 37: |
| Description | == Example 2 == command foo -i f -o out -f fvalue |
| Line 37: | Line 40: |
| file2 Description = Example 1 = command argA argB -flag1 foo -flag2 goo Description = Example 2 = command argA argB -flag1 foo -flag2 goo -flag3 hoo Description |
description |
| Line 52: | Line 43: |
| ["command2"] ["command3"] = Author = JaneSmith |
["othercommand1"], ["othercommand2"] |
| Line 60: | Line 46: |
| Command``Guide | FreeSurfer, FsFast = Methods Description = {{{ description description }}} |
| Line 63: | Line 55: |
| ## For example: ["Belliveau1991"] NameYear |
["References/Lastname###"] |
| Line 67: | Line 58: |
| Report bugs to <> | Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> |
| Line 69: | Line 60: |
| = Category = ## For example: CategoryFreeSurferCommandVolumeConversion Category``Stream``Command |
= Author/s = JaneSmith |
Name
command - 1/2 sentence summary
Synopsis
command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]
Positional Arguments
[argA] |
description |
Required Flagged Arguments
-flag1 [arg1] |
description |
-flag2 [arg2] |
description |
Optional Flagged Arguments
-flag3 [arg3] |
description |
-flag4 [arg4] |
description |
Outputs
volume1 |
description |
volume2 |
description |
Description
description
Examples
Example 1
command foo -i f -o out
description
Example 2
command foo -i f -o out -f fvalue
description
See Also
["othercommand1"], ["othercommand2"]
Links
Methods Description
description description
References
["References/Lastname###"]
Reporting Bugs
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>