1 # Pod::Text::Termcap -- Convert POD data to ASCII text with format escapes.
2 # $Id: Termcap.pm,v 0.4 1999/09/20 10:17:45 eagle Exp $
4 # Copyright 1999 by Russ Allbery <rra@stanford.edu>
6 # This program is free software; you can redistribute it and/or modify it
7 # under the same terms as Perl itself.
9 # This is a simple subclass of Pod::Text that overrides a few key methods to
10 # output the right termcap escape sequences for formatted text on the
11 # current terminal type.
13 ############################################################################
14 # Modules and declarations
15 ############################################################################
17 package Pod::Text::Termcap;
26 use vars qw(@ISA $VERSION);
30 # Use the CVS revision of this file as its version number.
31 ($VERSION = (split (' ', q$Revision: 0.4 $ ))[1]) =~ s/\.(\d)$/.0$1/;
34 ############################################################################
36 ############################################################################
38 # In the initialization method, grab our terminal characteristics as well as
39 # do all the stuff we normally do.
43 # The default Term::Cap path won't work on Solaris.
44 $ENV{TERMPATH} = "$ENV{HOME}/.termcap:/etc/termcap"
45 . ":/usr/share/misc/termcap:/usr/share/lib/termcap";
47 my $termios = POSIX::Termios->new;
49 my $ospeed = $termios->getospeed;
50 my $term = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed };
51 $$self{BOLD} = $$term{_md} or die 'BOLD';
52 $$self{UNDL} = $$term{_us} or die 'UNDL';
53 $$self{NORM} = $$term{_me} or die 'NORM';
55 unless (defined $$self{width}) {
56 $$self{width} = $ENV{COLUMNS} || $$term{_co} || 78;
60 $self->SUPER::initialize;
63 # Make level one headings bold.
68 $self->SUPER::cmd_head1 ("$$self{BOLD}$_$$self{NORM}");
71 # Make level two headings bold.
76 $self->SUPER::cmd_head2 ("$$self{BOLD}$_$$self{NORM}");
79 # Fix up B<> and I<>. Note that we intentionally don't do F<>.
80 sub seq_b { my $self = shift; return "$$self{BOLD}$_[0]$$self{NORM}" }
81 sub seq_i { my $self = shift; return "$$self{UNDL}$_[0]$$self{NORM}" }
83 # Override the wrapping code to igore the special sequences.
88 my $spaces = ' ' x $$self{MARGIN};
89 my $width = $$self{width} - $$self{MARGIN};
90 my $code = "(?:\Q$$self{BOLD}\E|\Q$$self{UNDL}\E|\Q$$self{NORM}\E)";
91 while (length > $width) {
92 if (s/^((?:$code?[^\n]){0,$width})\s+//
93 || s/^((?:$code?[^\n]){$width})//) {
94 $output .= $spaces . $1 . "\n";
99 $output .= $spaces . $_;
100 $output =~ s/\s+$/\n\n/;
105 ############################################################################
106 # Module return value and documentation
107 ############################################################################
114 Pod::Text::Color - Convert POD data to ASCII text with format escapes
118 use Pod::Text::Termcap;
119 my $parser = Pod::Text::Termcap->new (sentence => 0, width => 78);
121 # Read POD from STDIN and write to STDOUT.
122 $parser->parse_from_filehandle;
124 # Read POD from file.pod and write to file.txt.
125 $parser->parse_from_file ('file.pod', 'file.txt');
129 Pod::Text::Termcap is a simple subclass of Pod::Text that highlights output
130 text using the correct termcap escape sequences for the current terminal.
131 Apart from the format codes, it in all ways functions like Pod::Text. See
132 L<Pod::Text> for details and available options.
136 L<Pod::Text|Pod::Text>, L<Pod::Parser|Pod::Parser>
140 Russ Allbery E<lt>rra@stanford.eduE<gt>.