Debian Codegraph @

upstream/debian-unstable/man3/Pod::Perldoc::BaseTo.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Pod::Perldoc::BaseTo 3perl"
58 .TH Pod::Perldoc::BaseTo 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Pod::Perldoc::BaseTo \- Base for Pod::Perldoc formatters
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& package Pod::Perldoc::ToMyFormat;
69 \&
70 \& use parent qw( Pod::Perldoc::BaseTo );
71 \& ...
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 This package is meant as a base of Pod::Perldoc formatters,
76 like Pod::Perldoc::ToText, Pod::Perldoc::ToMan, etc.
77 .PP
78 It provides default implementations for the methods
79 .PP
80 .Vb 4
81 \& is_pageable
82 \& write_with_binmode
83 \& output_extension
84 \& _perldoc_elem
85 .Ve
86 .PP
87 The concrete formatter must implement
88 .PP
89 .Vb 2
90 \& new
91 \& parse_from_file
92 .Ve
93 .SH "SEE ALSO"
94 .IX Header "SEE ALSO"
95 perldoc
96 .SH "COPYRIGHT AND DISCLAIMERS"
97 .IX Header "COPYRIGHT AND DISCLAIMERS"
98 Copyright (c) 2002\-2007 Sean M. Burke.
99 .PP
100 This library is free software; you can redistribute it and/or modify it
101 under the same terms as Perl itself.
102 .PP
103 This program is distributed in the hope that it will be useful, but
104 without any warranty; without even the implied warranty of
105 merchantability or fitness for a particular purpose.
106 .SH AUTHOR
107 .IX Header "AUTHOR"
108 Current maintainer: Mark Allen \f(CW\*(C`<[email protected]>\*(C'\fR
109 .PP
110 Past contributions from:
111 brian d foy \f(CW\*(C`<[email protected]>\*(C'\fR
112 Adriano R. Ferreira \f(CW\*(C`<[email protected]>\*(C'\fR,
113 Sean M. Burke \f(CW\*(C`<[email protected]>\*(C'\fR