summaryrefslogtreecommitdiff
path: root/pod
diff options
context:
space:
mode:
authorSteve Peters <steve@fisharerojo.org>2005-12-07 12:36:59 +0000
committerSteve Peters <steve@fisharerojo.org>2005-12-07 12:36:59 +0000
commitb7ae008f237ac1d94314836a23dc578e678c9243 (patch)
treebb6578229c3930782c8ca18f93dced6f82326504 /pod
parent351625bd207602dfd0011de5eb4628c180eff839 (diff)
downloadperl-b7ae008f237ac1d94314836a23dc578e678c9243.tar.gz
Upgrade to podlators-2.00
p4raw-id: //depot/perl@26292
Diffstat (limited to 'pod')
-rw-r--r--pod/pod2man.PL51
-rw-r--r--pod/pod2text.PL27
2 files changed, 42 insertions, 36 deletions
diff --git a/pod/pod2man.PL b/pod/pod2man.PL
index b1b1a55841..5a78c012ea 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.10 2002/07/15 05:45:56 eagle Exp $
+# $Id: pod2man.PL,v 1.14 2004/12/31 20:39:30 eagle Exp $
#
# Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>
#
@@ -55,8 +55,7 @@ use strict;
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).
+# Getopt::Long; we want to interpret it as meaning stdin.
my $stdin;
@ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV;
@@ -85,9 +84,9 @@ delete $options{lax};
# 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 {
+ my $parser = Pod::Man->new (%options);
@files = splice (@ARGV, 0, 2);
print " $files[1]\n" if $verbose;
$parser->parse_from_file (@files);
@@ -101,7 +100,7 @@ pod2man - Convert POD data to formatted *roff input
=head1 SYNOPSIS
-pod2man [B<--section>=I<manext>] [B<--release>=I<version>]
+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<--name>=I<name>] [B<--official>]
@@ -252,7 +251,7 @@ Print out the name of each output file as it is being generated.
=head1 DIAGNOSTICS
-If B<pod2man> fails with errors, see L<Pod::Man> and L<Pod::Parser> for
+If B<pod2man> fails with errors, see L<Pod::Man> and L<Pod::Simple> for
information about what those errors might mean.
=head1 EXAMPLES
@@ -442,20 +441,6 @@ Bugs you don't plan to fix. :-)
Miscellaneous commentary.
-=item SEE ALSO
-
-Other man pages to check out, like man(1), man(7), makewhatis(8), or
-catman(8). Normally a simple list of man pages separated by commas, or a
-paragraph giving the name of a reference work. Man page references, if they
-use the standard C<name(section)> form, don't have to be enclosed in
-LE<lt>E<gt> (although it's recommended), but other things in this section
-probably should be when appropriate.
-
-If the package has a mailing list, include a URL or subscription
-instructions here.
-
-If the package has a web site, include a URL here.
-
=item AUTHOR
Who wrote it (use AUTHORS for multiple people). Including your current
@@ -464,6 +449,12 @@ so that users have a way of contacting you is a good idea. Remember that
program documentation tends to roam the wild for far longer than you expect
and pick an e-mail address that's likely to last if possible.
+=item HISTORY
+
+Programs derived from other sources sometimes have this, or you might keep
+a modification log here. If the log gets overly long or detailed,
+consider maintaining it in a separate file, though.
+
=item COPYRIGHT AND LICENSE
For copyright
@@ -481,11 +472,19 @@ This makes it easy for people to use your module with Perl. Note that
this licensing is neither an endorsement or a requirement, you are of
course free to choose any licensing.
-=item HISTORY
+=item SEE ALSO
-Programs derived from other sources sometimes have this, or you might keep
-a modification log here. If the log gets overly long or detailed,
-consider maintaining it in a separate file, though.
+Other man pages to check out, like man(1), man(7), makewhatis(8), or
+catman(8). Normally a simple list of man pages separated by commas, or a
+paragraph giving the name of a reference work. Man page references, if they
+use the standard C<name(section)> form, don't have to be enclosed in
+LE<lt>E<gt> (although it's recommended), but other things in this section
+probably should be when appropriate.
+
+If the package has a mailing list, include a URL or subscription
+instructions here.
+
+If the package has a web site, include a URL here.
=back
@@ -511,7 +510,7 @@ function names, man page references, and the like unadorned by markup and
the POD translators will figure it out for you. This makes it much easier
to later edit the documentation. Note that many existing translators
(including this one currently) will do the wrong thing with e-mail addresses
-or URLs when wrapped in LE<lt>E<gt>, so don't do that.
+when wrapped in LE<lt>E<gt>, so don't do that.
For additional information that may be more accurate for your specific
system, see either L<man(5)> or L<man(7)> depending on your system manual
@@ -519,7 +518,7 @@ section numbering conventions.
=head1 SEE ALSO
-L<Pod::Man>, L<Pod::Parser>, L<man(1)>, L<nroff(1)>, L<podchecker(1)>,
+L<Pod::Man>, L<Pod::Simple>, L<man(1)>, L<nroff(1)>, L<podchecker(1)>,
L<troff(1)>, L<man(7)>
The man page documenting the an macro set may be L<man(5)> instead of
diff --git a/pod/pod2text.PL b/pod/pod2text.PL
index 0486e2da0a..785a3f393f 100644
--- a/pod/pod2text.PL
+++ b/pod/pod2text.PL
@@ -67,7 +67,7 @@ for (my $i = 0; $i < @ARGV; $i++) {
}
# 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
+# Getopt::Long; we want to interpret it as meaning stdin (which Pod::Simple
# does correctly).
my $stdin;
@ARGV = map { $_ eq '-' && !$stdin++ ? ('--', $_) : $_ } @ARGV;
@@ -99,8 +99,12 @@ if ($options{color}) {
delete @options{'color', 'termcap', 'overstrike'};
# Initialize and run the formatter.
-my $parser = $formatter->new (%options);
-$parser->parse_from_file (@ARGV);
+do {
+ my $parser = $formatter->new (%options);
+ my ($input, $output) = splice (@ARGV, 0, 2);
+ $parser->parse_file ($input, $output);
+ undef $parser;
+} while (@ARGV);
__END__
@@ -111,7 +115,7 @@ pod2text - Convert POD data to formatted ASCII text
=head1 SYNOPSIS
pod2text [B<-aclost>] [B<--code>] [B<-i> I<indent>] S<[B<-q> I<quotes>]>
-S<[B<-w> I<width>]> [I<input> [I<output>]]
+S<[B<-w> I<width>]> [I<input> [I<output> ...]]
pod2text B<-h>
@@ -124,7 +128,10 @@ either termcap sequences or ANSI color escape sequences to format the text.
I<input> is the file to read for POD source (the POD can be embedded in
code). If I<input> isn't given, it defaults to STDIN. I<output>, if given,
is the file to which to write the formatted output. If I<output> isn't
-given, the formatted output is written to STDOUT.
+given, the formatted output is written to STDOUT. Several POD files can be
+processed in the same B<pod2text> invocation (saving module load and compile
+times) by providing multiple pairs of I<input> and I<output> files on the
+command line.
=head1 OPTIONS
@@ -213,7 +220,7 @@ your terminal device.
=head1 DIAGNOSTICS
-If B<pod2text> fails with errors, see L<Pod::Text> and L<Pod::Parser> for
+If B<pod2text> fails with errors, see L<Pod::Text> and L<Pod::Simple> for
information about what those errors might mean. Internally, it can also
produce the following diagnostics:
@@ -230,8 +237,8 @@ loaded.
=back
-In addition, other L<Getopt::Long|Getopt::Long> error messages may result
-from invalid command-line options.
+In addition, other L<Getopt::Long> error messages may result from invalid
+command-line options.
=head1 ENVIRONMENT
@@ -254,7 +261,7 @@ current terminal device.
=head1 SEE ALSO
L<Pod::Text>, L<Pod::Text::Color>, L<Pod::Text::Overstrike>,
-L<Pod::Text::Termcap>, L<Pod::Parser>
+L<Pod::Text::Termcap>, L<Pod::Simple>
The current version of this script is always available from its web site at
L<http://www.eyrie.org/~eagle/software/podlators/>. It is also part of the
@@ -266,7 +273,7 @@ Russ Allbery <rra@stanford.edu>.
=head1 COPYRIGHT AND LICENSE
-Copyright 1999, 2000, 2001 by Russ Allbery <rra@stanford.edu>.
+Copyright 1999, 2000, 2001, 2004 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.