Differences between revisions 2 and 23 (spanning 21 versions)
Revision 2 as of 2004-08-03 16:00:23
Size: 714
Editor: DavidTuch
Comment:
Revision 23 as of 2004-08-18 15:58:28
Size: 1306
Editor: DavidTuch
Comment: added Detailed Flag Description
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 - quick summary
command - 1/2 sentence summary
Line 6: Line 13:
 command argA argB -flag1 <arg1> -flag2 <arg2> -flag3 <arg3> command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]
Line 9: Line 16:
 argA

Description

argB

 Description
|| [argA] || description ||
Line 18: Line 19:
 -flag1 <arg1>

Description

- flag2 <arg2>

Description
|| -flag1 [arg1] || description ||
|| -flag2 [arg2] || description ||
Line 27: Line 23:
|| -flag3 [arg3] || description ||
|| -flag4 [arg4] || description ||
 
= Outputs =
|| volume1 || description ||
|| volume2 || description ||
Line 28: Line 30:
 -flag3 <arg3> = Description =
description
Line 30: Line 33:
 Description. = Detailed Flag Description =
== -flagAlpha [a] ==
== -flagBravo [b] ==
Line 32: Line 37:
= Outputs =
 file1
= Examples =
== Example 1 ==
command foo -i f -o out
Line 35: Line 41:
 Description description
Line 37: Line 43:
 file2 == Example 2 ==
command foo -i f -o out -f fvalue
Line 39: Line 46:
 Description description
Line 41: Line 48:
= Example 1 =
 command argA argB -flag1 foo -flag2 goo

 Description

= Example 2 =
 command argA argB -flag1 foo -flag2 goo -flag3 hoo

 Description

= Version =
 $ CVS ID $

= Author =
 JaneSmith
= See Also =
["othercommand1"], ["othercommand2"]
Line 58: Line 52:
 CommandGuide FreeSurfer, FsFast

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

= References =
["References/Lastname###"]
Line 61: Line 64:
 Report bugs to <> 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]

description

-flag2 [arg2]

description

Optional Flagged Arguments

-flag3 [arg3]

description

-flag4 [arg4]

description

Outputs

volume1

description

volume2

description

Description

description

Detailed Flag Description

-flagAlpha [a]

-flagBravo [b]

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)