|
Size: 961
Comment: New format.
|
Size: 1285
Comment: added comment to refer to HelpOnCommandTemplate
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| # see dtrecon as an exmaple | ## 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 6: | Line 11: |
| Line 8: | Line 14: |
| command arg1 -i <arg2> -o <arg3> [<options>] | command [argA] -flag1 [arg2] -flag2 [arg3] [<options>] |
| Line 13: | Line 19: |
| arg1 Description |
[argA] description |
| Line 19: | Line 25: |
| -i <arg2> | -flag1 [arg1] description description |
| Line 21: | Line 29: |
| -o <arg3> arg3 |
-flag2 [arg2] description description |
| Line 27: | Line 36: |
| -f <fvalue> | -flag3 [arg3] |
| Line 31: | Line 40: |
| -g <gvalue> | -flag4 [arg4] |
| Line 42: | Line 51: |
| = Description = description |
|
| Line 45: | Line 57: |
description |
|
| Line 50: | Line 64: |
description |
|
| Line 53: | Line 69: |
| ["othercommand1"] | ["othercommand1"], ["othercommand2"] |
| Line 55: | Line 71: |
| ["othercommand2"] = Author = JaneSmith |
= Author/s = JaneSmith |
| Line 61: | Line 75: |
| FreeSurfer | FreeSurfer, FsFast |
| Line 64: | Line 78: |
| ## For example: ["Belliveau1991"] NameYear |
["References/Lastname###"] |
| Line 68: | Line 81: |
| Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> | Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> = Methods Description = {{{ description description }}} |
| Line 71: | Line 90: |
| ## For example: CategoryFreeSurferCommandVolumeConversion Category''Stream''Function |
Category``Stream``Function |
Name
command - 1/2 sentence summary
Synopsis
command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]
Positional Arguments
[argA] description
Required Flagged Arguments
-flag1 [arg1] description description -flag2 [arg2] description description
Optional Flagged Arguments
-flag3 [arg3] description description -flag4 [arg4] description description
Outputs
volume1 - description volume2 - description
Description
description
Example 1
command foo -i f -o out description
Example 2
command foo -i f -o out -f fvalue description
See Also
["othercommand1"], ["othercommand2"]
Author/s
Links
References
["References/Lastname###"]
Reporting Bugs
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Methods Description
description description
Category
CategoryStreamFunction