POD Web

POD Web v. 1.4; 2023-05-03; rendering and searching through Perl's POD pages

DESCRIPTION

This set of CGI scripts displays Perl's documentation pages (PODs) and allows for searching their contents, indexes, names, and browsing all installed documentation. It runs in a plain Perl 5.20+ core environment with no additional dependencies, although a syntax highlighting engine may be enabled. It supports Syntax::SourceHighlight and Perl::Tidy.

It is fully customisable with a lot of configuration options, custom styling, and even the HTML skeleton that is utilised to render pages may be replaced altogether.

Apart from rendering pages in a similar way to the pod2html utility it is capable of formatting tables:

A	B	C
1	2	3
4		5
6

Full featured syntax highlighting with Syntax::SourceHighlight is also available:

SELECT   manufacturer, brand, count(*) AS malfunctions
FROM     products JOIN repairs USING (product_id)
WHERE    repair_date >= NOW() - INTERVAL('1 year')
GROUP BY manufacturer, brand
ORDER BY 3 DESC, manufacturer, brand

Downloading

GitLab: gitlab.com/Matlib/podweb

Git clone: https://gitlab.com/Matlib/podweb.git

The latest package can be downloaded directly too.

Installing

These scripts should work out of the box with their default settings. To enable searching you need to rename config.dist to config and specify the cache.int.dir path with /tmp/podweb being sufficient. The first search attempt will launch the indexer that will build the necessary cache files.

Example

This page is displayed with POD Web itself. You may freely use it to browse the decumentation for the Perl installed on this site which happens to be the one from Debian stable.