Differences between revisions 3 and 5 (spanning 2 versions)
Revision 3 as of 2004-08-03 22:00:41
Size: 903
Editor: DavidTuch
Comment: Added Category, References headings. Added commented examples.
Revision 5 as of 2004-08-04 11:25:27
Size: 961
Editor: DavidTuch
Comment: New format.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
# see dtrecon as an exmaple
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 arg1 -i <arg2> -o <arg3> [<options>]
}}}
Line 9: Line 12:
 argA

Description

 argB

 Description
{{{
arg1
  Description
}}}
Line 18: Line 18:
 -flag1 <arg1> {{{
-i <arg2>
Line 20: Line 21:
 Description

 - flag2 <arg2>

 Description
-o <arg3>
  arg3
}}}
Line 27: Line 26:
{{{
-f <fvalue>
  description
  description
Line 28: Line 31:
 -flag3 <arg3>

Description.
-g <gvalue>
  description
  description
}}}
Line 33: Line 37:
 file1

Description

 fi
le2

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

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

 Description
{{{
command foo -i f -o out -f fvalue
}}}
Line 52: Line 53:
 ["command2"]  ["othercommand1"]
Line 54: Line 55:
 ["command3"]  ["othercommand2"]
Line 60: Line 61:
 Command``Guide  FreeSurfer
Line 67: Line 68:
 Report bugs to <>  Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Line 71: Line 72:
 Category``Stream``Command  Category''Stream''Function

Name

command - 1/2 sentence summary

Synopsis

command arg1 -i <arg2> -o <arg3> [<options>]

Positional Arguments

arg1
  Description

Required Flagged Arguments

-i <arg2>

-o <arg3>
  arg3

Optional Flagged Arguments

-f <fvalue>
  description
  description

-g <gvalue>
  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

Links

References

Reporting Bugs

Category

  • CategoryStreamFunction

CommandTemplate (last edited 2008-04-29 11:45:05 by localhost)