|
Size: 1285
Comment: added comment to refer to HelpOnCommandTemplate
|
Size: 1306
Comment: added Detailed Flag Description
|
| 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 ## |
|
| Line 2: | Line 8: |
| ## ## Note: If you are modifying this page please refer to the ## CommandTemplate page and confirm that this page has the latest ## CommandTemplate formatting |
|
| Line 8: | Line 10: |
| {{{ | |
| Line 10: | Line 11: |
| }}} | |
| Line 13: | Line 13: |
| {{{ | |
| Line 15: | Line 14: |
| }}} | |
| Line 18: | Line 16: |
| {{{ [argA] description }}} |
|| [argA] || description || |
| Line 24: | Line 19: |
| {{{ -flag1 [arg1] description description -flag2 [arg2] description description }}} |
|| -flag1 [arg1] || description || || -flag2 [arg2] || description || |
| Line 35: | Line 23: |
| {{{ -flag3 [arg3] description description -flag4 [arg4] description description }}} |
|| -flag3 [arg3] || description || || -flag4 [arg4] || description || |
| Line 46: | Line 27: |
| {{{ volume1 - description volume2 - description }}} |
|| volume1 || description || || volume2 || description || |
| Line 54: | Line 33: |
| = Example 1 = {{{ |
= Detailed Flag Description = == -flagAlpha [a] == == -flagBravo [b] == = Examples = == Example 1 == |
| Line 59: | Line 42: |
| }}} | |
| Line 61: | Line 43: |
| = Example 2 = {{{ |
== Example 2 == |
| Line 66: | Line 47: |
| }}} | |
| Line 71: | Line 51: |
| = Author/s = JaneSmith |
|
| Line 76: | Line 53: |
= Methods Description = {{{ description description }}} |
|
| Line 83: | Line 66: |
| = Methods Description = {{{ description description }}} = Category = Category``Stream``Function |
= 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
Detailed Flag Description
-flagAlpha [a]
-flagBravo [b]
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>