Next: pod2man | Previous: pod2html |  | [Table of Contents] | [Index]

# pod2latex

- NAME
- SYNOPSIS
- DESCRIPTION
- OPTIONS AND ARGUMENTS
- BUGS
- SEE ALSO
- AUTHOR

## NAME

pod2latex - convert pod documentation to latex format

## SYNOPSIS

      pod2latex *.pm

      pod2latex -out mytex.tex *.pod

      pod2latex -full -sections 'DESCRIPTION|NAME' SomeDir

## DESCRIPTION

`pod2latex` is a program to convert POD format documentation (the perlpod manpage) 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.

## OPTIONS AND ARGUMENTS

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

-out
  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. `.tex` is appended if not present. If the argument is not supplied, a single document will be created for each input file.
-full
  Creates a complete `latex` file that can be processed immediately (unless `=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. See the section on SECTION SPECIFICATIONS in the Pod::Select manpage 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 `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. 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 `latex` label and index entries to be prefixed by the name of the module.
-help
  Print a brief help message and exit.
-man
  Print the manual page and exit.
-verbose
  Print information messages as each document is processed.

## BUGS

Known bugs are:

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

## SEE ALSO

the Pod::LaTeX manpage

## AUTHOR

Tim Jenness <t.jenness@jach.hawaii.edu>

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

Copyright (C) 2000 Tim Jenness.

[Top] Generated by Pod::HTML 0.43 on Mon Mar 19 17:36:46 2001