Differences between revisions 1 and 13 (spanning 12 versions)
Revision 1 as of 2004-08-03 15:52:15
Size: 191
Editor: DavidTuch
Comment: New page.
Revision 13 as of 2004-08-05 22:21:37
Size: 1238
Editor: DavidTuch
Comment: Added Description heading.
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 - 1/2 sentence summary
}}}
Line 4: Line 7:
{{{
command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]
}}}
Line 6: Line 12:
{{{
[argA]
  description
}}}
Line 7: Line 17:
= Required Arguments = = Required Flagged Arguments =
{{{
-flag1 [arg1]
  description
  description
Line 9: Line 23:
= Optional Arguments = -flag2 [arg2]
  description
  description
}}}

= Optional Flagged Arguments =
{{{
-flag3 [arg3]
  description
  description

-flag4 [arg4]
  description
  description
}}}
Line 12: Line 40:
{{{
volume1 - description
volume2 - description
}}}
Line 14: Line 46:
{{{
command foo -i f -o out
}}}
Line 15: Line 50:
= Version = = Example 2 =
{{{
command foo -i f -o out -f fvalue
}}}

= See Also =
["othercommand1"], ["othercommand2"]
Line 18: Line 59:
JaneSmith

= Links =
FreeSurfer, FsFast

= References =
## For example: ["Belliveau1991"]
NameYear

= Description =
description
Line 20: Line 72:
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Line 21: Line 74:
= Methods Description =
## Suitable for cutting and pasting into publication.
## No WikiLinks should be used.
{{{
description
description
}}}

= Category =
## For example: CategoryFreeSurferCommandVolumeConversion
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

Description

description

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)