summaryrefslogtreecommitdiff
path: root/pod
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
parenta5d0b98deea758380063fe2b6a93bf49a9fff7e5 (diff)
downloadperl-59548ecaeaf22737b5c8a75235f5e142c16de75d.tar.gz
Upgrade to podlators 1.11, from Russ Allbery.
p4raw-id: //depot/perl@12535
Diffstat (limited to 'pod')
-rw-r--r--pod/pod2man.PL18
-rw-r--r--pod/pod2text.PL17
2 files changed, 28 insertions, 7 deletions
diff --git a/pod/pod2man.PL b/pod/pod2man.PL
index cef507bc8e..5a1deeaed3 100644
--- a/pod/pod2man.PL
+++ b/pod/pod2man.PL
@@ -36,7 +36,7 @@ $Config{startperl}
print OUT <<'!NO!SUBS!';
# pod2man -- Convert POD data to formatted *roff input.
-# $Id: pod2man.PL,v 1.6 2001/07/10 11:23:46 eagle Exp $
+# $Id: pod2man.PL,v 1.7 2001/10/20 08:24:15 eagle Exp $
#
# Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>
#
@@ -51,6 +51,9 @@ use Pod::Usage qw(pod2usage);
use strict;
+# Silence -w warnings.
+use vars qw($running_under_some_shell);
+
# 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
# does correctly).
@@ -64,7 +67,7 @@ Getopt::Long::config ('bundling_override');
GetOptions (\%options, 'section|s=s', 'release|r=s', 'center|c=s',
'date|d=s', 'fixed=s', 'fixedbold=s', 'fixeditalic=s',
'fixedbolditalic=s', 'official|o', 'quotes|q=s', 'lax|l',
- 'help|h') or exit 1;
+ 'help|h', 'verbose|v') or exit 1;
pod2usage (0) if $options{help};
# Official sets --center, but don't override things explicitly set.
@@ -72,12 +75,17 @@ if ($options{official} && !defined $options{center}) {
$options{center} = 'Perl Programmers Reference Guide';
}
+# Verbose is only our flag, not a Pod::Man flag.
+my $verbose = $options{verbose};
+delete $options{verbose};
+
# Initialize and run the formatter, pulling a pair of input and output off at
# a time.
my $parser = Pod::Man->new (%options);
my @files;
do {
@files = splice (@ARGV, 0, 2);
+ print " $files[1]\n" if $verbose;
$parser->parse_from_file (@files);
} while (@ARGV);
@@ -93,7 +101,7 @@ pod2man [B<--section>=I<manext>] [B<--release>=I<version>]
[B<--center>=I<string>] [B<--date>=I<string>] [B<--fixed>=I<font>]
[B<--fixedbold>=I<font>] [B<--fixeditalic>=I<font>]
[B<--fixedbolditalic>=I<font>] [B<--official>] [B<--lax>]
-[B<--quotes>=I<quotes>] [I<input> [I<output>] ...]
+[B<--quotes>=I<quotes>] [B<--verbose>] [I<input> [I<output>] ...]
pod2man B<--help>
@@ -217,6 +225,10 @@ that are reliably consistent are 1, 2, and 3.
By default, section 1 will be used unless the file ends in .pm in which case
section 3 will be selected.
+=item B<-v>, B<--verbose>
+
+Print out the name of each output file as it is being generated.
+
=back
=head1 DIAGNOSTICS
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