.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "COUNTPERL 1p"
.TH COUNTPERL 1p "2021-03-24" "perl v5.32.1" "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"
countperl \- count lines, packages, subs and complexity of Perl files.
.SH "USAGE"
.IX Header "USAGE"
\&\fBcountperl\fR \fI\s-1FILE_OR_DIRECTORY\s0\fR [\fI\s-1FILE_OR_DIRECTORY\s0\fR ...] [\-\-html] [\-\-help] [\-\-method\-modifiers=a,b,c]
.SH "REQUIRED ARGUMENTS"
.IX Header "REQUIRED ARGUMENTS"
At least one file or directory path must be supplied.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-\-help" 4
.IX Item "--help"
Prints documentation to \s-1STDERR.\s0
.IP "\-\-html" 4
.IX Item "--html"
Produces \s-1HTML\s0 output instead of the plain-text default.
.IP "\-\-json" 4
.IX Item "--json"
Produces \s-1JSON\s0 output instead of the plain-text default.
.IP "\-\-method\-modifiers=a,b,c" 4
.IX Item "--method-modifiers=a,b,c"
A comma-separated list of method modifiers to be recognised, see
Moose::Manual::MethodModifiers for details. If unspecified, the
default list is before,after,around.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
N/A. Currently no support for any configuration files.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
Exits zero on success, non-zero on failure.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIcountperl\fR uses \fBPerl::Metrics::Simple\fR to examines the named files and
recursivesly searches named directories for Perl files.
.PP
Perl files are identified by \fBPerl::Metrics::Simple\->is_perl_file\fR. Basically
if the file ends in \f(CW\*(C`.pl\*(C'\fR, \f(CW\*(C`.pm\*(C'\fR, or \f(CW\*(C`.t\*(C'\fR or has what appears to be a perl
\&\fIshebang\fR line.
.PP
\&\fIcountperl\fR produces a report on \fI\s-1STDOUT\s0\fR of counts of total lines,
packages, subroutines/methods,
the minimum, maximum, mean, standard deviation, and median size and
mccabe_complexity (cyclomatic complexity) of subroutines and
the 'main' portion of each file (everything not in a subroutine.)
.SS "Output Format"
.IX Subsection "Output Format"
Line counts do not include comments nor pod.
.PP
The current output format is human-readable text:
.PP
.Vb 1
\&    Perl files found:                3
\&
\&    Counts
\&    \-\-\-\-\-\-
\&    total code lines:       856
\&    lines of non\-sub code:  450
\&    packages found:           3
\&    subs/methods:            42
\&
\&    Subroutine/Method Size
\&    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&    min:                  3 lines
\&    max:                  32 lines
\&    mean:                 9.67 lines
\&    std. deviation:       7.03
\&    median:               7.50
\&
\&    McCabe Complexity
\&    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&    Code not in any subroutine::
\&    min:                  1
\&    max                   1
\&    mean:                 1.00
\&    std. deviation:       0.00
\&    median:               1.00
\&
\&    Subroutines/Methods:
\&    min:                  1
\&    max:                  5
\&    avg:                  1.00
\&    std. deviation:       1.36
\&    median:               1.00
\&
\&    Tab\-delimited list of subroutines, with most complex at top
\&    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&    complexity      sub     path    size
\&    5       is_perl_file    lib/Perl/Metrics/Simple.pm      11
\&    5       _has_perl_shebang       lib/Perl/Metrics/Simple.pm      13
\&    5       _init   lib/Perl/Metrics/Simple/Analysis/File.pm        30
\&    4       find_files      lib/Perl/Metrics/Simple.pm      11
\&    4       new     lib/Perl/Metrics/Simple/Analysis.pm     10
\&    4       is_ref  lib/Perl/Metrics/Simple/Analysis.pm     8
.Ve
.PP
With \-\-html switch output format is \s-1HTML.\s0
.SH "VERSION"
.IX Header "VERSION"
This is version 0.031 of \fIcountperl\fR.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Prints usage message to \s-1STDERR\s0 if required arguments are not provided.
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None known.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
.SS "Bugs No bugs reported yet :\-) See: http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl\-Metrics\-Simple"
.IX Subsection "Bugs No bugs reported yet :-) See: http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl-Metrics-Simple"
.SS "Limitations"
.IX Subsection "Limitations"
.IP "Does not accept input from \s-1STDIN.\s0" 4
.IX Item "Does not accept input from STDIN."
.PD 0
.IP "No machine-readable report format available (e.g. \s-1XML,\s0 tab-delimited)" 4
.IX Item "No machine-readable report format available (e.g. XML, tab-delimited)"
.PD
.SH "SUPPORT"
.IX Header "SUPPORT"
Via \s-1CPAN:\s0
.SS "Disussion Forum"
.IX Subsection "Disussion Forum"
http://www.cpanforum.com/dist/Perl\-Metrics\-Simple
.SS "Bug Reports"
.IX Subsection "Bug Reports"
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Perl\-Metrics\-Simple
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
.IP "Perl::Metrics::Simple 0.13 (which depends upon \s-1PPI\s0.)" 4
.IX Item "Perl::Metrics::Simple 0.13 (which depends upon PPI.)"
.PD 0
.IP "Pod::Usage" 4
.IX Item "Pod::Usage"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\s-1PPI\s0" 4
.IX Item "PPI"
.PD 0
.IP "Perl::Critic" 4
.IX Item "Perl::Critic"
.IP "Perl::Metrics" 4
.IX Item "Perl::Metrics"
.IP "http://en.wikipedia.org/wiki/Cyclomatic_complexity" 4
.IX Item "http://en.wikipedia.org/wiki/Cyclomatic_complexity"
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 5
\&    Matisse Enzer
\&    CPAN ID: MATISSE
\&    Eigenstate Consulting, LLC
\&    matisse@eigenstate.net
\&    http://www.eigenstate.net/
.Ve
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.