File: AutoSplit.html

package info (click to toggle)
perl-doc-html 5.26.0-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 39,400 kB
  • sloc: xml: 36; makefile: 7
file content (572 lines) | stat: -rw-r--r-- 24,587 bytes parent folder | download
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <title>AutoSplit - perldoc.perl.org</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <meta http-equiv="Content-Language" content="en-gb">
  <link rel="search" type="application/opensearchdescription+xml" title="Search perldoc.perl.org" href="/static/search.xml"/>
  <link href="static/css-20100830.css" rel="stylesheet" rev="stylesheet" type="text/css" media="screen">
  <link href="static/exploreperl.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>

<body onLoad="perldoc.startup();" onPageShow="if (event.persisted) perldoc.startup();">
    <div id="page">
      
      <div id="header">
	<div id="homepage_link">
	  <a href="index.html"></a>
	</div>
	<div id="strapline">
	  Perl Programming Documentation
	</div>
	<div id="download_link" class="download">
	  <a href="http://www.perl.org/get.html">Download Perl</a>
	</div>
	<div id="explore_link" class="download">
	  <a id="explore_anchor" href="#">Explore</a>
	</div>
      </div>
      
      <div id="body">
        <div id="left_column">
          <div class="side_group">
            
	    <div class="side_panel doc_panel">
              <p>Manual</p>
              <ul>
                <li><a href="index-overview.html">Overview</a>
                <li><a href="index-tutorials.html">Tutorials</a>
                <li><a href="index-faq.html">FAQs</a>
                <li><a href="index-history.html">History / Changes</a>
                <li><a href="index-licence.html">License</a>
              </ul>
            </div>
            <div class="side_panel doc_panel">
              <p>Reference</p>
              <ul>
                <li><a href="index-language.html">Language</a>
                <li><a href="index-functions.html">Functions</a>
                <li><a href="perlop.html">Operators</a>
                <li><a href="perlvar.html">Special Variables</a>
                <li><a href="index-pragmas.html">Pragmas</a>
                <li><a href="index-utilities.html">Utilities</a>
                <li><a href="index-internals.html">Internals</a>
                <li><a href="index-platforms.html">Platform Specific</a>
              </ul>
            </div>
            <div class="side_panel doc_panel">
              <p>Modules</p>
              <ul>
		<li>
		
                
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		
                  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		
                  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		
                  
		
                  
		    
		  
		
                  
		
                  
		
		
                    <a href="index-modules-A.html">A</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-B.html">B</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-C.html">C</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-D.html">D</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-E.html">E</a>
                    
                      
                        <li>
                      
                    
                
                    <a href="index-modules-F.html">F</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-G.html">G</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-H.html">H</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-I.html">I</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-L.html">L</a>
                    
                      
                        <li>
                      
                    
                
                    <a href="index-modules-M.html">M</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-N.html">N</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-O.html">O</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-P.html">P</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-S.html">S</a>
                    
                      
                        <li>
                      
                    
                
                    <a href="index-modules-T.html">T</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-U.html">U</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-X.html">X</a>
                    
                
              </ul>
            </div>
            
	      <div class="side_panel doc_panel">
		<p>Tools</p>
		<ul>
		  <li><a href="preferences.html">Preferences</a>
		</ul>
	      </div>
            
          </div>
        </div>
        <div id="centre_column">
          <div id="content_header">
            <div id="title_bar">
              <div id="page_name">
                <h1>AutoSplit</h1>
              </div>
              <div id="perl_version">
                Perl 5 version 26.0 documentation
              </div>
              <div class="page_links" id="page_links_top">
                <a href="#" onClick="toolbar.goToTop();return false;">Go to top</a>
		
              </div>
	      <div class="page_links" id="page_links_bottom">
		
                  <a href="#" id="page_index_toggle">Show page index</a> &bull;
		
                <a href="#" id="recent_pages_toggle">Show recent pages</a>		
	      </div>
	      <div id="search_form">
		<form action="search.html" method="GET" id="search">
		  <input type="text" name="q" id="search_box" alt="Search">
		</form>
	      </div>
            </div>
            <div id="breadcrumbs">
                
    <a href="index.html">Home</a> &gt;
    
      
        <a href="index-modules-A.html">Core modules (A)</a> &gt;
      
    
    AutoSplit
  

            </div>
          </div>
          <div id="content_body">
	    <!--[if lt IE 7]>
 <div class="noscript">
   <p>
     <strong>It looks like you're using Internet Explorer 6. This is a very old
     browser which does not offer full support for modern websites.</strong>
   </p>
   <p>
     Unfortunately this means that this website will not work on
     your computer.
   </p>
   <p>
     Don't miss out though! To view the site (and get a better experience from
     many other websites), simply upgrade to
     <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet
