diff options
Diffstat (limited to 'pod/pod2text.PL')
| -rw-r--r-- | pod/pod2text.PL | 32 |
1 files changed, 27 insertions, 5 deletions
diff --git a/pod/pod2text.PL b/pod/pod2text.PL index 81d29a6d69..ede0fe76b0 100644 --- a/pod/pod2text.PL +++ b/pod/pod2text.PL @@ -79,7 +79,9 @@ $options{sentence} = 0; Getopt::Long::config ('bundling'); GetOptions (\%options, 'alt|a', 'code', 'color|c', 'help|h', 'indent|i=i', 'loose|l', 'margin|left-margin|m=i', 'overstrike|o', - 'quotes|q=s', 'sentence|s', 'termcap|t', 'width|w=i') or exit 1; + 'quotes|q=s', 'sentence|s', 'stderr', 'termcap|t', 'utf8|u', + 'width|w=i') + or exit 1; pod2usage (1) if $options{help}; # Figure out what formatter we're going to use. -c overrides -t. @@ -112,12 +114,13 @@ __END__ pod2text - Convert POD data to formatted ASCII text =for stopwords --aclost --alt Allbery +-aclostu --alt --stderr Allbery --overstrike overstrike --termcap --utf8 +UTF-8 =head1 SYNOPSIS -pod2text [B<-aclost>] [B<--code>] [B<-i> I<indent>] S<[B<-q> I<quotes>]> - S<[B<-w> I<width>]> [I<input> [I<output> ...]] +pod2text [B<-aclostu>] [B<--code>] [B<-i> I<indent>] S<[B<-q> I<quotes>]> + [B<--stderr>] S<[B<-w> I<width>]> [I<input> [I<output> ...]] pod2text B<-h> @@ -202,6 +205,13 @@ Assume each sentence ends with two spaces and try to preserve that spacing. Without this option, all consecutive whitespace in non-verbatim paragraphs is compressed into a single space. +=item B<--stderr> + +By default, B<pod2text> puts any errors detected in the POD input in a POD +ERRORS section in the output manual page. If B<--stderr> is given, errors +are sent to standard error instead and the POD ERRORS section is +suppressed. + =item B<-t>, B<--termcap> Try to determine the width of the screen and the bold and underline @@ -212,6 +222,18 @@ have a termcap file somewhere where Term::Cap can find it and requires that your system support termios. With this option, the output of B<pod2text> will contain terminal control sequences for your current terminal type. +=item B<-u>, B<--utf8> + +By default, B<pod2text> tries to use the same output encoding as its input +encoding (to be backward-compatible with older versions). This option +says to instead force the output encoding to UTF-8. + +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<-w>, B<--width=>I<width>, B<->I<width> The column at which to wrap text on the right-hand side. Defaults to 76, @@ -263,7 +285,7 @@ current terminal device. =head1 SEE ALSO L<Pod::Text>, L<Pod::Text::Color>, L<Pod::Text::Overstrike>, -L<Pod::Text::Termcap>, L<Pod::Simple> +L<Pod::Text::Termcap>, L<Pod::Simple>, L<perlpod(1)> The current version of this script is always available from its web site at L<http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the |