.TH RSTCHECK 1 "" "6.1.1+~1.0.3" "Text Processing Tools"
.SH NAME
rstcheck \- check syntax of reStructuredText files and nested code blocks
.SH SYNOPSIS
.SY rstcheck
.OP \-\-config FILE
.OP \-r
.OP \-\-report LEVEL
.OP \-\-ignore\-language LANG
.OP \-\-ignore\-messages MSG
.OP \-\-ignore\-directives DIR
.OP \-\-ignore\-substitutions SUB
.OP \-\-ignore\-roles ROLES
.I FILE.rst
.RI [ FILE.rst
.IR .\|.\|. ]
.YS
.SH DESCRIPTION
.B rstcheck
validates the syntax of reStructuredText files and can also verify the syntax
for a number of languages in nested code blocks:
.IP \(bu
Bash
.IP \(bu
Doctest
.IP \(bu
C (C99)
.IP \(bu
C++ (C++11)
.IP \(bu
JSON
.IP \(bu
XML
.IP \(bu
Python
.IP \(bu
restructuredTest
.SH OPTIONS
.TP
.BR \-\-config " " \fIFILE\fR
load configuration from
.IR FILE .
The configuration is expected in INI file format with a section
.B [rstcheck]
and key-value pairs which correspond with command line options.
.TP
.BR \-r ", " \-\-recursive
Treat input file names as directories and recursively check all
.B .rst
files within.
.TP
.BR \-\-report " " \fILEVEL\fR
restrict reported severities to
.I LEVEL
or higher.
Valid levels in increasing order of severity are:
.BR info ", " warning ", " error ", " severe .
You can also specify
.B none
to suppress all output.
.TP
.BR \-\-ignore\-language " " \fILANG\fR ", " \-\-ignore " " \fILANG\fR
Ignore code blocks with one of the languages
.IR LANG ,
where
.I LANG
is a comma-separated list of code block language identifiers. You can also
disable language checking with a block comment such as
.IP
.EX
\&.. rstcheck: ignore-language=cpp,python,rst
.EE
.IP
near the beginning of the input file.
.TP
.BR \-\-ignore\-messages " " (\fIMSG\fB)\fR
Ignore all messages that match the regular expression
.IR MSG .
Note that you will probably need to quote the regex to prevent spurious
shell expansion:
.IP
.EX
"(Title underline too short.*|Duplicate implicit target.*)"
.EE
.TP
.BR \-\-ignore\-directives \fIDIR\fR
Ignore any rST directives from the comma-separated list
.IR DIR .
.TP
.BR \-\-ignore\-substitutions \fISUB\fR
Ignore any rST substitutions from the comma-separated list
.IR SUB .
.TP
.BR \-\-ignore\-roles \fIROLES\fR
Ignore any rST roles from the comma-separated list
.IR ROLES .
.SH INTEGRATION WITH VIM
You can instruct
.B Syntastic
to check
.B .rst
files with
.B rstcheck
like this:
.PP
.EX
let g:syntastic_rst_checkers = ['rstcheck']
.EE
.PP
ALE will detect the presence of
.B rstcheck
automatically, no additional configuration is required.
.SH AUTHOR
.B rstcheck
was written by Steven Myint. This manual page was written by
.MT roehling@debian.org
Timo R\[u00F6]hling
.ME
for Debian and may be reused without restriction.