Differences between revisions 1 and 18 (spanning 17 versions)
Revision 1 as of 2004-08-03 15:52:15
Size: 191
Editor: DavidTuch
Comment: New page.
Revision 18 as of 2004-08-10 12:36:38
Size: 1285
Editor: DavidTuch
Comment: added comment to refer to HelpOnCommandTemplate
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 13:
{{{
command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]
}}}
Line 6: Line 18:
{{{
[argA]
  description
}}}
Line 7: Line 23:
= Required Arguments = = Required Flagged Arguments =
{{{
-flag1 [arg1]
  description
  description
Line 9: Line 29:
= Optional Arguments = -flag2 [arg2]
  description
  description
}}}

= Optional Flagged Arguments =
{{{
-flag3 [arg3]
  description
  description

-flag4 [arg4]
  description
  description
}}}
Line 12: Line 46:
{{{
volume1 - description
volume2 - description
}}}

= Description =
description
Line 14: Line 55:
{{{
command foo -i f -o out
Line 15: Line 58:
= Version = description
}}}
Line 17: Line 61:
= Author = = Example 2 =
{{{
command foo -i f -o out -f fvalue

description
}}}

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

= Author/s =
JaneSmith

= Links =
FreeSurfer, FsFast

= References =
["References/Lastname###"]
Line 20: Line 81:
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Line 21: Line 83:
= Methods Description =
{{{
description
description
}}}

= Category =
Category``Stream``Function

Name

command - 1/2 sentence summary

Synopsis

command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]

Positional Arguments

[argA]
  description

Required Flagged Arguments

-flag1 [arg1]
  description
  description

-flag2 [arg2]
  description
  description

Optional Flagged Arguments

-flag3 [arg3]
  description
  description

-flag4 [arg4]
  description
  description

Outputs

volume1 - description
volume2 - description

Description

description

Example 1

command foo -i f -o out

description

Example 2

command foo -i f -o out -f fvalue

description

See Also

["othercommand1"], ["othercommand2"]

Author/s

JaneSmith

Links

FreeSurfer, FsFast

References

["References/Lastname###"]

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)