-
-
02 Mar 2013 17:11:13 UTC
- Distribution: Env
- Module version: 1.04
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (1507 / 0 / 0)
- Kwalitee
Bus factor: 5- 77.55% Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (11.73KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
++ed by:1 non-PAUSE userand 3 contributors-
Chip Salzenberg
-
Gregor N. Purdy
- The Perl 5 Porters
- Dependencies
- Tie::Array
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Env - perl module that imports environment variables as scalars or arrays
SYNOPSIS
use Env; use Env qw(PATH HOME TERM); use Env qw($SHELL @LD_LIBRARY_PATH);
DESCRIPTION
Perl maintains environment variables in a special hash named
%ENV
. For when this access method is inconvenient, the Perl moduleEnv
allows environment variables to be treated as scalar or array variables.The
Env::import()
function ties environment variables with suitable names to global Perl variables with the same names. By default it ties all existing environment variables (keys %ENV
) to scalars. If theimport
function receives arguments, it takes them to be a list of variables to tie; it's okay if they don't yet exist. The scalar type prefix '$' is inferred for any element of this list not prefixed by '$' or '@'. Arrays are implemented in terms ofsplit
andjoin
, using$Config::Config{path_sep}
as the delimiter.After an environment variable is tied, merely use it like a normal variable. You may access its value
@path = split(/:/, $PATH); print join("\n", @LD_LIBRARY_PATH), "\n";
or modify it
$PATH .= ":."; push @LD_LIBRARY_PATH, $dir;
however you'd like. Bear in mind, however, that each access to a tied array variable requires splitting the environment variable's string anew.
The code:
use Env qw(@PATH); push @PATH, '.';
is equivalent to:
use Env qw(PATH); $PATH .= ":.";
except that if
$ENV{PATH}
started out empty, the second approach leaves it with the (odd) value ":.
", but the first approach leaves it with ".
".To remove a tied environment variable from the environment, assign it the undefined value
undef $PATH; undef @LD_LIBRARY_PATH;
LIMITATIONS
On VMS systems, arrays tied to environment variables are read-only. Attempting to change anything will cause a warning.
AUTHOR
Chip Salzenberg <chip@fin.uucp> and Gregor N. Purdy <gregor@focusresearch.com>
Module Install Instructions
To install Env, copy and paste the appropriate command in to your terminal.
cpanm Env
perl -MCPAN -e shell install Env
For more information on module installation, please visit the detailed CPAN module installation guide.