home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _131022b0bbc3d6715d493620cff4d9e5 < prev    next >
Text File  |  2000-03-24  |  6KB  |  208 lines
  1. @rem = '--*-Perl-*--
  2. @echo off
  3. if "%OS%" == "Windows_NT" goto WinNT
  4. perl -x -S "%0" %1 %2 %3 %4 %5 %6 %7 %8 %9
  5. goto endofperl
  6. :WinNT
  7. perl -x -S "%0" %*
  8. if NOT "%COMSPEC%" == "%SystemRoot%\system32\cmd.exe" goto endofperl
  9. if %errorlevel% == 9009 echo You do not have Perl in your PATH.
  10. if errorlevel 1 goto script_failed_so_exit_with_non_zero_val 2>nul
  11. goto endofperl
  12. @rem ';
  13. #!perl
  14. #line 15
  15.     eval 'exec D:\p4-view\main\Apps\Gecko\MSI\data\ActivePerl\Perl\bin\perl.exe -S $0 ${1+"$@"}'
  16.         if $running_under_some_shell;
  17.  
  18. # pod2text -- Convert POD data to formatted ASCII text.
  19. #
  20. # Copyright 1999, 2000 by Russ Allbery <rra@stanford.edu>
  21. #
  22. # This program is free software; you can redistribute it and/or modify it
  23. # under the same terms as Perl itself.
  24. #
  25. # The driver script for Pod::Text, Pod::Text::Termcap, and Pod::Text::Color,
  26. # invoked by perldoc -t among other things.
  27.  
  28. require 5.004;
  29.  
  30. use Getopt::Long qw(GetOptions);
  31. use Pod::Text ();
  32. use Pod::Usage qw(pod2usage);
  33.  
  34. use strict;
  35.  
  36. # Take an initial pass through our options, looking for one of the form
  37. # -<number>.  We turn that into -w <number> for compatibility with the
  38. # original pod2text script.
  39. for (my $i = 0; $i < @ARGV; $i++) {
  40.     last if $ARGV[$i] =~ /^--$/;
  41.     if ($ARGV[$i] =~ /^-(\d+)$/) {
  42.         splice (@ARGV, $i++, 1, '-w', $1);
  43.     }
  44. }
  45.  
  46. # Insert -- into @ARGV before any single dash argument to hide it from
  47. # Getopt::Long; we want to interpret it as meaning stdin (which Pod::Parser
  48. # does correctly).
  49. my $stdin;
  50. @ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV;
  51.  
  52. # Parse our options.  Use the same names as Pod::Text for simplicity, and
  53. # default to sentence boundaries turned off for compatibility.
  54. my %options;
  55. $options{sentence} = 0;
  56. Getopt::Long::config ('bundling');
  57. GetOptions (\%options, 'alt|a', 'color|c', 'help|h', 'indent|i=i',
  58.             'loose|l', 'sentence|s', 'termcap|t', 'width|w=i') or exit 1;
  59. pod2usage (1) if $options{help};
  60.  
  61. # Figure out what formatter we're going to use.  -c overrides -t.
  62. my $formatter = 'Pod::Text';
  63. if ($options{color}) {
  64.     $formatter = 'Pod::Text::Color';
  65.     eval { require Term::ANSIColor };
  66.     if ($@) { die "-c (--color) requires Term::ANSIColor be installed\n" }
  67.     require Pod::Text::Color;
  68. } elsif ($options{termcap}) {
  69.     $formatter = 'Pod::Text::Termcap';
  70.     require Pod::Text::Termcap;
  71. }
  72. delete @options{'color', 'termcap'};
  73.  
  74. # Initialize and run the formatter.
  75. my $parser = $formatter->new (%options);
  76. $parser->parse_from_file (@ARGV);
  77.  
  78. __END__
  79.  
  80. =head1 NAME
  81.  
  82. pod2text - Convert POD data to formatted ASCII text
  83.  
  84. =head1 SYNOPSIS
  85.  
  86. pod2text [B<-aclst>] [B<-i> I<indent>] [B<-w> I<width>] [I<input> [I<output>]]
  87.  
  88. pod2text B<-h>
  89.  
  90. =head1 DESCRIPTION
  91.  
  92. B<pod2text> is a front-end for Pod::Text and its subclasses.  It uses them
  93. to generate formatted ASCII text from POD source.  It can optionally use
  94. either termcap sequences or ANSI color escape sequences to format the text.
  95.  
  96. I<input> is the file to read for POD source (the POD can be embedded in
  97. code).  If I<input> isn't given, it defaults to STDIN.  I<output>, if given,
  98. is the file to which to write the formatted output.  If I<output> isn't
  99. given, the formatted output is written to STDOUT.
  100.  
  101. =head1 OPTIONS
  102.  
  103. =over 4
  104.  
  105. =item B<-a>, B<--alt>
  106.  
  107. Use an alternate output format that, among other things, uses a different
  108. heading style and marks C<=item> entries with a colon in the left margin.
  109.  
  110. =item B<-c>, B<--color>
  111.  
  112. Format the output with ANSI color escape sequences.  Using this option
  113. requires that Term::ANSIColor be installed on your system.
  114.  
  115. =item B<-i> I<indent>, B<--indent=>I<indent>
  116.  
  117. Set the number of spaces to indent regular text, and the default indentation
  118. for C<=over> blocks.  Defaults to 4 spaces if this option isn't given.
  119.  
  120. =item B<-h>, B<--help>
  121.  
  122. Print out usage information and exit.
  123.  
  124. =item B<-l>, B<--loose>
  125.  
  126. Print a blank line after a C<=head1> heading.  Normally, no blank line is
  127. printed after C<=head1>, although one is still printed after C<=head2>,
  128. because this is the expected formatting for manual pages; if you're
  129. formatting arbitrary text documents, using this option is recommended.
  130.  
  131. =item B<-s>, B<--sentence>
  132.  
  133. Assume each sentence ends with two spaces and try to preserve that spacing.
  134. Without this option, all consecutive whitespace in non-verbatim paragraphs
  135. is compressed into a single space.
  136.  
  137. =item B<-t>, B<--termcap>
  138.  
  139. Try to determine the width of the screen and the bold and underline
  140. sequences for the terminal from termcap, and use that information in
  141. formatting the output.  Output will be wrapped at two columns less than the
  142. width of your terminal device.  Using this option requires that your system
  143. have a termcap file somewhere where Term::Cap can find it and requires that
  144. your system support termios.  With this option, the output of B<pod2text>
  145. will contain terminal control sequences for your current terminal type.
  146.  
  147. =item B<-w>, B<--width=>I<width>, B<->I<width>
  148.  
  149. The column at which to wrap text on the right-hand side.  Defaults to 76,
  150. unless B<-t> is given, in which case it's two columns less than the width of
  151. your terminal device.
  152.  
  153. =back
  154.  
  155. =head1 DIAGNOSTICS
  156.  
  157. If B<pod2text> fails with errors, see L<Pod::Text> and L<Pod::Parser> for
  158. information about what those errors might mean.  Internally, it can also
  159. produce the following diagnostics:
  160.  
  161. =over 4
  162.  
  163. =item -c (--color) requires Term::ANSIColor be installed
  164.  
  165. (F) B<-c> or B<--color> were given, but Term::ANSIColor could not be
  166. loaded.
  167.  
  168. =item Unknown option: %s
  169.  
  170. (F) An unknown command line option was given.
  171.  
  172. =back
  173.  
  174. In addition, other L<Getopt::Long|Getopt::Long> error messages may result
  175. from invalid command-line options.
  176.  
  177. =head1 ENVIRONMENT
  178.  
  179. =over 4
  180.  
  181. =item COLUMNS
  182.  
  183. If B<-t> is given, B<pod2text> will take the current width of your screen
  184. from this environment variable, if available.  It overrides terminal width
  185. information in TERMCAP.
  186.  
  187. =item TERMCAP
  188.  
  189. If B<-t> is given, B<pod2text> will use the contents of this environment
  190. variable if available to determine the correct formatting sequences for your
  191. current terminal device.
  192.  
  193. =back
  194.  
  195. =head1 SEE ALSO
  196.  
  197. L<Pod::Text|Pod::Text>, L<Pod::Text::Color|Pod::Text::Color>,
  198. L<Pod::Text::Termcap|Pod::Text::Termcap>, L<Pod::Parser|Pod::Parser>
  199.  
  200. =head1 AUTHOR
  201.  
  202. Russ Allbery E<lt>rra@stanford.eduE<gt>.
  203.  
  204. =cut
  205.  
  206. __END__
  207. :endofperl
  208.