X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fpod2text.PL;h=ede0fe76b00dbcbd11612dc03efb2c9e235778d3;hb=fe61459e95657c432074058bd8854fec03559335;hp=7b5727decc0bf7a0e081dc3565830310a16afb3e;hpb=0e06870bf080a38cda51c06c6612359afc2334e1;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/pod2text.PL b/pod/pod2text.PL old mode 100644 new mode 100755 index 7b5727d..ede0fe7 --- a/pod/pod2text.PL +++ b/pod/pod2text.PL @@ -37,9 +37,9 @@ print OUT <<'!NO!SUBS!'; # pod2text -- Convert POD data to formatted ASCII text. # -# Copyright 1999, 2000 by Russ Allbery +# Copyright 1999, 2000, 2001, 2004, 2006, 2008 Russ Allbery # -# This program is free software; you can redistribute it and/or modify it +# This program is free software; you may redistribute it and/or modify it # under the same terms as Perl itself. # # The driver script for Pod::Text, Pod::Text::Termcap, and Pod::Text::Color, @@ -53,6 +53,9 @@ use Pod::Usage qw(pod2usage); use strict; +# Silence -w warnings. +use vars qw($running_under_some_shell); + # Take an initial pass through our options, looking for one of the form # -. We turn that into -w for compatibility with the # original pod2text script. @@ -64,7 +67,7 @@ for (my $i = 0; $i < @ARGV; $i++) { } # Insert -- into @ARGV before any single dash argument to hide it from -# Getopt::Long; we want to interpret it as meaning stdin (which Pod::Parser +# Getopt::Long; we want to interpret it as meaning stdin (which Pod::Simple # does correctly). my $stdin; @ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV; @@ -74,9 +77,11 @@ my $stdin; my %options; $options{sentence} = 0; Getopt::Long::config ('bundling'); -GetOptions (\%options, 'alt|a', 'color|c', 'help|h', 'indent|i=i', - 'loose|l', 'overstrike|o', 'quotes|q=s', 'sentence|s', - 'termcap|t', 'width|w=i') or exit 1; +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', '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. @@ -97,7 +102,10 @@ delete @options{'color', 'termcap', 'overstrike'}; # Initialize and run the formatter. my $parser = $formatter->new (%options); -$parser->parse_from_file (@ARGV); +do { + my ($input, $output) = splice (@ARGV, 0, 2); + $parser->parse_from_file ($input, $output); +} while (@ARGV); __END__ @@ -105,10 +113,14 @@ __END__ pod2text - Convert POD data to formatted ASCII text +=for stopwords +-aclostu --alt --stderr Allbery --overstrike overstrike --termcap --utf8 +UTF-8 + =head1 SYNOPSIS -pod2text [B<-aclost>] [B<-i> I] [B<-q> I] [B<-w> I] -[I [I]] +pod2text [B<-aclostu>] [B<--code>] [B<-i> I] S<[B<-q> I]> + [B<--stderr>] S<[B<-w> I]> [I [I ...]] pod2text B<-h> @@ -119,9 +131,12 @@ to generate formatted ASCII text from POD source. It can optionally use either termcap sequences or ANSI color escape sequences to format the text. I is the file to read for POD source (the POD can be embedded in -code). If I isn't given, it defaults to STDIN. I, if given, -is the file to which to write the formatted output. If I isn't -given, the formatted output is written to STDOUT. +code). If I isn't given, it defaults to C. I, if +given, is the file to which to write the formatted output. If I +isn't given, the formatted output is written to C. Several POD +files can be processed in the same B invocation (saving module +load and compile times) by providing multiple pairs of I and +I files on the command line. =head1 OPTIONS @@ -132,6 +147,12 @@ given, the formatted output is written to STDOUT. Use an alternate output format that, among other things, uses a different heading style and marks C<=item> entries with a colon in the left margin. +=item B<--code> + +Include any non-POD text from the input file in the output as well. Useful +for viewing code documented with POD blocks with the POD rendered and the +code left intact. + =item B<-c>, B<--color> Format the output with ANSI color escape sequences. Using this option @@ -153,9 +174,15 @@ printed after C<=head1>, although one is still printed after C<=head2>, because this is the expected formatting for manual pages; if you're formatting arbitrary text documents, using this option is recommended. +=item B<-m> I, B<--left-margin>=I, B<--margin>=I + +The width of the left margin in spaces. Defaults to 0. This is the margin +for all text, including headings, not the amount by which regular text is +indented; for the latter, see B<-i> option. + =item B<-o>, B<--overstrike> -Format the output with overstruck printing. Bold text is rendered as +Format the output with overstrike printing. Bold text is rendered as character, backspace, character. Italics and file names are rendered as underscore, backspace, character. Many pagers, such as B, know how to convert this to bold or underlined text. @@ -178,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 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 @@ -188,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 will contain terminal control sequences for your current terminal type. +=item B<-u>, B<--utf8> + +By default, B 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 for more information on the C<=encoding> command. + =item B<-w>, B<--width=>I, B<->I The column at which to wrap text on the right-hand side. Defaults to 76, @@ -198,7 +244,7 @@ your terminal device. =head1 DIAGNOSTICS -If B fails with errors, see L and L for +If B fails with errors, see L and L for information about what those errors might mean. Internally, it can also produce the following diagnostics: @@ -215,8 +261,8 @@ loaded. =back -In addition, other L error messages may result -from invalid command-line options. +In addition, other L error messages may result from invalid +command-line options. =head1 ENVIRONMENT @@ -238,12 +284,24 @@ current terminal device. =head1 SEE ALSO -L, L, -L, L +L, L, L, +L, L, L + +The current version of this script is always available from its web site at +L. It is also part of the +Perl core distribution as of 5.6.0. =head1 AUTHOR -Russ Allbery Erra@stanford.eduE. +Russ Allbery . + +=head1 COPYRIGHT AND LICENSE + +Copyright 1999, 2000, 2001, 2004, 2006, 2008 Russ Allbery +. + +This program is free software; you may redistribute it and/or modify it +under the same terms as Perl itself. =cut !NO!SUBS!