MAN page from Old RedHat 5.X perl-5.004-4.i386.rpm

ExtUtils::Mksymlists

Section: Perl Programmers Reference Guide (3)
Updated: perl 5.004, patch 04
Index

NAME

ExtUtils::Mksymlists - write linker options files for dynamic extension

SYNOPSIS

    use ExtUtils::Mksymlists;    Mksymlists({ NAME     => $name ,                 DL_VARS  => [ $var1, $var2, $var3 ],                 DL_FUNCS => { $pkg1 => [ $func1, $func2 ],                               $pkg2 => [ $func3 ] });

DESCRIPTION

ExtUtils::Mksymlists produces files used by the linker under some OSsduring the creation of shared libraries for dynamic extensions. It isnormally called from a MakeMaker-generated Makefile when the extensionis built. The linker option file is generated by calling the functionMksymlists, which is exported by default from ExtUtils::Mksymlists.It takes one argument, a list of key-value pairs, in which the followingkeys are recognized:

NAME: This gives the name of the extension (e.g. Tk::Canvas) for whichthe linker option file will be produced.
DL_FUNCS: This is identical to the DL_FUNCS attribute available via MakeMaker,from which it is usually taken. Its value is a reference to anassociative array, in which each key is the name of a package, andeach value is an a reference to an array of function names whichshould be exported by the extension. For instance, one might sayDL_FUNCS => { Homer::Iliad => [ qw(trojans greeks) ],Homer::Odyssey => [ qw(travellers family suitors) ] }. Thefunction names should be identical to those in the XSUB code;Mksymlists will alter the names written to the linker optionfile to match the changes made by xsubpp. In addition, ifnone of the functions in a list begin with the string boot_,Mksymlists will add a bootstrap function for that package,just as xsubpp does. (If a boot_<pkg> function ispresent in the list, it is passed through unchanged.) IfDL_FUNCS is not specified, it defaults to the bootstrapfunction for the extension specified in NAME.
DL_VARS: This is identical to the DL_VARS attribute available via MakeMaker,and, like DL_FUNCS, it is usually specified via MakeMaker. Itsvalue is a reference to an array of variable names which shouldbe exported by the extension.
FILE: This key can be used to specify the name of the linker option file(minus the OS-specific extension), if for some reason you do notwant to use the default value, which is the last word of the NAMEattribute (e.g. for Tk::Canvas, FILE defaults to `Canvas').
FUNCLIST: This provides an alternate means to specify function names to beexported from the extension. Its value is a reference to anarray of function names to be exported by the extension. Thesenames are passed through unaltered to the linker options file.
DLBASE: This item specifies the name by which the linker knows theextension, which may be different from the name of theextension itself (for instance, some linkers add an `_' to thename of the extension). If it is not specified, it is derivedfrom the NAME attribute. It is presently used only by OS2.

When calling Mksymlists, one should always specify the NAMEattribute. In most cases, this is all that's necessary. Inthe case of unusual extensions, however, the other attributescan be used to provide additional information to the linker.

AUTHOR

Charles Bailey <baileyAATTgenetics.upenn.edu>

REVISION

Last revised 14-Feb-1996, for Perl 5.002.

This document was created byman2html,using the manual pages.