Man page 1 : pod2latex

pod2latex - convert pod documentation to latex format

pod2latex *.pm pod2latex -out mytex.tex *.pod pod2latex -full -sections \*(AqDESCRIPTION|NAME\*(Aq SomeDir pod2latex -prefile h.tex -postfile t.tex my.pod

\f(CW\*(C`pod2latex\*(C'\fR is a program to convert POD format documentation (perlpod) into latex. It can process multiple input documents at a time and either generate a latex file per input document or a single combined output file.

This section describes the supported command line options. Minimum matching is supported.

-out 4 Name of the output file to be used. If there are multiple input pods it is assumed that the intention is to write all translated output into a single file. \f(CW\*(C`.tex\*(C'\fR is appended if not present. If the argument is not supplied, a single document will be created for each input file.

-full 4 Creates a complete \f(CW\*(C`latex\*(C'\fR file that can be processed immediately (unless \f(CW\*(C`=for/=begin\*(C'\fR directives are used that rely on extra packages). Table of contents and index generation commands are included in the wrapper \f(CW\*(C`latex\*(C'\fR code.

-sections 4 Specify pod sections to include (or remove if negated) in the translation. See \*(L"SECTION SPECIFICATIONS\*(R" in Pod::Select for the format to use for section-spec. This option may be given multiple times on the command line.This is identical to the similar option in the \f(CW\*(C`podselect()\*(C'\fR command.

-modify 4 This option causes the output \f(CW\*(C`latex\*(C'\fR to be slightly modified from the input pod such that when a \f(CW\*(C`=head1 NAME\*(C'\fR is encountered a section is created containing the actual pod name (rather than NAME) and all subsequent \f(CW\*(C`=head1\*(C'\fR directives are treated as subsections. This has the advantage that the description of a module will be in its own section which is helpful for including module descriptions in documentation. Also forces \f(CW\*(C`latex\*(C'\fR label and index entries to be prefixed by the name of the module.

-h1level 4 Specifies the \f(CW\*(C`latex\*(C'\fR section that is equivalent to a \f(CW\*(C`H1\*(C'\fR pod directive. This is an integer between 0 and 5 with 0 equivalent to a \f(CW\*(C`latex\*(C'\fR chapter, 1 equivalent to a \f(CW\*(C`latex\*(C'\fR section etc. The default is 1 (\f(CW\*(C`H1\*(C'\fR equivalent to a latex section).

-help 4 Print a brief help message and exit.

-man 4 Print the manual page and exit.

-verbose 4 Print information messages as each document is processed.

-preamble 4 A user-supplied preamble for the LaTeX code. Multiple values are supported and appended in order separated by \*(L"\n\*(R". See -prefile for reading the preamble from a file.

-postamble 4 A user supplied postamble for the LaTeX code. Multiple values are supported and appended in order separated by \*(L"\n\*(R". See -postfile for reading the postamble from a file.

-prefile 4 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 4 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.

Known bugs are:

4 Cross references between documents are not resolved when multiple pod documents are converted into a single output \f(CW\*(C`latex\*(C'\fR file.

4 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.

Pod::LaTeX

Tim Jenness <>

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.