Debian Codegraph @

upstream/debian-unstable/man3/Pod::Perldoc::ToMan.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::ToMan 3perl"
58 .TH Pod::Perldoc::ToMan 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::ToMan \- let Perldoc render Pod as man pages
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& perldoc \-o man Some::Modulename
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 This is a "plug-in" class that allows Perldoc to use
73 Pod::Man and \f(CW\*(C`groff\*(C'\fR for reading Pod pages.
74 .PP
75 The following options are supported: center, date, fixed, fixedbold,
76 fixeditalic, fixedbolditalic, quotes, release, section
77 .PP
78 (Those options are explained in Pod::Man.)
79 .PP
80 For example:
81 .PP
82 .Vb 1
83 \& perldoc \-o man \-w center:Pod Some::Modulename
84 .Ve
85 .SH CAVEAT
86 .IX Header "CAVEAT"
87 This module may change to use a different pod-to-nroff formatter class
88 in the future, and this may change what options are supported.
89 .SH "SEE ALSO"
90 .IX Header "SEE ALSO"
91 Pod::Man, Pod::Perldoc, Pod::Perldoc::ToNroff
92 .SH "COPYRIGHT AND DISCLAIMERS"
93 .IX Header "COPYRIGHT AND DISCLAIMERS"
94 Copyright (c) 2011 brian d foy. All rights reserved.
95 .PP
96 Copyright (c) 2002,3,4 Sean M. Burke. All rights reserved.
97 .PP
98 This library is free software; you can redistribute it and/or modify it
99 under the same terms as Perl itself.
100 .PP
101 This program is distributed in the hope that it will be useful, but
102 without any warranty; without even the implied warranty of
103 merchantability or fitness for a particular purpose.
104 .SH AUTHOR
105 .IX Header "AUTHOR"
106 Current maintainer: Mark Allen \f(CW\*(C`<[email protected]>\*(C'\fR
107 .PP
108 Past contributions from:
109 brian d foy \f(CW\*(C`<[email protected]>\*(C'\fR
110 Adriano R. Ferreira \f(CW\*(C`<[email protected]>\*(C'\fR,
111 Sean M. Burke \f(CW\*(C`<[email protected]>\*(C'\fR