1Code::TidyAll::Plugin::UPsoedrSpCeolnlt(r3i)buted Perl DCoocduem:e:nTtiadtyiAolnl::Plugin::PodSpell(3)
2
3
4

NAME

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

VERSION

9       version 0.82
10

SYNOPSIS

12          In configuration:
13
14          [PodSpell]
15          select = lib/**/*.{pm,pod}
16          ispell_argv = -p $ROOT/.ispell_english
17          suggest = 1
18

DESCRIPTION

20       Uses Pod::Spell in combination with ispell <http://fmg-
21       www.cs.ucla.edu/geoff/ispell.html> to spell-check POD. Any seemingly
22       misspelled words will be output one per line.
23
24       You can specify additional valid words by:
25
26       •   Adding them to your personal ispell dictionary, e.g.
27           ~/.ispell_english
28
29       •   Adding them to an ispell dictionary in the project root, then
30           including this in the configuration:
31
32               ispell_argv = -p $ROOT/.ispell_english
33
34       The dictionary file should contain one word per line.
35

INSTALLATION

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

CONFIGURATION

40       This plugin accepts the following configuration options:
41
42   ispell_argv
43       Arguments to pass to ispell. The "-a" flag will always be passed, in
44       order to parse the results.
45
46   ispell_cmd
47       The path for the "ispell" command. By default this is just "ispell",
48       meaning that the user's "PATH" will be searched for the command.
49
50   suggest
51       If true, show suggestions next to misspelled words. Default is false.
52

SUPPORT

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

SOURCE

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

AUTHORS

62       •   Jonathan Swartz <swartz@pobox.com>
63
64       •   Dave Rolsky <autarch@urth.org>
65

67       This software is copyright (c) 2011 - 2022 by Jonathan Swartz.
68
69       This is free software; you can redistribute it and/or modify it under
70       the same terms as the Perl 5 programming language system itself.
71
72       The full text of the license can be found in the LICENSE file included
73       with this distribution.
74
75
76
77perl v5.34.1                      2022-04-19Code::TidyAll::Plugin::PodSpell(3)
Impressum