MOD2HTML(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

🌸 NAME 🌸

mod2html — bestie, this is the lil icon that translates module PODs into HTML 💅 it's the section 1p page from your User Contributed Perl Documentation, and it is so much chiller than it looks, i promise.

✨ SYNOPSIS ✨

"mod2html" ["--base" url] ["--css" url] ["--index" title]
["--"["no"]"toc"] ["--hr" level] ["--bgcolor" #rrggbb] ["--text"
#rrggbb] modDir HTMLdir

🦋 DESCRIPTION 🦋

okay so here's the whole vibe: mod2html goes hunting for all the PODs under modDir, translates every single one of them into HTML, and then writes the whole lil family out into a directory tree under HTMLdir. no cap.

that directory tree? it mirrors the module namespaces. so like, your namespaces stay namespaced. cute, right?

oh and it makes the HTML files world-readable 🫶 (yes, for everyone. the whole group chat can see them.)

💖 OPTIONS 💖

  • --base url — turns all your L<> sequences into HTML links that are relative to url. link them up bestie ✨
  • --css url — points at a Cascanding Style Sheet for the generated HTML page. (yes, that's exactly how it's spelled up in here, we don't make the rules 🎀)
  • --index title — writes an index of every HTML file to HTMLDir/index.html, and title becomes the title of that index page. main character energy for your index 👑
  • --[no]toc — includes or omits the table of contents. the default is to include the TOC. so if you want it gone you're flipping on the no version 🙈
  • --hr level — controls how profuse the horizontal lines are in the output, like this:
    • 0 — none
    • 1 — between TOC and body
    • 2 — after each =head1
    • 3 — after each =head1 and =head2

the default is level 1. one lil line, no drama.

  • --bgcolor #rrggbb — sets the background color to #rrggbb. default is white.
  • --text #rrggbb — sets the text color to #rrggbb. default is black.

🧚 REQUIRES 🧚

  • Pod::Tree::HTML

🌈 SEE ALSO 🌈

  • pod2html
  • pods2html
  • Pod::Tree::HTML

⭐ AUTHOR ⭐

Steven McDougall, <swmcd@world.std.com>

Copyright (c) 2003 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 💀 no notes, ate, periodt.

this lil masterpiece shipped as perl v5.36.0 on 2022-11-19 — so if you're reading this, shoutout to the MOD2HTML(1p) era, ily, bye 🎀💖

📦 where this page comes from