Home Man
Today's Posts

Linux & Unix Commands - Search Man Pages

RedHat 9 (Linux i386) - man page for pod2latex (redhat section 1)

POD2LATEX(1)			 Perl Programmers Reference Guide		     POD2LATEX(1)

       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 (perlpod) into latex. It can
       process multiple input documents at a time and either generate a latex file per input doc-
       ument 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 "SEC-
	   TION 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 simi-
	   lar 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 sub-
	   sections. 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.

	   Specifies the "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).

	   Print a brief help message and exit.

	   Print the manual page and exit.

	   Print information messages as each document is processed.

       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.


       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.

perl v5.8.0				    2003-02-18				     POD2LATEX(1)

All times are GMT -4. The time now is 09:01 PM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
Show Password