Debian Codegraph @

upstream/mageia-cauldron/man3pm/ExtUtils::Typemaps::Cmd.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 "ExtUtils::Typemaps::Cmd 3pm"
61 .TH ExtUtils::Typemaps::Cmd 3pm 2025-06-24 "perl v5.42.0" "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 ExtUtils::Typemaps::Cmd \- Quick commands for handling typemaps
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 From XS:
71 .PP
72 .Vb 2
73 \& INCLUDE_COMMAND: $^X \-MExtUtils::Typemaps::Cmd \e
74 \& \-e "print embeddable_typemap(q{Excommunicated})"
75 .Ve
76 .PP
77 Loads \f(CW\*(C`ExtUtils::Typemaps::Excommunicated\*(C'\fR, instantiates an object,
78 and dumps it as an embeddable typemap for use directly in your XS file.
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 This is a helper module for ExtUtils::Typemaps for quick
82 one\-liners, specifically for inclusion of shared typemaps
83 that live on CPAN into an XS file (see SYNOPSIS).
84 .PP
85 For this reason, the following functions are exported by default:
86 .SH "EXPORTED FUNCTIONS"
87 .IX Header "EXPORTED FUNCTIONS"
88 .SS embeddable_typemap
89 .IX Subsection "embeddable_typemap"
90 Given a list of identifiers, \f(CW\*(C`embeddable_typemap\*(C'\fR
91 tries to load typemaps from a file of the given name(s),
92 or from a module that is an \f(CW\*(C`ExtUtils::Typemaps\*(C'\fR subclass.
93 .PP
94 Returns a string representation of the merged typemaps that can
95 be included verbatim into XS. Example:
96 .PP
97 .Vb 3
98 \& print embeddable_typemap(
99 \& "Excommunicated", "ExtUtils::Typemaps::Basic", "./typemap"
100 \& );
101 .Ve
102 .PP
103 This will try to load a module \f(CW\*(C`ExtUtils::Typemaps::Excommunicated\*(C'\fR
104 and use it as an \f(CW\*(C`ExtUtils::Typemaps\*(C'\fR subclass. If that fails, it\*(Aqll
105 try loading \f(CW\*(C`Excommunicated\*(C'\fR as a module, if that fails, it\*(Aqll try to
106 read a file called \fIExcommunicated\fR. It\*(Aqll work similarly for the
107 second argument, but the third will be loaded as a file first.
108 .PP
109 After loading all typemap files or modules, it will merge them in the
110 specified order and dump the result as an embeddable typemap.
111 .SH "SEE ALSO"
112 .IX Header "SEE ALSO"
113 ExtUtils::Typemaps
114 .PP
115 perlxs
116 .SH AUTHOR
117 .IX Header "AUTHOR"
118 Steffen Mueller \f(CW\*(C`<[email protected]\*(C'\fR>
119 .SH "COPYRIGHT & LICENSE"
120 .IX Header "COPYRIGHT & LICENSE"
121 Copyright 2012 Steffen Mueller
122 .PP
123 This program is free software; you can redistribute it and/or
124 modify it under the same terms as Perl itself.