From Free Software Directory
Jump to: navigation, search


Displays Perl reference documentation

Perl-reference is a program to quickly display reference documentation for a Perl function, variable, regexp operator, or language keyword. This documentation is generated from the default Perl POD files, namely perlfunc, perlop, and perlvar. Unlike perldoc, perl-reference relies on documentation generated at compile-time, which results in a much higher response time. It consists of two parts, mkperlreference and pf. 'mkperlreference' is run once during compile-time to create a cache of the Perl POD documentation. This cache consists of plain text files, one for each function, variable, regexp operator and language keyword in Perl. These files are usually installed in /usr/share/perl-reference. 'pf' displays the generated documentation by finding the right cached file and writing its contents to a pager or standard output.



Verified by

Verified on




Verified by

Janet Casey

Verified on

7 January 2003

Leaders and contributors

Oskar Liljeblad Maintainer

Resources and communication

AudienceResource typeURI
Bug Tracking,Developer,

Software prerequisites


Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.

The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.