--- /dev/null
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.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
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. | will give a
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.\"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "IO::InnerFile 3"
+.TH IO::InnerFile 3 "2005-02-10" "perl v5.8.7" "User Contributed Perl Documentation"
+.SH "NAME"
+IO::InnerFile \- define a file inside another file
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 5
+\& ### Read a subset of a file:
+\& $inner = IO::InnerFile\->new($fh, $start, $length);
+\& while (<$inner>) {
+\& ...
+\& }
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+If you have a filehandle that can \fIseek()\fR and \fItell()\fR, then you
+can open an IO::InnerFile on a range of the underlying file.
+.SH "PUBLIC INTERFACE"
+.IX Header "PUBLIC INTERFACE"
+.IP "new \s-1FILEHANDLE\s0, [\s-1START\s0, [\s-1LENGTH\s0]]" 4
+.IX Item "new FILEHANDLE, [START, [LENGTH]]"
+\&\fIClass method, constructor.\fR
+Create a new inner-file opened on the given \s-1FILEHANDLE\s0,
+from bytes \s-1START\s0 to \s-1START+LENGTH\s0. Both \s-1START\s0 and \s-1LENGTH\s0
+default to 0; negative values are silently coerced to zero.
+.Sp
+Note that \s-1FILEHANDLE\s0 must be able to \fIseek()\fR and \fItell()\fR, in addition
+to whatever other methods you may desire for reading it.
+.IP "set_length \s-1LENGTH\s0" 4
+.IX Item "set_length LENGTH"
+.PD 0
+.IP "get_length" 4
+.IX Item "get_length"
+.IP "add_length \s-1NBYTES\s0" 4
+.IX Item "add_length NBYTES"
+.PD
+\&\fIInstance methods.\fR
+Get/set the virtual length of the inner file.
+.IP "set_start \s-1START\s0" 4
+.IX Item "set_start START"
+.PD 0
+.IP "get_start" 4
+.IX Item "get_start"
+.IP "add_start \s-1NBYTES\s0" 4
+.IX Item "add_start NBYTES"
+.PD
+\&\fIInstance methods.\fR
+Get/set the virtual start position of the inner file.
+.IP "binmode" 4
+.IX Item "binmode"
+.PD 0
+.IP "close" 4
+.IX Item "close"
+.IP "flush" 4
+.IX Item "flush"
+.IP "getc" 4
+.IX Item "getc"
+.IP "getline" 4
+.IX Item "getline"
+.IP "print \s-1LIST\s0" 4
+.IX Item "print LIST"
+.IP "printf \s-1LIST\s0" 4
+.IX Item "printf LIST"
+.IP "read \s-1BUF\s0, \s-1NBYTES\s0" 4
+.IX Item "read BUF, NBYTES"
+.IP "readline" 4
+.IX Item "readline"
+.IP "seek \s-1OFFFSET\s0, \s-1WHENCE\s0" 4
+.IX Item "seek OFFFSET, WHENCE"
+.IP "tell" 4
+.IX Item "tell"
+.IP "write \s-1ARGS\s0..." 4
+.IX Item "write ARGS..."
+.PD
+\&\fIInstance methods.\fR
+Standard filehandle methods.
+.SH "VERSION"
+.IX Header "VERSION"
+$Id: InnerFile.pm,v 1.4 2005/02/10 21:21:53 dfs Exp $
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Original version by Doru Petrescu (pdoru@kappa.ro).
+.PP
+Documentation and by Eryq (eryq@zeegee.com).
+.PP
+Currently maintained by David F. Skoll (dfs@roaringpenguin.com).
projects / catagits/Gitalist.git / blobdiff