.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.19) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "Dist::Zilla::Plugin::PodSpellingTests 3pm" .TH Dist::Zilla::Plugin::PodSpellingTests 3pm "2011-08-31" "perl v5.12.4" "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" Dist::Zilla::Plugin::PodSpellingTests \- Release tests for POD spelling .SH "VERSION" .IX Header "VERSION" version 1.111520 .SH "SYNOPSIS" .IX Header "SYNOPSIS" In \f(CW\*(C`dist.ini\*(C'\fR: .PP .Vb 1 \& [PodSpellingTests] .Ve .PP or: .PP .Vb 7 \& [PodSpellingTests] \& wordlist = Pod::Wordlist \& spell_cmd = aspell list \& stopwords = CPAN \& stopwords = github \& stopwords = stopwords \& stopwords = wordlist .Ve .PP or, if you wanted to use my plugin bundle but just override this plugin's configuration: .PP .Vb 3 \& [@Filter] \& \-bundle = @MARCEL \& \-remove = PodSpellingTests \& \& [PodSpellingTests] \& wordlist = Pod::Wordlist \& spell_cmd = aspell list \& stopwords = CPAN \& stopwords = github \& stopwords = stopwords \& stopwords = wordlist .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is an extension of Dist::Zilla::Plugin::InlineFiles, providing the following file: .PP .Vb 1 \& xt/release/pod\-spell.t \- a standard Test::Spelling test .Ve .SH "METHODS" .IX Header "METHODS" .SS "wordlist" .IX Subsection "wordlist" The module name of a word list you wish to use that works with Test::Spelling. .PP Defaults to Pod::Wordlist::hanekomu. .SS "spell_cmd" .IX Subsection "spell_cmd" If \f(CW\*(C`spell_cmd\*(C'\fR is set then \f(CW\*(C`set_spell_cmd( your_spell_command );\*(C'\fR is added to the test file to allow for custom spell check programs. .PP Defaults to nothing. .SS "stopwords" .IX Subsection "stopwords" If stopwords is set then \f(CW\*(C`add_stopwords( )\*(C'\fR is added to the test file and the words are added after the \f(CW\*(C`_\|_DATA_\|_\*(C'\fR section. .PP \&\f(CW\*(C`stopwords\*(C'\fR can appear multiple times, one word per line. .PP Normally no stopwords are added by default, but author names appearing in \&\f(CW\*(C`dist.ini\*(C'\fR are automatically added as stopwords so you don't have to add them manually just because they might appear in the \f(CW\*(C`AUTHORS\*(C'\fR section of the generated \s-1POD\s0 document. .SH "INSTALLATION" .IX Header "INSTALLATION" See perlmodinstall for information and options on installing Perl modules. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .PP Please report any bugs or feature requests through the web interface at http://rt.cpan.org/Public/Dist/Display.html?Name=Dist\-Zilla\-Plugin\-PodSpellingTests . .SH "AVAILABILITY" .IX Header "AVAILABILITY" The latest version of this module is available from the Comprehensive Perl Archive Network (\s-1CPAN\s0). Visit to find a \s-1CPAN\s0 site near you, or see http://search.cpan.org/dist/Dist\-Zilla\-Plugin\-PodSpellingTests/ . .PP The development version lives at http://github.com/hanekomu/Dist\-Zilla\-Plugin\-PodSpellingTests and may be cloned from git://github.com/hanekomu/Dist\-Zilla\-Plugin\-PodSpellingTests.git . Instead of sending patches, please fork this project using the standard git and github infrastructure. .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Marcel Gruenauer .IP "\(bu" 4 Harley Pig .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2010 by Marcel Gruenauer. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.