summaryrefslogtreecommitdiff
path: root/utils/h2xs.PL
diff options
context:
space:
mode:
authorRafael Garcia-Suarez <rgarciasuarez@gmail.com>2007-05-09 07:57:50 +0000
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>2007-05-09 07:57:50 +0000
commite88439973becb3ddc3bfd26120bc77a6aacfb808 (patch)
tree534e840802bb000dcb03bb0b3d01fcdb1bf6706e /utils/h2xs.PL
parent1dcae2832b009ee3632057559967f11b1052d943 (diff)
downloadperl-e88439973becb3ddc3bfd26120bc77a6aacfb808.tar.gz
Add examples for h2xs -X, by Andy Armstrong
p4raw-id: //depot/perl@31175
Diffstat (limited to 'utils/h2xs.PL')
-rw-r--r--utils/h2xs.PL10
1 files changed, 8 insertions, 2 deletions
diff --git a/utils/h2xs.PL b/utils/h2xs.PL
index d62e96ec85..d16634ce63 100644
--- a/utils/h2xs.PL
+++ b/utils/h2xs.PL
@@ -66,6 +66,9 @@ the library path determined by Configure. That path can be augmented
by including arguments of the form B<-L/another/library/path> in the
extra-libraries argument.
+In spite of its name, I<h2xs> may also be used to create a skeleton pure
+Perl module. See the B<-X> option.
+
=head1 OPTIONS
=over 5
@@ -105,8 +108,8 @@ Omit the autogenerated stub POD section.
=item B<-X>, B<--omit-XS>
-Omit the XS portion. Used to generate templates for a module which is not
-XS-based. C<-c> and C<-f> are implicitly enabled.
+Omit the XS portion. Used to generate a skeleton pure Perl module.
+C<-c> and C<-f> are implicitly enabled.
=item B<-a>, B<--gen-accessors>
@@ -306,6 +309,9 @@ also the section on L<LIMITATIONS of B<-x>>.
# Extension is ONC::RPC.
h2xs -cfn ONC::RPC
+ # Extension is a pure Perl module with no XS code.
+ h2xs -X My::Module
+
# Extension is Lib::Foo which works at least with Perl5.005_03.
# Constants are created for all #defines and enums h2xs can find
# in foo.h.