1 # Pod::Text::Termcap -- Convert POD data to ASCII text with format escapes.
2 # $Id: Termcap.pm,v 1.5 2001/11/28 00:21:28 eagle Exp $
4 # Copyright 1999, 2001 by Russ Allbery <rra@stanford.edu>
6 # This program is free software; you may 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 current
13 ##############################################################################
14 # Modules and declarations
15 ##############################################################################
17 package Pod::Text::Termcap;
26 use vars qw(@ISA $VERSION);
30 # Don't use the CVS revision as the version, since this module is also in Perl
31 # core and too many things could munge CVS magic revision strings. This
32 # number should ideally be the same as the CVS revision in podlators, however.
36 ##############################################################################
38 ##############################################################################
40 # In the initialization method, grab our terminal characteristics as well as
41 # do all the stuff we normally do.
45 # The default Term::Cap path won't work on Solaris.
46 $ENV{TERMPATH} = "$ENV{HOME}/.termcap:/etc/termcap"
47 . ":/usr/share/misc/termcap:/usr/share/lib/termcap";
49 my $termios = POSIX::Termios->new;
51 my $ospeed = $termios->getospeed;
53 eval { $term = Tgetent Term::Cap { TERM => undef, OSPEED => $ospeed } };
54 $$self{BOLD} = $$term{_md} || "\e[1m";
55 $$self{UNDL} = $$term{_us} || "\e[4m";
56 $$self{NORM} = $$term{_me} || "\e[m";
58 unless (defined $$self{width}) {
59 $$self{width} = $ENV{COLUMNS} || $$term{_co} || 78;
63 $self->SUPER::initialize;
66 # Make level one headings bold.
71 $self->SUPER::cmd_head1 ("$$self{BOLD}$_$$self{NORM}");
74 # Make level two headings bold.
79 $self->SUPER::cmd_head2 ("$$self{BOLD}$_$$self{NORM}");
82 # Fix up B<> and I<>. Note that we intentionally don't do F<>.
83 sub seq_b { my $self = shift; return "$$self{BOLD}$_[0]$$self{NORM}" }
84 sub seq_i { my $self = shift; return "$$self{UNDL}$_[0]$$self{NORM}" }
86 # Output any included code in bold.
88 my ($self, $code) = @_;
89 $self->output ($$self{BOLD} . $code . $$self{NORM});
92 # Override the wrapping code to igore the special sequences.
97 my $spaces = ' ' x $$self{MARGIN};
98 my $width = $$self{width} - $$self{MARGIN};
99 my $code = "(?:\Q$$self{BOLD}\E|\Q$$self{UNDL}\E|\Q$$self{NORM}\E)";
100 while (length > $width) {
101 if (s/^((?:$code?[^\n]){0,$width})\s+//
102 || s/^((?:$code?[^\n]){$width})//) {
103 $output .= $spaces . $1 . "\n";
108 $output .= $spaces . $_;
109 $output =~ s/\s+$/\n\n/;
114 ##############################################################################
115 # Module return value and documentation
116 ##############################################################################
123 Pod::Text::Color - Convert POD data to ASCII text with format escapes
127 use Pod::Text::Termcap;
128 my $parser = Pod::Text::Termcap->new (sentence => 0, width => 78);
130 # Read POD from STDIN and write to STDOUT.
131 $parser->parse_from_filehandle;
133 # Read POD from file.pod and write to file.txt.
134 $parser->parse_from_file ('file.pod', 'file.txt');
138 Pod::Text::Termcap is a simple subclass of Pod::Text that highlights output
139 text using the correct termcap escape sequences for the current terminal.
140 Apart from the format codes, it in all ways functions like Pod::Text. See
141 L<Pod::Text> for details and available options.
145 This module uses Term::Cap to retrieve the formatting escape sequences for
146 the current terminal, and falls back on the ECMA-48 (the same in this
147 regard as ANSI X3.64 and ISO 6429, the escape codes also used by DEC VT100
148 terminals) if the bold, underline, and reset codes aren't set in the
153 L<Pod::Text>, L<Pod::Parser>, L<Term::Cap>
157 Russ Allbery <rra@stanford.edu>.
159 =head1 COPYRIGHT AND LICENSE
161 Copyright 1999, 2001 by Russ Allbery <rra@stanford.edu>.
163 This program is free software; you may redistribute it and/or modify it
164 under the same terms as Perl itself.