Commit | Line | Data |
3fea05b9 |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 |
2 | .\" |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
6 | .br |
7 | .if t .Sp |
8 | .ne 5 |
9 | .PP |
10 | \fB\\$1\fR |
11 | .PP |
12 | .. |
13 | .de Sp \" Vertical space (when we can't use .PP) |
14 | .if t .sp .5v |
15 | .if n .sp |
16 | .. |
17 | .de Vb \" Begin verbatim text |
18 | .ft CW |
19 | .nf |
20 | .ne \\$1 |
21 | .. |
22 | .de Ve \" End verbatim text |
23 | .ft R |
24 | .fi |
25 | .. |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
32 | .tr \(*W-|\(bv\*(Tr |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
34 | .ie n \{\ |
35 | . ds -- \(*W- |
36 | . ds PI pi |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
39 | . ds L" "" |
40 | . ds R" "" |
41 | . ds C` "" |
42 | . ds C' "" |
43 | 'br\} |
44 | .el\{\ |
45 | . ds -- \|\(em\| |
46 | . ds PI \(*p |
47 | . ds L" `` |
48 | . ds R" '' |
49 | 'br\} |
50 | .\" |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
54 | .\" output yourself in some meaningful fashion. |
55 | .if \nF \{\ |
56 | . de IX |
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
58 | .. |
59 | . nr % 0 |
60 | . rr F |
61 | .\} |
62 | .\" |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
64 | .\" way too many mistakes in technical documents. |
65 | .hy 0 |
66 | .if n .na |
67 | .\" |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
70 | . \" fudge factors for nroff and troff |
71 | .if n \{\ |
72 | . ds #H 0 |
73 | . ds #V .8m |
74 | . ds #F .3m |
75 | . ds #[ \f1 |
76 | . ds #] \fP |
77 | .\} |
78 | .if t \{\ |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
80 | . ds #V .6m |
81 | . ds #F 0 |
82 | . ds #[ \& |
83 | . ds #] \& |
84 | .\} |
85 | . \" simple accents for nroff and troff |
86 | .if n \{\ |
87 | . ds ' \& |
88 | . ds ` \& |
89 | . ds ^ \& |
90 | . ds , \& |
91 | . ds ~ ~ |
92 | . ds / |
93 | .\} |
94 | .if t \{\ |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
101 | .\} |
102 | . \" troff and (daisy-wheel) nroff accents |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
110 | .ds ae a\h'-(\w'a'u*4/10)'e |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
112 | . \" corrections for vroff |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
115 | . \" for low resolution devices (crt and lpr) |
116 | .if \n(.H>23 .if \n(.V>19 \ |
117 | \{\ |
118 | . ds : e |
119 | . ds 8 ss |
120 | . ds o a |
121 | . ds d- d\h'-1'\(ga |
122 | . ds D- D\h'-1'\(hy |
123 | . ds th \o'bp' |
124 | . ds Th \o'LP' |
125 | . ds ae ae |
126 | . ds Ae AE |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
130 | .\" |
131 | .IX Title "ExtUtils::Mksymlists 3" |
132 | .TH ExtUtils::Mksymlists 3 "2009-07-07" "perl v5.8.7" "User Contributed Perl Documentation" |
133 | .SH "NAME" |
134 | ExtUtils::Mksymlists \- write linker options files for dynamic extension |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 5 |
138 | \& use ExtUtils::Mksymlists; |
139 | \& Mksymlists({ NAME => $name , |
140 | \& DL_VARS => [ $var1, $var2, $var3 ], |
141 | \& DL_FUNCS => { $pkg1 => [ $func1, $func2 ], |
142 | \& $pkg2 => [ $func3 ] }); |
143 | .Ve |
144 | .SH "DESCRIPTION" |
145 | .IX Header "DESCRIPTION" |
146 | \&\f(CW\*(C`ExtUtils::Mksymlists\*(C'\fR produces files used by the linker under some OSs |
147 | during the creation of shared libraries for dynamic extensions. It is |
148 | normally called from a MakeMaker-generated Makefile when the extension |
149 | is built. The linker option file is generated by calling the function |
150 | \&\f(CW\*(C`Mksymlists\*(C'\fR, which is exported by default from \f(CW\*(C`ExtUtils::Mksymlists\*(C'\fR. |
151 | It takes one argument, a list of key-value pairs, in which the following |
152 | keys are recognized: |
153 | .IP "\s-1DLBASE\s0" 4 |
154 | .IX Item "DLBASE" |
155 | This item specifies the name by which the linker knows the |
156 | extension, which may be different from the name of the |
157 | extension itself (for instance, some linkers add an '_' to the |
158 | name of the extension). If it is not specified, it is derived |
159 | from the \s-1NAME\s0 attribute. It is presently used only by \s-1OS2\s0 and Win32. |
160 | .IP "\s-1DL_FUNCS\s0" 4 |
161 | .IX Item "DL_FUNCS" |
162 | This is identical to the \s-1DL_FUNCS\s0 attribute available via MakeMaker, |
163 | from which it is usually taken. Its value is a reference to an |
164 | associative array, in which each key is the name of a package, and |
165 | each value is an a reference to an array of function names which |
166 | should be exported by the extension. For instance, one might say |
167 | \&\f(CW\*(C`DL_FUNCS => { Homer::Iliad => [ qw(trojans greeks) ], |
168 | Homer::Odyssey => [ qw(travellers family suitors) ] }\*(C'\fR. The |
169 | function names should be identical to those in the \s-1XSUB\s0 code; |
170 | \&\f(CW\*(C`Mksymlists\*(C'\fR will alter the names written to the linker option |
171 | file to match the changes made by \fIxsubpp\fR. In addition, if |
172 | none of the functions in a list begin with the string \fBboot_\fR, |
173 | \&\f(CW\*(C`Mksymlists\*(C'\fR will add a bootstrap function for that package, |
174 | just as xsubpp does. (If a \fBboot_<pkg>\fR function is |
175 | present in the list, it is passed through unchanged.) If |
176 | \&\s-1DL_FUNCS\s0 is not specified, it defaults to the bootstrap |
177 | function for the extension specified in \s-1NAME\s0. |
178 | .IP "\s-1DL_VARS\s0" 4 |
179 | .IX Item "DL_VARS" |
180 | This is identical to the \s-1DL_VARS\s0 attribute available via MakeMaker, |
181 | and, like \s-1DL_FUNCS\s0, it is usually specified via MakeMaker. Its |
182 | value is a reference to an array of variable names which should |
183 | be exported by the extension. |
184 | .IP "\s-1FILE\s0" 4 |
185 | .IX Item "FILE" |
186 | This key can be used to specify the name of the linker option file |
187 | (minus the OS-specific extension), if for some reason you do not |
188 | want to use the default value, which is the last word of the \s-1NAME\s0 |
189 | attribute (\fIe.g.\fR for \f(CW\*(C`Tk::Canvas\*(C'\fR, \s-1FILE\s0 defaults to \f(CW\*(C`Canvas\*(C'\fR). |
190 | .IP "\s-1FUNCLIST\s0" 4 |
191 | .IX Item "FUNCLIST" |
192 | This provides an alternate means to specify function names to be |
193 | exported from the extension. Its value is a reference to an |
194 | array of function names to be exported by the extension. These |
195 | names are passed through unaltered to the linker options file. |
196 | Specifying a value for the \s-1FUNCLIST\s0 attribute suppresses automatic |
197 | generation of the bootstrap function for the package. To still create |
198 | the bootstrap name you have to specify the package name in the |
199 | \&\s-1DL_FUNCS\s0 hash: |
200 | .Sp |
201 | .Vb 3 |
202 | \& Mksymlists({ NAME => $name , |
203 | \& FUNCLIST => [ $func1, $func2 ], |
204 | \& DL_FUNCS => { $pkg => [] } }); |
205 | .Ve |
206 | .IP "\s-1IMPORTS\s0" 4 |
207 | .IX Item "IMPORTS" |
208 | This attribute is used to specify names to be imported into the |
209 | extension. It is currently only used by \s-1OS/2\s0 and Win32. |
210 | .IP "\s-1NAME\s0" 4 |
211 | .IX Item "NAME" |
212 | This gives the name of the extension (\fIe.g.\fR \f(CW\*(C`Tk::Canvas\*(C'\fR) for which |
213 | the linker option file will be produced. |
214 | .PP |
215 | When calling \f(CW\*(C`Mksymlists\*(C'\fR, one should always specify the \s-1NAME\s0 |
216 | attribute. In most cases, this is all that's necessary. In |
217 | the case of unusual extensions, however, the other attributes |
218 | can be used to provide additional information to the linker. |
219 | .SH "AUTHOR" |
220 | .IX Header "AUTHOR" |
221 | Charles Bailey \fI<bailey@newman.upenn.edu>\fR |
222 | .SH "REVISION" |
223 | .IX Header "REVISION" |
224 | Last revised 14\-Feb\-1996, for Perl 5.002. |