.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" 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 "Module::CPANTS::Analyse 3" .TH Module::CPANTS::Analyse 3 "2008-01-07" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Module::CPANTS::Analyse \- Generate Kwalitee ratings for a distribution .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 9 \& my $analyser=Module::CPANTS::Analyse( \& { \& dist=>'path/to/Foo-Bar-1.42.tgz', \& } \& ); \& $a->unpack; \& $a->analyse; \& $a->calc_kwalitee; \& # results are in $a->d; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" .Sh "Methods" .IX Subsection "Methods" \fInew\fR .IX Subsection "new" .PP .Vb 1 \& my $analyser=Module::CPANTS::Analyse->new({dist=>'path/to/file'}); .Ve .PP Plain old constructor. .PP \fIunpack\fR .IX Subsection "unpack" .PP Unpack the distribution into a temporary directory. .PP Returns an error if something went wrong, \f(CW\*(C`undef\*(C'\fR if all went well. .PP \fIanalyse\fR .IX Subsection "analyse" .PP Run all analysers (defined in \f(CW\*(C`Module::CPANTS::Kwalitee::*\*(C'\fR on the dist. .PP \fIcalc_kwalitee\fR .IX Subsection "calc_kwalitee" .PP Check if the dist conforms to the Kwalitee indicators. .Sh "Helper Methods" .IX Subsection "Helper Methods" \fItestdir\fR .IX Subsection "testdir" .PP Returns the path to the unique temp directory. .PP \fItestfile\fR .IX Subsection "testfile" .PP Returns the location of the unextracted tarball. .PP \fItarball\fR .IX Subsection "tarball" .PP Returns the filename of the tarball. .PP \fIread_meta_yml\fR .IX Subsection "read_meta_yml" .PP Reads the \s-1META\s0.yml file and returns its content. .SH "WEBSITE" .IX Header "WEBSITE" http://cpants.perl.org/ .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests, or send any patches, to bug-module-cpants-analyse at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module\-CPANTS\-Analyse. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "AUTHOR" .IX Header "AUTHOR" Thomas Klausner, , http://domm.zsi.at .PP Please use the perl-qa mailing list for discussing all things \s-1CPANTS:\s0 http://lists.perl.org/showlist.cgi?name=perl\-qa .PP Based on work by Leon Brocard and the original idea proposed by Michael G. Schwern .SH "LICENSE" .IX Header "LICENSE" This code is Copyright (c) 2003\-2006 Thomas Klausner. All rights reserved. .PP You may use and distribute this module according to the same terms that Perl is distributed under.