This page provides a description of the headings in the CommandTemplate. Adherence to the this format helps maintain a consistent style specification across all of the commands in FreeSurfer.

Name - Name of command followed by a dash (-) followed by a very brief summary. Eg, mri_info - provides informtion about volume.

Synopsis - Command usage. Options should be placed in square brackets and required arguments should just be written as text, e.g., mri_info [-m] [-o outputfile] inputfile. If there are too many options then use the placeholder <options>, e.g., mri_info <options> inputfile.


Outputs - Name, description, and file format of volumes ouput by the command.

Description - Detailed description of command including relevant concepts.


Bugs - Known bugs. Note that bugs should not be reported here. Rather, bug reports should be sent to the relevant support line.

See Also - Related commands in FreeSurfer.

Links - Relevant links on FreeSurferWiki.

Methods Description - Description of command which would be suitable for publication in a manuscript. As much as possible, the text should be copy-and-pastable into the Methods section of the manuscript. No Wiki formmating should be used in this section.

References - Relevant references. The reference can be posted in the ["References"] section.

Reporting Bugs - Where to report bugs.

Author/s - Author/s of command.