.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Export 3pm" .TH Export 3pm "2008-03-12" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Perl6::Export \- Implements the Perl 6 'is export(...)' trait .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& # Perl 5 code... .Ve .PP .Vb 2 \& package Some::Module; \& use Perl6::Export; .Ve .PP .Vb 2 \& # Export &foo by default, when explicitly requested, \& # or when the \(aq:ALL\(aq export set is requested... .Ve .PP .Vb 3 \& sub foo is export(:DEFAULT) { \& print "phooo!"; \& } .Ve .PP .Vb 3 \& # Export &var by default, when explicitly requested, \& # or when the \(aq:bees\(aq, \(aq:pubs\(aq, or \(aq:ALL\(aq export set is requested... \& # the parens after \(aqis export\(aq are like the parens of a qw(...) .Ve .PP .Vb 3 \& sub bar is export(:DEFAULT :bees :pubs) { \& print "baaa!"; \& } .Ve .PP .Vb 2 \& # Export &baz when explicitly requested \& # or when the \(aq:bees\(aq or \(aq:ALL\(aq export set is requested... .Ve .PP .Vb 3 \& sub baz is export(:bees) { \& print "baassss!"; \& } .Ve .PP .Vb 2 \& # Always export &qux \& # (no matter what else is explicitly or implicitly requested) .Ve .PP .Vb 3 \& sub qux is export(:MANDATORY) { \& print "quuuuuuuuux!"; \& } .Ve .PP .Vb 5 \& sub import { \& # This subroutine is called when the module is used (as usual), \& # but it is called after any export requests have been handled. \& # Those requests will have been stripped from its argument list \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Implements what I hope the Perl 6 symbol export mechanism might look like. .PP It's very straightforward: .IP "\(bu" 4 If you want a subroutine to be capable of being exported (when explicitly requested in the \f(CW\*(C`use\*(C'\fR arguments), you mark it with the \f(CW\*(C`is export\*(C'\fR trait. .IP "\(bu" 4 If you want a subroutine to be automatically exported when the module is used (without specific overriding arguments), you mark it with the \f(CW\*(C`is export(:DEFAULT)\*(C'\fR trait. .IP "\(bu" 4 If you want a subroutine to be automatically exported when the module is used (even if the user specifies overriding arguments), you mark it with the \f(CW\*(C`is export(:MANDATORY)\*(C'\fR trait. .IP "\(bu" 4 If the subroutine should also be exported when particular export groups are requested, you add the names of those export groups to the trait's argument list. .PP That's it. .SH "WARNING" .IX Header "WARNING" The syntax and semantics of Perl 6 is still being finalized and consequently is at any time subject to change. That means the same caveat applies to this module. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" Requires Filter::Simple .SH "AUTHOR" .IX Header "AUTHOR" Damian Conway (damian@conway.org) .SH "BUGS AND IRRITATIONS" .IX Header "BUGS AND IRRITATIONS" Does not yet handle the export of variables. .PP Comments, suggestions, and patches welcome. .SH "COPYRIGHT" .IX Header "COPYRIGHT" .Vb 3 \& Copyright (c) 2003, Damian Conway. All Rights Reserved. \& This module is free software. It may be used, redistributed \& and/or modified under the same terms as Perl itself. .Ve