manual/mod/mod_env.xml

	mod_env.xml revision 6fbd2e53c97ea6976d93e0ac521adabc55e0fb73
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<?xml version="1.0"?>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<!--
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte Copyright 2002-2004 The Apache Software Foundation
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte Licensed under the Apache License, Version 2.0 (the "License");
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte you may not use this file except in compliance with the License.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte You may obtain a copy of the License at
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte     http://www.apache.org/licenses/LICENSE-2.0
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte Unless required by applicable law or agreed to in writing, software
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte distributed under the License is distributed on an "AS IS" BASIS,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte See the License for the specific language governing permissions and
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte limitations under the License.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte-->
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
a1e9eea083a8f257157edb8a1efb5bbd300eb4bfSrikanth, Ramana<modulesynopsis metafile="mod_env.xml.meta">
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<name>mod_env</name>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<description>Modifies the environment which is passed to CGI scripts and
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn ForteSSI pages</description>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<status>Base</status>
a1e9eea083a8f257157edb8a1efb5bbd300eb4bfSrikanth, Ramana<sourcefile>mod_env.c</sourcefile>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<identifier>env_module</identifier>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<summary>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    <p>This module allows for control of the environment that will
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    be provided to CGI scripts and SSI pages. Environment variables
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    may be passed from the shell which invoked the httpd process.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    Alternatively, environment variables may be set or unset within
    the configuration process.</p>
</summary>
<seealso><a href="/env.html">Environment Variables</a></seealso>

<directivesynopsis>
<name>PassEnv</name>
<description>Passes environment variables from the shell</description>
<syntax>PassEnv <var>env-variable</var> [<var>env-variable</var>]
...</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<override>FileInfo</override>

<usage>
    <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.</p>

    <example><title>Example</title>
      PassEnv LD_LIBRARY_PATH
    </example>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>SetEnv</name>
<description>Sets environment variables</description>
<syntax>SetEnv <var>env-variable</var> <var>value</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<override>FileInfo</override>

<usage>
    <p>Sets an environment variable, which is then passed on to CGI
    scripts and SSI pages.</p>

    <example><title>Example</title>
      SetEnv SPECIAL_PATH /foo/bin
    </example>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>UnsetEnv</name>
<description>Removes variables from the environment</description>
<syntax>UnsetEnv <var>env-variable</var> [<var>env-variable</var>]
...</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context></contextlist>
<override>FileInfo</override>

<usage>
    <p>Removes one or more environment variables from those passed
    on to CGI scripts and SSI pages.</p>

    <example><title>Example</title>
      UnsetEnv LD_LIBRARY_PATH
    </example>
</usage>
</directivesynopsis>

</modulesynopsis>