1POD2LATEX(1) User Contributed Perl Documentation POD2LATEX(1)
2
6 pod2latex - convert pod documentation to latex format
7
9 pod2latex *.pm
10 pod2latex -out mytex.tex *.pod
12 pod2latex -full -sections 'DESCRIPTION|NAME' SomeDir
14 pod2latex -prefile h.tex -postfile t.tex my.pod
16
18 "pod2latex" is a program to convert POD format documentation (perlpod)
19 into latex. It can process multiple input documents at a time and
20 either generate a latex file per input document or a single combined
21 output file.
22
24 This section describes the supported command line options. Minimum
25 matching is supported.
26 -out
28 Name of the output file to be used. If there are multiple input
29 pods it is assumed that the intention is to write all translated
30 output into a single file. ".tex" is appended if not present. If
31 the argument is not supplied, a single document will be created for
32 each input file.
33 -full
35 Creates a complete "latex" file that can be processed immediately
36 (unless "=for/=begin" directives are used that rely on extra
37 packages). Table of contents and index generation commands are
38 included in the wrapper "latex" code.
39 -sections
41 Specify pod sections to include (or remove if negated) in the
42 translation. See "SECTION SPECIFICATIONS" in Pod::Select for the
43 format to use for section-spec. This option may be given multiple
44 times on the command line.This is identical to the similar option
45 in the podselect() command.
46 -modify
48 This option causes the output "latex" to be slightly modified from
49 the input pod such that when a "=head1 NAME" is encountered a
50 section is created containing the actual pod name (rather than
51 NAME) and all subsequent "=head1" directives are treated as
52 subsections. This has the advantage that the description of a
53 module will be in its own section which is helpful for including
54 module descriptions in documentation. Also forces "latex" label
55 and index entries to be prefixed by the name of the module.
56 -h1level
58 Specifies the "latex" section that is equivalent to a "H1" pod
59 directive. This is an integer between 0 and 5 with 0 equivalent to
60 a "latex" chapter, 1 equivalent to a "latex" section etc. The
61 default is 1 ("H1" equivalent to a latex section).
62 -help
64 Print a brief help message and exit.
65 -man
67 Print the manual page and exit.
68 -verbose
70 Print information messages as each document is processed.
71 -preamble
73 A user-supplied preamble for the LaTeX code. Multiple values are
74 supported and appended in order separated by "\n". See -prefile
75 for reading the preamble from a file.
76 -postamble
78 A user supplied postamble for the LaTeX code. Multiple values are
79 supported and appended in order separated by "\n". See -postfile
80 for reading the postamble from a file.
81 -prefile
83 A user-supplied preamble for the LaTeX code to be read from the
84 named file. Multiple values are supported and appended in order.
85 See -preamble.
86 -postfile
88 A user-supplied postamble for the LaTeX code to be read from the
89 named file. Multiple values are supported and appended in order.
90 See -postamble.
91
93 Known bugs are:
94 • Cross references between documents are not resolved when multiple
96 pod documents are converted into a single output "latex" file.
97 • Functions and variables are not automatically recognized and they
99 will therefore not be marked up in any special way unless
100 instructed by an explicit pod command.
101
103 Pod::LaTeX
104
106 Tim Jenness <tjenness@cpan.org>
107 This program is free software; you can redistribute it and/or modify it
109 under the same terms as Perl itself.
110 Copyright (C) 2000, 2003, 2004 Tim Jenness. All Rights Reserved.
112perl v5.36.0 2023-01-20 POD2LATEX(1)