'\" t
.\"     Title: pylama
.\"    Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 11/16/2022
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "PYLAMA" "1" "11/16/2022" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pylama \- code audit tool for Python
.SH "SYNOPSYS"
.sp
\fBpylama\fR [\fI\-h\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR] [\fI\-\-format {pep8, pylint}\fR] [\fI\-\-select SELECT\fR] [\fI\-\-sort SORT\fR] [\fI\-\-linters LINTERS\fR] [\fI\-\-ignore IGNORE\fR] [\fI\-\-skip SKIP\fR] [\fI\-\-report REPORT\fR] [\fI\-\-hook\fR] [\fI\-\-async\fR] [\fI\-\-options OPTIONS\fR] [\fI\-\-force\fR] [\fI\-\-abspath\fR] [\fIpaths\fR [\fIpaths \&...\fR]]
.SH "OPTIONS"
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
show the help message and exit
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
verbose mode
.RE
.PP
\fB\-\-version\fR
.RS 4
show program\(cqs version number and exit
.RE
.PP
\fB\-f {pep8, pylint}\fR, \fB\-\-format {pep8, pylint}\fR
.RS 4
Choose errors format (pep8, pylint)\&.
.RE
.PP
\fB\-s SELECT\fR, \fB\-\-select SELECT\fR
.RS 4
Select errors and warnings\&. (comma\-separated list)
.RE
.PP
\fB\-\-sort SORT\fR
.RS 4
Sort result by error types\&. Ex\&. E, W, D
.RE
.PP
\fB\-l LINTERS\fR, \fB\-\-linters LINTERS\fR
.RS 4
Select linters\&. (comma\-separated)\&. Choices are pyflakes, pep8, pep257, mccabe\&.
.RE
.PP
\fB\-i IGNORE\fR, \fB\-\-ignore IGNORE\fR
.RS 4
Ignore errors and warnings\&. (comma\-separated)
.RE
.PP
\fB\-\-skip SKIP\fR
.RS 4
Skip files by masks (comma\-separated, Ex\&.
\fB*/messages\&.py\fR)
.RE
.PP
\fB\-r REPORT\fR, \fB\-\-report REPORT\fR
.RS 4
Send report to file [REPORT]
.RE
.PP
\fB\-\-hook\fR
.RS 4
Install Git (Mercurial) hook\&.
.RE
.PP
\fB\-\-async\fR
.RS 4
Enable async mode\&. Useful for checking a lot of files\&. Unsupported with pylint\&.
.RE
.PP
\fB\-o FILE\fR, \fB\-\-options FILE\fR
.RS 4
Specify configuration file\&. Looks for pylama\&.ini, setup\&.cfg, tox\&.ini, or pytest\&.ini in the current directory\&.
.RE
.PP
\fB\-F\fR, \fB\-\-force\fR
.RS 4
Force code checking (if linter doesn\(cqt allow)
.RE
.PP
\fB\-a\fR, \fB\-\-abspath\fR
.RS 4
Use absolute paths in output\&.
.RE
.SH "AUTHOR"
.sp
This manual page was written by ChangZhuo Chen \fI<\fR\fIczchen@debian\&.org\fR\fI>\fR for the \fBDebian GNU/Linux system\fR (but may be used by others)\&.