pod/pod2text.PL

   1 #!/usr/local/bin/perl
   2
   3 use Config;
   4 use File::Basename qw(&basename &dirname);
   5 use Cwd;
   6
   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
  11 #  $startperl
  12 # to ensure Configure will look for $Config{startperl}.
  13
  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.
  16 $origdir = cwd;
  17 chdir dirname($0);
  18 $file = basename($0, '.PL');
  19 $file .= '.com' if $^O eq 'VMS';
  20
  21 open OUT,">$file" or die "Can't create $file: $!";
  22
  23 print "Extracting $file (with variable substitutions)\n";
  24
  25 # In this section, perl variables will be expanded during extraction.
  26 # You can use $Config{...} to use Configure variables.
  27
  28 print OUT <<"!GROK!THIS!";
  29 $Config{startperl}
  30     eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
  31         if \$running_under_some_shell;
  32 !GROK!THIS!
  33
  34 # In the following, perl variables are not expanded during extraction.
  35
  36 print OUT <<'!NO!SUBS!';
  37
  38 # pod2text -- Convert POD data to formatted ASCII text.
  39 #
  40 # Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>
  41 #
  42 # This program is free software; you may redistribute it and/or modify it
  43 # under the same terms as Perl itself.
  44 #
  45 # The driver script for Pod::Text, Pod::Text::Termcap, and Pod::Text::Color,
  46 # invoked by perldoc -t among other things.
  47
  48 require 5.004;
  49
  50 use Getopt::Long qw(GetOptions);
  51 use Pod::Text ();
  52 use Pod::Usage qw(pod2usage);
  53
  54 use strict;
  55
  56 # Silence -w warnings.
  57 use vars qw($running_under_some_shell);
  58
  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);
  66     }
  67 }
  68
  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
  71 # does correctly).
  72 my $stdin;
  73 @ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV;
  74
  75 # Parse our options.  Use the same names as Pod::Text for simplicity, and
  76 # default to sentence boundaries turned off for compatibility.
  77 my %options;
  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', 'overstrike|o', 'quotes|q=s', 'sentence|s',
  82             'termcap|t', 'width|w=i') or exit 1;
  83 pod2usage (1) if $options{help};
  84
  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;
  98 }
  99 delete @options{'color', 'termcap', 'overstrike'};
 100
 101 # Initialize and run the formatter.
 102 my $parser = $formatter->new (%options);
 103 $parser->parse_from_file (@ARGV);
 104
 105 __END__
 106
 107 =head1 NAME
 108
 109 pod2text - Convert POD data to formatted ASCII text
 110
 111 =head1 SYNOPSIS
 112
 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>]]
 115
 116 pod2text B<-h>
 117
 118 =head1 DESCRIPTION
 119
 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.
 123
 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.
 128
 129 =head1 OPTIONS
 130
 131 =over 4
 132
 133 =item B<-a>, B<--alt>
 134
 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.
 137
 138 =item B<--code>
 139
 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
 142 code left intact.
 143
 144 =item B<-c>, B<--color>
 145
 146 Format the output with ANSI color escape sequences.  Using this option
 147 requires that Term::ANSIColor be installed on your system.
 148
 149 =item B<-i> I<indent>, B<--indent=>I<indent>
 150
 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.
 153
 154 =item B<-h>, B<--help>
 155
 156 Print out usage information and exit.
 157
 158 =item B<-l>, B<--loose>
 159
 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.
 164
 165 =item B<-o>, B<--overstrike>
 166
 167 Format the output with overstruck printing.  Bold text is rendered as
 168 character, backspace, character.  Italics and file names are rendered as
 169 underscore, backspace, character.  Many pagers, such as B<less>, know how
 170 to convert this to bold or underlined text.
 171
 172 =item B<-q> I<quotes>, B<--quotes>=I<quotes>
 173
 174 Sets the quote marks used to surround CE<lt>> text to I<quotes>.  If
 175 I<quotes> is a single character, it is used as both the left and right
 176 quote; if I<quotes> is two characters, the first character is used as the
 177 left quote and the second as the right quoted; and if I<quotes> is four
 178 characters, the first two are used as the left quote and the second two as
 179 the right quote.
 180
 181 I<quotes> may also be set to the special value C<none>, in which case no
 182 quote marks are added around CE<lt>> text.
 183
 184 =item B<-s>, B<--sentence>
 185
 186 Assume each sentence ends with two spaces and try to preserve that spacing.
 187 Without this option, all consecutive whitespace in non-verbatim paragraphs
 188 is compressed into a single space.
 189
 190 =item B<-t>, B<--termcap>
 191
 192 Try to determine the width of the screen and the bold and underline
 193 sequences for the terminal from termcap, and use that information in
 194 formatting the output.  Output will be wrapped at two columns less than the
 195 width of your terminal device.  Using this option requires that your system
 196 have a termcap file somewhere where Term::Cap can find it and requires that
 197 your system support termios.  With this option, the output of B<pod2text>
 198 will contain terminal control sequences for your current terminal type.
 199
 200 =item B<-w>, B<--width=>I<width>, B<->I<width>
 201
 202 The column at which to wrap text on the right-hand side.  Defaults to 76,
 203 unless B<-t> is given, in which case it's two columns less than the width of
 204 your terminal device.
 205
 206 =back
 207
 208 =head1 DIAGNOSTICS
 209
 210 If B<pod2text> fails with errors, see L<Pod::Text> and L<Pod::Parser> for
 211 information about what those errors might mean.  Internally, it can also
 212 produce the following diagnostics:
 213
 214 =over 4
 215
 216 =item -c (--color) requires Term::ANSIColor be installed
 217
 218 (F) B<-c> or B<--color> were given, but Term::ANSIColor could not be
 219 loaded.
 220
 221 =item Unknown option: %s
 222
 223 (F) An unknown command line option was given.
 224
 225 =back
 226
 227 In addition, other L<Getopt::Long|Getopt::Long> error messages may result
 228 from invalid command-line options.
 229
 230 =head1 ENVIRONMENT
 231
 232 =over 4
 233
 234 =item COLUMNS
 235
 236 If B<-t> is given, B<pod2text> will take the current width of your screen
 237 from this environment variable, if available.  It overrides terminal width
 238 information in TERMCAP.
 239
 240 =item TERMCAP
 241
 242 If B<-t> is given, B<pod2text> will use the contents of this environment
 243 variable if available to determine the correct formatting sequences for your
 244 current terminal device.
 245
 246 =back
 247
 248 =head1 SEE ALSO
 249
 250 L<Pod::Text|Pod::Text>, L<Pod::Text::Color|Pod::Text::Color>,
 251 L<Pod::Text::Termcap|Pod::Text::Termcap>, L<Pod::Parser|Pod::Parser>
 252
 253 =head1 AUTHOR
 254
 255 Russ Allbery <rra@stanford.edu>.
 256
 257 =head1 COPYRIGHT AND LICENSE
 258
 259 Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>.
 260
 261 This program is free software; you may redistribute it and/or modify it
 262 under the same terms as Perl itself.
 263
 264 =cut
 265 !NO!SUBS!
 266
 267 close OUT or die "Can't close $file: $!";
 268 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
 269 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';
 270 chdir $origdir;