.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.\" 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.  \*(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-
.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" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "WWW::IndexParser 3pm"
.TH WWW::IndexParser 3pm "2016-12-17" "perl v5.24.1" "User Contributed Perl Documentation"
.\" 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"
WWW::IndexParser \- Fetch and parse the directory index from a web server
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\& use WWW::IndexParser;
\& my @files = WWW::IndexParser\->new(url => \*(Aqhttp://www.example.com/dir/\*(Aq);
\& foreach my $entry (@files) {
\&   printf "%s %s\en", $entry\->filename, 
\&        scalar(localtime($entry\->time)||\*(Aq\*(Aq);
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBWWW::IndexParser\fR is a module that uses \s-1LWP\s0 to fetch a \s-1URL\s0 from a web 
server. It then atempts to parse this page as if it were an auto generated 
index page.  It returns an array of \fBWWW::IndexParser::Entry\fR objects, one 
per entry in the directory index that it has found. Each Entry has a 
set of methods: \fIfilename()\fR, \fItime()\fR, \fIsize()\fR, and others if supported 
by the autoindex generated: \fItype()\fR and \fIsize_units()\fR.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .IP "new ( url => $url, timeout => $seconds, proxy => $proxy_url, debug => 1  )" 4
.el .IP "new ( url => \f(CW$url\fR, timeout => \f(CW$seconds\fR, proxy => \f(CW$proxy_url\fR, debug => 1  )" 4
.IX Item "new ( url => $url, timeout => $seconds, proxy => $proxy_url, debug => 1 )"
When called with a \s-1URL\s0 to examine, this method does not return an object, 
but an array of WWW::IndexParser::Entry obects, one per entry in the 
directory listing that was accessed.
.Sp
The options to this are:
.RS 4
.IP "url" 4
.IX Item "url"
The complete \s-1URL\s0 of the index to fetch.
.IP "timeout" 4
.IX Item "timeout"
The timeout for the request to fetch data, default 10 seconds.
.IP "proxy" 4
.IX Item "proxy"
A proxy server \s-1URL,\s0 eg, 'http://proxy:3128/'.
.IP "debug" 4
.IX Item "debug"
Decide if to print parsing debug information. Set to 0 (the default) to 
disable, or anything non-false to print. Recommened you use a digit (ie, 1) 
as this may become a numeric 'level' of debug in the future.
.RE
.RS 4
.RE
.SH "METHODS"
.IX Header "METHODS"
All methods are private in this module. Pass only a \s-1URL\s0 to the constructor, 
and it does everything for you itself.
.SH "PREREQUISUTES"
.IX Header "PREREQUISUTES"
This modile depends upon \f(CW\*(C`LWP\*(C'\fR, \f(CW\*(C`HTML::Parser\*(C'\fR, \f(CW\*(C`Time::Local\*(C'\fR.
.SH "OSNAMES"
.IX Header "OSNAMES"
any
.SH "BUGS"
.IX Header "BUGS"
Currently only supports Apache, \s-1IIS\s0 and Tomcat style auto indexes. Send suggestions for new Auto-Indexes to support to the author (along with sample \s-1HTML\s0)!
.SH "AUTHOR"
.IX Header "AUTHOR"
James Bromberger <james@rcpt.to>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2006 James Bromberger. All rights reserved. All rights 
reserved. This program is free software; you can redistribute it and/or 
modify it under the same terms as Perl itself.