Explorer 8</a>
     or download an alternative browser such as
     <a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>,
     <a href="http://www.apple.com/safari/download/">Safari</a>, or
     <a href="http://www.google.co.uk/chrome">Google Chrome</a>.
   </p>
   <p>
     All of these browsers are free. If you're using a PC at work, you may
     need to contact your IT administrator.
   </p>
 </div>
<![endif]-->
	    <noscript>
	      <div class="noscript">
	      <p>
                <strong>Please note: Many features of this site require JavaScript. You appear to have JavaScript disabled,
	        or are running a non-JavaScript capable web browser.</strong>
	      </p>
	      <p>
		To get the best experience, please enable JavaScript or download a modern web browser such as <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet Explorer 8</a>, <a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>, <a href="http://www.apple.com/safari/download/">Safari</a>, or <a href="http://www.google.co.uk/chrome">Google Chrome</a>.
              </p>
	      </div>
	    </noscript>

	    <div id="recent_pages" class="hud_container">
	      <div id="recent_pages_header" class="hud_header">
		<div id="recent_pages_close" class="hud_close"><a href="#" onClick="recentPages.hide();return false;"></a></div>
		<div id="recent_pages_title" class="hud_title"><span class="hud_span_top">Recently read</span></div>
		<div id="recent_pages_topright" class="hud_topright"></div>
	      </div>
	      <div id="recent_pages_content" class="hud_content">
	      </div>
	      <div id="recent_pages_footer" class="hud_footer">
		<div id="recent_pages_bottomleft" class="hud_bottomleft"></div>
		<div id="recent_pages_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
		<div id="recent_pages_resize" class="hud_resize"></div>
	      </div>
	    </div>
  
	    <div id="from_search"></div>
            <h1>AutoSplit</h1>


  <!--    -->
<ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Multiple-packages">Multiple packages</a></ul><li><a href="#DIAGNOSTICS">DIAGNOSTICS</a><li><a href="#AUTHOR">AUTHOR</a><li><a href="#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></ul><a name="NAME"></a><h1>NAME</h1>
<p>AutoSplit - split a package for autoloading</p>
<a name="SYNOPSIS"></a><h1>SYNOPSIS</h1>
<pre class="verbatim"><ol><li> <span class="i">autosplit</span><span class="s">(</span><span class="i">$file</span><span class="cm">,</span> <span class="i">$dir</span><span class="cm">,</span> <span class="i">$keep</span><span class="cm">,</span> <span class="i">$check</span><span class="cm">,</span> <span class="i">$modtime</span><span class="s">)</span><span class="sc">;</span></li><li></li><li> <span class="i">autosplit_lib_modules</span><span class="s">(</span><span class="i">@modules</span><span class="s">)</span><span class="sc">;</span></li></ol></pre><a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>
<p>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.</p>
<p>The <code class="inline"><span class="w">autosplit</span></code>
 interface splits the specified file into a hierarchy 
rooted at the directory <code class="inline"><span class="i">$dir</span></code>
. It creates directories as needed to reflect
class hierarchy, and creates the file <i>autosplit.ix</i>. This file acts as
both forward declaration of all package routines, and as timestamp for the
last update of the hierarchy.</p>
<p>The remaining three arguments to <code class="inline"><span class="w">autosplit</span></code>
 govern other options to
the autosplitter.</p>
<ul>
<li><a name="%24keep"></a><b>$keep</b>
<p>If the third argument, <i>$keep</i>, is false, then any
pre-existing <code class="inline">*.al</code> files in the autoload directory are removed if
they are no longer part of the module (obsoleted functions).
$keep defaults to 0.</p>
</li>
<li><a name="%24check"></a><b>$check</b>
<p>The
fourth argument, <i>$check</i>, instructs <code class="inline"><span class="w">autosplit</span></code>
 to check the module
currently being split to ensure that it includes a <code class="inline"><a class="l_k" href="functions/use.html">use</a></code>
specification for the AutoLoader module, and skips the module if
AutoLoader is not detected.
$check defaults to 1.</p>
</li>
<li><a name="%24modtime"></a><b>$modtime</b>
<p>Lastly, the <i>$modtime</i> argument specifies
that <code class="inline"><span class="w">autosplit</span></code>
 is to check the modification time of the module
against that of the <code class="inline"><span class="w">autosplit</span>.<span class="w">ix</span></code>
 file, and only split the module if
