Differences between revisions 26 and 27
Deletions are marked like this. Additions are marked like this.
Line 13: Line 13:
command [argA] -flag1 [arg2] -flag2 [arg3] [<options>] command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4]
Line 15: Line 15:
= Positional Arguments =
|| [argA] || description ||
= Arguments =
== Positional Arguments ==
|| argA || brief description || detailed description (eg, help file information) ||
|| argB || brief description || detailed description (eg, help file information) ||
Line 18: Line 20:
= Required Flagged Arguments =
|| -flag1 [arg1] || brief description || detailed description (eg, help file information) ||
|| -flag2 [arg2] || 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) ||
Line 22: Line 24:
= Optional Flagged Arguments =
|| -flag3 [arg3] || brief description ||detailed description (eg, help file information) ||
|| -flag4 [arg4] || 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) ||

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)