summaryrefslogtreecommitdiff
path: root/htdocs/manual/mod/mod_env.html.en
blob: 421754928d911fa44f60d6bc1dbdc3813bb4f269 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta name="generator" content="HTML Tidy, see www.w3.org" />

    <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>

      <li><a href="#setenv">SetEnv</a></li>

      <li><a href="#unsetenv">UnsetEnv</a></li>
    </ul>
    <hr />

    <h2><a id="passenv" name="passenv">PassEnv</a> directive</h2>
    <a href="directive-dict.html#Syntax"
    rel="Help"><strong>Syntax:</strong></a> PassEnv
    <em>env-variable</em> [<em>env-variable</em>] ...<br />
     <a href="directive-dict.html#Context"
    rel="Help"><strong>Context:</strong></a> server config, virtual
    host, directory, .htaccess<br />
     <a href="directive-dict.html#Override"
    rel="Help"><strong>Override:</strong></a> FileInfo<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.  Directory and .htaccess context
    is available in Apache 1.3.7 and later.

    <p class="currentdocs"><strong>Current documentation for this directive may be found <a
    href="http://httpd.apache.org/docs/current/mod/mod_env.html#passenv">here</a></strong></p>

    <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:</p>
<pre>
    PassEnv LD_LIBRARY_PATH
</pre>
    <hr />

    <h2><a id="setenv" name="setenv">SetEnv</a> directive</h2>
    <a href="directive-dict.html#Syntax"
    rel="Help"><strong>Syntax:</strong></a> SetEnv <em>env-variable
    value</em><br />
     <a href="directive-dict.html#Context"
    rel="Help"><strong>Context:</strong></a> server config, virtual
    host, directory, .htaccess<br />
     <a href="directive-dict.html#Override"
    rel="Help"><strong>Override:</strong></a> FileInfo<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.  Directory and .htaccess context
    is available in Apache 1.3.7 and later.

    <p class="currentdocs"><strong>Current documentation for this directive may be found <a
    href="http://httpd.apache.org/docs/current/mod/mod_env.html#setenv">here</a></strong></p>

    <p>Sets an environment variable, which is then passed on to CGI
    scripts and SSI pages. Example:</p>
<pre>
    SetEnv SPECIAL_PATH /foo/bin
</pre>
    <hr />

    <h2><a id="unsetenv" name="unsetenv">UnsetEnv</a>
    directive</h2>
    <a href="directive-dict.html#Syntax"
    rel="Help"><strong>Syntax:</strong></a> UnsetEnv
    <em>env-variable</em> [<em>env-variable</em>] ...<br />
     <a href="directive-dict.html#Context"
    rel="Help"><strong>Context:</strong></a> server config, virtual
    host, directory, .htaccess<br />
     <a href="directive-dict.html#Override"
    rel="Help"><strong>Override:</strong></a> FileInfo<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.  Directory and .htaccess context
    is available in Apache 1.3.7 and later.

    <p class="currentdocs"><strong>Current documentation for this directive may be found <a
    href="http://httpd.apache.org/docs/current/mod/mod_env.html#unsetenv">here</a></strong></p>

    <p>Removes one or more environment variables from those passed
    on to CGI scripts and SSI pages. Example:</p>
<pre>
    UnsetEnv LD_LIBRARY_PATH
</pre>
    <!--#include virtual="footer.html" -->
  </body>
</html>