h2xs - convert .h C header files to Perl extensions

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>h2xs - convert .h C header files to Perl extensions - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/h2xs"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.005</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/h2xs">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/h2xs">5.40.1</a> <a class="dropdown-item" href="/5.40.0/h2xs">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/h2xs">5.38.3</a> <a class="dropdown-item" href="/5.38.2/h2xs">5.38.2</a> <a class="dropdown-item" href="/5.38.1/h2xs">5.38.1</a> <a class="dropdown-item" href="/5.38.0/h2xs">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/h2xs">5.36.3</a> <a class="dropdown-item" href="/5.36.2/h2xs">5.36.2</a> <a class="dropdown-item" href="/5.36.1/h2xs">5.36.1</a> <a class="dropdown-item" href="/5.36.0/h2xs">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/h2xs">5.34.3</a> <a class="dropdown-item" href="/5.34.2/h2xs">5.34.2</a> <a class="dropdown-item" href="/5.34.1/h2xs">5.34.1</a> <a class="dropdown-item" href="/5.34.0/h2xs">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/h2xs">5.32.1</a> <a class="dropdown-item" href="/5.32.0/h2xs">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/h2xs">5.30.3</a> <a class="dropdown-item" href="/5.30.2/h2xs">5.30.2</a> <a class="dropdown-item" href="/5.30.1/h2xs">5.30.1</a> <a class="dropdown-item" href="/5.30.0/h2xs">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/h2xs">5.28.3</a> <a class="dropdown-item" href="/5.28.2/h2xs">5.28.2</a> <a class="dropdown-item" href="/5.28.1/h2xs">5.28.1</a> <a class="dropdown-item" href="/5.28.0/h2xs">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/h2xs">5.26.3</a> <a class="dropdown-item" href="/5.26.2/h2xs">5.26.2</a> <a class="dropdown-item" href="/5.26.1/h2xs">5.26.1</a> <a class="dropdown-item" href="/5.26.0/h2xs">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/h2xs">5.24.4</a> <a class="dropdown-item" href="/5.24.3/h2xs">5.24.3</a> <a class="dropdown-item" href="/5.24.2/h2xs">5.24.2</a> <a class="dropdown-item" href="/5.24.1/h2xs">5.24.1</a> <a class="dropdown-item" href="/5.24.0/h2xs">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/h2xs">5.22.4</a> <a class="dropdown-item" href="/5.22.3/h2xs">5.22.3</a> <a class="dropdown-item" href="/5.22.2/h2xs">5.22.2</a> <a class="dropdown-item" href="/5.22.1/h2xs">5.22.1</a> <a class="dropdown-item" href="/5.22.0/h2xs">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/h2xs">5.20.3</a> <a class="dropdown-item" href="/5.20.2/h2xs">5.20.2</a> <a class="dropdown-item" href="/5.20.1/h2xs">5.20.1</a> <a class="dropdown-item" href="/5.20.0/h2xs">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/h2xs">5.18.4</a> <a class="dropdown-item" href="/5.18.3/h2xs">5.18.3</a> <a class="dropdown-item" href="/5.18.2/h2xs">5.18.2</a> <a class="dropdown-item" href="/5.18.1/h2xs">5.18.1</a> <a class="dropdown-item" href="/5.18.0/h2xs">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/h2xs">5.16.3</a> <a class="dropdown-item" href="/5.16.2/h2xs">5.16.2</a> <a class="dropdown-item" href="/5.16.1/h2xs">5.16.1</a> <a class="dropdown-item" href="/5.16.0/h2xs">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/h2xs">5.14.4</a> <a class="dropdown-item" href="/5.14.3/h2xs">5.14.3</a> <a class="dropdown-item" href="/5.14.2/h2xs">5.14.2</a> <a class="dropdown-item" href="/5.14.1/h2xs">5.14.1</a> <a class="dropdown-item" href="/5.14.0/h2xs">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/h2xs">5.12.5</a> <a class="dropdown-item" href="/5.12.4/h2xs">5.12.4</a> <a class="dropdown-item" href="/5.12.3/h2xs">5.12.3</a> <a class="dropdown-item" href="/5.12.2/h2xs">5.12.2</a> <a class="dropdown-item" href="/5.12.1/h2xs">5.12.1</a> <a class="dropdown-item" href="/5.12.0/h2xs">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/h2xs">5.10.1</a> <a class="dropdown-item" href="/5.10.0/h2xs">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/h2xs">5.8.9</a> <a class="dropdown-item" href="/5.8.8/h2xs">5.8.8</a> <a class="dropdown-item" href="/5.8.7/h2xs">5.8.7</a> <a class="dropdown-item" href="/5.8.6/h2xs">5.8.6</a> <a class="dropdown-item" href="/5.8.5/h2xs">5.8.5</a> <a class="dropdown-item" href="/5.8.4/h2xs">5.8.4</a> <a class="dropdown-item" href="/5.8.3/h2xs">5.8.3</a> <a class="dropdown-item" href="/5.8.2/h2xs">5.8.2</a> <a class="dropdown-item" href="/5.8.1/h2xs">5.8.1</a> <a class="dropdown-item" href="/5.8.0/h2xs">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/h2xs">5.6.2</a> <a class="dropdown-item" href="/5.6.1/h2xs">5.6.1</a> <a class="dropdown-item" href="/5.6.0/h2xs">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/h2xs">5.005_04</a> <a class="dropdown-item" href="/5.005_03/h2xs">5.005_03</a> <a class="dropdown-item" href="/5.005_02/h2xs">5.005_02</a> <a class="dropdown-item" href="/5.005_01/h2xs">5.005_01</a> <a class="dropdown-item active" href="/5.005/h2xs">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/h2xs">blead</a> <a class="dropdown-item" href="/5.41.10/h2xs">5.41.10</a> <a class="dropdown-item" href="/5.41.9/h2xs">5.41.9</a> <a class="dropdown-item" href="/5.41.8/h2xs">5.41.8</a> <a class="dropdown-item" href="/5.41.7/h2xs">5.41.7</a> <a class="dropdown-item" href="/5.41.6/h2xs">5.41.6</a> <a class="dropdown-item" href="/5.41.5/h2xs">5.41.5</a> <a class="dropdown-item" href="/5.41.4/h2xs">5.41.4</a> <a class="dropdown-item" href="/5.41.3/h2xs">5.41.3</a> <a class="dropdown-item" href="/5.41.2/h2xs">5.41.2</a> <a class="dropdown-item" href="/5.41.1/h2xs">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/h2xs">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/h2xs">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/h2xs">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/h2xs">5.39.10</a> <a class="dropdown-item" href="/5.39.9/h2xs">5.39.9</a> <a class="dropdown-item" href="/5.39.8/h2xs">5.39.8</a> <a class="dropdown-item" href="/5.39.7/h2xs">5.39.7</a> <a class="dropdown-item" href="/5.39.6/h2xs">5.39.6</a> <a class="dropdown-item" href="/5.39.5/h2xs">5.39.5</a> <a class="dropdown-item" href="/5.39.4/h2xs">5.39.4</a> <a class="dropdown-item" href="/5.39.3/h2xs">5.39.3</a> <a class="dropdown-item" href="/5.39.2/h2xs">5.39.2</a> <a class="dropdown-item" href="/5.39.1/h2xs">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/h2xs">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.005/perl">Perl</a> <a class="dropdown-item" href="/5.005/perlintro">Intro</a> <a class="dropdown-item" href="/5.005/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.005/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.005/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005/perlop">Operators</a> <a class="dropdown-item" href="/5.005/functions">Functions</a> <a class="dropdown-item" href="/5.005/variables">Variables</a> <a class="dropdown-item" href="/5.005/modules">Modules</a> <a class="dropdown-item" href="/5.005/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.005/perlcommunity">Community</a> <a class="dropdown-item" href="/5.005/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.005/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.005/h2xs">h2xs</a> <div id="more"> (<a href="/5.005/h2xs.txt">source</a>, <a href="https://metacpan.org/pod/h2xs">CPAN</a>) </div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.005. <a href="/h2xs">View the latest version</a> </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#OPTIONS">OPTIONS</a> </li> <li> <a class="text-decoration-none" href="#EXAMPLES">EXAMPLES</a> </li> <li> <a class="text-decoration-none" href="#ENVIRONMENT">ENVIRONMENT</a> </li> <li> <a class="text-decoration-none" href="#AUTHOR">AUTHOR</a> </li> <li> <a class="text-decoration-none" href="#SEE-ALSO">SEE ALSO</a> </li> <li> <a class="text-decoration-none" href="#DIAGNOSTICS">DIAGNOSTICS</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>h2xs - convert .h C header files to Perl extensions</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <p><b>h2xs</b> [<b>-AOPXcdf</b>] [<b>-v</b> version] [<b>-n</b> module_name] [<b>-p</b> prefix] [<b>-s</b> sub] [headerfile ... [extra_libraries]]</p> <p><b>h2xs</b> <b>-h</b></p> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p><i>h2xs</i> builds a Perl extension from C header files. The extension will include functions which can be used to retrieve the value of any #define statement which was in the C header files.</p> <p>The <i>module_name</i> will be used for the name of the extension. If module_name is not supplied then the name of the first header file will be used, with the first character capitalized.</p> <p>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 <b>-L/another/library/path</b> in the extra-libraries argument.</p> <h1 id="OPTIONS"><a class="permalink" href="#OPTIONS">#</a>OPTIONS</h1> <dl> <dt id="-A"><a class="permalink" href="#-A">#</a><a id="A"></a><b>-A</b></dt> <dd> <p>Omit all autoload facilities. This is the same as <b>-c</b> but also removes the <span style="white-space: nowrap;"><code>require AutoLoader</code></span> statement from the .pm file.</p> </dd> <dt id="-F"><a class="permalink" href="#-F">#</a><a id="F"></a><b>-F</b></dt> <dd> <p>Additional flags to specify to C preprocessor when scanning header for function declarations. Should not be used without <b>-x</b>.</p> </dd> <dt id="-O"><a class="permalink" href="#-O">#</a><a id="O"></a><b>-O</b></dt> <dd> <p>Allows a pre-existing extension directory to be overwritten.</p> </dd> <dt id="-P"><a class="permalink" href="#-P">#</a><a id="P"></a><b>-P</b></dt> <dd> <p>Omit the autogenerated stub POD section.</p> </dd> <dt id="-X"><a class="permalink" href="#-X">#</a><a id="X"></a><b>-X</b></dt> <dd> <p>Omit the XS portion. Used to generate templates for a module which is not XS-based.</p> </dd> <dt id="-c"><a class="permalink" href="#-c">#</a><a id="c"></a><b>-c</b></dt> <dd> <p>Omit <code>constant()</code> from the .xs file and corresponding specialised <code>AUTOLOAD</code> from the .pm file.</p> </dd> <dt id="-d"><a class="permalink" href="#-d">#</a><a id="d"></a><b>-d</b></dt> <dd> <p>Turn on debugging messages.</p> </dd> <dt id="-f"><a class="permalink" href="#-f">#</a><a id="f"></a><b>-f</b></dt> <dd> <p>Allows an extension to be created for a header even if that header is not found in /usr/include.</p> </dd> <dt id="-h"><a class="permalink" href="#-h">#</a><a id="h"></a><b>-h</b></dt> <dd> <p>Print the usage, help and version for this h2xs and exit.</p> </dd> <dt id="-n-module_name"><a class="permalink" href="#-n-module_name">#</a><a id="n-module_name"></a><b>-n</b> <i>module_name</i></dt> <dd> <p>Specifies a name to be used for the extension, e.g., <span style="white-space: nowrap;">-n RPC::DCE</span></p> </dd> <dt id="-p-prefix"><a class="permalink" href="#-p-prefix">#</a><a id="p-prefix"></a><b>-p</b> <i>prefix</i></dt> <dd> <p>Specify a prefix which should be removed from the Perl function names, e.g., <span style="white-space: nowrap;">-p sec_rgy_</span> This sets up the XS <b>PREFIX</b> keyword and removes the prefix from functions that are autoloaded via the <code>constant()</code> mechansim.</p> </dd> <dt id="-s-sub1,sub2"><a class="permalink" href="#-s-sub1,sub2">#</a><a id="s-sub1-sub2"></a><b>-s</b> <i>sub1,sub2</i></dt> <dd> <p>Create a perl subroutine for the specified macros rather than autoload with the constant() subroutine. These macros are assumed to have a return type of <b>char *</b>, e.g., <span style="white-space: nowrap;">-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid</span>.</p> </dd> <dt id="-v-version"><a class="permalink" href="#-v-version">#</a><a id="v-version"></a><b>-v</b> <i>version</i></dt> <dd> <p>Specify a version number for this extension. This version number is added to the templates. The default is 0.01.</p> </dd> <dt id="-x"><a class="permalink" href="#-x">#</a><a id="x"></a><b>-x</b></dt> <dd> <p>Automatically generate XSUBs basing on function declarations in the header file. The package <code>C::Scan</code> should be installed. If this option is specified, the name of the header file may look like <code>NAME1,NAME2</code>. In this case NAME1 is used instead of the specified string, but XSUBs are emitted only for the declarations included from file NAME2.</p> <p>Note that some types of arguments/return-values for functions may result in XSUB-declarations/typemap-entries which need hand-editing. Such may be objects which cannot be converted from/to a pointer (like <code>long long</code>), pointers to functions, or arrays.</p> </dd> </dl> <h1 id="EXAMPLES"><a class="permalink" href="#EXAMPLES">#</a>EXAMPLES</h1> <pre><code class="plaintext"> # 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 # Extension is DCE::rgynbase # prefix "sec_rgy_" is dropped from perl function names h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase # Extension is DCE::rgynbase # prefix "sec_rgy_" is dropped from perl function names # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid h2xs -n DCE::rgynbase -p sec_rgy_ \ -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase # Make XS without defines in perl.h, but with function declarations # visible from perl.h. Name of the extension is perl1. # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)= # Extra backslashes below because the string is passed to shell. # Note that a directory with perl header files would # be added automatically to include path. h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h # Same with function declaration in proto.h as visible from perl.h. h2xs -xAn perl2 perl.h,proto.h</code></pre> <h1 id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">#</a>ENVIRONMENT</h1> <p>No environment variables are used.</p> <h1 id="AUTHOR"><a class="permalink" href="#AUTHOR">#</a>AUTHOR</h1> <p>Larry Wall and others</p> <h1 id="SEE-ALSO"><a class="permalink" href="#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1> <p><a href="/5.005/perl">perl</a>, <a href="/5.005/perlxstut">perlxstut</a>, <a href="/5.005/ExtUtils::MakeMaker">ExtUtils::MakeMaker</a>, and <a href="/5.005/AutoLoader">AutoLoader</a>.</p> <h1 id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">#</a>DIAGNOSTICS</h1> <p>The usual warnings if it cannot read or write the files involved.</p> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

h2xs - convert .h C header files to Perl extensions - Perldoc Browser