Several options have been introduced since pep8 0.4.2 and some of them are gone. List of options as presented by `pep8 --help` output, and while at it also include some useful usage examples.
Closes: #749468 --- pep8.1 | 56 ++++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 44 insertions(+), 12 deletions(-) diff --git a/pep8.1 b/pep8.1 index 376f0f4..9a17236 100644 --- a/pep8.1 +++ b/pep8.1 @@ -1,4 +1,4 @@ -.TH PEP8 "1" "October 2009" "pep8 0.4.2" "User Commands" +.TH PEP8 "1" "May 2014" "pep8 1.4.6" "User Commands" .SH NAME pep8 \- A tool to check your Python code against some of the style conventions in PEP 8. .SH SYNOPSIS @@ -6,6 +6,9 @@ pep8 \- A tool to check your Python code against some of the style conventions i [\fIoptions\fR] \fIinput \fR... .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 @@ -15,34 +18,63 @@ print status messages, or debug with \fB\-vv\fR \fB\-q\fR, \fB\-\-quiet\fR report only file names, or nothing with \fB\-qq\fR .TP +\fB\-r\fR, \fB\-\-repeat\fR +(obsolete) show all occurrences of the same error +.TP +\fB\--first\fR +show first occurrence of each error +.TP \fB\-\-exclude\fR=\fIpatterns\fR -skip matches (default .svn,CVS,*.pyc,*.pyo) +exclude files or directories which match these comma separated patterns (default: .svn,CVS,.bzr,.hg,.git,__pycache__) .TP \fB\-\-filename\fR=\fIpatterns\fR -only check matching files (e.g. *.py) +when parsing directories, only check filenames matching these comma separated patterns (default: *.py) +.TP +\fB\-\-select\fR=\fIerrors\fR +select errors and warnings (e.g. E,W6) .TP \fB\-\-ignore\fR=\fIerrors\fR skip errors and warnings (e.g. E4,W) .TP -\fB\-\-repeat\fR -show all occurrences of the same error -.TP \fB\-\-show\-source\fR show source code for each error .TP \fB\-\-show\-pep8\fR -show text of PEP 8 for each error +show text of PEP 8 for each error (implies --first) .TP \fB\-\-statistics\fR count errors and warnings .TP +\fB\-\-count\fR +print total number of errors and warnings to standard error and set exit code to 1 if total is not null +.TP +\fB\-\-max\-line\-length\fR=\fIn\fR +set maximum allowed line length (default: 79) +.TP +\fB\-\-hang-closing\fR +hang closing bracket instead of matching indentation of opening bracket's line +.TP +\fB\-\-format\fR=\fIformat\fR +set the error format [default|pylint|<custom>] +.TP +\fB\-\-diff\fR +report only lines changed according to the unified diff received on STDIN +.TP \fB\-\-benchmark\fR measure processing speed .TP -\fB\-\-testsuite\fR=\fIdir\fR -run regression tests from dir +\fB\-\-config\fR=\fIpath\fR +user config file location (default: $HOME/.config/pep8) +.TP +.SH "USAGE EXAMPLES" +.TP +Display how often each error was found: +.sp +% pep8 --statistics -qq example/lib/ +.TP +Show source code and more verbose explanation from PEP 8: +.sp +% pep8 --show-source --show-pep8 foo.py .TP -\fB\-\-doctest\fR -run doctest on myself .SH AUTHOR -This manual page was written by David Watson <da...@bashton.com>. +This manual page was written by David Watson <da...@bashton.com> and Michael Prokop <m...@debian.org>. -- 1.9.0 -- To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org
