Differences between revisions 8 and 29 (spanning 21 versions)
Revision 8 as of 2004-08-05 02:08:54
Size: 961
Editor: DavidTuch
Comment: Removed indentation.
Revision 29 as of 2004-09-01 15:00:21
Size: 1686
Editor: DavidTuch
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## see dtrecon as an exmaple ## 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

'''Index'''
[[TableOfContents]]

Line 3: Line 14:
{{{
Line 5: Line 15:
}}}
Line 7: Line 17:
{{{
command arg1 -i <arg2> -o <arg3> [<options>]
}}}
command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4]
Line 11: Line 19:
= Positional Arguments =
{{{
arg1
  Description
}}}
= Arguments =
== Positional Arguments ==
|| argA || brief description || detailed description (eg, help file information) ||
|| argB || brief description || detailed description (eg, help file information) ||
Line 17: Line 24:
= Required Flagged Arguments =
{{{
-i <arg2>
== Required Flagged Arguments ==
|| -flag1 arg1 || brief description || detailed description (eg, help file information) ||
|| -flag2 arg2 || brief description || detailed description (eg, help file information) ||
Line 21: Line 28:
-o <arg3>
  arg3
}}}
== 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 25: Line 36:
= Optional Flagged Arguments =
{{{
-f <fvalue>
  description
  description
= Description =
description
Line 31: Line 39:
-g <gvalue>
  description
  description
}}}
= Examples =
== Example 1 ==
command foo -i f -o out
Line 36: Line 43:
= Outputs =
{{{
volume1 - description
volume2 - description
}}}
description
Line 42: Line 45:
= Example 1 =
{{{

command foo -i f -o out
}}}
== Example 2 ==
command foo -i f -o out -f fvalue
Line 47: Line 48:
= Example 2 =
{{{
command foo -i f -o out -f fvalue
}}}
description

= Bugs =
None
Line 55: Line 56:
= Author =
JaneSmith
Line 61: Line 59:
= Methods Description =
{{{
description
description
}}}
Line 62: Line 66:
## For example: ["Belliveau1991"]
NameYear
["References/Lastname###"]
Line 68: Line 71:
= Category =
## For example: CategoryFreeSurferCommandVolumeConversion
Category``Stream``Function
= Author/s =
JaneSmith

Index TableOfContents

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)