[Python-modules-commits] [pycodestyle] 01/01: Added manpage (Closes: #841174)

[Ondřej Nový]

This is an automated email from the git hooks/post-receive script.

onovy pushed a commit to branch master
in repository pycodestyle.

commit fe858d1186a04bbab7e82215de51c8a81682ddd9
Author: Ondřej Nový <onovy at debian.org>
Date:   Thu Nov 3 22:10:04 2016 +0100

    Added manpage (Closes: #841174)
---
 debian/changelog            |  6 ++++
 debian/pycodestyle.1        | 80 +++++++++++++++++++++++++++++++++++++++++++++
 debian/pycodestyle.manpages |  1 +
 3 files changed, 87 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index 4bb060c..74ee2e6 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+pycodestyle (2.0.0-2) unstable; urgency=medium
+
+  * Added manpage (Closes: #841174)
+
+ -- Ondřej Nový <onovy at debian.org>  Thu, 03 Nov 2016 22:09:56 +0100
+
 pycodestyle (2.0.0-1) unstable; urgency=medium
 
   * Initial release. (Closes: #833683)
diff --git a/debian/pycodestyle.1 b/debian/pycodestyle.1
new file mode 100644
index 0000000..1172116
--- /dev/null
+++ b/debian/pycodestyle.1
@@ -0,0 +1,80 @@
+.TH PYCODESTYLE "1" "November 2016" "pycodestyle 2.0.0" "User Commands"
+.SH NAME
+pycodestyle \- A tool to check your Python code against some of the style conventions in PEP 8.
+.SH SYNOPSIS
+.B pycodestyle
+[\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
+\fB\-v\fR, \fB\-\-verbose\fR
+print status messages, or debug with \fB\-vv\fR
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+report only file names, or nothing with \fB\-qq\fR
+.TP
+\fB\-\-exclude\fR=\fIpatterns\fR
+exclude files or directories which match these comma separated patterns (default: .svn,CVS,.bzr,.hg,.git,__pycache__,.tox)
+.TP
+\fB\-\-filename\fR=\fIpatterns\fR
+when parsing directories, only check filenames matching these comma separated patterns (default: *.py)
+.TP
+\fB\-\-select\fR=\fIerrors\fR
+select errors and warning (e.g. E,W6)
+.TP
+\fB\-\-ignore\fR=\fIerrors\fR
+skip errors and warnings (e.g. E4,W)
+(default: E121,E123,E126,E226,E24,E704,W503)
+.TP
+\fB\-\-first\fR
+show first occurrence of each error
+.TP
+\fB\-r\fR, \fB\-\-repeat\fR
+(obsolete) 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 (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\-\-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
+% pycodestyle \-\-statistics \-qq example/lib/
+.TP
+Show source code and more verbose explanation from PEP 8:
+.sp
+% pycodestyle \-\-show-source \-\-show-pep8 foo.py
+.SH AUTHOR
+This manual page was written by David Watson <dwatson at debian.org>, Michael Prokop <mika at debian.org> and Ondřej Nový <onovy at debian.org>.
diff --git a/debian/pycodestyle.manpages b/debian/pycodestyle.manpages
new file mode 100644
index 0000000..cdb7b37
--- /dev/null
+++ b/debian/pycodestyle.manpages
@@ -0,0 +1 @@
+debian/pycodestyle.1

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/pycodestyle.git