blob: 3d6d610fe93fc1c7b26220af073636f55bf46cf1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE>Apache module mod_env</TITLE>
</HEAD>
<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
<BODY
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#000080"
ALINK="#FF0000"
>
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Apache module mod_env</H1>
<p>This module provides for modifying the environment which
is passed to CGI scripts and SSI pages.</p>
<P><A
HREF="module-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Base
<BR>
<A
HREF="module-dict.html#SourceFile"
REL="Help"
><STRONG>Source File:</STRONG></A> mod_env.c
<BR>
<A
HREF="module-dict.html#ModuleIdentifier"
REL="Help"
><STRONG>Module Identifier:</STRONG></A> env_module
<BR>
<A
HREF="module-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Available in Apache 1.1 and later.
</P>
<H2>Summary</H2>
<p>This module allows for control of the environment that will be
provided to CGI scripts and SSI pages. Environment variables may be
passed from the shell which invoked the httpd process. Alternatively,
environment variables may be set or unset within the configuration
process.</p>
<p>For additional information, we provide a document on
<a href="../env.html">Environment Variables in Apache</a>.</p>
<H2>Directives</H2>
<UL>
<LI><A HREF="#passenv">PassEnv</A>
<LI><A HREF="#setenv">SetEnv</A>
<LI><A HREF="#unsetenv">UnsetEnv</A>
</UL>
<HR>
<H2><A NAME="passenv">PassEnv</A> directive</H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> PassEnv <EM>variable</em>
[<em>variable</em>] ...<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Base<BR>
<A
HREF="directive-dict.html#Module"
REL="Help"
><STRONG>Module:</STRONG></A> mod_env<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> PassEnv is only available in
Apache 1.1 and later.<P>
Specifies one or more environment variables to pass to CGI scripts
and SSI pages from the environment of the shell which invoked
the httpd process. Example:
<PRE>
PassEnv LD_LIBRARY_PATH
</PRE>
<HR>
<H2><A NAME="setenv">SetEnv</A> directive</H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> SetEnv <EM>variable value</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Base<BR>
<A
HREF="directive-dict.html#Module"
REL="Help"
><STRONG>Module:</STRONG></A> mod_env<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> SetEnv is only available in
Apache 1.1 and later.<P>
Sets an environment variable, which is then passed on to CGI
scripts and SSI pages. Example:
<PRE>
SetEnv SPECIAL_PATH /foo/bin
</PRE>
<HR>
<H2><A NAME="unsetenv">UnsetEnv</A> directive</H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> UnsetEnv <EM>variable</em>
[<em>variable</em>] ...<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Base<BR>
<A
HREF="directive-dict.html#Module"
REL="Help"
><STRONG>Module:</STRONG></A> mod_env<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> UnsetEnv is only available in
Apache 1.1 and later.<P>
Removes one or more environment variables from those passed on to
CGI scripts and SSI pages. Example:
<PRE>
UnsetEnv LD_LIBRARY_PATH
</PRE>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>