summaryrefslogtreecommitdiff
path: root/pod/pod2text.PL
diff options
context:
space:
mode:
authorJarkko Hietaniemi <jhi@iki.fi>2001-10-20 15:18:57 +0000
committerJarkko Hietaniemi <jhi@iki.fi>2001-10-20 15:18:57 +0000
commit59548ecaeaf22737b5c8a75235f5e142c16de75d (patch)
treee4a134fb0cc2ed95415bc1519976cb660ef940d1 /pod/pod2text.PL
parenta5d0b98deea758380063fe2b6a93bf49a9fff7e5 (diff)
downloadperl-59548ecaeaf22737b5c8a75235f5e142c16de75d.tar.gz
Upgrade to podlators 1.11, from Russ Allbery.
p4raw-id: //depot/perl@12535
Diffstat (limited to 'pod/pod2text.PL')
-rw-r--r--pod/pod2text.PL17
1 files changed, 13 insertions, 4 deletions
diff --git a/pod/pod2text.PL b/pod/pod2text.PL
index 54a22790a4..e038021c70 100644
--- a/pod/pod2text.PL
+++ b/pod/pod2text.PL
@@ -37,7 +37,7 @@ print OUT <<'!NO!SUBS!';
# pod2text -- Convert POD data to formatted ASCII text.
#
-# Copyright 1999, 2000 by Russ Allbery <rra@stanford.edu>
+# Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>
#
# This program is free software; you may redistribute it and/or modify it
# under the same terms as Perl itself.
@@ -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
# -<number>. We turn that into -w <number> for compatibility with the
# original pod2text script.
@@ -74,7 +77,7 @@ my $stdin;
my %options;
$options{sentence} = 0;
Getopt::Long::config ('bundling');
-GetOptions (\%options, 'alt|a', 'color|c', 'help|h', 'indent|i=i',
+GetOptions (\%options, 'alt|a', 'code', 'color|c', 'help|h', 'indent|i=i',
'loose|l', 'overstrike|o', 'quotes|q=s', 'sentence|s',
'termcap|t', 'width|w=i') or exit 1;
pod2usage (1) if $options{help};
@@ -107,8 +110,8 @@ pod2text - Convert POD data to formatted ASCII text
=head1 SYNOPSIS
-pod2text [B<-aclost>] [B<-i> I<indent>] [B<-q> I<quotes>] [B<-w> I<width>]
-[I<input> [I<output>]]
+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<-h>
@@ -132,6 +135,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