.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.7.
.TH CODESPELL "1" "October 2018" "codespell 1.14.0" "User Commands"
.SH NAME
codespell \- detect spelling mistakes in source code
.SH SYNOPSIS
\fBcodespell\fR [OPTIONS] [file1 file2 ... fileN]
.SH DESCRIPTION
.PP
codespell is designed to find and fix common misspellings in text files.
It is designed primarily for checking misspelled words in source code,
but it can be used with other files as well.
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-d\fR, \fB\-\-disable\-colors\fR
disable colors even when printing to terminal (always
on for Windows)
.TP
\fB\-c\fR, \fB\-\-enable\-colors\fR
enable colors even when not printing to terminal
.TP
\fB\-w\fR, \fB\-\-write\-changes\fR
write changes in place if possible
.TP
\fB\-D\fR FILE, \fB\-\-dictionary\fR=\fI\,FILE\/\fR
Custom dictionary file that contains spelling
corrections. If this flag is not specified or equals
"\-" then the default dictionary is used. This option
can be specified multiple times.
.TP
\fB\-I\fR FILE, \fB\-\-ignore\-words\fR=\fI\,FILE\/\fR
File that contains words which will be ignored by
codespell. File must contain 1 word per line. Words
are case sensitive based on how they are written in
codespell_lib/data/dictionary.txt
.TP
\fB\-L\fR WORDS, \fB\-\-ignore\-words\-list\fR=\fI\,WORDS\/\fR
Comma separated list of words to be ignored by
codespell. Words are case sensitive based on how they
are written in codespell_lib/data/dictionary.txt
.TP
\fB\-r\fR REGEX, \fB\-\-regex\fR=\fI\,REGEX\/\fR
Regular expression which is used to find words. By
default any alphanumeric character, the underscore,
the hyphen, and the apostrophe is used to build words
(i.e. [\ew\e\-'?`]+). This option cannot be specified
together with the write\-changes functionality.
.TP
\fB\-s\fR, \fB\-\-summary\fR
print summary of fixes
.TP
\fB\-S\fR SKIP, \fB\-\-skip\fR=\fI\,SKIP\/\fR
Comma\-separated list of files to skip. It accepts
globs as well. E.g.: if you want codespell to skip
\&.eps and .txt files, you'd give "*.eps,*.txt" to this
option.
.TP
\fB\-x\fR FILE, \fB\-\-exclude\-file\fR=\fI\,FILE\/\fR
FILE with lines that should not be changed
.TP
\fB\-i\fR INTERACTIVE, \fB\-\-interactive\fR=\fI\,INTERACTIVE\/\fR
Set interactive mode when writing changes. 0 is the
same as no interactivity; 1 makes codespell ask for
confirmation; 2 ask user to choose one fix when more
than one is available; 3 applies both 1 and 2
.TP
\fB\-q\fR QUIET_LEVEL, \fB\-\-quiet\-level\fR=\fI\,QUIET_LEVEL\/\fR
Bitmask that allows codespell to run quietly. 0: the
default, in which all messages are printed. 1: disable
warnings about wrong encoding. 2: disable warnings
about binary file. 4: shut down warnings about
automatic fixes that were disabled in dictionary. 8:
don't print anything for non\-automatic fixes. 16:
don't print fixed files.
.TP
\fB\-e\fR, \fB\-\-hard\-encoding\-detection\fR
Use chardet to detect the encoding of each file. This
can slow down codespell, but is more reliable in
detecting encodings other than utf\-8, iso8859\-1 and
ascii.
.TP
\fB\-f\fR, \fB\-\-check\-filenames\fR
Check file names as well.
.TP
\fB\-H\fR, \fB\-\-check\-hidden\fR
Check hidden files (those starting with ".") as well.
.SH AUTHOR
Lucas De Marchi <lucas.de.marchi@gmail.com>
.SH "SEE ALSO"
https://github.com/codespell-project/codespell