local-lib5/man/man3/IO::InnerFile.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   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 "IO::InnerFile 3"
 132 .TH IO::InnerFile 3 "2005-02-10" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 IO::InnerFile \- define a file inside another file
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 5
 138 \&    ### Read a subset of a file:
 139 \&    $inner = IO::InnerFile\->new($fh, $start, $length);
 140 \&    while (<$inner>) {
 141 \&        ...
 142 \&    }
 143 .Ve
 144 .SH "DESCRIPTION"
 145 .IX Header "DESCRIPTION"
 146 If you have a filehandle that can \fIseek()\fR and \fItell()\fR, then you
 147 can open an IO::InnerFile on a range of the underlying file.
 148 .SH "PUBLIC INTERFACE"
 149 .IX Header "PUBLIC INTERFACE"
 150 .IP "new \s-1FILEHANDLE\s0, [\s-1START\s0, [\s-1LENGTH\s0]]" 4
 151 .IX Item "new FILEHANDLE, [START, [LENGTH]]"
 152 \&\fIClass method, constructor.\fR
 153 Create a new inner-file opened on the given \s-1FILEHANDLE\s0,
 154 from bytes \s-1START\s0 to \s-1START+LENGTH\s0.  Both \s-1START\s0 and \s-1LENGTH\s0
 155 default to 0; negative values are silently coerced to zero.
 156 .Sp
 157 Note that \s-1FILEHANDLE\s0 must be able to \fIseek()\fR and \fItell()\fR, in addition
 158 to whatever other methods you may desire for reading it.
 159 .IP "set_length \s-1LENGTH\s0" 4
 160 .IX Item "set_length LENGTH"
 161 .PD 0
 162 .IP "get_length" 4
 163 .IX Item "get_length"
 164 .IP "add_length \s-1NBYTES\s0" 4
 165 .IX Item "add_length NBYTES"
 166 .PD
 167 \&\fIInstance methods.\fR
 168 Get/set the virtual length of the inner file.
 169 .IP "set_start \s-1START\s0" 4
 170 .IX Item "set_start START"
 171 .PD 0
 172 .IP "get_start" 4
 173 .IX Item "get_start"
 174 .IP "add_start \s-1NBYTES\s0" 4
 175 .IX Item "add_start NBYTES"
 176 .PD
 177 \&\fIInstance methods.\fR
 178 Get/set the virtual start position of the inner file.
 179 .IP "binmode" 4
 180 .IX Item "binmode"
 181 .PD 0
 182 .IP "close" 4
 183 .IX Item "close"
 184 .IP "flush" 4
 185 .IX Item "flush"
 186 .IP "getc" 4
 187 .IX Item "getc"
 188 .IP "getline" 4
 189 .IX Item "getline"
 190 .IP "print \s-1LIST\s0" 4
 191 .IX Item "print LIST"
 192 .IP "printf \s-1LIST\s0" 4
 193 .IX Item "printf LIST"
 194 .IP "read \s-1BUF\s0, \s-1NBYTES\s0" 4
 195 .IX Item "read BUF, NBYTES"
 196 .IP "readline" 4
 197 .IX Item "readline"
 198 .IP "seek \s-1OFFFSET\s0, \s-1WHENCE\s0" 4
 199 .IX Item "seek OFFFSET, WHENCE"
 200 .IP "tell" 4
 201 .IX Item "tell"
 202 .IP "write \s-1ARGS\s0..." 4
 203 .IX Item "write ARGS..."
 204 .PD
 205 \&\fIInstance methods.\fR
 206 Standard filehandle methods.
 207 .SH "VERSION"
 208 .IX Header "VERSION"
 209 $Id: InnerFile.pm,v 1.4 2005/02/10 21:21:53 dfs Exp $
 210 .SH "AUTHOR"
 211 .IX Header "AUTHOR"
 212 Original version by Doru Petrescu (pdoru@kappa.ro).
 213 .PP
 214 Documentation and by Eryq (eryq@zeegee.com).
 215 .PP
 216 Currently maintained by David F. Skoll (dfs@roaringpenguin.com).