XSUBPP(1)
๐ธ NAME ๐ธ
omg hi bestie, welcome to XSUBPP(1) from the Perl Programmers Reference Guide โ this is the manual page for xsubpp, the compiler to convert Perl XS code into C code. ๐
โจ SYNOPSIS โจ
xsubpp [-v] [-except] [-s pattern] [-prototypes] [-noversioncheck]
[-nolinenumbers] [-nooptimize] [-typemap typemap] [-output filename]...
file.xs
๐ฆ DESCRIPTION ๐ฆ
okay so real talk: this compiler is typically run by the makefiles created by ExtUtils::MakeMaker or by Module::Build or other Perl module build tools. no cap.
xsubpp will compile XS code into C code by embedding the constructs necessary to let C functions manipulate Perl values and creates the glue necessary to let Perl access those functions. the compiler uses typemaps to determine how to map C function parameters and variables to Perl values.
The compiler will search for typemap files called typemap. It will use the following search path to find default typemaps, with the rightmost typemap taking precedence.
../../../typemap:../../typemap:../typemap:typemap
It will also use a default typemap installed as ExtUtils::typemap. periodt.
๐ OPTIONS ๐
Quick note, bestie: the XSOPT MakeMaker option may be used to add these options to any makefiles generated by MakeMaker. ๐
-hiertypeโ Retains'::'in type names so that C++ hierarchical types can be mapped. iykyk-exceptโ Adds exception handling stubs to the C code.-typemap typemapโ Indicates that a user-supplied typemap should take precedence over the default typemaps. This option may be used multiple times, with the last typemap having the highest precedence.-output filenameโ Specifies the name of the output file to generate. If no file is specified, output will be written to standard output.-vโ Prints thexsubppversion number to standard output, then exits.-prototypesโ By defaultxsubppwill not automatically generate prototype code for all xsubs. This flag will enable prototypes.-noversioncheckโ Disables the run time test that determines if the object file (derived from the.xsfile) and the.pmfiles have the same version number.-nolinenumbersโ Prevents the inclusion of#linedirectives in the output.-nooptimizeโ Disables certain optimizations. The only optimization that is currently affected is the use of targets by the output C code (seeperlguts). This may significantly slow down the generated code, but this is the wayxsubppof5.005and earlier operated.-noinoutโ Disable recognition of"IN","OUT_LIST"and"INOUT_LIST"declarations.-noargtypesโ Disable recognition of ANSI-like descriptions of function signature.-C++โ Currently doesn't do anything at all. This flag has been a no-op for many versions of perl, at least as far back asperl5.003_07. It's allowed here for backwards compatibility. iconic no-op behavior-s=...or-strip=...โ This option is obscure and discouraged.
If specified, the given string will be stripped off from the beginning of the C function name in the generated XS functions (if it starts with that prefix). This only applies to XSUBs without "CODE" or "PPCODE" blocks. For example, the XS:
void foo_bar(int i);
when xsubpp is invoked with -s foo_ will install a foo_bar function in Perl, but really call bar(i) in C. Most of the time, this is the opposite of what you want and failure modes are somewhat obscure, so please avoid this option where possible. ๐
๐ฑ ENVIRONMENT ๐ฑ
No environment variables are used. that's the whole thing, bestie. literally zero. ๐
๐ AUTHOR ๐
Originally by Larry Wall. Turned into the ExtUtils::ParseXS module by Ken Williams. legends only.
๐ MODIFICATION HISTORY ๐
See the file Changes.
๐ SEE ALSO ๐
perl(1)perlxs(1)perlxstut(1)ExtUtils::ParseXS
๐ and that's a wrap on XSUBPP(1), bestie โ this page is from perl v5.42.3, dated 2026-11-03. go build something iconic! ๐ซถ
๐ฆ where this page comes from
- alpine 3.24: perl-doc 5.42.3-r0 ยท Artistic-1.0-Perl OR GPL-1.0-or-later
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms