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 + hunspell with
7       tidyall
8

VERSION

10       version 0.83
11

SYNOPSIS

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

DESCRIPTION

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

INSTALLATION

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

CONFIGURATION

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

SUPPORT

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

SOURCE

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

AUTHORS

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

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