Differences between revisions 1 and 27 (spanning 26 versions)
Revision 1 as of 2004-08-03 15:52:15
Size: 191
Editor: DavidTuch
Comment: New page.
Revision 27 as of 2004-08-25 10:06:55
Size: 1648
Editor: DavidTuch
Comment: made arugments headings into subheadings. changed argument style.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## 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 2: Line 10:
command - 1/2 sentence summary
Line 4: Line 13:
command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4]
Line 5: Line 15:
= Positional Arguments = = Arguments =
== Positional Arguments ==
|| argA || brief description || detailed description (eg, help file information) ||
|| argB || brief description || detailed description (eg, help file information) ||
Line 7: Line 20:
= Required Arguments = == Required Flagged Arguments ==
|| -flag1 arg1 || brief description || detailed description (eg, help file information) ||
|| -flag2 arg2 || brief description || detailed description (eg, help file information) ||
Line 9: Line 24:
= Optional Arguments = == 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 ||
Line 11: Line 32:
= Outputs = = Description =
description
Line 13: Line 35:
= Example 1 = = Examples =
== Example 1 ==
command foo -i f -o out
Line 15: Line 39:
= Version = description
Line 17: Line 41:
= Author = == 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###"]
Line 20: Line 65:
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Line 21: Line 67:
= Author/s =
JaneSmith

Name

command - 1/2 sentence summary

Synopsis

command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4]

Arguments

Positional Arguments

argA

brief description

detailed description (eg, help file information)

argB

brief description

detailed description (eg, help file information)

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)