---
name: "Code::TidyAll::Plugin::PodSpell"
section: "3pm"
platform: "linux"
package: "libcode-tidyall-perl"
version: "0.84~ds-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Code::TidyAll::Plugin::PodSpell"
---

# Code::TidyAll::Plugin::PodSpell(3pm)

Use Pod::Spell + ispell with tidyall

## NAME

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

## VERSION

version 0.84

## 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

This plugin accepts the following configuration options:

### ispell\_argv

Arguments to pass to ispell. The "-a" flag will always be passed, in order to parse the results.

### ispell\_cmd

The path for the `"ispell"` command. By default this is just `"ispell"`, meaning that the user's `"PATH"` will be searched for the command.

### suggest

If true, show suggestions next to misspelled words. Default is false.

## SUPPORT

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

## SOURCE

The source code repository for Code-TidyAll can be found at \<https://github.com/houseabsolute/perl-code-tidyall\>.

## AUTHORS

- •

  Jonathan Swartz \<swartz@pobox.com\>

- •

  Dave Rolsky \<autarch@urth.org\>

## COPYRIGHT AND LICENSE

This software is copyright (c) 2011 - 2023 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.

The full text of the license can be found in the *LICENSE* file included with this distribution.