.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "HTTP::Server::Simple::Static 3pm"
.TH HTTP::Server::Simple::Static 3pm "2013-08-20" "perl v5.14.2" "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"
HTTP::Server::Simple::Static \- Serve static files with HTTP::Server::Simple
.SH "VERSION"
.IX Header "VERSION"
This documentation refers to HTTP::Server::Simple::Static version 0.07
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package MyServer;
\&
\&    use base qw(HTTP::Server::Simple::CGI);
\&    use HTTP::Server::Simple::Static;
\&
\&    my $webroot = \*(Aq/var/www\*(Aq;
\&
\&    sub handle_request {
\&        my ( $self, $cgi ) = @_;
\&
\&        if ( !$self\->serve_static( $cgi, $webroot ) ) {
\&            print "HTTP/1.0 404 Not found\er\en";
\&            print $cgi\->header, 
\&                  $cgi\->start_html(\*(AqNot found\*(Aq),
\&                  $cgi\->h1(\*(AqNot found\*(Aq),
\&                  $cgi\->end_html;
\&        }
\&    } 
\&
\&    package main;
\&
\&    my $server = MyServer\->new();
\&    $server\->run();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
this mixin adds a method to serve static files from your HTTP::Server::Simple
subclass.
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
.ie n .IP "serve_static( $cgi, $base )" 4
.el .IP "serve_static( \f(CW$cgi\fR, \f(CW$base\fR )" 4
.IX Item "serve_static( $cgi, $base )"
Takes a reference to the \s-1CGI\s0 object and a document root path, and
tries to serve a static file. Returns 0 if the file does not exist,
returns 1 on success.
.Sp
This method sets the \f(CW\*(C`Date\*(C'\fR and \f(CW\*(C`Last\-Modified\*(C'\fR \s-1HTTP\s0 headers when
sending a response for a valid file. Further to this, the method
supports clients which send an \f(CW\*(C`If\-Modified\-Since\*(C'\fR \s-1HTTP\s0 header in the
request, it will return a 304 \f(CW\*(C`Not Modified\*(C'\fR response if the file is
unchanged. See \s-1RFC\-2616\s0 for full details.
.Sp
If the client makes a \f(CW\*(C`HEAD\*(C'\fR request then no message body will be
returned in the response.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Bugs or wishlist requests should be submitted via http://rt.cpan.org/
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
The File::LibMagic module is used to detect the MIME-type of
a file. The URI::Escape module is used for \s-1URI\s0 handling. The
HTTP::Date module is used to format the timestamp in the
Last-Modified \s-1HTTP\s0 header.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTTP::Server::Simple, HTTP::Server::Simple::CGI
.SH "AUTHOR"
.IX Header "AUTHOR"
Stephen Quinney \f(CW\*(C`sjq\-perl@jadevine.org.uk\*(C'\fR
.PP
Thanks to Marcus Ramberg \f(CW\*(C`marcus@thefeed.no\*(C'\fR and Simon Cozens for
initial implementation.
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2006 \- 2013. Stephen Quinney \f(CW\*(C`sjq\-perl@jadevine.org.uk\*(C'\fR
.PP
You may distribute this code under the same terms as Perl itself.