PERL2HTML(1p)

📦
version 1.31 · 2 versions
  • 1.31 · debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 1.31 · ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 perl2html — NAME 💖

okay bestie, listen: perl2html generates Perl documentation in HTML. that's it, that's the whole vibe ✨ it's the little script that takes your dusty old POD and makes it ✨glow✨ on the web.

🌸 SYNOPSIS 🌸

perl2html [--[no]toc] [--hr level] [--bgcolor #rrggbb] [--text #rrggbb]
[--v verbosity] PerlDir HTMLDir

yes, those brackets are real, no, you can't skip them, iykyk 🫶

🦋 DESCRIPTION 🦋

okay so perl2html translates Perl documentation to HTML. literally its whole job. main character energy fr 💅

PerlDir is the root of the Perl source tree. like, the top of it. the mothership 🌳

The HTML pages are organized into a directory tree rooted at HTMLDir. so it's not just one big pile of files, it's a whole lil ecosystem in there 🐛🦋🐝

A top-level index is written to HTMLDir"/index.html" — that's your front door, your landing page, the thing you send people to 👑

In addition to the Perl sources, perl2html searches @INC for module PODs, and $ENV{PATH} for program PODS. so it's out here scavenging, collecting lore from everywhere 🔍✨

All the HTML pages are created world-readable. everyone can see them. no gatekeeping here 🌈

Perldir and HTMLDir must be absolute path names. not relative, not vibes-based, ABSOLUTE. i'm serious bestie, it will simply not work otherwise 😭

✨ OPTIONS ✨

  • --["no"]toc — Includes or omits a table of contents in each page. Default is to include the TOC. so if you want it, you get it (that's the default anyway), and if you're feeling minimalist, hit it with the no 🎀
  • --hr level — Controls the profusion of horizontal lines in the output, as follows:
level   horizontal lines
0       none
1       between TOC and body
2       after each =head1
3       after each =head1 and =head2

Default is level 1. so basically: how many cute lil lines do you want breaking up your page? zero? iconic. after every =head1 and =head2? chaotic, love that for you 💀

  • --bgcolor #rrggbb — Set the background color to #rrggbb. Default is off-white. it's giving cozy cream paper aesthetic ☁️
  • --text #rrggbb — Set the text color to #rrggbb. Default is black. classic, timeless, cannot go wrong 🖤
  • --v verbosity — Verbosity level: 0, 1, 2, 3. pick your volume bestie 🔊

🫶 REQUIRES 🫶

Perl 5 Getopt::Long. that's the whole list, that's the tea 🍓

🔥 SEE ALSO 🔥

  • pods2html
  • Pod::Tree
  • Pod::Tree::HTML
  • Pod::Tree::PerlBin
  • Pod::Tree::PerlDist
  • Pod::Tree::PerlFunc
  • Pod::Tree::PerlLib
  • Pod::Tree::PerlMap
  • Pod::Tree::PerlPod
  • Pod::Tree::PerlTop

the whole Pod::Tree fam, they're all connected, it's a whole universe 🌌

👑 AUTHOR 👑

Steven McDougall, swmcd@world.std.com — the icon who made all this happen 💜

Copyright 2000 by Steven McDougall. This program is free software; you can redistribute it and/or modify it under the same terms as Perl.

and that's the whole page, bestie!! this lil manual is from perl v5.36.0, dated 2022-11-19, and it's filed under PERL2HTML(1p) in the User Contributed Perl Documentation section 🦋✨ go forth and generate some gorgeous HTML, ily, mwah 💖

📦 where this page comes from