granicus.if.org Git - apache/blob - 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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.4</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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.4</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_env</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_env.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_env.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="../ja/mod/mod_env.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  30 <a href="../ko/mod/mod_env.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  31 <a href="../tr/mod/mod_env.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  32 </div>
  33 <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
  34 SSI pages</td></tr>
  35 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  36 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>env_module</td></tr>
  37 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_env.c</td></tr></table>
  38 <h3>Summary</h3>
  39
  40     <p>This module allows for control of internal environment variables that
  41     are used by various Apache HTTP Server modules. These variables are also
  42     provided to CGI scripts as native system environment variables, and available
  43     for use in SSI pages. Environment variables may be passed from the shell
  44     which invoked the <code class="program"><a href="../programs/httpd.html">httpd</a></code> process. Alternatively,
  45     environment variables may be set or unset within the configuration process.</p>
  46 </div>
  47 <div id="quickview"><h3 class="directives">Directives</h3>
  48 <ul id="toc">
  49 <li><img alt="" src="../images/down.gif" /> <a href="#passenv">PassEnv</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#setenv">SetEnv</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#unsetenv">UnsetEnv</a></li>
  52 </ul>
  53 <h3>See also</h3>
  54 <ul class="seealso">
  55 <li><a href="../env.html">Environment Variables</a></li>
  56 <li><code class="directive"><a href="../mod/mod_setenvif.html#setenvif">SetEnvIf</a></code></li>
  57 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  58
  59 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  60 <div class="directive-section"><h2><a name="PassEnv" id="PassEnv">PassEnv</a> <a name="passenv" id="passenv">Directive</a></h2>
  61 <table class="directive">
  62 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Passes environment variables from the shell</td></tr>
  63 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>PassEnv <var>env-variable</var> [<var>env-variable</var>]
  64 ...</code></td></tr>
  65 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  66 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  67 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  68 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_env</td></tr>
  69 </table>
  70     <p>Specifies one or more native system environment variables to make available
  71     as internal environment variables, which are available to Apache HTTP Server modules
  72     as well as propogated to CGI scripts and SSI pages. Values come from the
  73     native OS environment of the shell which invoked the
  74     <code class="program"><a href="../programs/httpd.html">httpd</a></code> process.</p>
  75
  76     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
  77       PassEnv LD_LIBRARY_PATH
  78       </pre>
  79 </div>
  80
  81 </div>
  82 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  83 <div class="directive-section"><h2><a name="SetEnv" id="SetEnv">SetEnv</a> <a name="setenv" id="setenv">Directive</a></h2>
  84 <table class="directive">
  85 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets environment variables</td></tr>
  86 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetEnv <var>env-variable</var> <var>value</var></code></td></tr>
  87 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  88 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  89 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  90 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_env</td></tr>
  91 </table>
  92     <p>Sets an internal environment variable, which is then available to Apache
  93     HTTP Server modules, and passed on to CGI scripts and SSI pages.</p>
  94
  95     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
  96       SetEnv SPECIAL_PATH /foo/bin
  97       </pre>
  98 </div>
  99
 100     <div class="note"><p>The internal environment variables set by this directive are set
 101     <em>after</em> most early request processing directives are run, such as access
 102     control and URI-to-filename mapping.  If the environment variable you're
 103     setting is meant as input into this early phase of processing such as the
 104     <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive, you should
 105     instead set the environment variable with
 106     <code class="directive"><a href="../mod/mod_setenvif.html# setenvif"> SetEnvIf</a></code>.</p>
 107     </div>
 108
 109
 110 <h3>See also</h3>
 111 <ul>
 112 <li><a href="../env.html">Environment Variables</a></li>
 113 </ul>
 114 </div>
 115 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 116 <div class="directive-section"><h2><a name="UnsetEnv" id="UnsetEnv">UnsetEnv</a> <a name="unsetenv" id="unsetenv">Directive</a></h2>
 117 <table class="directive">
 118 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Removes variables from the environment</td></tr>
 119 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UnsetEnv <var>env-variable</var> [<var>env-variable</var>]
 120 ...</code></td></tr>
 121 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 122 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 123 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 124 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_env</td></tr>
 125 </table>
 126     <p>Removes one or more internal environment variables from those passed
 127     on to CGI scripts and SSI pages.</p>
 128
 129     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
 130       UnsetEnv LD_LIBRARY_PATH
 131       </pre>
 132 </div>
 133
 134 </div>
 135 </div>
 136 <div class="bottomlang">
 137 <p><span>Available Languages: </span><a href="../en/mod/mod_env.html" title="English">&nbsp;en&nbsp;</a> |
 138 <a href="../fr/mod/mod_env.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 139 <a href="../ja/mod/mod_env.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 140 <a href="../ko/mod/mod_env.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 141 <a href="../tr/mod/mod_env.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 142 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 143 <script type="text/javascript"><!--//--><![CDATA[//><!--
 144 var comments_shortname = 'httpd';
 145 var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_env.html';
 146 (function(w, d) {
 147     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 148         d.write('<div id="comments_thread"><\/div>');
 149         var s = d.createElement('script');
 150         s.type = 'text/javascript';
 151         s.async = true;
 152         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 153         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 154     }
 155     else {
 156         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 157     }
 158 })(window, document);
 159 //--><!]]></script></div><div id="footer">
 160 <p class="apache">Copyright 2012 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>
 161 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 162 if (typeof(prettyPrint) !== 'undefined') {
 163     prettyPrint();
 164 }
 165 //--><!]]></script>
 166 </body></html>