view release on metacpan or  search on metacpan

lib/Any/Daemon/HTTP/UserDirs.pod  view on Meta::CPAN

=encoding utf8

=head1 NAME

Any::Daemon::HTTP::UserDirs - describe user directories

=head1 INHERITANCE

 Any::Daemon::HTTP::UserDirs
   is an Any::Daemon::HTTP::Directory
   is an Any::Daemon::HTTP::Source

=head1 SYNOPSIS

 # implicit creation of ::Directory object
 my $vh = Any::Daemon::HTTP::VirtualHost
   ->new(user_dirs => {location => ...})

 # explicit use
 my $ud = Any::Daemon::HTTP::Directory::UserDirs
   ->new(location => sub {...});
 my $vh = Any::Daemon::HTTP::VirtualHost->new(user_dirs => $ud);

=head1 DESCRIPTION

Each L<Any::Daemon::HTTP::VirtualHost|Any::Daemon::HTTP::VirtualHost> may define user directories.

Extends L<"DESCRIPTION" in Any::Daemon::HTTP::Directory|Any::Daemon::HTTP::Directory/"DESCRIPTION">.
 
=head1 METHODS

Extends L<"METHODS" in Any::Daemon::HTTP::Directory|Any::Daemon::HTTP::Directory/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Any::Daemon::HTTP::Directory|Any::Daemon::HTTP::Directory/"Constructors">.
 
=over 4

=item Any::Daemon::HTTP::UserDirs-E<gt>B<new>(%options|\%options)

The user-dir rewrite routine has by default Apache-like behavior.

 -Option        --Defined in                  --Default
  allow           Any::Daemon::HTTP::Source     <undef>
  allow_users                                   undef
  charset         Any::Daemon::HTTP::Directory  utf-8
  deny            Any::Daemon::HTTP::Source     <undef>
  deny_users                                    []
  directory_list  Any::Daemon::HTTP::Directory  <false>
  index_file      Any::Daemon::HTTP::Directory  ['index.html', 'index.htm']
  location        Any::Daemon::HTTP::Directory  CODE
  name            Any::Daemon::HTTP::Source     path
  path            Any::Daemon::HTTP::Source     <ignored>
  user_subdirs                                  'public_html'

=over 2

=item allow => CIDR|HOSTNAME|DOMAIN|CODE|ARRAY

=item allow_users => ARRAY