Commit | Line | Data |
67523925 |
1 | =pod |
2 | |
3 | =encoding UTF-8 |
4 | |
5 | =head1 NAME |
6 | |
63ea1fd0 |
7 | Sub::Name - (Re)name a sub |
67523925 |
8 | |
9 | =head1 VERSION |
10 | |
efdd6a09 |
11 | version 0.23 |
67523925 |
12 | |
13 | =head1 SYNOPSIS |
14 | |
15 | use Sub::Name; |
16 | |
17 | subname $name, $subref; |
18 | |
19 | $subref = subname foo => sub { ... }; |
20 | |
21 | =head1 DESCRIPTION |
22 | |
23 | This module has only one function, which is also exported by default: |
24 | |
25 | =for stopwords subname |
26 | |
27 | =head2 subname NAME, CODEREF |
28 | |
29 | Assigns a new name to referenced sub. If package specification is omitted in |
30 | the name, then the current package is used. The return value is the sub. |
31 | |
32 | The name is only used for informative routines (caller, Carp, etc). You won't |
33 | be able to actually invoke the sub by the given name. To allow that, you need |
34 | to do glob-assignment yourself. |
35 | |
36 | Note that for anonymous closures (subs that reference lexicals declared outside |
37 | the sub itself) you can name each instance of the closure differently, which |
38 | can be very useful for debugging. |
39 | |
40 | =head1 SEE ALSO |
41 | |
42 | =over 4 |
43 | |
44 | =item * |
db3290d9 |
45 | |
67523925 |
46 | L<Sub::Identify> - for getting information about subs |
47 | |
db3290d9 |
48 | =item * |
67523925 |
49 | |
db3290d9 |
50 | L<Sub::Util> - set_subname is another implementation of C<subname> |
67523925 |
51 | |
db3290d9 |
52 | =back |
67523925 |
53 | |
db3290d9 |
54 | =for stopwords cPanel |
67523925 |
55 | |
71457ae8 |
56 | =head1 SUPPORT |
57 | |
58 | Bugs may be submitted through L<the RT bug tracker|https://rt.cpan.org/Public/Dist/Display.html?Name=Sub-Name> |
59 | (or L<bug-Sub-Name@rt.cpan.org|mailto:bug-Sub-Name@rt.cpan.org>). |
60 | |
61 | There is also an irc channel available for users of this distribution, at |
62 | L<C<#toolchain> on C<irc.perl.org>|irc://irc.perl.org/#toolchain>. |
63 | |
67523925 |
64 | =head1 AUTHOR |
65 | |
66 | Matthijs van Duin <xmath@cpan.org> |
67 | |
68 | =head1 CONTRIBUTORS |
69 | |
8a86fed4 |
70 | =for stopwords Karen Etheridge Leon Timmermans Graham Knop Reini Urban Florian Ragwitz Matthijs van Duin Dagfinn Ilmari Mannsåker gfx Aristotle Pagaltzis J.R. Mash Alexander Bluhm |
67523925 |
71 | |
72 | =over 4 |
73 | |
74 | =item * |
75 | |
76 | Karen Etheridge <ether@cpan.org> |
77 | |
78 | =item * |
79 | |
9d60c912 |
80 | Leon Timmermans <fawaka@gmail.com> |
67523925 |
81 | |
82 | =item * |
83 | |
8a86fed4 |
84 | Graham Knop <haarg@haarg.org> |
63ea1fd0 |
85 | |
86 | =item * |
87 | |
4a3201da |
88 | Reini Urban <rurban@cpanel.net> |
67523925 |
89 | |
90 | =item * |
91 | |
8a86fed4 |
92 | Florian Ragwitz <rafl@debian.org> |
67523925 |
93 | |
94 | =item * |
95 | |
8a86fed4 |
96 | Matthijs van Duin <xmath-no-spam@nospam.cpan.org> |
63ea1fd0 |
97 | |
98 | =item * |
99 | |
67523925 |
100 | Dagfinn Ilmari Mannsåker <ilmari@ilmari.org> |
101 | |
102 | =item * |
103 | |
8a86fed4 |
104 | gfx <gfuji@cpan.org> |
105 | |
106 | =item * |
107 | |
63ea1fd0 |
108 | Aristotle Pagaltzis <pagaltzis@gmx.de> |
67523925 |
109 | |
00d17844 |
110 | =item * |
111 | |
112 | J.R. Mash <jmash.code@gmail.com> |
113 | |
4a3201da |
114 | =item * |
115 | |
116 | Alexander Bluhm <alexander.bluhm@gmx.net> |
117 | |
67523925 |
118 | =back |
119 | |
120 | =head1 COPYRIGHT AND LICENSE |
121 | |
db3290d9 |
122 | This software is copyright (c) 2004, 2008 by Matthijs van Duin, all rights reserved; |
123 | copyright (c) 2014 cPanel Inc., all rights reserved. |
124 | |
125 | This program is free software; you can redistribute it and/or modify |
126 | it under the same terms as Perl itself. |
127 | |
67523925 |
128 | =cut |