| 1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sh \" Subsection heading |
| 6 | .br |
| 7 | .if t .Sp |
| 8 | .ne 5 |
| 9 | .PP |
| 10 | \fB\\$1\fR |
| 11 | .PP |
| 12 | .. |
| 13 | .de Sp \" Vertical space (when we can't use .PP) |
| 14 | .if t .sp .5v |
| 15 | .if n .sp |
| 16 | .. |
| 17 | .de Vb \" Begin verbatim text |
| 18 | .ft CW |
| 19 | .nf |
| 20 | .ne \\$1 |
| 21 | .. |
| 22 | .de Ve \" End verbatim text |
| 23 | .ft R |
| 24 | .fi |
| 25 | .. |
| 26 | .\" Set up some character translations and predefined strings. \*(-- will |
| 27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
| 29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
| 30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
| 31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
| 32 | .tr \(*W-|\(bv\*(Tr |
| 33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 | .ie n \{\ |
| 35 | . ds -- \(*W- |
| 36 | . ds PI pi |
| 37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 | . ds L" "" |
| 40 | . ds R" "" |
| 41 | . ds C` "" |
| 42 | . ds C' "" |
| 43 | 'br\} |
| 44 | .el\{\ |
| 45 | . ds -- \|\(em\| |
| 46 | . ds PI \(*p |
| 47 | . ds L" `` |
| 48 | . ds R" '' |
| 49 | 'br\} |
| 50 | .\" |
| 51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 | .\" output yourself in some meaningful fashion. |
| 55 | .if \nF \{\ |
| 56 | . de IX |
| 57 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 58 | .. |
| 59 | . nr % 0 |
| 60 | . rr F |
| 61 | .\} |
| 62 | .\" |
| 63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 64 | .\" way too many mistakes in technical documents. |
| 65 | .hy 0 |
| 66 | .if n .na |
| 67 | .\" |
| 68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 | . \" fudge factors for nroff and troff |
| 71 | .if n \{\ |
| 72 | . ds #H 0 |
| 73 | . ds #V .8m |
| 74 | . ds #F .3m |
| 75 | . ds #[ \f1 |
| 76 | . ds #] \fP |
| 77 | .\} |
| 78 | .if t \{\ |
| 79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 | . ds #V .6m |
| 81 | . ds #F 0 |
| 82 | . ds #[ \& |
| 83 | . ds #] \& |
| 84 | .\} |
| 85 | . \" simple accents for nroff and troff |
| 86 | .if n \{\ |
| 87 | . ds ' \& |
| 88 | . ds ` \& |
| 89 | . ds ^ \& |
| 90 | . ds , \& |
| 91 | . ds ~ ~ |
| 92 | . ds / |
| 93 | .\} |
| 94 | .if t \{\ |
| 95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 | .\} |
| 102 | . \" troff and (daisy-wheel) nroff accents |
| 103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 | . \" corrections for vroff |
| 113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 | . \" for low resolution devices (crt and lpr) |
| 116 | .if \n(.H>23 .if \n(.V>19 \ |
| 117 | \{\ |
| 118 | . ds : e |
| 119 | . ds 8 ss |
| 120 | . ds o a |
| 121 | . ds d- d\h'-1'\(ga |
| 122 | . ds D- D\h'-1'\(hy |
| 123 | . ds th \o'bp' |
| 124 | . ds Th \o'LP' |
| 125 | . ds ae ae |
| 126 | . ds Ae AE |
| 127 | .\} |
| 128 | .rm #[ #] #H #V #F C |
| 129 | .\" ======================================================================== |
| 130 | .\" |
| 131 | .IX Title "AutoSplit 3" |
| 132 | .TH AutoSplit 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" |
| 133 | .SH "NAME" |
| 134 | AutoSplit \- split a package for autoloading |
| 135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
| 137 | .Vb 1 |
| 138 | \& autosplit($file, $dir, $keep, $check, $modtime); |
| 139 | .Ve |
| 140 | .PP |
| 141 | .Vb 1 |
| 142 | \& autosplit_lib_modules(@modules); |
| 143 | .Ve |
| 144 | .SH "DESCRIPTION" |
| 145 | .IX Header "DESCRIPTION" |
| 146 | This function will split up your program into files that the AutoLoader |
| 147 | module can handle. It is used by both the standard perl libraries and by |
| 148 | the MakeMaker utility, to automatically configure libraries for autoloading. |
| 149 | .PP |
| 150 | The \f(CW\*(C`autosplit\*(C'\fR interface splits the specified file into a hierarchy |
| 151 | rooted at the directory \f(CW$dir\fR. It creates directories as needed to reflect |
| 152 | class hierarchy, and creates the file \fIautosplit.ix\fR. This file acts as |
| 153 | both forward declaration of all package routines, and as timestamp for the |
| 154 | last update of the hierarchy. |
| 155 | .PP |
| 156 | The remaining three arguments to \f(CW\*(C`autosplit\*(C'\fR govern other options to |
| 157 | the autosplitter. |
| 158 | .IP "$keep" 2 |
| 159 | .IX Item "$keep" |
| 160 | If the third argument, \fI$keep\fR, is false, then any |
| 161 | pre-existing \f(CW\*(C`*.al\*(C'\fR files in the autoload directory are removed if |
| 162 | they are no longer part of the module (obsoleted functions). |
| 163 | \&\f(CW$keep\fR defaults to 0. |
| 164 | .IP "$check" 2 |
| 165 | .IX Item "$check" |
| 166 | The |
| 167 | fourth argument, \fI$check\fR, instructs \f(CW\*(C`autosplit\*(C'\fR to check the module |
| 168 | currently being split to ensure that it includes a \f(CW\*(C`use\*(C'\fR |
| 169 | specification for the AutoLoader module, and skips the module if |
| 170 | AutoLoader is not detected. |
| 171 | \&\f(CW$check\fR defaults to 1. |
| 172 | .IP "$modtime" 2 |
| 173 | .IX Item "$modtime" |
| 174 | Lastly, the \fI$modtime\fR argument specifies |
| 175 | that \f(CW\*(C`autosplit\*(C'\fR is to check the modification time of the module |
| 176 | against that of the \f(CW\*(C`autosplit.ix\*(C'\fR file, and only split the module if |
| 177 | it is newer. |
| 178 | \&\f(CW$modtime\fR defaults to 1. |
| 179 | .PP |
| 180 | Typical use of AutoSplit in the perl MakeMaker utility is via the command-line |
| 181 | with: |
| 182 | .PP |
| 183 | .Vb 1 |
| 184 | \& perl -e 'use AutoSplit; autosplit($ARGV[0], $ARGV[1], 0, 1, 1)' |
| 185 | .Ve |
| 186 | .PP |
| 187 | Defined as a Make macro, it is invoked with file and directory arguments; |
| 188 | \&\f(CW\*(C`autosplit\*(C'\fR will split the specified file into the specified directory and |
| 189 | delete obsolete \f(CW\*(C`.al\*(C'\fR files, after checking first that the module does use |
| 190 | the AutoLoader, and ensuring that the module is not already currently split |
| 191 | in its current form (the modtime test). |
| 192 | .PP |
| 193 | The \f(CW\*(C`autosplit_lib_modules\*(C'\fR form is used in the building of perl. It takes |
| 194 | as input a list of files (modules) that are assumed to reside in a directory |
| 195 | \&\fBlib\fR relative to the current directory. Each file is sent to the |
| 196 | autosplitter one at a time, to be split into the directory \fBlib/auto\fR. |
| 197 | .PP |
| 198 | In both usages of the autosplitter, only subroutines defined following the |
| 199 | perl \fI_\|_END_\|_\fR token are split out into separate files. Some |
| 200 | routines may be placed prior to this marker to force their immediate loading |
| 201 | and parsing. |
| 202 | .Sh "Multiple packages" |
| 203 | .IX Subsection "Multiple packages" |
| 204 | As of version 1.01 of the AutoSplit module it is possible to have |
| 205 | multiple packages within a single file. Both of the following cases |
| 206 | are supported: |
| 207 | .PP |
| 208 | .Vb 7 |
| 209 | \& package NAME; |
| 210 | \& __END__ |
| 211 | \& sub AAA { ... } |
| 212 | \& package NAME::option1; |
| 213 | \& sub BBB { ... } |
| 214 | \& package NAME::option2; |
| 215 | \& sub BBB { ... } |
| 216 | .Ve |
| 217 | .PP |
| 218 | .Vb 5 |
| 219 | \& package NAME; |
| 220 | \& __END__ |
| 221 | \& sub AAA { ... } |
| 222 | \& sub NAME::option1::BBB { ... } |
| 223 | \& sub NAME::option2::BBB { ... } |
| 224 | .Ve |
| 225 | .SH "DIAGNOSTICS" |
| 226 | .IX Header "DIAGNOSTICS" |
| 227 | \&\f(CW\*(C`AutoSplit\*(C'\fR will inform the user if it is necessary to create the |
| 228 | top-level directory specified in the invocation. It is preferred that |
| 229 | the script or installation process that invokes \f(CW\*(C`AutoSplit\*(C'\fR have |
| 230 | created the full directory path ahead of time. This warning may |
| 231 | indicate that the module is being split into an incorrect path. |
| 232 | .PP |
| 233 | \&\f(CW\*(C`AutoSplit\*(C'\fR will warn the user of all subroutines whose name causes |
| 234 | potential file naming conflicts on machines with drastically limited |
| 235 | (8 characters or less) file name length. Since the subroutine name is |
| 236 | used as the file name, these warnings can aid in portability to such |
| 237 | systems. |
| 238 | .PP |
| 239 | Warnings are issued and the file skipped if \f(CW\*(C`AutoSplit\*(C'\fR cannot locate |
| 240 | either the \fI_\|_END_\|_\fR marker or a \*(L"package Name;\*(R"\-style specification. |
| 241 | .PP |
| 242 | \&\f(CW\*(C`AutoSplit\*(C'\fR will also emit general diagnostics for inability to |
| 243 | create directories or files. |