github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_env.html.en (about)

     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  <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
     5  <!--
     6          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     7                This file is generated from xml source: DO NOT EDIT
     8          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     9        -->
    10  <title>mod_env - Apache HTTP Server Version 2.2</title>
    11  <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
    12  <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
    13  <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" />
    14  <script src="../style/scripts/prettify.min.js" type="text/javascript">
    15  </script>
    16  
    17  <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_env.html" rel="canonical" /></head>
    18  <body>
    19  <div id="page-header">
    20  <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>
    21  <p class="apache">Apache HTTP Server Version 2.2</p>
    22  <img alt="" src="../images/feather.gif" /></div>
    23  <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
    24  <div id="path">
    25  <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.2</a> &gt; <a href="./">Modules</a></div>
    26  <div id="page-content">
    27  <div class="retired"><h4>Please note</h4>
    28              <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p>
    29          <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_env.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_env</h1>
    30  <div class="toplang">
    31  <p><span>Available Languages: </span><a href="../en/mod/mod_env.html" title="English">&nbsp;en&nbsp;</a> |
    32  <a href="../ja/mod/mod_env.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
    33  <a href="../ko/mod/mod_env.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
    34  <a href="../tr/mod/mod_env.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
    35  </div>
    36  <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
    37  SSI pages</td></tr>
    38  <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
    39  <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>env_module</td></tr>
    40  <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_env.c</td></tr></table>
    41  <h3>Summary</h3>
    42  
    43      <p>This module allows for control of internal environment variables that
    44      are used by various Apache HTTP Server modules. These variables are also
    45      provided to CGI scripts as native system environment variables, and available
    46      for use in SSI pages. Environment variables may be passed from the shell
    47      which invoked the <code class="program"><a href="../programs/httpd.html">httpd</a></code> process. Alternatively,
    48      environment variables may be set or unset within the configuration process.</p>
    49  </div>
    50  <div id="quickview"><h3 class="directives">Directives</h3>
    51  <ul id="toc">
    52  <li><img alt="" src="../images/down.gif" /> <a href="#passenv">PassEnv</a></li>
    53  <li><img alt="" src="../images/down.gif" /> <a href="#setenv">SetEnv</a></li>
    54  <li><img alt="" src="../images/down.gif" /> <a href="#unsetenv">UnsetEnv</a></li>
    55  </ul>
    56  <h3>See also</h3>
    57  <ul class="seealso">
    58  <li><a href="../env.html">Environment Variables</a></li>
    59  <li><code class="directive"><a href="../mod/mod_setenvif.html#setenvif">SetEnvIf</a></code></li>
    60  </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
    61  
    62  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    63  <div class="directive-section"><h2><a name="PassEnv" id="PassEnv">PassEnv</a> <a name="passenv" id="passenv">Directive</a></h2>
    64  <table class="directive">
    65  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Passes environment variables from the shell</td></tr>
    66  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>PassEnv <var>env-variable</var> [<var>env-variable</var>]
    67  ...</code></td></tr>
    68  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
    69  <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
    70  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
    71  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_env</td></tr>
    72  </table>
    73      <p>Specifies one or more native system environment variables to make available
    74      as internal environment variables, which are available to Apache HTTP Server modules
    75      as well as propagated to CGI scripts and SSI pages. Values come from the
    76      native OS environment of the shell which invoked the
    77      <code class="program"><a href="../programs/httpd.html">httpd</a></code> process.</p>
    78  
    79      <div class="example"><h3>Example</h3><p><code>
    80        PassEnv LD_LIBRARY_PATH
    81      </code></p></div>
    82  
    83  </div>
    84  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    85  <div class="directive-section"><h2><a name="SetEnv" id="SetEnv">SetEnv</a> <a name="setenv" id="setenv">Directive</a></h2>
    86  <table class="directive">
    87  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets environment variables</td></tr>
    88  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetEnv <var>env-variable</var> [<var>value</var>]</code></td></tr>
    89  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
    90  <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
    91  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
    92  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_env</td></tr>
    93  </table>
    94      <p>Sets an internal environment variable, which is then available to Apache
    95      HTTP Server modules, and passed on to CGI scripts and SSI pages.</p>
    96  
    97      <div class="example"><h3>Example</h3><p><code>
    98        SetEnv SPECIAL_PATH /foo/bin
    99      </code></p></div>
   100  
   101      <p> If you omit the <var>value</var> argument, the variable is set to
   102      an empty string.</p>
   103  
   104      <div class="note"><p>The internal environment variables set by this directive are set
   105      <em>after</em> most early request processing directives are run, such as access
   106      control and URI-to-filename mapping.  If the environment variable you're
   107      setting is meant as input into this early phase of processing such as the
   108      <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive, you should
   109      instead set the environment variable with
   110      <code class="directive"><a href="../mod/mod_setenvif.html#setenvif">SetEnvIf</a></code>.</p>
   111      </div>
   112      <div class="note"><p>On 2.2, the PATH environment variable cannot be set using Setenv.</p>
   113      </div>
   114  
   115  
   116  <h3>See also</h3>
   117  <ul>
   118  <li><a href="../env.html">Environment Variables</a></li>
   119  </ul>
   120  </div>
   121  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
   122  <div class="directive-section"><h2><a name="UnsetEnv" id="UnsetEnv">UnsetEnv</a> <a name="unsetenv" id="unsetenv">Directive</a></h2>
   123  <table class="directive">
   124  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Removes variables from the environment</td></tr>
   125  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UnsetEnv <var>env-variable</var> [<var>env-variable</var>]
   126  ...</code></td></tr>
   127  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
   128  <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
   129  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
   130  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_env</td></tr>
   131  </table>
   132      <p>Removes one or more internal environment variables from those passed
   133      on to CGI scripts and SSI pages.</p>
   134  
   135      <div class="example"><h3>Example</h3><p><code>
   136        UnsetEnv LD_LIBRARY_PATH
   137      </code></p></div>
   138  
   139  </div>
   140  </div>
   141  <div class="bottomlang">
   142  <p><span>Available Languages: </span><a href="../en/mod/mod_env.html" title="English">&nbsp;en&nbsp;</a> |
   143  <a href="../ja/mod/mod_env.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
   144  <a href="../ko/mod/mod_env.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
   145  <a href="../tr/mod/mod_env.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
   146  </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>
   147  <script type="text/javascript"><!--//--><![CDATA[//><!--
   148  var comments_shortname = 'httpd';
   149  var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_env.html';
   150  (function(w, d) {
   151      if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
   152          d.write('<div id="comments_thread"><\/div>');
   153          var s = d.createElement('script');
   154          s.type = 'text/javascript';
   155          s.async = true;
   156          s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
   157          (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
   158      }
   159      else { 
   160          d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
   161      }
   162  })(window, document);
   163  //--><!]]></script></div><div id="footer">
   164  <p class="apache">Copyright 2017 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>
   165  <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[//><!--
   166  if (typeof(prettyPrint) !== 'undefined') {
   167      prettyPrint();
   168  }
   169  //--><!]]></script>
   170  </body></html>