h2xs

h2xs [options] [headerfile ...] [extralibraries_]

h2xs builds a Perl extension skeleton from C header files. It generates XS code to wrap C libraries, making their constants and functions accessible from Perl, along with a `Makefile.PL`, `.pm` module file, `.xs` file, and test stubs.If no module name is supplied with `-n`, the name of the first header file is used with its first character capitalised. Extra libraries needed at link time can be appended on the command line in the form `-lm -lposix`, optionally with `-L/path` to add a library search directory.The tool can also create a skeleton pure Perl module (no XS) by using the `-X` flag.

HEADERFILE

One or more C header files to parse for `#define` constants and function declarations.

Extra libraries to link against, in the form `-lm -lposix`, optionally with `-L/path` to add search directories.

Specify the name for the extension, e.g. `RPC::DCE`. If omitted, the name of the first header file (capitalised) is used.

Omit all AutoLoader facilities. Removes `use AutoLoader` from the .pm file and implies `-c`.

Omit the XS portion and generate a skeleton pure Perl module. Implies `-c` and `-f`.

Omit `constant()` from the .xs file and the corresponding `AUTOLOAD` from the .pm file.

Allow an existing extension directory to be overwritten.

Generate a .pm file backwards-compatible with the specified Perl version (e.g. `5.005_03`). Versions below 5.6.0 avoid `our` and `use warnings`.

Use an alpha/beta-style version number (`0.00_01`) instead of `0.01`.

Omit creation of the `Changes` file and add a `HISTORY` section to the POD template instead.

Additional flags to pass to the C preprocessor when scanning headers. Also written into the generated `Makefile.PL`.

Select only functions and macros whose names match the given regular expression.

Omit the autogenerated stub POD section.

Generate accessor methods for each element of structs and unions found in the header.

Turn on debugging messages.

Skip constants defined in C enumerations. If a regex is given, skip only enums whose names match it.

Allow creating an extension for a header that is not found in standard include directories.

Include code for safely storing static data in the .xs file.

For function arguments declared as `const`, omit the `const` attribute in the generated XS code.

(Experimental) Declare Perl variables magically tied to C variables of the same name.

Treat C types matched by the regex as opaque data types even if they appear in typemaps. Use with `-x`.

Remove the given prefix from Perl function names (e.g. `-p secrgy`).

Create Perl subroutines for the specified macros (assumed `char *` return type) rather than using the `constant()` mechanism.

Internal type used by `constant()` for macros. Defaults to `IV` (signed integer).

Set the version number for the extension. Defaults to `0.01` (or `0.00_01` with `-B`).

Automatically generate XSUBs from function declarations in the header. Requires the `C::Scan` module.

Do not use `Exporter` or export any symbols.

Do not use `Devel::PPPort` (disables portability to older Perl versions).

Do not use `AutoLoader`, but keep the `constant()` function and `AUTOLOAD` sub for constants.

Do not add `use strict` to the generated module.

Do not add `use warnings` to the generated module.

When `-b` is in effect, generate tests using `Test::More` rather than the older `Test` module.

Force generation of tests using the older `Test` module.

Print usage and version information and exit.

Generated code frequently needs manual customisation. Complex C APIs (function pointers, arrays, non-integer types) require hand-editing of the XS file and typemap. The `-x` option requires the `C::Scan` CPAN module to be installed.

h2xs has been part of Perl since version 5, providing the standard way to create XS extension modules.

h2ph(1), perl(1), perldoc(1)