.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Exporter 3pm" .TH Exporter 3pm 2024-02-05 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME PDL::Exporter \- PDL export control .SH DESCRIPTION .IX Header "DESCRIPTION" Implements the standard conventions for import of PDL modules in to the namespace .PP Hopefully will be extended to allow fine control of which namespace is used. .SH SYNOPSIS .IX Header "SYNOPSIS" use PDL::Exporter; .PP .Vb 3 \& use PDL::MyModule; # Import default function list \*(Aq:Func\*(Aq \& use PDL::MyModule \*(Aq\*(Aq; # Import nothing (OO) \& use PDL::MyModule \*(Aq...\*(Aq; # Same behaviour as Exporter .Ve .SH SUMMARY .IX Header "SUMMARY" \&\f(CW\*(C`PDL::Exporter\*(C'\fR is a drop-in replacement for the Exporter module. It confers the standard PDL export conventions to your module. Usage is fairly straightforward and best illustrated by an example. The following shows typical usage near the top of a simple PDL module: .PP .Vb 1 \& package PDL::MyMod; \& \& use strict; \& \& # For Perl 5.6: \& use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS); \& # For more modern Perls: \& our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS); \& \& require PDL::Exporter; \& \& @ISA = qw(PDL::Exporter); \& @EXPORT_OK = qw(inc myfunc); # these will be exported by default \& %EXPORT_TAGS = (Func=>[@EXPORT_OK], \& Internal => [qw/internfunc1 internfunc2/], \& ); \& \& # ... body of your module \& \& 1; # end of simple module .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" Exporter .SH AUTHOR .IX Header "AUTHOR" Copyright (C) Karl Glazebrook (kgb@aaoepp.aao.gov.au). Some docs by Christian Soeller. All rights reserved. There is no warranty. You are allowed to redistribute this software / documentation under certain conditions. For details, see the file COPYING in the PDL distribution. If this file is separated from the PDL distribution, the copyright notice should be included in the file.