#!/usr/bin/perl -w

$ID = q$Id: pod2txt,v 0.1 1999/06/13 02:42:18 eagle Exp $;

# pod2txt -- Convert POD data to formatted ASCII text.
#            Copyright 1999 by Russ Allbery <rra@stanford.edu>
#
# This program is free software; you can redistribute it and/or modify it
# under the same terms as Perl itself.
#
# The driver script for Pod::SimpleText, Pod::Text::Termcap, and
# Pod::Text::Color, invoked by perldoc -t among other things.

require 5.004;

use Getopt::Long qw(GetOptions);
use Pod::SimpleText ();
use Pod::Usage qw(pod2usage);

use strict;
use vars qw($ID);

# 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.
for (my $i = 0; $i < @ARGV; $i++) {
    last if $ARGV[$i] =~ /^--$/;
    if ($ARGV[$i] =~ /^-(\d+)$/) {
        splice (@ARGV, $i++, 1, '-w', $1);
    }
}

# Parse our options.  Use the same names as Pod::SimpleText for simplicity,
# and default to sentence boundaries turned off for compatibility.
my %options;
$options{termcap} = -t STDOUT;
$options{sentence} = 0;
Getopt::Long::config ('bundling');
GetOptions (\%options, 'alt|a', 'color|c', 'help|h', 'indent|i=i',
            'loose|l', 'sentence|s', 'termcap|t!', 'width|w=i') or exit 1;
pod2usage (1) if $options{help};

# Figure out what formatter we're going to use.  -c overrides -t.
my $formatter = 'Pod::SimpleText';
if ($options{color}) {
    $formatter = 'Pod::Text::Color';
    require Pod::Text::Color;
} elsif ($options{termcap}) {
    $formatter = 'Pod::Text::Termcap';
    require Pod::Text::Termcap;
}
delete @options{'color', 'termcap'};

# Initialize and run the formatter.
my $parser = $formatter->new (%options);
$parser->parse_from_file (@ARGV);

__END__

=head1 NAME

pod2txt - Convert POD data to formatted ASCII text

=head1 SYNOPSIS

pod2txt [B<-aclst>] [B<-i> I<indent>] [B<-w> I<width>] [I<input> [I<output>]]

pod2txt B<-h>

=head1 DESCRIPTION

B<pod2txt> is a front-end for Pod::SimpleText and its subclasses.  It uses
them to generate formatted ASCII text from POD source.  It can optionally
use 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.

=head1 OPTIONS

=over 4

=item B<-a>, B<--alt>

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<-c>, B<--color>

Format the output with ANSI color escape sequences.  Using this option
requires that Term::ANSIColor be installed on your system.

=item B<-i> I<indent>, B<--indent=>I<indent>

Set the number of spaces to indent regular text, and the default indentation
for C<=over> blocks.  Defaults to 4 spaces if this option isn't given.

=item B<-l>, B<--loose>

Print a blank line after a C<=head1> heading.  Normally, no blank line is
printed after C<=head1>, although one is still printed after C<=head2>.
This is the default because it's the expected formatting for manual pages;
if you're formatting arbitrary text documents, using this option is
recommended.

=item B<-s>, B<--sentence>

Assume each sentence ends in two spaces and try to preserve that spacing.
Without this option, all consecutive whitespace in non-verbatim paragraphs
is compressed into a single space.

=item B<-t>, B<--termcap>

Try to determine the width of the screen and the bold and underline
sequences for the terminal from termcap, and use that information in
formatting the output.  Output will be wrapped at two columns less than the
width of your terminal device.  Using this option requires that your system
have a termcap file somewhere where Term::Cap can find it.  With this
option, the output of B<pod2txt> will contain terminal control sequences for
your current terminal type.

=item B<-w>, B<--width=>I<width>, B<->I<width>

The column at which to wrap text on the right-hand side.  Defaults to 76,
unless B<-t> is given, in which case it's two columns less than the width of
your terminal device.

=back

=head1 ENVIRONMENT

=over 4

=item COLUMNS

If B<-t> is given, B<pod2txt> will take the current width of your screen
from this environment variable, if available.  It overrides terminal width
information in TERMCAP.

=item TERMCAP

If B<-t> is given, B<pod2txt> will use the contents of this environment
variable if available to determine the correct formatting sequences for your
current terminal device.

=back

=head1 DIAGNOSTICS

If B<pod2txt> fails with POD errors, see L<Pod::SimpleText> and
L<Pod::Parser> for information about what those errors might mean.

=head1 SEE ALSO

L<Pod::SimpleText|Pod::SimpleText>, L<Pod::Text::Color|Pod::Text::Color>,
L<Pod::Text::Termcap|Pod::Text::Termcap>, L<Pod::Parser|Pod::Parser>

=head1 AUTHOR

Russ Allbery E<lt>rra@stanford.eduE<gt>.

=cut
