X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fpod2man.PL;h=7d7d68f46bac06c7c54a8deeaa555aa6f7b8017a;hb=8162142bfe8ad55439ff878b28c85e654d9a67d3;hp=c353455391f7f8c40377dc4ba780d0db43d8a3a6;hpb=2504ae5250790bc6da9ecd41645e0005cd550a86;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/pod2man.PL b/pod/pod2man.PL old mode 100644 new mode 100755 index c353455..7d7d68f --- 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 used to check its input for validity as a manual -page, but this should now be done by L instead. Accepted for -backwards compatibility; this option no longer does anything. +No longer used. B used to check its input for validity as a +manual page, but this should now be done by L instead. +Accepted for backward compatibility; this option no longer does anything. =item B<-n> I, B<--name>=I @@ -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 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. @@ -345,7 +351,8 @@ documented by this POD page, such as: Manual page indexers are often extremely picky about the format of this section, so don't put anything in it except this line. A single dash, and only a single dash, should separate the list of programs or functions from -the description. Functions should not be qualified with C<()> or the like. +the description. Do not use any markup such as CEE or +BEE. Functions should not be qualified with C<()> or the like. The description should ideally fit on a single line, even if a man program replaces the dash with a few tabs. @@ -547,8 +554,8 @@ section numbering conventions. =head1 SEE ALSO -L, L, L, L, L, -L, L +L, L, L, L, L, +L, L, L The man page documenting the an macro set may be L instead of L on your system.