Differences between revisions 23 and 30 (spanning 7 versions)
⇤ ← Revision 23 as of 2004-08-18 15:58:28 →
Size: 1306
Editor: DavidTuch
Comment: added Detailed Flag Description
← Revision 30 as of 2008-04-29 11:45:05 → ⇥
Size: 1686
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 9: Line 9:
'''Index'''
<<TableOfContents>>
Line 13: Line 17:
command [argA] -flag1 [arg2] -flag2 [arg3] [<options>] command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4]
Line 15: Line 19:
= 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 24:
= Required Flagged Arguments =
|| -flag1 [arg1] || description ||
|| -flag2 [arg2] || description ||		 == 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 28:
= Optional Flagged Arguments =
|| -flag3 [arg3] || description ||
|| -flag4 [arg4] || description ||		 == Optional Flagged Arguments ==
|| -flag3 arg3 || brief description ||detailed description (eg, help file information) ||
|| -flag4 arg4 || brief description ||detailed description (eg, help file information) ||
Line 32: Line 38:

= Detailed Flag Description =
== -flagAlpha [a] ==
== -flagBravo [b] ==
Line 48: Line 50:
= Bugs =
None
Line 49: Line 54:
["othercommand1"], ["othercommand2"] [[othercommand1]], [[othercommand2]]
Line 61: Line 66:
["References/Lastname###"] [[References/Lastname###]]

Index

Contents

  1. Name
  2. Synopsis
  3. Arguments
    1. Positional Arguments
    2. Required Flagged Arguments
    3. Optional Flagged Arguments
  4. Outputs
  5. Description
  6. Examples
    1. Example 1
    2. Example 2
  7. Bugs
  8. See Also
  9. Links
  10. Methods Description
  11. References
  12. Reporting Bugs
  13. Author/s

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)