Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Perldoc::BaseTo.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Perldoc::BaseTo 3pm"
61 .TH Pod::Perldoc::BaseTo 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Perldoc::BaseTo \- Base for Pod::Perldoc formatters
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& package Pod::Perldoc::ToMyFormat;
72 \&
73 \& use parent qw( Pod::Perldoc::BaseTo );
74 \& ...
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 This package is meant as a base of Pod::Perldoc formatters,
79 like Pod::Perldoc::ToText, Pod::Perldoc::ToMan, etc.
80 .PP
81 It provides default implementations for the methods
82 .PP
83 .Vb 4
84 \& is_pageable
85 \& write_with_binmode
86 \& output_extension
87 \& _perldoc_elem
88 .Ve
89 .PP
90 The concrete formatter must implement
91 .PP
92 .Vb 2
93 \& new
94 \& parse_from_file
95 .Ve
96 .SH "SEE ALSO"
97 .IX Header "SEE ALSO"
98 perldoc
99 .SH "COPYRIGHT AND DISCLAIMERS"
100 .IX Header "COPYRIGHT AND DISCLAIMERS"
101 Copyright (c) 2002\-2007 Sean M. Burke.
102 .PP
103 This library is free software; you can redistribute it and/or modify it
104 under the same terms as Perl itself.
105 .PP
106 This program is distributed in the hope that it will be useful, but
107 without any warranty; without even the implied warranty of
108 merchantability or fitness for a particular purpose.
109 .SH AUTHOR
110 .IX Header "AUTHOR"
111 Current maintainer: Mark Allen \f(CW\*(C`<[email protected]>\*(C'\fR
112 .PP
113 Past contributions from:
114 brian d foy \f(CW\*(C`<[email protected]>\*(C'\fR
115 Adriano R. Ferreira \f(CW\*(C`<[email protected]>\*(C'\fR,
116 Sean M. Burke \f(CW\*(C`<[email protected]>\*(C'\fR