it is newer.
$modtime defaults to 1.</p>
</li>
</ul>
<p>Typical use of AutoSplit in the perl MakeMaker utility is via the command-line
with:</p>
<pre class="verbatim"><ol><li> <span class="w">perl</span> -e <span class="q">&#39;use AutoSplit; autosplit($ARGV[0], $ARGV[1], 0, 1, 1)&#39;</span></li></ol></pre><p>Defined as a Make macro, it is invoked with file and directory arguments;
<code class="inline"><span class="w">autosplit</span></code>
 will split the specified file into the specified directory and
delete obsolete <code class="inline">.al</code> 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).</p>
<p>The <code class="inline"><span class="w">autosplit_lib_modules</span></code>
 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
<b>lib</b> relative to the current directory. Each file is sent to the 
autosplitter one at a time, to be split into the directory <b>lib/auto</b>.</p>
<p>In both usages of the autosplitter, only subroutines defined following the
perl <i>__END__</i> token are split out into separate files. Some
routines may be placed prior to this marker to force their immediate loading
and parsing.</p>
<a name="Multiple-packages"></a><h2>Multiple packages</h2>
<p>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:</p>
<pre class="verbatim"><ol><li><a name="package-NAME"></a>   package <span class="i">NAME</span><span class="sc">;</span></li><li><a name="__END__"></a>   __END__</li><li><span class="q">   sub AAA { ... }</span></li><li><span class="q">   package NAME::option1;</span></li><li><span class="q">   sub BBB { ... }</span></li><li><span class="q">   package NAME::option2;</span></li><li><span class="q">   sub BBB { ... }</span></li><li></li><li><span class="q">   package NAME;</span></li><li><span class="q">   __END__</span></li><li><span class="q">   sub AAA { ... }</span></li><li><span class="q">   sub NAME::option1::BBB { ... }</span></li><li><span class="q">   sub NAME::option2::BBB { ... }</span></li></ol></pre><a name="DIAGNOSTICS"></a><h1>DIAGNOSTICS</h1>
<p><code class="inline"><span class="w">AutoSplit</span></code>
 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 <code class="inline"><span class="w">AutoSplit</span></code>
 have
created the full directory path ahead of time. This warning may
indicate that the module is being split into an incorrect path.</p>
<p><code class="inline"><span class="w">AutoSplit</span></code>
 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.</p>
<p>Warnings are issued and the file skipped if <code class="inline"><span class="w">AutoSplit</span></code>
 cannot locate
either the <i>__END__</i> marker or a "package Name;"-style specification.</p>
<p><code class="inline"><span class="w">AutoSplit</span></code>
 will also emit general diagnostics for inability to
create directories or files.</p>
<a name="AUTHOR"></a><h1>AUTHOR</h1>
<p><code class="inline"><span class="w">AutoSplit</span></code>
 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.</p>
