perl-pod / Pod-Spell

Pod::Spell perl module
https://metacpan.org/pod/Pod::Spell
4 stars 8 forks source link

Improve POD in podspell script #25

Open kentfredric opened 8 years ago

kentfredric commented 8 years ago

Presently, the POD in the podspell script is not very useful, especially not when it gets converted to man format during installation.

Gentoo have for example, inherited the following custom alternative man page from debian, and are shipping it instead of the man page that is automatically generated.

podspell(1)                                                        podspell(1)

NAME
       podspell  -  a formatter for spell checking Pod(Plain Old Documentation
       format)

SYNTAX
       podspell <filename.pm>

DESCRIPTION
       podspell is an implementation of Pod::Spell(3pm); it is a Pod formatter
       whose output is good for spell checking.

       podspell  could  be  use to pipe an output to spell(1) or ispell(1), or
       can be use to redirect the output to a file ej.  > temp.txt ), and then
       open the text file in your word processor for spell-checking.

       podspell is provided by Pod::Spell Module package.

AUTHORS
       This manual page was written by Rene  Mayorga  <rmayorga@debian.org.sv>
       for  the  Debian  system  (but  may  be used by others).  Permission is
       granted to copy, distribute and/or modify this document under the terms
       of  the  GNU  General  Public License, Version 2 any later version pub‐
       lished by the Free Software Foundation.

       On Debian systems, the complete text of the GNU General Public  License
       can be found in /usr/share/common-licenses/GPL.

SEE ALSO
       Pod::Spell(3pm)

Debian Project                   23 Oct. 2007                      podspell(1)

If something along these lines was incorporated by default, no local supplementation would be necessary.

dolmen commented 8 years ago

:+1: fo the idea.

@rmayorga is the author of this man page. But I would prefer a POD document that follows more Perl conventions: NAME/SYNOPSIS/DESCRIPTION... So I will probably write it myself rather than asking relicensing for strict reuse. Unless one contributor proposes something...