Commit | Line | Data |
1a67fee7 |
1 | |
2 | require 5; |
3 | package Pod::Perldoc::ToMan; |
4 | use strict; |
5 | use warnings; |
6 | |
7 | # This class is unlike ToText.pm et al, because we're NOT paging thru |
a60a0c74 |
8 | # the output in our particular format -- we make the output and |
1a67fee7 |
9 | # then we run nroff (or whatever) on it, and then page thru the |
10 | # (plaintext) output of THAT! |
11 | |
12 | use base qw(Pod::Perldoc::BaseTo); |
13 | sub is_pageable { 1 } |
14 | sub write_with_binmode { 0 } |
15 | sub output_extension { 'txt' } |
16 | |
17 | sub __filter_nroff { shift->_perldoc_elem('__filter_nroff' , @_) } |
18 | sub __nroffer { shift->_perldoc_elem('__nroffer' , @_) } |
19 | sub __bindir { shift->_perldoc_elem('__bindir' , @_) } |
20 | sub __pod2man { shift->_perldoc_elem('__pod2man' , @_) } |
21 | sub __output_file { shift->_perldoc_elem('__output_file' , @_) } |
22 | |
23 | sub center { shift->_perldoc_elem('center' , @_) } |
24 | sub date { shift->_perldoc_elem('date' , @_) } |
25 | sub fixed { shift->_perldoc_elem('fixed' , @_) } |
26 | sub fixedbold { shift->_perldoc_elem('fixedbold' , @_) } |
27 | sub fixeditalic { shift->_perldoc_elem('fixeditalic' , @_) } |
28 | sub fixedbolditalic { shift->_perldoc_elem('fixedbolditalic', @_) } |
29 | sub quotes { shift->_perldoc_elem('quotes' , @_) } |
30 | sub release { shift->_perldoc_elem('release' , @_) } |
31 | sub section { shift->_perldoc_elem('section' , @_) } |
32 | |
33 | sub new { return bless {}, ref($_[0]) || $_[0] } |
34 | |
35 | use File::Spec::Functions qw(catfile); |
36 | |
37 | sub parse_from_file { |
38 | my $self = shift; |
39 | my($file, $outfh) = @_; |
40 | |
41 | my $render = $self->{'__nroffer'} || die "no nroffer set!?"; |
42 | |
43 | # turn the switches into CLIs |
44 | my $switches = join ' ', |
45 | map qq{"--$_=$self->{$_}"}, |
46 | grep !m/^_/s, |
47 | keys %$self |
48 | ; |
49 | |
50 | my $command = |
51 | catfile( |
52 | ($self->{'__bindir'} || die "no bindir set?!" ), |
53 | ($self->{'__pod2man'} || die "no pod2man set?!" ), |
54 | ) |
55 | . " $switches --lax $file | $render -man" |
56 | ; # no temp file, just a pipe! |
a60a0c74 |
57 | |
58 | # I hear persistent reports that adding a -c switch to $render |
59 | # solves many people's problems. But I also hear that some mans |
60 | # don't have a -c switch, so that adding it here would presumably |
61 | # be a Bad Thing -- sburke@cpan.org |
62 | |
1a67fee7 |
63 | $command .= " | col -x" if $^O =~ /hpux/; |
64 | |
65 | defined(&Pod::Perldoc::DEBUG) |
66 | and Pod::Perldoc::DEBUG() |
67 | and print "About to run $command\n"; |
68 | ; |
69 | |
70 | my $rslt = `$command`; |
71 | |
72 | my $err; |
73 | |
74 | if( $self->{'__filter_nroff'} ) { |
75 | defined(&Pod::Perldoc::DEBUG) |
76 | and &Pod::Perldoc::DEBUG() |
77 | and print "filter_nroff is set, so filtering...\n"; |
78 | $rslt = $self->___Do_filter_nroff($rslt); |
79 | } else { |
80 | defined(&Pod::Perldoc::DEBUG) |
81 | and Pod::Perldoc::DEBUG() |
82 | and print "filter_nroff isn't set, so not filtering.\n"; |
83 | } |
84 | |
85 | if (($err = $?)) { |
86 | defined(&Pod::Perldoc::DEBUG) |
87 | and Pod::Perldoc::DEBUG() |
88 | and print "Nonzero exit ($?) while running $command.\n", |
89 | "Falling back to Pod::Perldoc::ToPod\n ", |
90 | ; |
91 | # A desperate fallthru: |
92 | require Pod::Perldoc::ToPod; |
93 | return Pod::Perldoc::ToPod->new->parse_from_file(@_); |
94 | |
95 | } else { |
96 | print $outfh $rslt |
97 | or die "Can't print to $$self{__output_file}: $!"; |
98 | } |
99 | |
100 | return; |
101 | } |
102 | |
103 | |
104 | sub ___Do_filter_nroff { |
105 | my $self = shift; |
106 | my @data = split /\n{2,}/, shift; |
107 | |
108 | shift @data while @data and $data[0] !~ /\S/; # Go to header |
109 | shift @data if @data and $data[0] =~ /Contributed\s+Perl/; # Skip header |
110 | pop @data if @data and $data[-1] =~ /^\w/; # Skip footer, like |
111 | # 28/Jan/99 perl 5.005, patch 53 1 |
112 | join "\n\n", @data; |
113 | } |
114 | |
115 | 1; |
116 | |
117 | __END__ |
118 | |
119 | =head1 NAME |
120 | |
121 | Pod::Perldoc::ToMan - let Perldoc render Pod as man pages |
122 | |
123 | =head1 SYNOPSIS |
124 | |
125 | perldoc -o man Some::Modulename |
126 | |
127 | =head1 DESCRIPTION |
128 | |
129 | This is a "plug-in" class that allows Perldoc to use |
130 | Pod::Man and C<nroff> for reading Pod pages. |
131 | |
132 | The following options are supported: center, date, fixed, fixedbold, |
133 | fixeditalic, fixedbolditalic, quotes, release, section |
134 | |
135 | (Those options are explained in L<Pod::Man>.) |
136 | |
137 | For example: |
138 | |
139 | perldoc -o man -w center:Pod Some::Modulename |
140 | |
141 | =head1 CAVEAT |
142 | |
143 | This module may change to use a different pod-to-nroff formatter class |
144 | in the future, and this may change what options are supported. |
145 | |
146 | =head1 SEE ALSO |
147 | |
148 | L<Pod::Man>, L<Pod::Perldoc>, L<Pod::Perldoc::ToNroff> |
149 | |
150 | =head1 COPYRIGHT AND DISCLAIMERS |
151 | |
152 | Copyright (c) 2002 Sean M. Burke. All rights reserved. |
153 | |
154 | This library is free software; you can redistribute it and/or modify it |
155 | under the same terms as Perl itself. |
156 | |
157 | This program is distributed in the hope that it will be useful, but |
158 | without any warranty; without even the implied warranty of |
159 | merchantability or fitness for a particular purpose. |
160 | |
161 | =head1 AUTHOR |
162 | |
163 | Sean M. Burke C<sburke@cpan.org> |
164 | |
165 | =cut |
166 | |