.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CPANTS_LINT 1p"
.TH CPANTS_LINT 1p "2022-06-08" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
cpants_lint \- commandline frontend to Module::CPANTS::Analyse
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    cpants_lint path/to/Foo\-Dist\-1.42.tgz
\&
\&    Options:
\&        \-\-help              brief help message
\&        \-\-man               full documentation
\&        \-\-verbose           print more info during run
\&        \-\-colour, \-\-color   pretty output
\&
\&        \-\-dump              dump result using Data::Dumper
\&        \-\-yaml              dump result as YAML
\&        \-\-json              dump result as JSON
\&
\&        \-\-save              write report (or dump) to a file
\&        \-\-dir               directory to save a report to
\&        \-\-metrics_path      search path for extra metrics modules
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`cpants_lint\*(C'\fR checks the \fBKwalitee\fR of a \s-1CPAN\s0 distribution. More exact, it checks how a given tarball will be rated on \f(CW\*(C`http://cpants.perl.org\*(C'\fR, without needing to upload it first.
.PP
For more information on Kwalitee, and the whole of \s-1CPANTS,\s0 see \f(CW\*(C`http://cpants.perl.org\*(C'\fR and / or \f(CW\*(C`Module::CPANTS::Analyse\*(C'\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.SS "\-\-help"
.IX Subsection "--help"
Print a brief help message.
.SS "\-\-man"
.IX Subsection "--man"
Print manpage.
.SS "\-\-verbose"
.IX Subsection "--verbose"
Print some informative messages while analysing a distribution.
.SS "\-\-colour, \-\-color"
.IX Subsection "--colour, --color"
Like \f(CW\*(C`\-\-verbose\*(C'\fR, but prettier. You need to install Term::ANSIColor (and Win32::Console::ANSI for Win32) to enable this option.
.SS "\-\-dump"
.IX Subsection "--dump"
Dump the result using Data::Dumper (instead of displaying a report text).
.SS "\-\-yaml"
.IX Subsection "--yaml"
Dump the result as \s-1YAML.\s0
.SS "\-\-json"
.IX Subsection "--json"
Dump the result as \s-1JSON.\s0
.PP
\fI\-\-save\fR
.IX Subsection "--save"
.PP
Output the result into a file instead of \s-1STDOUT.\s0
.PP
The name of the file will be \fIFoo\-Dist.txt\fR (well, the extension depends on the dump format and can be \f(CW\*(C`.dmp\*(C'\fR, \f(CW\*(C`.yml\*(C'\fR or \f(CW\*(C`.json\*(C'\fR)
.PP
\fI\-\-dir\fR
.IX Subsection "--dir"
.PP
Directory to dump a file to. Defaults to the current working directory.
.PP
\fI\-\-metrics_path\fR
.IX Subsection "--metrics_path"
.PP
Search path for extra metrics modules
.SH "AUTHOR"
.IX Header "AUTHOR"
Thomas Klausner <https://metacpan.org/author/domm>
.PP
Kenichi Ishigaki <https://metacpan.org/author/ishigaki>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright © 2003–2006, 2009 Thomas Klausner <https://metacpan.org/author/domm>
.PP
Copyright © 2014 Kenichi Ishigaki <https://metacpan.org/author/ishigaki>
.PP
You may use and distribute this module according to the same terms
that Perl is distributed under.