Differences between revisions 5 and 16 (spanning 11 versions)
Revision 5 as of 2004-08-04 11:25:27
Size: 961
Editor: DavidTuch
Comment: New format.
Revision 16 as of 2004-08-07 02:37:01
Size: 1381
Editor: DavidTuch
Comment: added comment to refer to latest CommandTemplate
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
# see dtrecon as an exmaple ## If you are modifying this page please take a look at the
## CommandTemplate page and check that this page has the latest
## CommandTemplate formatting
Line 8: Line 11:
command arg1 -i <arg2> -o <arg3> [<options>] command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]
Line 13: Line 16:
arg1
  Description
[argA]
  description
Line 19: Line 22:
-i <arg2> -flag1 [arg1]
  description
  description
Line 21: Line 26:
-o <arg3>
  arg3
-flag2 [arg2]
  description
  description
Line 27: Line 33:
-f <fvalue> -flag3 [arg3]
Line 31: Line 37:
-g <gvalue> -flag4 [arg4]
Line 45: Line 51:

description
Line 50: Line 58:

description
Line 53: Line 63:
 ["othercommand1"] ["othercommand1"], ["othercommand2"]
Line 55: Line 65:
 ["othercommand2"]

= Author =
 JaneSmith
= Author/s =
JaneSmith
Line 61: Line 69:
 FreeSurfer FreeSurfer, FsFast

= Description =
description
Line 65: Line 76:
 NameYear NameYear
Line 68: Line 79:
 Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>

= Methods Description =
## Suitable for cutting and pasting into publication.
## No WikiLinks should be used.
{{{
description
description
}}}
Line 72: Line 91:
 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

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

JaneSmith

Links

FreeSurfer, FsFast

Description

description

References

NameYear

Reporting Bugs

Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>

Methods Description

description
description

Category

CategoryStreamFunction

CommandTemplate (last edited 2008-04-29 11:45:05 by localhost)