Differences between revisions 1 and 22 (spanning 21 versions)
Revision 1 as of 2004-08-03 15:52:15
Size: 191
Editor: DavidTuch
Comment: New page.
Revision 22 as of 2004-08-17 09:32:44
Size: 1155
Editor: DavidTuch
Comment: added Examples heading
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## See HelpOnCommandTemplate for description of formatting
##
## Note: If you are modifying this page please refer to the
## CommandTemplate page and confirm that this page has the latest
## CommandTemplate formatting
Line 2: Line 8:
command - 1/2 sentence summary
Line 4: Line 11:
command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]
Line 6: Line 14:
|| [argA] || description ||
Line 7: Line 16:
= Required Arguments = = Required Flagged Arguments =
|| -flag1 [arg1] || description ||
|| -flag2 [arg2] || description ||
Line 9: Line 20:
= Optional Arguments = = Optional Flagged Arguments =
|| -flag3 [arg3] || description ||
|| -flag4 [arg4] || description ||
 
= Outputs =
|| volume1 || description ||
|| volume2 || description ||
Line 11: Line 28:
= Outputs = = Description =
description
Line 13: Line 31:
= Example 1 = = Examples =
== Example 1 ==
command foo -i f -o out
Line 15: Line 35:
= Version = description
Line 17: Line 37:
= Author = == Example 2 ==
command foo -i f -o out -f fvalue

description

= See Also =
["othercommand1"], ["othercommand2"]

= Links =
FreeSurfer, FsFast

= Methods Description =
{{{
description
description
}}}

= References =
["References/Lastname###"]
Line 20: Line 58:
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Line 21: Line 60:
= 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]

description

-flag2 [arg2]

description

Optional Flagged Arguments

-flag3 [arg3]

description

-flag4 [arg4]

description

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

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)