POD::PERLDOC::TONROFF(3perl)

📦
version 5.44.0 · 14 versions
, in arch rolling

💖 Pod::Perldoc::ToNroff — let Perldoc convert Pod to nroff 💖

okay so bestie, you know how perldoc can spit your Pod out in all kinds of formats? yeah. this is the lil plug-in that makes the nroff magic happen. perl's own docs, but make it man-page. iconic behavior fr fr. 👑

✨ SYNOPSIS ✨

perldoc -o nroff -d something.3 Some::Modulename

that's it. that's the whole vibe. 💅

🌸 DESCRIPTION 🌸

so this is what we call a "plug-in" class, right? and what it does is let Perldoc use Pod::Man as its formatter class. like, it's the little matchmaker that sets them up. 🫶

the options it supports are, and I'm listing every single one because we don't skip, we never skip:

  • center
  • date
  • fixed
  • fixedbold
  • fixeditalic
  • fixedbolditalic
  • quotes
  • release
  • section

(no cap, that's all nine of them. count them. I did. 🍓)

and where do these get explained? Pod::Man. that's the girlypop with the answers. go look there.

for example, and yes this is a whole extra example, not the same one as the synopsis, stay with me:

perldoc -o nroff -w center:Pod -d something.3 Some::Modulename

look at that -w center:Pod like okayyyyy passing options, main character energy for real. 🌈

⚠️ CAVEAT ⚠️

bestie listen. this module might, in the future, switch over to using a different pod-to-nroff formatter class. and if that happens?? the options it supports could change too. so like. don't build your whole personality around these options staying identical forever. 💀

👀 SEE ALSO 👀

go read these, they're the friend group:

  • Pod::Man
  • Pod::Perldoc
  • Pod::Perldoc::ToMan

Copyright (c) 2002 Sean M. Burke. All rights reserved.

this library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. periodt. 💜

and this program 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. so like, it's giving hopeful, not giving guaranteed. 😭

🎀 AUTHOR 🎀

current maintainer is Mark Allen "<mallen@cpan.org>" — thank you for your service king 👑

past contributions from: brian d foy "<bdfoy@cpan.org>", Adriano R. Ferreira "<ferreira@cpan.org>", and Sean M. Burke "<sburke@cpan.org>". legends, all of them, we stan. 🦋

and that's the whole page, bestie!! this was perl v5.44.0, dated 2026-10-17, and yeah it's a Pod::P...ToNroff(3perl) situation but you understood it, I understood it, we ate. 💅✨

📦 where this page comes from