/ 
Pod-PerlPoint-0.06
River stage zero No dependents
/ pod2pp

NAME

pod2pp - a POD to PerlPoint translator

VERSION

This manual describes version 0.01.

DESCRIPTION

This is a translator in the tradition of the various pod2..., translating POD into PerlPoint files.

SYNOPSIS

Currently, usage is very straight forward. Just pass the sources you want to process.

pod2pp file1.pod Module.pm

In case you want to process STDIN, omit the list of POD files.

pod2pp

Options

-help

displays an online help and terminates the script.

-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;

-outfile

Results are written to STDOUT, except when option -outfile outfile is used, in which case all output is redirected to the file specified.

pod2pp -outfile file.pp file.pod

-outfile may be abbreviated.

-parserversion

Accepts the version of PerlPoint::Parser to produce for. If this option is omitted, it is assumed that a parser prior to 0.39 will be used.

Example: -parserversion 0.40

Note: for parsers from 0.40 on, this option is required to get readable results. See Pod::PerlPoint for details.

Option files

pod2pp options can be passed by files, which makes repeated calls easier. Just write options into a file, spread or in one line, as if you would do in the command line. Newlines, empty lines and comment lines (beginning with a #) are allowed.

-outfile /tmp/perlpoint.result

To pass the option file, enter its name, preceded by an @.

pod2pp @options

In case options should become standard, store them in a file .pod2pp in your home directory. To make settings valid for all users, store them in a .pod2pp file in the directory of pod2pp itself. .pod2pp files will be read automatically.

Option files can be nested and cascaded, see Getopt::ArgvFile for further details.

NOTES

pod2pp uses Pod::PerlPoint, which is strongly based on Pod::Simple::Text. Thanks to its author Sean M. Burke.

SEE ALSO

Pod::PerlPoint

The module this script is based upon.

pp2pod

A PerlPoint to POD translator that comes with PerlPoint::Package.

Bundle::PerlPoint

A bundle of packages to deal with PerlPoint documents.

AUTHOR

Copyright (c) Jochen Stenzel (perl@jochen-stenzel.de), 2002-2004. All rights reserved.

SUPPORT

A PerlPoint mailing list is set up to discuss usage, ideas, bugs, suggestions and translator development. To subscribe, please send an empty message to perlpoint-subscribe@perl.org.

If you prefer, you can contact me via perl@jochen-stenzel.de as well.

AUTHOR

Copyright (c) Jochen Stenzel (perl@jochen-stenzel.de), 2002-2004. All rights reserved.

This script is free software, you can redistribute it and/or modify it under the terms of the Artistic License distributed with Perl version 5.003 or (at your option) any later version. Please refer to the Artistic License that came with your Perl distribution for more details.

The Artistic License should have been included in your distribution of Perl. It resides in the file named "Artistic" at the top-level of the Perl source tree (where Perl was downloaded/unpacked - ask your system administrator if you dont know where this is). Alternatively, the current version of the Artistic License distributed with Perl can be viewed on-line on the World-Wide Web (WWW) from the following URL: http://www.perl.com/perl/misc/Artistic.html

DISCLAIMER

This software is distributed in the hope that it will be useful, but is provided "AS IS" WITHOUT WARRANTY OF ANY KIND, either expressed or implied, INCLUDING, without limitation, the implied warranties of MERCHANTABILITY and FITNESS FOR A PARTICULAR PURPOSE.

The ENTIRE RISK as to the quality and performance of the software IS WITH YOU (the holder of the software). Should the software prove defective, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT WILL ANY COPYRIGHT HOLDER OR ANY OTHER PARTY WHO MAY CREATE, MODIFY, OR DISTRIBUTE THE SOFTWARE BE LIABLE OR RESPONSIBLE TO YOU OR TO ANY OTHER ENTITY FOR ANY KIND OF DAMAGES (no matter how awful - not even if they arise from known or unknown flaws in the software).

Please refer to the Artistic License that came with your Perl distribution for more details.