Version: pod2pdf 0.42
Related: https://rt.cpan.org/Ticket/Display.html?id=50341
Here is patch to correct the POD:
- Present options in alphabetical order; Cf. ls(1), cp(1) etc.
- Use standard B<> (bold) for options names
- Add option ARGUMENTS
- Use half-tab indent (4 spaces) for code examples; de facto
- Remove trailing EOL whitespaces
>From e3b0b588081633aacb7d399b4ad2b03b7667a846 Mon Sep 17 00:00:00 2001
From: Jari Aalto <jari.aa...@cante.net>
Date: Thu, 8 Oct 2009 21:05:25 +0300
Subject: [PATCH] bin/pod2pdf: (POD): Use B<> for options. Alpha order. half-tab indent
Signed-off-by: Jari Aalto <jari.aa...@cante.net>
---
bin/pod2pdf | 131 +++++++++++++++++++++++++++++++----------------------------
1 files changed, 69 insertions(+), 62 deletions(-)
diff --git a/bin/pod2pdf b/bin/pod2pdf
index 51e3c56..9245516 100755
--- a/bin/pod2pdf
+++ b/bin/pod2pdf
@@ -119,6 +119,8 @@ sub optionspec {
#--------------------------------------------------------------------------
#--------------------------------------------------------------------------
+=pod
+
=head1 NAME
pod2pdf - converts Pod to PDF format
@@ -130,80 +132,82 @@ format to PDF files.
=head2 Usage
- pod2pdf [options] input.pod >output.pdf
+ pod2pdf [options] input.pod >output.pdf
-If no input filename is specified, pod2pdf will read from STDIN, e.g.
+If no input filename is specified, pod2pdf will read from I<stdin>, e.g.
- perldoc -u File::Find | pod2pdf [options] >File-Find.pdf
+ perldoc -u File::Find | pod2pdf [options] >File-Find.pdf
=head2 Options
pod2pdf accepts the following command-line options:
-=over
+=over 4
-=item C<--output-file>
+=item B<--[no]footer>
-Sets the output filename for the generated PDF file. By default pod2pdf will output
-to STDOUT.
+Controls if a footer (containg the current page number and optional text string)
+will be included on each page. By default the footer will be included, so use
+B<--nofooter> to disable.
-=item C<--page-size>
+=item B<--footer-text TEXT>
-Sets the page size to be used in the PDF file, can be set to any of the standard
-paper sizes (A4, A5, Letter, etc). Defaults to A4.
+Sets an optional footer TEXT string that will be included in the
+bottom left corner of each page.
-=item C<--page-orientation>
+=item B<--[no]header>
-Controls if pages are produces in landscape or portrait format. Defaults to 'portrait'.
+Controls if a header (containing the page title, and optional timestamp and icon)
+will be included on each page. Defaults to on, so use B<--noheader> to disable.
-=item C<--page-width>, C<--page-height>
+=item B<--icon FILE>
-Sets the width and height of the generated pages in points (for using non-standard
-paper sizes).
+FILE of an icon to be displayed in the top left corner of each page.
-=item C<--left-margin>, C<--right-margin>, C<--top-margin>, C<--bottom-margin>
+=item B<--icon-scale DECIMAL>
-Allows each of the page margins (top, bottom, left, and right) to be individually
-set in points.
+Scaling value for the header icon (defaults to 0.25).
-=item C<--margins>
+=item B<--left-margin NUMBER>, B<--right-margin NUMBER>, B<--top-margin NUMBER>, B<--bottom-margin NUMBER>
-Sets all page margins to the same size (specified in points).
+Sets each of the page margins in points (top, bottom, left, and right)
+individually.
-=item C<--header>, C<--noheader>
+=item B<--margins NUMBER>
-Controls if a header (containing the page title, and optional timestamp and icon)
-will be included on each page. Defaults to on, so use C<--noheader> to disable.
+Sets all page margins to the same size in points.
-=item C<--title>
+=item B<--output-file FILE>
-Sets the page title (defaults to the input filename).
+Sets the output FILE for the generated PDF file. By default pod2pdf will output
+to I<stdout>.
-=item C<--timestamp>
+=item B<--page-size TYPE>
-Boolean option - if set, includes the 'last modified' timestamp of the input file in
-the page header.
+Sets the page size TYPE to be used in the PDF file, can be set to any
+of the standard paper sizes. The TYPE can be A4, A5, Letter, etc.
+Default value is A4.
-=item C<--icon>
+=item B<--page-orientation TYPE>
-Filename of an icon to be displayed in the top left corner of each page.
+Controls the TYPE of orientation: either I<landscape> or I<portrait>
+format. Defaults to 'portrait'.
-=item C<--icon-scale>
+=item B<--page-width NUMBER>, B<--page-height NUMBER>
-Scaling value for the header icon (defaults to 0.25).
+Sets the width and height of the generated pages in points (for using non-standard
+paper sizes).
-=item C<--footer>, C<--nofooter>
+=item B<--title NAME>
-Controls if a footer (containg the current page number and optional text string)
-will be included on each page. By default the footer will be included, so use
-C<--nofooter> to disable.
+Sets the NAME of the page title (defaults to the input filename).
-=item C<--footer-text>
+=item B<--timestamp>
-Sets an optional footer text string that will be included in the bottom left corner
-of each page.
+Boolean option - if set, includes the 'last modified' timestamp of the input file in
+the page header.
-=item C<--version>
+=item B<--version>
Prints version number and exits.
@@ -211,47 +215,48 @@ Prints version number and exits.
=head2 Configuration files
-Sets of command-line options may be saved into configuration files.
+Sets of command-line options may be saved into configuration files.
-A configuration file contains options in the same format as used by pod2pdf on the command-line,
-with one option given on each line of the file, e.g.
+A configuration file contains options in the same format as used by
+pod2pdf on the command-line, with one option given on each line of the
+file, e.g.
- --page-size A5
- --page-orientation landscape
+ --page-size A5
+ --page-orientation landscape
To use a config file, invoke pod2pdf with the option C<@/path/to/configfile.conf>.
-For example, if you wanted to always include a company logo, timestamp, and copyright
+For example, if you wanted to always include a company logo, timestamp, and copyright
notice in your PDF files, create a file F<mycompany.conf> containing the following:
- --icon "/path/to/your/logo.png"
- --footer-text "Copyright 2007 MyCompany Limited"
- --timestamp
+ --icon "/path/to/your/logo.png"
+ --footer-text "Copyright 2007 MyCompany Limited"
+ --timestamp
Then invoke pod2pdf as:
- pod2pdf @/path/to/mycompany.conf input.pod >output.pdf
+ pod2pdf @/path/to/mycompany.conf input.pod >output.pdf
-If you create a config file called F<pod2pdf.conf> and place this in the same
+If you create a config file called F<pod2pdf.conf> and place this in the same
directory as the pod2pdf script, it will be loaded as the default configuration.
-=head1 POD ENTENSIONS
+=head1 POD EXTENSIONS
As well as the standard POD commands (see L<perlpodspec>), pod2pdf supports the following
extensions to the POD format:
=over
-=item C<=ff>
+=item B<=ff>
-The C<=ff> command inserts a page bread (form feed) into the document.
+The B<=ff> command inserts a page bread (form feed) into the document.
-=item C<< OE<lt>...E<gt> >>
+=item B<< OE<lt>...E<gt> >>
-The C<< OE<lt>...E<gt> >> formatting code inserts an external object (file) into the document. This
+The B<< OE<lt>...E<gt> >> formatting code inserts an external object (file) into the document. This
is primarily intended for embedding images, e.g.
- O</path/to/figure1.jpg>
+ O</path/to/figure1.jpg>
to insert diagrams, etc into documentation.
@@ -263,14 +268,14 @@ pod2pdf supports the file types JPG, GIF, TIFF, PNG, and PNM for embedded object
pod2pdf requires the following modules to be installed:
-=over
+=over 4
+
+=item L<Getopt::ArgvFile>
=item L<PDF::API2>
=item L<Pod::Escapes>
-=item L<Getopt::ArgvFile>
-
=back
Additionally to use images, the modules L<File::Type> and L<Image::Size> must
@@ -282,7 +287,7 @@ is required.
The pod2pdf homepage: L<http://perl.jonallen.info/projects/pod2pdf>
For more information about POD, read the L<perlpod> manpage or see the POD page
-on the Perl 5 Wiki (L<http://www.perlfoundation.org/perl5/index.cgi?pod>).
+on the Perl 5 Wiki L<http://www.perlfoundation.org/perl5/index.cgi?pod>.
=head1 COPYRIGHT and LICENSE
@@ -291,6 +296,8 @@ Copyright (C) 2007 Jon Allen (JJ) <j...@jonallen.info>
This software is licensed under the terms of the Artistic
License version 2.0.
-For full license details, please read the file F<artistic-2_0.txt>
+For full license details, please read the file F<artistic-2_0.txt>
included with this distribution, or see
L<http://www.perlfoundation.org/legal/licenses/artistic-2_0.html>.
+
+=cut
--
1.6.3.3
