Differences between revisions 15 and 26 (spanning 11 versions)
Revision 15 as of 2004-08-06 13:42:02
Size: 1240
Editor: DavidTuch
Comment: Author -> Author/s
Revision 26 as of 2004-08-23 14:11:33
Size: 1477
Editor: DavidTuch
Comment: fixed typo
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## see CommandTemplate and dtrecon as exmaples ## 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
##
## See HelpOnCommandTemplate for description of formatting
Line 3: Line 10:
{{{
Line 5: Line 11:
}}}
Line 7: Line 13:
{{{
Line 9: Line 14:
}}}
Line 12: Line 16:
{{{
[argA]
description
}}}
|| [argA] || description ||
Line 18: Line 19:
{{{
-flag1 [arg1]
description
description

-flag2 [arg2]
description
description
}}}
|| -flag1 [arg1] || brief description || detailed description (eg, help file information) ||
|| -flag2 [arg2] || brief description || detailed description (eg, help file information) ||
Line 29: Line 23:
{{{
-flag3 [arg3]
  description
  description
|| -flag3 [arg3] || brief description ||detailed description (eg, help file information) ||
|| -flag4 [arg4] || brief description ||detailed description (eg, help file information) ||
 
= Outputs =
|| volume1 || description ||
|| volume2 || description ||
Line 34: Line 30:
-flag4 [arg4]
  description
  description
}}}
= Description =
description
Line 39: Line 33:
= Outputs =
{{{
volume1 - description
volume2 - description
}}}
= Examples =
== Example 1 ==
command foo -i f -o out
Line 45: Line 37:
= Example 1 =
{{{
command foo -i f -o out
}}}
description
Line 50: Line 39:
= Example 2 =
{{{
== Example 2 ==
Line 53: Line 41:
}}}
description

= Bugs =
None
Line 58: Line 50:
= Author/s =
JaneSmith
Line 64: Line 53:
= Description =
description

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

= Reporting Bugs =
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Line 75: Line 54:
## Suitable for cutting and pasting into publication.
## No WikiLinks should be used.
Line 82: Line 59:
= Category =
## For example: CategoryFreeSurferCommandVolumeConversion
Category``Stream``Function
= References =
["References/Lastname###"]

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

= 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]

brief description

detailed description (eg, help file information)

-flag2 [arg2]

brief description

detailed description (eg, help file information)

Optional Flagged Arguments

-flag3 [arg3]

brief description

detailed description (eg, help file information)

-flag4 [arg4]

brief description

detailed description (eg, help file information)

Outputs

volume1

description

volume2

description

Description

description

Examples

Example 1

command foo -i f -o out

description

Example 2

command foo -i f -o out -f fvalue

description

Bugs

None

See Also

["othercommand1"], ["othercommand2"]

Links

FreeSurfer, FsFast

Methods Description

description
description

References

["References/Lastname###"]

Reporting Bugs

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

Author/s

JaneSmith

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