Table Of Contents

help-rst

Synopsis

help-rst [-h] [-output file] [-output-brief-description file]
[-synopsis] [-description]
[-include-description INCLUDE_DESCRIPTION] [-arguments]
[-examples] [-noheaders] [-generated] [-orphan]
command_name

Description

No description available.

Arguments

command_name

Name of MIRTK command.

Command options

-h, --help

show this help message and exit

-output file

Write help to specified output file. (default: STDOUT)

-output-brief-description file

Write brief description to specified output file.

-synopsis

Output command synopsis/brief usage.

-description

Output command description.

-include-description INCLUDE_DESCRIPTION

Include description from specified file.

-arguments

Output command arguments.

-examples

Output command examples.

-noheaders

Do not print section headers.

-generated

Add comment noting that file was generated

-orphan

Add :orphan: in first line to silence warnings if document not included