Differences between revisions 3 and 13 (spanning 10 versions)
Revision 3 as of 2004-08-03 22:00:41
Size: 903
Editor: DavidTuch
Comment: Added Category, References headings. Added commented examples.
Revision 13 as of 2004-08-05 22:21:37
Size: 1238
Editor: DavidTuch
Comment: Added Description heading.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## see CommandTemplate and dtrecon as exmaples
Line 2: Line 3:

 command - quick summary
{{{
command - 1/2 sentence summary
}}}
Line 6: Line 7:
 command argA argB -flag1 <arg1> -flag2 <arg2> -flag3 <arg3> {{{
command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]
}}}
Line 9: Line 12:
 argA

 Description

 argB

 Description
{{{
[argA]
  description
}}}
Line 18: Line 18:
 -flag1 <arg1> {{{
-flag1 [arg1]
  description
  description
Line 20: Line 23:
 Description

- flag2 <arg2>

 D
escription
-flag2 [arg2]
  d
escription
  description
}}}
Line 27: Line 29:
{{{
-flag3 [arg3]
  description
  description
Line 28: Line 34:
 -flag3 <arg3>

 Description.
-flag4 [arg4]
  description
  description
}}}
Line 33: Line 40:
 file1

Description

 fi
le2

Description
{{{      volume1 - description
volume2 - description
}}}
Line 42: Line 46:
 command argA argB -flag1 foo -flag2 goo

 Description
{{{
command foo -i f -o out
}}}
Line 47: Line 51:
 command argA argB -flag1 foo -flag2 goo -flag3 hoo

 Description
{{{
command foo -i f -o out -f fvalue
}}}
Line 52: Line 56:
 ["command2"]

 ["command3"]
["othercommand1"], ["othercommand2"]
Line 57: Line 59:
 JaneSmith JaneSmith
Line 60: Line 62:
 Command``Guide FreeSurfer, FsFast
Line 64: Line 66:
 NameYear NameYear

= Description =
description
Line 67: Line 72:
 Report bugs to <> Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>

= Methods Description =
## Suitable for cutting and pasting into publication.
## No WikiLinks should be used.
{{{
description
description
}}}
Line 71: Line 84:
 Category``Stream``Command 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

Example 1

command foo -i f -o out

Example 2

command foo -i f -o out -f fvalue

See Also

["othercommand1"], ["othercommand2"]

Author

JaneSmith

Links

FreeSurfer, FsFast

References

NameYear

Description

description

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)