Differences between revisions 2 and 12 (spanning 10 versions)

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

Author

JaneSmith

Links

FreeSurfer, FsFast

References

NameYear

Reporting Bugs

Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>

Methods Description

description
description

-  ⇤ ← Revision 2 as of 2004-08-03 16:00:23 → 
  Size: 714
  Editor: DavidTuch
  Comment:
+   ← Revision 12 as of 2004-08-05 12:53:23 → ⇥
  Size: 1112
  Editor: DavidTuch
  Comment: Added see CommandTemplate comment.
-Deletions are marked like this.
+Additions are marked like this.
 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:
- -flag1 <arg1>
+{{{
-flag1 [arg1]
  description
  description
-Line 20:
+Line 23:
- Description

 - flag2 <arg2>

 Description
+-flag2 [arg2]
  description
  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

 file2 

 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
+{{{
command foo -i f -o out -f fvalue
}}}
-Line 49:
+Line 55:
- Description

= Version =
 $ CVS ID $
+= See Also =
["othercommand1"], ["othercommand2"]
-Line 55:
+Line 59:
- JaneSmith
+JaneSmith
-Line 58:
+Line 62:
- CommandGuide
+FreeSurfer, FsFast

= References =
## For example: ["Belliveau1991"]
NameYear
-Line 61:
+Line 69:
- Report bugs to <>
+Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>

= Methods Description =
{{{
description
description
}}}
= Category =
## For example: CategoryFreeSurferCommandVolumeConversion
Category``Stream``Function