|
Size: 903
Comment: Added Category, References headings. Added commented examples.
|
Size: 1686
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## Note: This page was created with the CommandTemplate ## ## If you're modifying this page please take a look at the ## latest version of CommandTemplate to ensure that you're ## using the latest version of the CommandTemplate ## ## See HelpOnCommandTemplate for description of formatting '''Index''' [[TableOfContents]] |
|
| Line 2: | Line 14: |
command - quick summary |
command - 1/2 sentence summary |
| Line 6: | Line 17: |
| command argA argB -flag1 <arg1> -flag2 <arg2> -flag3 <arg3> | command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4] |
| Line 8: | Line 19: |
| = Positional Arguments = argA |
= Arguments = == Positional Arguments == || argA || brief description || detailed description (eg, help file information) || || argB || brief description || detailed description (eg, help file information) || |
| Line 11: | Line 24: |
| Description | == Required Flagged Arguments == || -flag1 arg1 || brief description || detailed description (eg, help file information) || || -flag2 arg2 || brief description || detailed description (eg, help file information) || |
| Line 13: | Line 28: |
| argB | == Optional Flagged Arguments == || -flag3 arg3 || brief description ||detailed description (eg, help file information) || || -flag4 arg4 || brief description ||detailed description (eg, help file information) || = Outputs = || volume1 || description || || volume2 || description || |
| Line 15: | Line 36: |
| Description | = Description = description |
| Line 17: | Line 39: |
| = Required Flagged Arguments = -flag1 <arg1> |
= Examples = == Example 1 == command foo -i f -o out |
| Line 20: | Line 43: |
| Description | description |
| Line 22: | Line 45: |
| - flag2 <arg2> | == Example 2 == command foo -i f -o out -f fvalue |
| Line 24: | Line 48: |
| Description | description |
| Line 26: | Line 50: |
| = 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 |
= Bugs = None |
| Line 52: | Line 54: |
| ["command2"] ["command3"] = Author = JaneSmith |
["othercommand1"], ["othercommand2"] |
| Line 60: | Line 57: |
| Command``Guide | FreeSurfer, FsFast = Methods Description = {{{ description description }}} |
| Line 63: | Line 66: |
| ## For example: ["Belliveau1991"] NameYear |
["References/Lastname###"] |
| Line 67: | Line 69: |
| Report bugs to <> | Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> |
| Line 69: | Line 71: |
| = Category = ## For example: CategoryFreeSurferCommandVolumeConversion Category``Stream``Command |
= Author/s = JaneSmith |
Index TableOfContents
Name
command - 1/2 sentence summary
Synopsis
command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4]
Arguments
Positional Arguments
argA |
brief description |
detailed description (eg, help file information) |
argB |
brief description |
detailed description (eg, help file information) |
Required Flagged Arguments
-flag1 arg1 |
brief description |
detailed description (eg, help file information) |
-flag2 arg2 |
brief description |
detailed description (eg, help file information) |
Optional Flagged Arguments
-flag3 arg3 |
brief description |
detailed description (eg, help file information) |
-flag4 arg4 |
brief description |
detailed description (eg, help file information) |
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
Bugs
None
See Also
["othercommand1"], ["othercommand2"]
Links
Methods Description
description description
References
["References/Lastname###"]
Reporting Bugs
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>