POD2LATEX(1p)

💖 NAME 💖

okay bestie, gather round — pod2latex is the little icon that converts pod documentation into latex format. That's it, that's the whole gig. ✨

(also heads up, this page lives in the User Contributed Perl Documentation section of the manual, POD2LATEX(1p) style — iykyk 🫶)

---

🌸 SYNOPSIS 🌸

the four moods of pod2latex, served fresh:

pod2latex *.pm

pod2latex -out mytex.tex *.pod

pod2latex -full -sections 'DESCRIPTION|NAME' SomeDir

pod2latex -prefile h.tex -postfile t.tex my.pod

---

🦋 DESCRIPTION 🦋

pod2latex is a program that takes POD format documentation (that's perlpod, bestie) and turns it into latex. 💅

It can chew through multiple input documents at a time, and it'll either:

• generate one latex file per input document, or
• generate a single combined output file.

your call, queen. 👑

---

🎀 OPTIONS AND ARGUMENTS 🎀

this section describes the supported command line options. and yes — minimum matching is supported. so you can be lazy, as a treat. 💅

• -out — the name of the output file to be used. If there are multiple input pods, it's assumed you want all that translated output written into a single file. .tex gets appended if it's not already there. If you don't supply the argument, a single document gets created for each input file. 🗂️
• -full — creates a complete latex file that can be processed immediately (unless, plot twist, =for/=begin directives are used that rely on extra packages 🙈). Table of contents and index generation commands are included in the wrapper latex code. ✨
• -sections — specify pod sections to include (or remove if negated) in the translation. For the format to use for section-spec, see "SECTION SPECIFICATIONS" in Pod::Select. This option can be given multiple times on the command line. It's identical to the similar option in the podselect() command. 📑
• -modify — this option causes the output latex to be slightly modified from the input pod such that when a =head1 NAME is encountered, a section is created containing the actual pod name (rather than NAME), and all subsequent =head1 directives are treated as subsections. The advantage? A module's description ends up in its own section, which is super helpful for including module descriptions in documentation. It also forces latex label and index entries to be prefixed by the name of the module. 🌈
• -h1level — specifies the latex section that's equivalent to an H1 pod directive. It's an integer between 0 and 5, where 0 is equivalent to a latex chapter, 1 is equivalent to a latex section, etc. The default is 1 (H1 equivalent to a latex section). 🔢
• -help — print a brief help message and exit. 🫶
• -man — print the manual page and exit. 📖
• -verbose — print information messages as each document is processed. she's chatty and we love that. 💬
• -preamble — a user-supplied preamble for the LaTeX code. Multiple values are supported and appended in order, separated by "\n". See -prefile for reading the preamble from a file. 🎀
• -postamble — a user supplied postamble for the LaTeX code. Multiple values are supported and appended in order, separated by "\n". See -postfile for reading the postamble from a file. 🎀
• -prefile — a user-supplied preamble for the LaTeX code, to be read from the named file. Multiple values are supported and appended in order. See -preamble. 📄
• -postfile — a user-supplied postamble for the LaTeX code, to be read from the named file. Multiple values are supported and appended in order. See -postamble. 📄

---

💀 BUGS 💀

the known bugs, no cap, we're listing them:

• Cross references between documents are not resolved when multiple pod documents are converted into a single output latex file. 😭
• Functions and variables are not automatically recognized, and they will therefore not be marked up in any special way unless instructed by an explicit pod command. 💀

bestie these are real, don't @ me, they're literally in the docs.

---

👑 SEE ALSO 👑

• Pod::LaTeX — go read her next, she's the main character. ✨

---

💜 AUTHOR 💜

Tim Jenness <tjenness@cpan.org> wrote this. 🫶

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Copyright (C) 2000, 2003, 2004 Tim Jenness. All Rights Reserved.

---

and that's the whole page, bestie!! this one shipped as part of perl v5.30.0, dated 2020-05-17 — slay, go convert some pod. 💅✨🦋