diff options
| author | Gurusamy Sarathy <gsar@cpan.org> | 2000-03-11 16:02:53 +0000 |
|---|---|---|
| committer | Gurusamy Sarathy <gsar@cpan.org> | 2000-03-11 16:02:53 +0000 |
| commit | 39a979071e199f758bf7a4717d7350ad29106ba2 (patch) | |
| tree | f16cae92bdfde27071863fdac1bf1ab5dc987ecb /pod/perlpod.pod | |
| parent | 286fb5aa0519c676a30f964202b99f6d0a01f8f5 (diff) | |
| download | perl-39a979071e199f758bf7a4717d7350ad29106ba2.tar.gz | |
mention podchecker (from Tim Jenness <timj@jach.hawaii.edu>)
p4raw-id: //depot/perl@5648
Diffstat (limited to 'pod/perlpod.pod')
| -rw-r--r-- | pod/perlpod.pod | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/pod/perlpod.pod b/pod/perlpod.pod index f4725ba790..97112eecef 100644 --- a/pod/perlpod.pod +++ b/pod/perlpod.pod @@ -294,10 +294,10 @@ use the form LE<lt>show this text|fooE<gt> instead. =item * -The script F<pod/checkpods.PL> in the Perl source distribution -provides skeletal checking for lines that look empty but aren't -B<only>, but is there as a placeholder until someone writes -Pod::Checker. The best way to check your pod is to pass it through +The F<L<podchecker|podchecker>> command is provided to check pod syntax +for errors and warnings. For example, it checks for completely +blank lines in pod segments and for unknown escape sequences. +It is still advised to pass it through one or more translators and proofread the result, or print out the result and proofread that. Some of the problems found may be bugs in the translators, which you may or may not wish to work around. @@ -306,7 +306,8 @@ the translators, which you may or may not wish to work around. =head1 SEE ALSO -L<pod2man> and L<perlsyn/"PODs: Embedded Documentation"> +L<pod2man>, L<perlsyn/"PODs: Embedded Documentation">, +L<podchecker> =head1 AUTHOR |