summaryrefslogtreecommitdiff
path: root/pod/pod2man.PL
diff options
context:
space:
mode:
authorSteve Hay <SteveHay@planit.com>2008-11-07 08:47:26 +0000
committerSteve Hay <SteveHay@planit.com>2008-11-07 08:47:26 +0000
commit9f2f055aa1e8c86d97b5ea42473ab1747f518f3a (patch)
treee1212dc0d5e0cc17adc3b16631339cef8cf4e63a /pod/pod2man.PL
parent3327bb648bca3705820d35dd728f98436ea9f8aa (diff)
downloadperl-9f2f055aa1e8c86d97b5ea42473ab1747f518f3a.tar.gz
Upgrade to podlators-2.2.0
p4raw-id: //depot/perl@34758
Diffstat (limited to 'pod/pod2man.PL')
-rw-r--r--pod/pod2man.PL20
1 files changed, 13 insertions, 7 deletions
diff --git a/pod/pod2man.PL b/pod/pod2man.PL
index c353455391..25df0df0b4 100644
--- a/pod/pod2man.PL
+++ b/pod/pod2man.PL
@@ -58,7 +58,7 @@ use vars qw($running_under_some_shell);
my $stdin;
@ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV;
-# Parse our options, trying to retain backwards compatibility with pod2man but
+# Parse our options, trying to retain backward compatibility with pod2man but
# allowing short forms as well. --lax is currently ignored.
my %options;
$options{errors} = 'pod';
@@ -78,7 +78,7 @@ if ($options{official} && !defined $options{center}) {
my $verbose = $options{verbose};
delete $options{verbose};
-# This isn't a valid Pod::Man option and is only accepted for backwards
+# This isn't a valid Pod::Man option and is only accepted for backward
# compatibility.
delete $options{lax};
@@ -191,9 +191,9 @@ Print out usage information.
=item B<-l>, B<--lax>
-No longer used. B<pod2man> used to check its input for validity as a manual
-page, but this should now be done by L<podchecker(1)> instead. Accepted for
-backwards compatibility; this option no longer does anything.
+No longer used. B<pod2man> used to check its input for validity as a
+manual page, but this should now be done by L<podchecker(1)> instead.
+Accepted for backward compatibility; this option no longer does anything.
=item B<-n> I<name>, B<--name>=I<name>
@@ -271,6 +271,12 @@ However, be warned that *roff source with literal UTF-8 characters is not
supported by many implementations and may even result in segfaults and
other bad behavior.
+Be aware that, when using this option, the input encoding of your POD
+source must be properly declared unless it is US-ASCII or Latin-1. POD
+input without an C<=encoding> command will be assumed to be in Latin-1,
+and if it's actually in UTF-8, the output will be double-encoded. See
+L<perlpod(1)> for more information on the C<=encoding> command.
+
=item B<-v>, B<--verbose>
Print out the name of each output file as it is being generated.
@@ -547,8 +553,8 @@ section numbering conventions.
=head1 SEE ALSO
-L<Pod::Man>, L<Pod::Simple>, L<man(1)>, L<nroff(1)>, L<podchecker(1)>,
-L<troff(1)>, L<man(7)>
+L<Pod::Man>, L<Pod::Simple>, L<man(1)>, L<nroff(1)>, L<perlpod(1)>,
+L<podchecker(1)>, L<troff(1)>, L<man(7)>
The man page documenting the an macro set may be L<man(5)> instead of
L<man(7)> on your system.