<p>Author and Maintainer: The Perl5-Porters &lt;perl5-porters@perl.org&gt;</p>
<p>Maintainer of the CPAN release: Steffen Mueller &lt;smueller@cpan.org&gt;</p>
<a name="COPYRIGHT-AND-LICENSE"></a><h1>COPYRIGHT AND LICENSE</h1>
<p>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.</p>
<p>This package has the same copyright and license as the perl core:</p>
<pre class="verbatim"><ol><li>             Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,</li><li>        2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008</li><li>        by Larry Wall and others</li><li>    </li><li>			    All rights reserved.</li><li>    </li><li>    This program is free software; you can redistribute it and/or modify</li><li>    it under the terms of either:</li><li>    </li><li>	a) the GNU General Public License as published by the Free</li><li>	Software Foundation; either version 1, or (at your option) any</li><li>	later version, or</li><li>    </li><li>	b) the "Artistic License" which comes with this Kit.</li><li>    </li><li>    This program is distributed in the hope that it will be useful,</li><li>    but WITHOUT ANY WARRANTY; without even the implied warranty of</li><li>    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either</li><li>    the GNU General Public License or the Artistic License for more details.</li><li>    </li><li>    You should have received a copy of the Artistic License with this</li><li>    Kit, in the file named "Artistic".  If not, I'll be glad to provide one.</li><li>    </li><li>    You should also have received a copy of the GNU General Public License</li><li>    along with this program in the file named "Copying". If not, write to the </li><li>    Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA </li><li>    02111-1307, USA or visit their web page on the internet at</li><li>    http://www.gnu.org/copyleft/gpl.html.</li><li>    </li><li>    For those of you that choose to use the GNU General Public License,</li><li>    my interpretation of the GNU General Public License is that no Perl</li><li>    script falls under the terms of the GPL unless you explicitly put</li><li>    said script under the terms of the GPL yourself.  Furthermore, any</li><li>    object code linked with perl does not automatically fall under the</li><li>    terms of the GPL, provided such object code only adds definitions</li><li>    of subroutines and variables, and does not otherwise impair the</li><li>    resulting interpreter from executing any standard Perl script.  I</li><li>    consider linking in C subroutines in this manner to be the moral</li><li>    equivalent of defining subroutines in the Perl language itself.  You</li><li>    may sell such an object file as proprietary provided that you provide</li><li>    or offer to provide the Perl source, as specified by the GNU General</li><li>    Public License.  (This is merely an alternate way of specifying input</li><li>    to the program.)  You may also sell a binary produced by the dumping of</li><li>    a running Perl script that belongs to you, provided that you provide or</li><li>    offer to provide the Perl source as specified by the GPL.  (The</li><li>    fact that a Perl interpreter and your code are in the same binary file</li><li>    is, in this case, a form of mere aggregation.)  This is my interpretation</li><li>    of the GPL.  If you still have concerns or difficulties understanding</li><li>    my intent, feel free to contact me.  Of course, the Artistic License</li><li>    spells all this out for your protection, so you may prefer to use that.</li></ol></pre>



  <div id="page_index" class="hud_container">
    <div id="page_index_header" class="hud_header">
      <div id="page_index_close" class="hud_close"><a href="#" onClick="pageIndex.hide();return false;"></a></div>
      <div id="page_index_title" class="hud_title"><span class="hud_span_top">Page index</span></div>
      <div id="page_index_topright" class="hud_topright"></div>
    </div>
    <div id="page_index_content" class="hud_content">
      <ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Multiple-packages">Multiple packages</a></ul><li><a href="#DIAGNOSTICS">DIAGNOSTICS</a><li><a href="#AUTHOR">AUTHOR</a><li><a href="#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></ul>
    </div>
    <div id="page_index_footer" class="hud_footer">
      <div id="page_index_bottomleft" class="hud_bottomleft"></div>
      <div id="page_index_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
      <div id="page_index_resize" class="hud_resize"></div>
    </div>
  </div>


	    &nbsp;
          </div>
          <div id="content_footer">
          </div>
        </div>
        <div class="clear"></div>
      </div>
      
    <div id="footer">
      <div id="footer_content">
        <div id="footer_strapline">
          perldoc.perl.org - Official documentation for the Perl programming language
        </div>
        <div id="footer_links">
          <div id="address">
            <p class="name">Contact details</p>
            <p class="address">
	      Site maintained by <a href="mailto:jj@jonallen.info">Jon Allen (JJ)</a><br>
	    </p>
            <p class="contact">
              Documentation maintained by the <a href="http://lists.cpan.org/showlist.cgi?name=perl5-porters">Perl 5 Porters</a>
            </p>
          </div>
          <ul class="f1">
            <li>Manual
              <ul class="f2">
                <li><a href="index-overview.html">Overview</a>
                <li><a href="index-tutorials.html">Tutorials</a>
                <li><a href="index-faq.html">FAQs</a>
                <li><a href="index-history.html">Changes</a>
              </ul>
            <li>Reference
              <ul class="f2">
                <li><a href="index-language.html">Language</a>
                <li><a href="index-functions.html">Functions</a>
                <li><a href="perlop.html">Operators</a>
                <li><a href="perlvar.html">Variables</a>
              </ul>
            <li>Modules
              <ul class="f2">
                <li><a href="index-modules-A.html">Modules</a>
                <li><a href="index-pragmas.html">Pragmas</a>
                <li><a href="index-utilities.html">Utilities</a>
              </ul>
            <li>Misc
              <ul class="f2">
                <li><a href="index-licence.html">License</a>
                <li><a href="index-internals.html">Internals</a>
                <li><a href="index-platforms.html">Platforms</a>
              </ul>          </ul>
          <div class="clear"></div>
        </div>
      </div>
      <div id="footer_end">
      </div>
    </div>
      
    </div>
      <script language="JavaScript" type="text/javascript" src="static/exploreperl.js"></script>
      <script language="JavaScript" src="static/combined-20100403.js" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
  perldoc.setPath(0);
  perldoc.pageName    = 'AutoSplit';
  perldoc.pageAddress = 'AutoSplit.html';
  perldoc.contentPage = 1;
  explorePerl.render();
  explorePerl.addEvents('explore_anchor');
</script>
    
  </body>
</html>