Differences between revisions 4 and 12 (spanning 8 versions)
Revision 4 as of 2004-08-04 11:00:17
Size: 1052
Editor: DavidTuch
Comment: Improved formatting.
Revision 12 as of 2004-08-05 12:53:23
Size: 1112
Editor: DavidTuch
Comment: Added see CommandTemplate comment.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## see CommandTemplate and dtrecon as exmaples
Line 2: Line 3:

 command - quick summary
{{{
command - 1/2 sentence summary
}}}
Line 6: Line 7:
 command argA argB -flag1 <arg1> -flag2 <arg2> -flag3 <arg3> {{{
command argA -flag1 [arg2] -flag2 [arg3] [<options>]
}}}
Line 9: Line 12:
 || argA ||
 || Description ||

 || argB ||
 || Description ||
{{{
argA
  description
}}}
Line 16: Line 18:
 || -flag1 <arg1> ||
 || Description ||
{{{
-flag1 [arg1]
  description
 description
Line 19: Line 23:
 || - flag2 <arg2> ||
 || Description ||
-flag2 [arg2]
  description
 description
}}}
Line 23: Line 29:
{{{
-flag3 [arg3]
  description
  description
Line 24: Line 34:
 || -flag3 <arg3> ||
 || Description ||
-flag4 [arg4]
  description
 description
}}}
Line 28: Line 40:
 
 || file1 || Description ||

 || fi
le2 || Description ||
{{{
volume1 - description
volume2 - description
}}}
Line 34: Line 46:
 || command argA argB -flag1 foo -flag2 goo ||
 || Description ||
{{{
command foo -i f -o out
}}}
Line 38: Line 51:
 || command argA argB -flag1 foo -flag2 goo -flag3 hoo ||
 || Description ||
{{{
command foo -i f -o out -f fvalue
}}}
Line 42: Line 56:
 || ["command2"] ||
 || ["command3"] ||
["othercommand1"], ["othercommand2"]
Line 46: Line 59:
 JaneSmith JaneSmith
Line 49: Line 62:
 Command``Guide FreeSurfer, FsFast
Line 52: Line 65:
## For example: ["References/Belliveau1991"]
 ["References/NameYear"]
## For example: ["Belliveau1991"]
NameYear
Line 56: Line 69:
 Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Line 58: Line 71:
= Methods Description =
{{{
description
description
}}}
Line 60: Line 78:
 Category``Stream``Command 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

Example 2

command foo -i f -o out -f fvalue

See Also

["othercommand1"], ["othercommand2"]

Author

JaneSmith

Links

FreeSurfer, FsFast

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)