Scroll to navigation

Code::TidyAll::Plugin::PodSpell(3pm) User Contributed Perl Documentation Code::TidyAll::Plugin::PodSpell(3pm)

NAME

Code::TidyAll::Plugin::PodSpell - Use Pod::Spell + ispell with tidyall

VERSION

version 0.55

SYNOPSIS

   In configuration:

   [PodSpell]
   select = lib/**/*.{pm,pod}
   ispell_argv = -p $ROOT/.ispell_english
   suggest = 1

DESCRIPTION

Uses Pod::Spell in combination with ispell <http://fmg-www.cs.ucla.edu/geoff/ispell.html> to spell-check POD. Any seemingly misspelled words will be output one per line.

You can specify additional valid words by:

  • Adding them to your personal ispell dictionary, e.g. ~/.ispell_english
  • Adding them to an ispell dictionary in the project root, then including this in the configuration: 

        ispell_argv = -p $ROOT/.ispell_english

The dictionary file should contain one word per line.

INSTALLATION

Install ispell from your package manager or from the link above.

CONFIGURATION

ispell_argv
Arguments to pass to ispell. "-a" will always be passed, in order to parse the results.
ispell_cmd
Full path to ispell
suggest
If true, show suggestions next to misspelled words. Default is false.

SUPPORT

Bugs may be submitted through <https://github.com/houseabsolute/perl-code-tidyall/issues>.

I am also usually active on IRC as 'drolsky' on "irc://irc.perl.org".

AUTHORS

  • Jonathan Swartz <swartz@pobox.com>
  • Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 - 2016 by Jonathan Swartz.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2017-01-06 perl v5.24.1