Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages
Catalyst::Plugin::Setenv(3) User Contributed Perl Documentation Catalyst::Plugin::Setenv(3)

Catalyst::Plugin::Setenv - Allows you to set up the environment from Catalyst's config file.

Version 0.03

In your application:

    use Catalyst qw/Setenv/;

In your config file:

      FOO: bar
      BAR: baz

When your app starts, $ENV{FOO} will be "bar", and $ENV{BAR} will be "baz".

You can also append and prepend to existing environment variables. For example, if $PATH is "/bin:/usr/bin", you can append "/myapp/bin" by writing:

     PATH: "::/myapp/bin"

After that, $PATH will be set to "/bin:/usr/bin:/myapp/bin". You can prepend, too:

     PATH: "/myapp/bin::"

which yields "/myapp/bin:/bin:/usr/bin".

If you want a literal colon at the beginning or end of the environment variable, escape it with a "\", like "\:foo" or "foo\:". Note that slashes aren't meaningful elsewhere, they're inserted verbatim into the relevant environment variable.

A list of functions that can be exported. You can delete this section if you don't export anything, such as for a purely object-oriented module.

Calls the other setup methods, and then sets the environment variables.

Jonathan Rockway, "<jrockway at>"

Things like "\:foo" can't be literally inserted into an environment variable, due to my simplistic escaping scheme. Patches to fix this (but not interpert "\"s anywhere else) are welcome.

Please report any bugs or feature requests to "bug-catalyst-plugin-setenv at", or through the web interface at <>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

You can find documentation for this module with the perldoc command.

    perldoc Catalyst::Plugin::Setenv

You can also look for information at:

  • The Catalyst Website


  • AnnoCPAN: Annotated CPAN documentation


  • CPAN Ratings


  • RT: CPAN's request tracker


  • Search CPAN


Thanks to Bill Moseley's message to the mailing list that prompted me to write this.

Copyright 2006 Jonathan Rockway, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

2022-04-08 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.