Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   31170 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

Mojo::Home(3)	      User Contributed Perl Documentation	 Mojo::Home(3)

NAME
       Mojo::Home - Detect And Access The Project Root Directory In Mojo

SYNOPSIS
	 use Mojo::Home;

	 my $home = Mojo::Home->new;
	 $home->detect;

DESCRIPTION
       Mojo::Home is a container for home directories.

ATTRIBUTES
       Mojo::Home implements the following attributes.

   "app_class"
	 my $class = $home->app_class;
	 $home	   = $home->app_class('Foo::Bar');

       Application class.

METHODS
       Mojo::Home inherits all methods from Mojo::Base and implements the
       following new ones.

   "new"
	 my $home = Mojo::Home->new;
	 my $home = Mojo::Home->new('/foo/bar');

       Construct a new Mojo::Home object.

   "detect"
	 $home = $home->detect;
	 $home = $home->detect('My::App');

       Detect home directory from application class.

   "lib_dir"
	 my $path = $home->lib_dir;

       Path to "lib" directory.

   "list_files"
	 my $files = $home->list_files;
	 my $files = $home->list_files('foo/bar');

       List all files in directory and subdirectories recursively.

   "mojo_lib_dir"
	 my $path = $home->mojo_lib_dir;

       Path to "lib" directory in which Mojolicious is installed.  Note that
       this method is EXPERIMENTAL and might change without warning!

   "parse"
	 $home = $home->parse('/foo/bar');

       Parse path.

   "rel_dir"
	 my $path = $home->rel_dir('foo/bar');

       Generate absolute path for relative directory.

   "rel_file"
	 my $path = $home->rel_file('foo/bar.html');

       Generate absolute path for relative file.

   "slurp_rel_file"
	 my $string = $home->slurp_rel_file('foo/bar.html');

       Read all file data at once.  Note that this method is EXPERIMENTAL and
       might change without warning!

   "to_string"
	 my $string = $home->to_string;
	 my $string = "$home";

       Home directory.

SEE ALSO
       Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.

perl v5.14.1			  2011-09-11			 Mojo::Home(3)

Vote for polarhome