1 # Pod::Text::Termcap -- Convert POD data to ASCII text with format escapes.
2 # $Id: Termcap.pm,v 1.0 2000/12/25 12:52:48 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 # Don't use the CVS revision as the version, since this module is also in
31 # Perl core and too many things could munge CVS magic revision strings.
32 # This number should ideally be the same as the CVS revision in podlators,
37 ############################################################################
39 ############################################################################
41 # In the initialization method, grab our terminal characteristics as well as
42 # do all the stuff we normally do.
46 # The default Term::Cap path won't work on Solaris.
47 $ENV{TERMPATH
} = "$ENV{HOME}/.termcap:/etc/termcap"
48 . ":/usr/share/misc/termcap:/usr/share/lib/termcap";
50 my $termios = POSIX
::Termios
->new;
52 my $ospeed = $termios->getospeed;
53 my $term = Tgetent Term
::Cap
{ TERM
=> undef, OSPEED
=> $ospeed };
54 $$self{BOLD
} = $$term{_md
} or die 'BOLD';
55 $$self{UNDL
} = $$term{_us
} or die 'UNDL';
56 $$self{NORM
} = $$term{_me
} or die 'NORM';
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 # Override the wrapping code to igore the special sequences.
91 my $spaces = ' ' x
$$self{MARGIN
};
92 my $width = $$self{width
} - $$self{MARGIN
};
93 my $code = "(?:\Q$$self{BOLD}\E|\Q$$self{UNDL}\E|\Q$$self{NORM}\E)";
94 while (length > $width) {
95 if (s/^((?:$code?[^\n]){0,$width})\s+//
96 || s/^((?:$code?[^\n]){$width})//) {
97 $output .= $spaces . $1 . "\n";
102 $output .= $spaces . $_;
103 $output =~ s/\s+$/\n\n/;
108 ############################################################################
109 # Module return value and documentation
110 ############################################################################
117 Pod::Text::Color - Convert POD data to ASCII text with format escapes
121 use Pod::Text::Termcap;
122 my $parser = Pod::Text::Termcap->new (sentence => 0, width => 78);
124 # Read POD from STDIN and write to STDOUT.
125 $parser->parse_from_filehandle;
127 # Read POD from file.pod and write to file.txt.
128 $parser->parse_from_file ('file.pod', 'file.txt');
132 Pod::Text::Termcap is a simple subclass of Pod::Text that highlights output
133 text using the correct termcap escape sequences for the current terminal.
134 Apart from the format codes, it in all ways functions like Pod::Text. See
135 L<Pod::Text> for details and available options.
139 L<Pod::Text|Pod::Text>, L<Pod::Parser|Pod::Parser>
143 Russ Allbery E<lt>rra@stanford.eduE<gt>.