.\" 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 .\" .\" 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::Test::PodSpelling 3pm" .TH Dist::Zilla::Plugin::Test::PodSpelling 3pm "2022-10-14" "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" Dist::Zilla::Plugin::Test::PodSpelling \- Author tests for POD spelling .SH "VERSION" .IX Header "VERSION" version 2.007005 .SH "SYNOPSIS" .IX Header "SYNOPSIS" In \f(CW\*(C`dist.ini\*(C'\fR: .PP .Vb 1 \& [Test::PodSpelling] .Ve .PP or: .PP .Vb 8 \& [Test::PodSpelling] \& directory = docs \& wordlist = Pod::Wordlist \& spell_cmd = aspell list \& stopword = CPAN \& stopword = github \& stopword = stopwords \& stopword = wordlist .Ve .PP If you're using \f(CW\*(C`[ExtraTests]\*(C'\fR it must come after \f(CW\*(C`[Test::PodSpelling]\*(C'\fR, it's worth noting that this ships in the \f(CW\*(C`[@Basic]\*(C'\fR bundle so you may have to remove it from that first. .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is a plugin that runs at the gather files stage, providing the file: .PP .Vb 1 \& xt/author/pod\-spell.t \- a standard Test::Spelling test .Ve .PP Test::Spelling will be added as a develop prerequisite. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .SS "directories (or directory)" .IX Subsection "directories (or directory)" Additional directories you wish to search for \s-1POD\s0 spell checking purposes. \&\f(CW\*(C`bin\*(C'\fR and \f(CW\*(C`lib\*(C'\fR are set by default. .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. .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`stopword\*(C'\fR or \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. The same goes for contributors listed under the \&'x_contributors' field on your distributions \s-1META\s0 file. .SH "METHODS" .IX Header "METHODS" .SS "add_stopword" .IX Subsection "add_stopword" Called to add stopwords to the stopwords array. It is used to determine if automagically detected words are valid and print out debug logging for the process. .SH "SUPPORT" .IX Header "SUPPORT" Bugs may be submitted through the \s-1RT\s0 bug tracker (or bug\-Dist\-Zilla\-Plugin\-Test\-PodSpelling@rt.cpan.org ). .PP There is also a mailing list available for users of this distribution, at . .PP There is also an irc channel available for users of this distribution, at \&\f(CW\*(C`#distzilla\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR . .PP I am also usually active on irc, as 'ether' at \f(CW\*(C`irc.perl.org\*(C'\fR. .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Caleb Cushing .IP "\(bu" 4 Marcel Gruenauer .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 Karen Etheridge .IP "\(bu" 4 Randy Stauner .IP "\(bu" 4 Graham Knop .IP "\(bu" 4 David Golden .IP "\(bu" 4 Harley Pig .IP "\(bu" 4 Alexandr Ciornii .IP "\(bu" 4 Breno G. de Oliveira .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is Copyright (c) 2010 by Karen Etheridge. .PP This is free software, licensed under: .PP .Vb 1 \& The Artistic License 2.0 (GPL Compatible) .Ve