Lorenz Domke > PerlPoint-Converters > pp2latex

Download:
PerlPoint-Converters-1.0205.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

pp2latex - PerlPoint to LaTeX converter

VERSION ^

This man page describes $Revision: 1.14 $ from PerlPoint::Converters Package 1.0205

SYNOPSIS ^

  pp2latex --help
  pp2latex [@options_file] [options] slide_text 

DESCRIPTION ^

pp2latex creates a LaTeX file from a PerlPoint input file.

SYNTAX of PerlPoint Files ^

For a detailed description of the PerlPoint language please refer to the excellent POD documentation of the PerlPoint::Parser Module by Jochen Stenzel. There you will find everything you ever wanted to know about PerlPoint ;-)

OPTIONS ^

--section-sequence=chapter

This option may (and should) be specified more than once. For each level of headline a corresponding LaTeX section can be specified: The following sequence of options yields the assignment shown below:

 --section-sequence=section
 --section-sequence=subsection
 --section-sequence=subsubsection
 --section-sequence=paragraph
 --section-sequence=bftext

 =Healine Level 0             --->  \section{Headline Level 0}
 ==Healine Level 1            --->  \subsection{Headline Level 1}
 ===Healine Level 2           --->  \subsubsection{Headline Level 2}
 ====Healine Level 3          --->  \paragraph{Headline Level 3}
 =====Healine Level 4, 5, ... --->  \textbf{Headline Level 4, 5, ...}

Note: --section-sequence=chapter can only be use if the document class is report or book.

--filter=regexp

This specifies a regular expression regexp which should match all allowed languages for EMBEDed code. The expression is evaluated caseinsensitively.

Example: --filter="perl|latex"

--prolog=filename

Specifies a file which must contain the LaTeX Declarations for the document. \documentclass and \begin{document} must be defined there.

--activeContents

PerlPoint sources can embed Perl code which is evaluated while the source is parsed. For reasons of security this feature is deactivated by default. Set this option to active it. You can use --safeOpcode to fine tune which operations shall be permitted.

--double_lines

This option has the effect that all horizontal Lines in Tables are doubled.

--cache

parsing of one and the same document several times can be accelerated by activating the PerlPoint parser cache by this option. The performance boost depends on your document structure.

Cache files are written besides the source and named ".<source file>.ppcache".

It can be useful to (temporarily) deactivate the cache to get correct line numbers in parser error messages (currently numbers cannot always reported correctly with activated cache because of a special perl behaviour).

--cacheCleanup

PerlPoint parser cache files grow (with every modified version of a source parsed) because they store expressions for every parsed variant of a paragraph. This is usually uncritical but you may wish to clean up the cache occasionally. Use this option to perform the task (or remove the cache file manually).

-nocopyright

suppresses the copyright message;

-noinfo

supresses runtime informations;

--nowarn

supresses warnings;

--quiet

a shortcut for "--nocopyright --noinfo --nowarn": all non critical runtime messages are suppressed;

--safeOpcode <opcode>

If active contents is enabled (--activeContents), Perl code embedded into the translated PerlPoint sources will be evaluated. To keep security this is done via an object of class Safe which restricts code to permitted operations. By this option you can declare which opcode (or opcode tag) is permitted. Please see the Safe and Opcode manual pages for further details. (These modules come with perl.)

This option can be used multiply.

You may want to store these options in default option files, see below for details.

For the examples used in ppdoc.pp you should use

 --safeOpcode=:filesys_open --safeOpcode=:still_to_be_decided --safeOpcode=:browse
--set <flag>

This option allows you to pass certain settings - of your choice - to active contents (like conditions) where it can be accessed via the $PerlPoint hash reference. For example, your PerlPoint code could contain a condition like

  ? $PerlPoint->{userSettings}{special}

  Special part.

  ? 1

. The special part enclosed by the two conditions would then be processed only if you call pp2html with

  --set special

- and if active contents was enabled by -active, of course.

This option can be used multiply.

--trace [<level>]

activates traces of the specified level. You may use the environment variable SCRIPTDEBUG alternatively (but an option overwrites environment settings). The following levels are defined (use the numeric values) - if a description sounds cryptic to you, just ignore the setting:

--help

Output of usage.

--version

Output of version information.

FILES ^

Configuration file $HOME/.pp2latex

ENVIRONMENT ^

The following environment variables have influence on the program:

SCRIPTDEBUG

may be set to a numeric value to activate certain trace levels. You can use option -trace alternatively (note that a used option overwrites an environment setting). The several levels are described with this option.

SEE ALSO ^

pp2html

AUTHOR ^

Lorenz Domke (lorenz.domke@gmx.de), 2001. All rights reserved.

syntax highlighting: