Differences between revisions 2 and 10 (spanning 8 versions)
Revision 2 as of 2004-08-03 16:00:23
Size: 714
Editor: DavidTuch
Comment:
Revision 10 as of 2004-08-05 03:32:03
Size: 1074
Editor: DavidTuch
Comment: Improved formatting.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## see dtrecon as an exmaple
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 arg1 -i <arg2> -o <arg3> [<options>]
}}}
Line 9: Line 12:
 argA

 Description

 argB

 Description
{{{
arg1
  description
}}}
Line 18: Line 18:
 -flag1 <arg1> {{{
-i <arg2>
  description
  description
Line 20: Line 23:
 Description

- flag2 <arg2>

 D
escription
-o <arg3>
  d
escription
  description
}}}
Line 27: Line 29:
{{{
-f <fvalue>
  description
  description
Line 28: Line 34:
 -flag3 <arg3>

Description.
-g <gvalue>
  description
  description
}}}
Line 33: Line 40:
 file1

Description

 fi
le2

Description
{{{      volume1 - description
volume2 - description
}}}
Line 42: Line 46:
 command argA argB -flag1 foo -flag2 goo

 Description
{{{
command foo -i f -o out
}}}
Line 47: Line 51:
 command argA argB -flag1 foo -flag2 goo -flag3 hoo {{{
command foo -i f -o out -f fvalue
}}}
Line 49: Line 55:
 Description

= Version =
 $ CVS ID $
= See Also =
["othercommand1"], ["othercommand2"]
Line 55: Line 59:
 JaneSmith JaneSmith
Line 58: Line 62:
 CommandGuide FreeSurfer, FsFast

= References =
## For example: ["Belliveau1991"]
NameYear
Line 61: Line 69:
 Report bugs to <> Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>

= Methods Description =
{{{
description
description
}}}
= Category =
## For example: CategoryFreeSurferCommandVolumeConversion
Category``Stream``Function

Name

command - 1/2 sentence summary

Synopsis

command arg1 -i <arg2> -o <arg3> [<options>]

Positional Arguments

arg1
  description

Required Flagged Arguments

-i <arg2>
  description
  description

-o <arg3>
  description
  description

Optional Flagged Arguments

-f <fvalue>
  description
  description

-g <gvalue>
  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)