NAME

h2xs - convert .h C header files to Perl extensions

SYNOPSIS

h2xs [-APcf] [-v version] [-n module_name] [headerfile [extra_libraries]]

h2xs -h

DESCRIPTION

h2xs builds a Perl extension from any C header file. The extension will include functions which can be used to retrieve the value of any #define statement which was in the C header.

The module_name will be used for the name of the extension. If module_name is not supplied then the name of the header file will be used, with the first character capitalized.

If the extension might need extra libraries, they should be included here. The extension Makefile.PL will take care of checking whether the libraries actually exist and how they should be loaded. The extra libraries should be specified in the form -lm -lposix, etc, just as on the cc command line. By default, the Makefile.PL will search through the library path determined by Configure. That path can be augmented by including arguments of the form -L/another/library/path in the extra-libraries argument.

OPTIONS

-A

Omit all autoload facilities. This is the same as -c but also removes the require AutoLoader statement from the .pm file.

-P

Omit the autogenerated stub POD section.

-c

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

-f

Allows an extension to be created for a header even if that header is not found in /usr/include.

-h

Print the usage, help and version for this h2xs and exit.

-n module_name

Specifies a name to be used for the extension, e.g., -n RPC::DCE

-v version

Specify a version number for this extension. This version number is added to the templates. The default is 0.01.

EXAMPLES

# Default behavior, extension is Rusers
h2xs rpcsvc/rusers

# Same, but extension is RUSERS
h2xs -n RUSERS rpcsvc/rusers

# Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
h2xs rpcsvc::rusers

# Extension is ONC::RPC.  Still finds <rpcsvc/rusers.h>
h2xs -n ONC::RPC rpcsvc/rusers

# Without constant() or AUTOLOAD
h2xs -c rpcsvc/rusers

# Creates templates for an extension named RPC
h2xs -cfn RPC

# Extension is ONC::RPC.
h2xs -cfn ONC::RPC

# Makefile.PL will look for library -lrpc in 
# additional directory /opt/net/lib
h2xs rpcsvc/rusers -L/opt/net/lib -lrpc

ENVIRONMENT

No environment variables are used.

AUTHOR

Larry Wall and others

SEE ALSO

perl, perlxstut, ExtUtils::MakeMaker, and AutoLoader.

DIAGNOSTICS

The usual warnings if it can't read or write the files involved.