1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
.\" -*- 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 "AutoSplit 3pm"
.TH AutoSplit 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" 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
AutoSplit \- split a package for autoloading
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& autosplit($file, $dir, $keep, $check, $modtime);
\&
\& autosplit_lib_modules(@modules);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This function will split up your program into files that the AutoLoader
module can handle. It is used by both the standard perl libraries and by
the MakeMaker utility, to automatically configure libraries for autoloading.
.PP
The \f(CW\*(C`autosplit\*(C'\fR interface splits the specified file into a hierarchy
rooted at the directory \f(CW$dir\fR. It creates directories as needed to reflect
class hierarchy, and creates the file \fIautosplit.ix\fR. This file acts as
both forward declaration of all package routines, and as timestamp for the
last update of the hierarchy.
.PP
The remaining three arguments to \f(CW\*(C`autosplit\*(C'\fR govern other options to
the autosplitter.
.ie n .IP $keep 2
.el .IP \f(CW$keep\fR 2
.IX Item "$keep"
If the third argument, \fR\f(CI$keep\fR\fI\fR, is false, then any
pre-existing \f(CW\*(C`*.al\*(C'\fR files in the autoload directory are removed if
they are no longer part of the module (obsoleted functions).
\&\f(CW$keep\fR defaults to 0.
.ie n .IP $check 2
.el .IP \f(CW$check\fR 2
.IX Item "$check"
The
fourth argument, \fR\f(CI$check\fR\fI\fR, instructs \f(CW\*(C`autosplit\*(C'\fR to check the module
currently being split to ensure that it includes a \f(CW\*(C`use\*(C'\fR
specification for the AutoLoader module, and skips the module if
AutoLoader is not detected.
\&\f(CW$check\fR defaults to 1.
.ie n .IP $modtime 2
.el .IP \f(CW$modtime\fR 2
.IX Item "$modtime"
Lastly, the \fR\f(CI$modtime\fR\fI\fR argument specifies
that \f(CW\*(C`autosplit\*(C'\fR is to check the modification time of the module
against that of the \f(CW\*(C`autosplit.ix\*(C'\fR file, and only split the module if
it is newer.
\&\f(CW$modtime\fR defaults to 1.
.PP
Typical use of AutoSplit in the perl MakeMaker utility is via the command-line
with:
.PP
.Vb 1
\& perl \-e \*(Aquse AutoSplit; autosplit($ARGV[0], $ARGV[1], 0, 1, 1)\*(Aq
.Ve
.PP
Defined as a Make macro, it is invoked with file and directory arguments;
\&\f(CW\*(C`autosplit\*(C'\fR will split the specified file into the specified directory and
delete obsolete \f(CW\*(C`.al\*(C'\fR files, after checking first that the module does use
the AutoLoader, and ensuring that the module is not already currently split
in its current form (the modtime test).
.PP
The \f(CW\*(C`autosplit_lib_modules\*(C'\fR form is used in the building of perl. It takes
as input a list of files (modules) that are assumed to reside in a directory
\&\fBlib\fR relative to the current directory. Each file is sent to the
autosplitter one at a time, to be split into the directory \fBlib/auto\fR.
.PP
In both usages of the autosplitter, only subroutines defined following the
perl \fI_\|_END_\|_\fR token are split out into separate files. Some
routines may be placed prior to this marker to force their immediate loading
and parsing.
.SS "Multiple packages"
.IX Subsection "Multiple packages"
As of version 1.01 of the AutoSplit module it is possible to have
multiple packages within a single file. Both of the following cases
are supported:
.PP
.Vb 7
\& package NAME;
\& _\|_END_\|_
\& sub AAA { ... }
\& package NAME::option1;
\& sub BBB { ... }
\& package NAME::option2;
\& sub BBB { ... }
\&
\& package NAME;
\& _\|_END_\|_
\& sub AAA { ... }
\& sub NAME::option1::BBB { ... }
\& sub NAME::option2::BBB { ... }
.Ve
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
\&\f(CW\*(C`AutoSplit\*(C'\fR will inform the user if it is necessary to create the
top-level directory specified in the invocation. It is preferred that
the script or installation process that invokes \f(CW\*(C`AutoSplit\*(C'\fR have
created the full directory path ahead of time. This warning may
indicate that the module is being split into an incorrect path.
.PP
\&\f(CW\*(C`AutoSplit\*(C'\fR will warn the user of all subroutines whose name causes
potential file naming conflicts on machines with drastically limited
(8 characters or less) file name length. Since the subroutine name is
used as the file name, these warnings can aid in portability to such
systems.
.PP
Warnings are issued and the file skipped if \f(CW\*(C`AutoSplit\*(C'\fR cannot locate
either the \fI_\|_END_\|_\fR marker or a "package Name;"\-style specification.
.PP
\&\f(CW\*(C`AutoSplit\*(C'\fR will also emit general diagnostics for inability to
create directories or files.
.SH AUTHOR
.IX Header "AUTHOR"
\&\f(CW\*(C`AutoSplit\*(C'\fR is maintained by the perl5\-porters. Please direct
any questions to the canonical mailing list. Anything that
is applicable to the CPAN release can be sent to its maintainer,
though.
.PP
Author and Maintainer: The Perl5\-Porters <perl5\-porters@perl.org>
.PP
Maintainer of the CPAN release: Steffen Mueller <smueller@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This package has been part of the perl core since the first release
of perl5. It has been released separately to CPAN so older installations
can benefit from bug fixes.
.PP
This package has the same copyright and license as the perl core:
.PP
.Vb 3
\& Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
\& 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
\& by Larry Wall and others
\&
\& All rights reserved.
\&
\& This program is free software; you can redistribute it and/or modify
\& it under the terms of either:
\&
\& a) the GNU General Public License as published by the Free
\& Software Foundation; either version 1, or (at your option) any
\& later version, or
\&
\& b) the "Artistic License" which comes with this Kit.
\&
\& This program is distributed in the hope that it will be useful,
\& but WITHOUT ANY WARRANTY; without even the implied warranty of
\& MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either
\& the GNU General Public License or the Artistic License for more details.
\&
\& You should have received a copy of the Artistic License with this
\& Kit, in the file named "Artistic". If not, I\*(Aqll be glad to provide one.
\&
\& You should also have received a copy of the GNU General Public License
\& along with this program in the file named "Copying". If not, write to the
\& Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
\& 02111\-1307, USA or visit their web page on the internet at
\& http://www.gnu.org/copyleft/gpl.html.
\&
\& For those of you that choose to use the GNU General Public License,
\& my interpretation of the GNU General Public License is that no Perl
\& script falls under the terms of the GPL unless you explicitly put
\& said script under the terms of the GPL yourself. Furthermore, any
\& object code linked with perl does not automatically fall under the
\& terms of the GPL, provided such object code only adds definitions
\& of subroutines and variables, and does not otherwise impair the
\& resulting interpreter from executing any standard Perl script. I
\& consider linking in C subroutines in this manner to be the moral
\& equivalent of defining subroutines in the Perl language itself. You
\& may sell such an object file as proprietary provided that you provide
\& or offer to provide the Perl source, as specified by the GNU General
\& Public License. (This is merely an alternate way of specifying input
\& to the program.) You may also sell a binary produced by the dumping of
\& a running Perl script that belongs to you, provided that you provide or
\& offer to provide the Perl source as specified by the GPL. (The
\& fact that a Perl interpreter and your code are in the same binary file
\& is, in this case, a form of mere aggregation.) This is my interpretation
\& of the GPL. If you still have concerns or difficulties understanding
\& my intent, feel free to contact me. Of course, the Artistic License
\& spells all this out for your protection, so you may prefer to use that.
.Ve
|
