*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Linux man pages -> pod2latex (1)              



NAME    [Toc]    [Back]

       pod2latex - convert pod documentation to latex format

SYNOPSIS    [Toc]    [Back]

	 pod2latex *.pm

	 pod2latex -out mytex.tex *.pod

	 pod2latex -full -sections 'DESCRIPTION|NAME' SomeDir

DESCRIPTION    [Toc]    [Back]

       "pod2latex" 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. Minium
       matching is supported.

	   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.

	   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.

	   Specify pod sections to include (or remove if negated) in the
	   translation.  See "SECTION SPECIFICATIONS" 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 "podselect()" command.

	   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.

	   Print a brief help message and exit.

	   Print the manual page and exit.

	   Print information messages as each document is processed.

BUGS    [Toc]    [Back]

       Known bugs are:

       o   Cross references between documents are not resolved when multiple
	   pod documents are converted into a single output "latex" file.

       o   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    [Toc]    [Back]


AUTHOR    [Toc]    [Back]

       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.

3rd Berkeley Distribution	  2004-12-24			  POD2LATEX(1)
[ Back ]
 Similar pages
Name OS Title
perldoc IRIX Look up Perl documentation in pod format.
perlpod OpenBSD the Plain Old Documentation format
perldoc OpenBSD Look up Perl documentation in Pod format.
podchecker Linux check the syntax of POD format documentation files
podchecker OpenBSD check the syntax of POD format documentation files
perlpodspec OpenBSD Plain Old Documentation: format specification and notes
bdftopcf Tru64 convert X font from Bitmap Distribution Format to Portable Compiled Format
bdftopcf IRIX convert X font from Bitmap Distribution Format to Portable Compiled Format
bdftopcf HP-UX convert X font from Bitmap Distribution Format to Portable Compiled Format
cddbcvt IRIX convert old (cdplayer) format CD database to new format
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service