diff options
| author | jkeenan <jkeenan@cpan.org> | 2012-08-12 21:55:42 -0400 |
|---|---|---|
| committer | James E Keenan <jkeenan@cpan.org> | 2016-12-31 10:49:52 -0500 |
| commit | 4446c207838dd833a07dde6e8d8e328480e7f331 (patch) | |
| tree | ba2fe8607cfe7e8623ed8e37f90e6e2462a7432d | |
| parent | 8df022406424cfae8a958737434c9949fd7d1bdc (diff) | |
| download | perl-4446c207838dd833a07dde6e8d8e328480e7f331.tar.gz | |
Clarify that 'installhtml' is intended only for use in the Perl 5 core distribution.
For: RT # 114466
| -rw-r--r-- | installhtml | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/installhtml b/installhtml index 0199709bb4..1094c6a6f0 100644 --- a/installhtml +++ b/installhtml @@ -23,8 +23,9 @@ installhtml - converts a collection of POD pages to HTML format. =head1 DESCRIPTION I<installhtml> converts a collection of POD pages to a corresponding -collection of HTML pages. This is primarily used to convert the pod -pages found in the perl distribution. +collection of HTML pages. This is used to convert the pod pages found in the +perl distribution. (It is not intended as a general-purpose +converter/installer of POD pages in HTML format. See L<Pod::Html>.) =head1 OPTIONS @@ -67,10 +68,11 @@ relative to podroot. =item B<--splititem> POD files to split on =item directive -Comma-separated list of all pod files to split by the =item directive. -The .pod suffix is optional. I<installhtml> does not do the actual -split, rather it invokes I<splitpod> to do the dirty work. As with ---splithead, these files should have names specified relative to podroot. +Comma-separated list of all pod files to split by the =item directive. The +.pod suffix is optional. I<installhtml> does not do the actual split, rather +it invokes I<splitpod>, a separate program in the Perl 5 core distribution, +to do the dirty work. As with --splithead, these files should have names +specified relative to podroot. =item B<--splitpod> Directory containing the splitpod program |