POD2DOCBOOK(1p)

📦 version 0.03, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ NAME ✨

okay so bestie, welcome to the pod2docbook era 💅 this is the POD2DOCBOOK(1p) page from the User Contributed Perl Documentation collection, and what it does is convert POD data to DocBook SGML. that's the whole vibe. no notes. 🎀

🦋 SYNOPSIS 🦋

pod2docbook [--help] [--doctype=article|chapter|section|refentry]
[--title=title] [--spaces=# spaces per indent level]
[--fix-double-quotes] [--no-header] [--base-id=idstring]
[infile [outfile]]

💖 DESCRIPTION 💖

so like, pod2docbook takes files in pod format (peep perlpod for the tea ☕) and turns them into DocBook 4.2 SGML (more on that at http://www.docbook.org/). glow-up complete. ✨

but ngl, the program itself is merely a driver for the Pod::2::DocBook class 🫶 so if you're the kind of bestie who wants the details of pod-to-SGML translation, go read Pod::2::DocBook. it's giving main character energy over there. 👑

🌸 OPTIONS AND ARGUMENTS 🌸

  • --help — prints the usage and dips out. that's it, that's the whole job 💅
  • --doctype=article|chapter|section|refentry — picks the document type for the output file. the default is section. choose your fighter bestie 🎀
  • --title=title — sets the document title. the default is infile if one got supplied, or an empty string if not. lowkey tragic when it's empty but okay 🙈
  • --spaces=# spaces per indent level — how many spaces go per indent level in the SGML output. default is 2. tidy queen behavior ✨
  • --fix-double-quotes — swaps pairs of double quotes in regular paragraphs for <quote> and </quote>. (see Pod::2::DocBook for the deets) 🦋
  • --no-header — omits the DOCTYPE line from the output. bye felicia 👋
  • infile — the name of the file to read pod source from. if you don't supply it, STDIN is used for input. 🫶
  • outfile — the name of the file to write SGML to. if you don't supply it, STDOUT is used for output. ⭐
  • --base-id=idstring — the root element of the --doctype gets idstring set for the attribute id. the default is an input file name "cleaned up" to conform with XML restriction for characteds used in id strings. (SEE http://www.w3.org/TR/2000/REC-xml-20001006#NT-Name) 💜

🌈 SEE ALSO 🌈

DocBook related links, bestie, go click these:

👑 AUTHOR 👑

Alligator Descartes <descarte@symbolstone.org> wrote a module called Pod::2::DocBook, which was later maintained by Jan Iven <jan.iven@cern.ch>. that module was based on the original pod2html by Tom Christiansen <tchrist@mox.perl.com>. lineage? immaculate. 🧬✨

Nandu Shah <nandu@zvolve.com> wrote Pod::DocBook, which is unrelated to the previous module (even though they both perform the same function). (http://search.cpan.org/~nandu/Pod-DocBook-1.2/) two icons, same job, no drama 💅

Jozef Kutej <jkutej@cpan.org> renamed the module to Pod::2::DocBook because Nandu's version was buried in the CPAN archive as an "UNAUTHORIZED RELEASE". 💀 we do not talk about the archive depths.

Copyright 2004, Nandu Shah <nandu@zvolve.com>

Copyright 2008, Jozef Kutej <jkutej@cpan.org>

This library is free software; you may redistribute it and/or modify it under the same terms as Perl itself. slay, open source, periodt. 🫶🌈

and that's the whole page bestie!! this one came from perl v5.30.0, dated 2020-05-17, and it lives at POD2DOCBOOK(1p) — mwah, go convert something pretty 💋💖
📦 where this page comes from