granicus.if.org Git - apache/blob - docs/manual/mod/mod_env.xml

   1 <?xml version="1.0"?>
   2 <?xml-stylesheet type="text/xsl" href="../style/manual.xsl"?>
   3 <modulesynopsis>
   4
   5 <name>mod_env</name>
   6   <description>Modifies the environment which is
   7     passed to CGI scripts and SSI pages</description>
   8   <status>Base</status>
   9   <sourcefile>mod_env.c</sourcefile>
  10   <identifier>env_module</identifier>
  11   <summary>
  12     <p>This module allows for control of the environment that will
  13     be provided to CGI scripts and SSI pages. Environment variables
  14     may be passed from the shell which invoked the httpd process.
  15     Alternatively, environment variables may be set or unset within
  16     the configuration process.</p>
  17   </summary>
  18   <seealso><a href="../env.html">Environment Variables</a></seealso>
  19
  20   <directivesynopsis>
  21     <name>PassEnv</name>
  22     <description>Passes environment variables from the shell</description>
  23     <syntax>PassEnv
  24     <em>env-variable</em> [<em>env-variable</em>] ...</syntax>
  25     <contextlist>
  26       <context>server config</context><context>virtual host</context>
  27       <context>directory</context><context>.htaccess</context>
  28     </contextlist>
  29     <override>FileInfo</override>
  30
  31 <usage>
  32     <p>Specifies one or more environment variables to pass to CGI
  33     scripts and SSI pages from the environment of the shell which
  34     invoked the httpd process. Example:</p>
  35 <example>
  36     PassEnv LD_LIBRARY_PATH
  37 </example>
  38 </usage>
  39 </directivesynopsis>
  40
  41 <directivesynopsis>
  42 <name>SetEnv</name>
  43 <description>Sets environment variables</description>
  44 <syntax>SetEnv <em>env-variable value</em></syntax>
  45 <contextlist>
  46 <context>server config</context><context>virtual host</context>
  47 <context>directory</context><context>.htaccess</context>
  48 </contextlist>
  49 <override>FileInfo</override>
  50
  51 <usage>
  52     <p>Sets an environment variable, which is then passed on to CGI
  53     scripts and SSI pages. Example:</p>
  54 <example>
  55     SetEnv SPECIAL_PATH /foo/bin
  56 </example>
  57 </usage>
  58 </directivesynopsis>
  59
  60 <directivesynopsis>
  61 <name>UnsetEnv</name>
  62 <description>Removes variables from the environment</description>
  63 <syntax>UnsetEnv <em>env-variable</em> [<em>env-variable</em>] ...</syntax>
  64 <contextlist>
  65 <context>server config</context><context>virtual host</context>
  66 <context>directory</context><context>.htaccess</context>
  67 </contextlist>
  68 <override>FileInfo</override>
  69
  70 <usage>
  71     <p>Removes one or more environment variables from those passed
  72     on to CGI scripts and SSI pages. Example:</p>
  73 <example>
  74     UnsetEnv LD_LIBRARY_PATH
  75 </example>
  76 </usage>
  77 </directivesynopsis>
  78
  79 </modulesynopsis>
  80