pod2latex.bundled

pod2latex.bundled [--full] [--sections=section_list] [--output=file] [podfile]
pod2latex.bundled [options] < input.pod > output.tex

podfile
    The path to the Pod source file to be converted. If omitted, input is read from standard input.

--full
    Generate a complete LaTeX document including standard preamble and document class. Without this, only a LaTeX fragment is produced.

--sections=section_list
    Specify a comma-separated list of section names to include in the output (e.g., `--sections="NAME,SYNOPSIS,DESCRIPTION"`).

--output=file
    Write the LaTeX output to the specified file instead of standard output.

-h, --help
    Display a brief help message and exit.

-V, --version
    Print the version information and exit.

--encoding=encoding
    Specify the input character encoding for the Pod source (e.g., `UTF-8`).

--preamble=file
    Insert the content of file directly into the LaTeX preamble (before `\begin{document}`).

--stylesheet=file
    Use file as a custom LaTeX stylesheet. This file is included via `\input{file}`.

--nocode
    Suppress the output of verbatim (code) paragraphs, which are normally rendered as `\begin{verbatim}` blocks.

--lax
    Enable more permissive parsing of the Pod input, for example, allowing `=head1` without a preceding blank line.

--skip
    Ignore unknown Pod directives rather than issuing warnings or errors.

--doctype=type
    Specify the LaTeX document class for `--full` output (e.g., `article`, `report`, `book`). Defaults to `article`.

--magnification=factor
    Scale the document by the given factor (e.g., `1.2` for 120% size). Affects the `\documentclass` option.

--release=version
    Set the version string (e.g., `\release{version}`) in the LaTeX output.

--date=date
    Set the date string (e.g., `\date{date}`) in the LaTeX output.

--quotes=type
    Control how quotes are rendered: `none` (no special rendering), `latex` (using LaTeX specific commands like `\textquotedblleft`), or `quotes` (using standard ' and " characters).

--backticks
    Render `C<...>` formatting codes as monospace (`\texttt{...}`) rather than italics (`\textit{...}`).

--footnote-macros
    Use LaTeX `\footnote` macros for `F<...>` formatting codes instead of simple superscripts.

--verbose
    Print status and debugging messages to standard error during conversion.

pod2latex.bundled is a utility designed to convert documentation written in Pod (Plain Old Documentation) format into LaTeX. Pod is a simple markup language used primarily for documenting Perl modules and scripts. This command takes Pod input, either from standard input or a specified file, and transforms it into LaTeX source code, which can then be compiled into a PDF or other formats using a LaTeX compiler like pdflatex.

It handles various Pod constructs such as paragraphs, verbatim blocks, headings, lists, bold/italic/code text, and cross-references, mapping them to appropriate LaTeX commands. This allows developers to maintain their documentation in a single, easy-to-read Pod format and then generate high-quality typeset output suitable for printing or distribution. The `.bundled` suffix often indicates it's part of a larger Perl distribution or a specific software package, ensuring its availability and functionality within that ecosystem.

pod2latex.bundled relies on a LaTeX distribution being installed on your system to compile the generated `.tex` files into presentable documents (e.g., PDF). It may not support all advanced LaTeX features or highly complex Pod constructs perfectly, and some manual tweaking of the generated `.tex` file might be necessary for very specific formatting requirements. The `.bundled` suffix typically indicates it's part of a specific Perl installation or a larger software package, meaning its availability and exact version might depend on your system's Perl environment.

To obtain a PDF document from the `.tex` file generated by pod2latex.bundled, you typically run a LaTeX compiler like pdflatex. For example:
`pod2latex.bundled yourfile.pod > yourfile.tex`
`pdflatex yourfile.tex`
This process might need to be run multiple times (e.g., `pdflatex yourfile.tex` twice or thrice) to resolve internal references such as a table of contents, citations, or cross-references, ensuring all elements are correctly placed and numbered.

The pod2latex utility is a long-standing component of the core Perl distribution's Pod utilities, developed and maintained over many years alongside Perl itself. It serves a crucial role in enabling Perl developers to document their code in a standard, easily parsable format (Pod) and then generate professional-looking documentation in various output formats, including typeset LaTeX. Its development has focused on robustness in parsing diverse Pod inputs and providing configurable options for LaTeX output to suit different documentation needs. The `.bundled` suffix often indicates a specific version or wrapper included within a larger software package, ensuring compatibility and functionality within that ecosystem.

pod2text(1), pod2html(1), pod2man(1), perlpod(1), latex(1), pdflatex(1)