apache/docs/manual/mod/mod_env.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_env - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.3</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_env</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_env.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../ja/mod/mod_env.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  26 <a href="../ko/mod/mod_env.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  27 <a href="../tr/mod/mod_env.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  28 </div>
  29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Modifies the environment which is passed to CGI scripts and
  30 SSI pages</td></tr>
  31 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  32 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>env_module</td></tr>
  33 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_env.c</td></tr></table>
  34 <h3>Summary</h3>
  35
  36     <p>This module allows for control of the environment that will
  37     be provided to CGI scripts and SSI pages. Environment variables
  38     may be passed from the shell which invoked the <code class="program"><a href="../programs/httpd.html">httpd</a></code>
  39     process. Alternatively, environment variables may be set or unset within
  40     the configuration process.</p>
  41 </div>
  42 <div id="quickview"><h3 class="directives">Directives</h3>
  43 <ul id="toc">
  44 <li><img alt="" src="../images/down.gif" /> <a href="#passenv">PassEnv</a></li>
  45 <li><img alt="" src="../images/down.gif" /> <a href="#setenv">SetEnv</a></li>
  46 <li><img alt="" src="../images/down.gif" /> <a href="#unsetenv">UnsetEnv</a></li>
  47 </ul>
  48 <h3>See also</h3>
  49 <ul class="seealso">
  50 <li><a href="../env.html">Environment Variables</a></li>
  51 </ul></div>
  52
  53 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  54 <div class="directive-section"><h2><a name="PassEnv" id="PassEnv">PassEnv</a> <a name="passenv" id="passenv">Directive</a></h2>
  55 <table class="directive">
  56 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Passes environment variables from the shell</td></tr>
  57 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>PassEnv <var>env-variable</var> [<var>env-variable</var>]
  58 ...</code></td></tr>
  59 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  60 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  61 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  62 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_env</td></tr>
  63 </table>
  64     <p>Specifies one or more environment variables to pass to CGI
  65     scripts and SSI pages from the environment of the shell which
  66     invoked the <code class="program"><a href="../programs/httpd.html">httpd</a></code> process.</p>
  67
  68     <div class="example"><h3>Example</h3><p><code>
  69       PassEnv LD_LIBRARY_PATH
  70     </code></p></div>
  71
  72 </div>
  73 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  74 <div class="directive-section"><h2><a name="SetEnv" id="SetEnv">SetEnv</a> <a name="setenv" id="setenv">Directive</a></h2>
  75 <table class="directive">
  76 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets environment variables</td></tr>
  77 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetEnv <var>env-variable</var> <var>value</var></code></td></tr>
  78 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  79 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  80 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  81 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_env</td></tr>
  82 </table>
  83     <p>Sets an environment variable, which is then passed on to CGI
  84     scripts and SSI pages.</p>
  85
  86     <div class="example"><h3>Example</h3><p><code>
  87       SetEnv SPECIAL_PATH /foo/bin
  88     </code></p></div>
  89
  90 </div>
  91 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  92 <div class="directive-section"><h2><a name="UnsetEnv" id="UnsetEnv">UnsetEnv</a> <a name="unsetenv" id="unsetenv">Directive</a></h2>
  93 <table class="directive">
  94 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Removes variables from the environment</td></tr>
  95 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UnsetEnv <var>env-variable</var> [<var>env-variable</var>]
  96 ...</code></td></tr>
  97 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  98 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  99 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 100 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_env</td></tr>
 101 </table>
 102     <p>Removes one or more environment variables from those passed
 103     on to CGI scripts and SSI pages.</p>
 104
 105     <div class="example"><h3>Example</h3><p><code>
 106       UnsetEnv LD_LIBRARY_PATH
 107     </code></p></div>
 108
 109 </div>
 110 </div>
 111 <div class="bottomlang">
 112 <p><span>Available Languages: </span><a href="../en/mod/mod_env.html" title="English">&nbsp;en&nbsp;</a> |
 113 <a href="../ja/mod/mod_env.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 114 <a href="../ko/mod/mod_env.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 115 <a href="../tr/mod/mod_env.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 116 </div><div id="footer">
 117 <p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 118 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 119 </body></html>