GNU ELPA - perl-doc

perl-doc

Description
Read Perl documentation
Latest
perl-doc-0.6.tar, 2022-Sep-29, 30.0 KiB
Maintainer
Harald Jörg <haj@posteo.de>
Website
https://github.com/HaraldJoerg/emacs-perl-doc
Browse ELPA's repository
CGit or Gitweb
Badge

To install this package, run in Emacs:

M-x package-install RET perl-doc RET

Full description

This file contains a command to read Perl documentation in Emacs.
It uses two external commands which come with Perl: `perldoc` to
locate the Perl documentation for the Perl modules installed on
your system, and `pod2html` to format the documentation to HTML.
This HTML version is then displayed using Emacs' "simple HTML
renderer" shr.

Motivation

Perl documentation is written in a markup format called POD ("Plain
Old Documentation") and is usually converted to other formats for
reading by humans.  The documentation used to be available in Emacs
for a long time in 'info' or 'man' format.  However, Perl does no
longer ship 'info' files, and the software available from CPAN
never did.  'man' is not available on all platforms and allows only
rather restricted formatting, most notably linking between
documents does not work.

On the other hand, Perl provides a converter from POD to HTML.
HTML is well supported by Emacs and is well suited for presentation
of structured documents.

The user visible benefits over the other formats are:

 * Works nicely on platforms which do not have man

 * Unlike with 'man', Hyperlinks between POD documents work and
  resolve to POD documentation on your system, no web server
  required.

 * Makes use of Emacs faces: variable-pitch font for text,
   fixed-pitch for code, italics for, well, italics

Old versions

perl-doc-0.4.tar.lz2022-Sep-278.23 KiB
perl-doc-0.2.tar.lz2022-Aug-077.25 KiB

News

perl-doc.el for GNU Emacs NEWS -- history of user-visible changes.

Copyright (C) 2022 Free Software Foundation, Inc.
See the end of the file for license conditions.

* Changes in perl-doc.el 0.6

Bugfix: A vertical bar in markup is now processed correctly (seen in
perlport.pod).

* Changes in perl-doc.el 0.3

** New command `perl-doc-file'

Like `perl-doc', but prompt for a file name with completion.

** New command `perl-doc-view-source'

View the POD source for the Perl documentation shown in the current
buffer.  The command is bound to "v" in `perl-doc-mode'.



----------------------------------------------------------------------
perl-doc.el is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

perl-doc.el is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.


Local variables:
coding: utf-8
mode: outline
paragraph-separate: "[ 	]*$"
end: