view release on metacpan or  search on metacpan

pod2pp  view on Meta::CPAN

=item -help

displays an online help and terminates the script.

=item -nocopyright

suppresses the copyright message;

=item -noinfo

supresses runtime informations;

=item -nowarn

supresses warnings;

=item -quiet

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

=item -outfile

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

 pod2pp -outfile file.pp file.pod

C<-outfile> may be abbreviated.

=item -parserversion

Accepts the version of C<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 I<required> to get readable results. See
C<Pod::PerlPoint> for details.

=back


=head2 Option files

C<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 C<#>) are allowed.

  -outfile /tmp/perlpoint.result

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

  pod2pp @options

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

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



=head1 NOTES

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

=head1 SEE ALSO

=over 4

=item B<Pod::PerlPoint>

The module this script is based upon.

=item B<pp2pod>

A PerlPoint to POD translator that comes with C<PerlPoint::Package>.

=item B<Bundle::PerlPoint>

A bundle of packages to deal with PerlPoint documents.


=back


=head1 AUTHOR

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



=head1 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.


=head1 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