4 use File::Basename qw(&basename &dirname);
7 # List explicitly here the variables you want Configure to
8 # generate. Metaconfig only looks for shell variables, so you
9 # have to mention them as if they were shell variables, not
10 # %Config entries. Thus you write
12 # to ensure Configure will look for $Config{startperl}.
14 # This forces PL files to create target in same directory as PL file.
15 # This is so that make depend always knows where to find PL derivatives.
18 $file = basename($0, '.PL');
19 $file .= '.com' if $^O eq 'VMS';
21 open OUT,">$file" or die "Can't create $file: $!";
23 print "Extracting $file (with variable substitutions)\n";
25 # In this section, perl variables will be expanded during extraction.
26 # You can use $Config{...} to use Configure variables.
28 print OUT <<"!GROK!THIS!";
30 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
31 if \$running_under_some_shell;
34 # In the following, perl variables are not expanded during extraction.
36 print OUT <<'!NO!SUBS!';
38 # pod2text -- Convert POD data to formatted ASCII text.
40 # Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>
42 # This program is free software; you may redistribute it and/or modify it
43 # under the same terms as Perl itself.
45 # The driver script for Pod::Text, Pod::Text::Termcap, and Pod::Text::Color,
46 # invoked by perldoc -t among other things.
50 use Getopt::Long qw(GetOptions);
52 use Pod::Usage qw(pod2usage);
56 # Silence -w warnings.
57 use vars qw($running_under_some_shell);
59 # Take an initial pass through our options, looking for one of the form
60 # -<number>. We turn that into -w <number> for compatibility with the
61 # original pod2text script.
62 for (my $i = 0; $i < @ARGV; $i++) {
63 last if $ARGV[$i] =~ /^--$/;
64 if ($ARGV[$i] =~ /^-(\d+)$/) {
65 splice (@ARGV, $i++, 1, '-w', $1);
69 # Insert -- into @ARGV before any single dash argument to hide it from
70 # Getopt::Long; we want to interpret it as meaning stdin (which Pod::Parser
73 @ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV;
75 # Parse our options. Use the same names as Pod::Text for simplicity, and
76 # default to sentence boundaries turned off for compatibility.
78 $options{sentence} = 0;
79 Getopt::Long::config ('bundling');
80 GetOptions (\%options, 'alt|a', 'code', 'color|c', 'help|h', 'indent|i=i',
81 'loose|l', 'margin|left-margin|m=i', 'overstrike|o',
82 'quotes|q=s', 'sentence|s', 'termcap|t', 'width|w=i') or exit 1;
83 pod2usage (1) if $options{help};
85 # Figure out what formatter we're going to use. -c overrides -t.
86 my $formatter = 'Pod::Text';
87 if ($options{color}) {
88 $formatter = 'Pod::Text::Color';
89 eval { require Term::ANSIColor };
90 if ($@) { die "-c (--color) requires Term::ANSIColor be installed\n" }
91 require Pod::Text::Color;
92 } elsif ($options{termcap}) {
93 $formatter = 'Pod::Text::Termcap';
94 require Pod::Text::Termcap;
95 } elsif ($options{overstrike}) {
96 $formatter = 'Pod::Text::Overstrike';
97 require Pod::Text::Overstrike;
99 delete @options{'color', 'termcap', 'overstrike'};
101 # Initialize and run the formatter.
102 my $parser = $formatter->new (%options);
103 $parser->parse_from_file (@ARGV);
109 pod2text - Convert POD data to formatted ASCII text
113 pod2text [B<-aclost>] [B<--code>] [B<-i> I<indent>] S<[B<-q> I<quotes>]>
114 S<[B<-w> I<width>]> [I<input> [I<output>]]
120 B<pod2text> is a front-end for Pod::Text and its subclasses. It uses them
121 to generate formatted ASCII text from POD source. It can optionally use
122 either termcap sequences or ANSI color escape sequences to format the text.
124 I<input> is the file to read for POD source (the POD can be embedded in
125 code). If I<input> isn't given, it defaults to STDIN. I<output>, if given,
126 is the file to which to write the formatted output. If I<output> isn't
127 given, the formatted output is written to STDOUT.
133 =item B<-a>, B<--alt>
135 Use an alternate output format that, among other things, uses a different
136 heading style and marks C<=item> entries with a colon in the left margin.
140 Include any non-POD text from the input file in the output as well. Useful
141 for viewing code documented with POD blocks with the POD rendered and the
144 =item B<-c>, B<--color>
146 Format the output with ANSI color escape sequences. Using this option
147 requires that Term::ANSIColor be installed on your system.
149 =item B<-i> I<indent>, B<--indent=>I<indent>
151 Set the number of spaces to indent regular text, and the default indentation
152 for C<=over> blocks. Defaults to 4 spaces if this option isn't given.
154 =item B<-h>, B<--help>
156 Print out usage information and exit.
158 =item B<-l>, B<--loose>
160 Print a blank line after a C<=head1> heading. Normally, no blank line is
161 printed after C<=head1>, although one is still printed after C<=head2>,
162 because this is the expected formatting for manual pages; if you're
163 formatting arbitrary text documents, using this option is recommended.
165 =item B<-m> I<width>, B<--left-margin>=I<width>, B<--margin>=I<width>
167 The width of the left margin in spaces. Defaults to 0. This is the margin
168 for all text, including headings, not the amount by which regular text is
169 indented; for the latter, see B<-i> option.
171 =item B<-o>, B<--overstrike>
173 Format the output with overstruck printing. Bold text is rendered as
174 character, backspace, character. Italics and file names are rendered as
175 underscore, backspace, character. Many pagers, such as B<less>, know how
176 to convert this to bold or underlined text.
178 =item B<-q> I<quotes>, B<--quotes>=I<quotes>
180 Sets the quote marks used to surround CE<lt>> text to I<quotes>. If
181 I<quotes> is a single character, it is used as both the left and right
182 quote; if I<quotes> is two characters, the first character is used as the
183 left quote and the second as the right quoted; and if I<quotes> is four
184 characters, the first two are used as the left quote and the second two as
187 I<quotes> may also be set to the special value C<none>, in which case no
188 quote marks are added around CE<lt>> text.
190 =item B<-s>, B<--sentence>
192 Assume each sentence ends with two spaces and try to preserve that spacing.
193 Without this option, all consecutive whitespace in non-verbatim paragraphs
194 is compressed into a single space.
196 =item B<-t>, B<--termcap>
198 Try to determine the width of the screen and the bold and underline
199 sequences for the terminal from termcap, and use that information in
200 formatting the output. Output will be wrapped at two columns less than the
201 width of your terminal device. Using this option requires that your system
202 have a termcap file somewhere where Term::Cap can find it and requires that
203 your system support termios. With this option, the output of B<pod2text>
204 will contain terminal control sequences for your current terminal type.
206 =item B<-w>, B<--width=>I<width>, B<->I<width>
208 The column at which to wrap text on the right-hand side. Defaults to 76,
209 unless B<-t> is given, in which case it's two columns less than the width of
210 your terminal device.
216 If B<pod2text> fails with errors, see L<Pod::Text> and L<Pod::Parser> for
217 information about what those errors might mean. Internally, it can also
218 produce the following diagnostics:
222 =item -c (--color) requires Term::ANSIColor be installed
224 (F) B<-c> or B<--color> were given, but Term::ANSIColor could not be
227 =item Unknown option: %s
229 (F) An unknown command line option was given.
233 In addition, other L<Getopt::Long|Getopt::Long> error messages may result
234 from invalid command-line options.
242 If B<-t> is given, B<pod2text> will take the current width of your screen
243 from this environment variable, if available. It overrides terminal width
244 information in TERMCAP.
248 If B<-t> is given, B<pod2text> will use the contents of this environment
249 variable if available to determine the correct formatting sequences for your
250 current terminal device.
256 L<Pod::Text>, L<Pod::Text::Color>, L<Pod::Text::Overstrike>,
257 L<Pod::Text::Termcap>, L<Pod::Parser>
259 The current version of this script is always available from its web site at
260 L<http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
261 Perl core distribution as of 5.6.0.
265 Russ Allbery <rra@stanford.edu>.
267 =head1 COPYRIGHT AND LICENSE
269 Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>.
271 This program is free software; you may redistribute it and/or modify it
272 under the same terms as Perl itself.
277 close OUT or die "Can't close $file: $!";
278 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
279 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';