This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Synchronize pod2html usage output and its POD text
authorPetr Písař <ppisar@redhat.com>
Sun, 9 Jun 2013 18:14:24 +0000 (14:14 -0400)
committerRicardo Signes <rjbs@cpan.org>
Sun, 9 Jun 2013 18:21:10 +0000 (14:21 -0400)
ext/Pod-Html/bin/pod2html
ext/Pod-Html/lib/Pod/Html.pm

index c422ebf..b022859 100644 (file)
@@ -6,10 +6,14 @@ pod2html - convert .pod files to .html files
 
 =head1 SYNOPSIS
 
-    pod2html --help --htmlroot=<name> --infile=<name> --outfile=<name>
+    pod2html --help --htmldir=<name> --htmlroot=<URL>
+             --infile=<name> --outfile=<name>
              --podpath=<name>:...:<name> --podroot=<name>
-             --recurse --norecurse --verbose
-             --index --noindex --title=<name>
+             --cachedir=<name> --flush --recurse --norecurse
+             --quiet --noquiet --verbose --noverbose
+             --index --noindex --backlink --nobacklink
+             --header --noheader --poderrors --nopoderrors
+             --css=<URL> --title=<name>
 
 =head1 DESCRIPTION
 
@@ -27,12 +31,27 @@ pod2html takes the following arguments:
 
 Displays the usage message.
 
+=item htmldir
+
+  --htmldir=name
+
+Sets the directory to which all cross references in the resulting HTML file
+will be relative. Not passing this causes all links to be absolute since this
+is the value that tells Pod::Html the root of the documentation tree.
+
+Do not use this and --htmlroot in the same call to pod2html; they are mutually
+exclusive.
+
 =item htmlroot
 
-  --htmlroot=name
+  --htmlroot=URL
+
+Sets the base URL for the HTML files.  When cross-references are made, the
+HTML root is prepended to the URL.
+
+Do not use this if relative links are desired: use --htmldir instead.
 
-Sets the base URL for the HTML files.  When cross-references are made,
-the HTML root is prepended to the URL.
+Do not pass both this and --htmldir to pod2html; they are mutually exclusive.
 
 =item infile
 
@@ -61,6 +80,59 @@ Specify the base directory for finding library pods.
 Specify which subdirectories of the podroot contain pod files whose
 HTML converted forms can be linked-to in cross-references.
 
+=item cachedir
+
+  --cachedir=name
+
+Specify which directory is used for storing cache. Default directory is the
+current working directory.
+
+=item flush
+
+  --flush
+
+Flush the cache.
+
+=item backlink
+
+  --backlink
+
+Turn =head1 directives into links pointing to the top of the HTML file.
+
+=item nobacklink
+
+  --nobacklink
+
+Do not turn =head1 directives into links pointing to the top of the HTML file
+(default behaviour).
+
+=item header
+
+  --header
+
+Create header and footer blocks containing the text of the "NAME" section.
+
+=item noheader
+
+  --noheader
+
+Do not create header and footer blocks containing the text of the "NAME"
+section (default behaviour).
+
+=item poderrors
+
+  --poderrors
+
+Include a "POD ERRORS" section in the outfile if there were any POD errors in
+the infile (default behaviour).
+
+=item nopoderrors
+
+  --nopoderrors
+
+Do not include a "POD ERRORS" section in the outfile if there were any POD
+errors in the infile.
+
 =item index
 
   --index
@@ -86,18 +158,44 @@ Recurse into subdirectories specified in podpath (default behaviour).
 
 Do not recurse into subdirectories specified in podpath.
 
+=item css
+
+  --css=URL
+
+Specify the URL of cascading style sheet to link from resulting HTML file.
+Default is none style sheet.
+
 =item title
 
   --title=title
 
 Specify the title of the resulting HTML file.
 
+=item quiet
+
+  --quiet
+
+Don't display mostly harmless warning messages.
+
+=item noquiet
+
+  --noquiet
+
+Display mostly harmless warning messages (default behaviour). But this is not
+the same as "verbose" mode.
+
 =item verbose
 
   --verbose
 
 Display progress messages.
 
+=item noverbose
+
+  --noverbose
+
+Do not display progress messages (default behaviour).
+
 =back
 
 =head1 AUTHOR
index 72b37c2..3feb812 100644 (file)
@@ -3,7 +3,7 @@ use strict;
 require Exporter;
 
 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
-$VERSION = 1.18;
+$VERSION = 1.19;
 @ISA = qw(Exporter);
 @EXPORT = qw(pod2html htmlify);
 @EXPORT_OK = qw(anchorify);
@@ -447,9 +447,14 @@ sub usage {
     my $podfile = shift;
     warn "$0: $podfile: @_\n" if @_;
     die <<END_OF_USAGE;
-Usage:  $0 --help --htmlroot=<name> --infile=<name> --outfile=<name>
-           --podpath=<name>:...:<name> --podroot=<name> --cachedir=<name>
-           --recurse --verbose --index --norecurse --noindex
+Usage:  $0 --help --htmldir=<name> --htmlroot=<URL>
+           --infile=<name> --outfile=<name>
+           --podpath=<name>:...:<name> --podroot=<name>
+           --cachedir=<name> --flush --recurse --norecurse
+           --quiet --noquiet --verbose --noverbose
+           --index --noindex --backlink --nobacklink
+           --header --noheader --poderrors --nopoderrors
+           --css=<URL> --title=<name>
 
   --[no]backlink  - turn =head1 directives into links pointing to the top of
                       the page (off by default).