pod2latex - convert pod documentation to latex format |
pod2latex - convert pod documentation to latex format
pod2latex *.pm
pod2latex -out mytex.tex *.pod
pod2latex -full -sections 'DESCRIPTION|NAME' SomeDir
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.
This section describes the supported command line options. Minium matching is supported.
.tex
is appended if not present. If the
argument is not supplied, a single document will be created for each
input file.
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.
podselect()
command.
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.
latex
section that is equivalent to a H1
pod
directive. This is an integer between 0 and 5 with 0 equivalent to a
latex
chapter, 1 equivalent to a latex
section etc. The default
is 1 (H1
equivalent to a latex section).
Known bugs are:
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.
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.
pod2latex - convert pod documentation to latex format |