|
Size: 1238
Comment: Added Description heading.
|
← Revision 30 as of 2008-04-29 11:45:05 ⇥
Size: 1686
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## see CommandTemplate and dtrecon as exmaples | ## 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 3: | Line 14: |
| {{{ | |
| Line 5: | Line 15: |
| }}} | |
| Line 7: | Line 17: |
| {{{ command [argA] -flag1 [arg2] -flag2 [arg3] [<options>] }}} |
command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4] |
| Line 11: | Line 19: |
| = Positional Arguments = {{{ [argA] description }}} |
= Arguments = == Positional Arguments == || argA || brief description || detailed description (eg, help file information) || || argB || brief description || detailed description (eg, help file information) || |
| Line 17: | Line 24: |
| = Required Flagged Arguments = {{{ -flag1 [arg1] description 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 23: | Line 28: |
| -flag2 [arg2] description description }}} |
== 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 28: | Line 36: |
| = Optional Flagged Arguments = {{{ -flag3 [arg3] description description |
= Description = description |
| Line 34: | Line 39: |
| -flag4 [arg4] description description }}} |
= Examples = == Example 1 == command foo -i f -o out |
| Line 39: | Line 43: |
| = Outputs = {{{ volume1 - description volume2 - description }}} |
description |
| Line 45: | Line 45: |
| = Example 1 = {{{ command foo -i f -o out }}} |
== Example 2 == command foo -i f -o out -f fvalue |
| Line 50: | Line 48: |
| = Example 2 = {{{ command foo -i f -o out -f fvalue }}} |
description = Bugs = None |
| Line 56: | Line 54: |
| ["othercommand1"], ["othercommand2"] = Author = JaneSmith |
[[othercommand1]], [[othercommand2]] |
| Line 64: | Line 59: |
| = References = ## For example: ["Belliveau1991"] NameYear = Description = description = Reporting Bugs = Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> |
|
| Line 75: | Line 60: |
| ## Suitable for cutting and pasting into publication. ## No WikiLinks should be used. |
|
| Line 82: | Line 65: |
| = Category = ## For example: CategoryFreeSurferCommandVolumeConversion Category``Stream``Function |
= References = [[References/Lastname###]] = Reporting Bugs = Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> = Author/s = JaneSmith |
Index
Contents
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
Links
Methods Description
description description
References
Reporting Bugs
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>