dtRdr - toplevel data/environment for dotReader
For the dotReader documentation, see dtRdr::doc.
This module handles the initialization and locations. It will probably eventually absorb most of the functionality currently found in the dtRdr::User modules.
dtRdr->init;
my @dirs = dtRdr->plugin_dirs;
dtRdr->_init_reloader
dtRdr->_init_logger;
In most cases, this should be called before init().
Set app dir to PAR_TEMP (or other various environmentally defined places) if it exists.
dtRdr->init_app_dir(__FILE__); # must be next to data/
The app directory is what would typically be found next to the executable in an installed situation. It contains things like 'data/'
This call also initializes various other parts of the environment.
dtRdr->set_user_dir($dirname);
Uses program_base() to determine where dtRdr->user_dir is. Currently, the answer is './' or next to the application.
dtRdr->_init_user_dir;
The environment variable DOTREADER_USER_DIR can be used to override this iff it is set at init() time.
DOTREADER_USER_DIR
Eventually, we'll support the ~/.dotreader/ directory.
Reload changed modules.
dtRdr->_reload;
dtRdr->release_number;
Returns true if this is the first time the app has been run.
dtRdr->first_time;
my $text = dtRdr->get_LICENSE;
my $text = dtRdr->get_COPYING;
dtRdr->_get_THIS('LICENSE|COPYING');
Eric Wilhelm <ewilhelm at cpan dot org>
http://scratchcomputing.com/
Copyright (C) 2006 Eric L. Wilhelm and OSoft, All Rights Reserved.
Absolutely, positively NO WARRANTY, neither express or implied, is offered with this software. You use this software at your own risk. In case of loss, no person or entity owes you anything whatsoever. You have been warned.
The dotReader(TM) is OSI Certified Open Source Software licensed under the GNU General Public License (GPL) Version 2, June 1991. Non-encrypted and encrypted packages are usable in connection with the dotReader(TM). The ability to create, edit, or otherwise modify content of such encrypted packages is self-contained within the packages, and NOT provided by the dotReader(TM), and is addressed in a separate commercial license.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
To install dtRdr, copy and paste the appropriate command in to your terminal.
cpanm
cpanm dtRdr
CPAN shell
perl -MCPAN -e shell install dtRdr
For more information on module installation, please visit the detailed CPAN module installation guide.