NAME

App::Env::Example - example application environment module for App::Env.

DESCRIPTION

Modules used by App::Env to load application environments are named

App::Env::<application>

or, if there is a site specific version:

App::Env::<SITE>::<application>

It is very important that the loaded environment be based upon the current environment. For example, if the environment is derived from running a shell script, make sure either that the shell script is run without running the user's startup file, or that any differences between the current environment and that constructed by the script which are not due to the application are resolved in the current environment's favor. For example, say that LD_LIBRARY_PATH is set in the user's .cshrc file:

setenv LD_LIBRARY_PATH /my/path1

and that before invoking App::Env the user has modified it to

/my/path1:/my/path2

If a csh script is sourced to create the environment, and csh is not run with the -f flag, the user's .cshrc will be sourced, the user's modifications to LD_LIBRARY_PATH will be lost, and breakage may happen.

Functions

They should define the following functions:

envs

$hashref = envs( \%opts );

$hashref is a hash containing environmental variables and their values. %opts will contain the options passed to App::Env::import via the AppOpts option.

See the source of this module for a simple example.