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

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Copyright 2002-2005 The Apache Software Foundation or its licensors, as
   8  applicable.
   9
  10  Licensed under the Apache License, Version 2.0 (the "License");
  11  you may not use this file except in compliance with the License.
  12  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_actions.xml.meta">
  24
  25 <name>mod_actions</name>
  26
  27 <description>This module provides for executing CGI scripts based on
  28 media type or request method.</description>
  29
  30 <status>Base</status>
  31 <sourcefile>mod_actions.c</sourcefile>
  32 <identifier>actions_module</identifier>
  33
  34 <summary>
  35     <p>This module has two directives. The <directive
  36     module="mod_actions">Action</directive> directive lets you run CGI
  37     scripts whenever a file of a certain <glossary
  38     ref="mime-type">MIME content type</glossary> is requested. The
  39     <directive module="mod_actions">Script</directive> directive lets
  40     you run CGI scripts whenever a particular method is used in a
  41     request. This makes it much easier to execute scripts that process
  42     files.</p> </summary>
  43
  44 <seealso><module>mod_cgi</module></seealso>
  45 <seealso><a href="../howto/cgi.html">Dynamic Content with CGI</a></seealso>
  46 <seealso><a href="../handler.html">Apache's Handler Use</a></seealso>
  47
  48 <directivesynopsis>
  49 <name>Action</name>
  50 <description>Activates a CGI script for a particular handler or
  51 content-type</description>
  52 <syntax>Action <var>action-type</var> <var>cgi-script</var> [virtual]</syntax>
  53 <contextlist>
  54 <context>server config</context><context>virtual host</context>
  55 <context>directory</context><context>.htaccess</context>
  56 </contextlist>
  57 <override>FileInfo</override>
  58 <compatibility>The <code>virtual</code> modifier and handler passing were
  59 introduced in Apache 2.1</compatibility>
  60
  61 <usage>
  62     <p>This directive adds an action, which will activate
  63     <var>cgi-script</var> when <var>action-type</var> is triggered by
  64     the request.  The <var>cgi-script</var> is the URL-path to a
  65     resource that has been designated as a CGI script using <directive
  66     module="mod_alias">ScriptAlias</directive> or <directive
  67     module="mod_mime">AddHandler</directive>.  The
  68     <var>action-type</var> can be either a <a
  69     href="../handler.html">handler</a> or a <glossary
  70     ref="mime-type">MIME content type</glossary>. It sends the URL and
  71     file path of the requested document using the standard CGI
  72     <code>PATH_INFO</code> and <code>PATH_TRANSLATED</code>
  73     environment variables. The handler used for the particular request
  74     is passed using the <code>REDIRECT_HANDLER</code> variable.</p>
  75
  76     <example><title>Examples</title>
  77       # Requests for files of a particular MIME content type:<br />
  78       Action image/gif /cgi-bin/images.cgi<br />
  79       <br />
  80       # Files of a particular file extension<br />
  81       AddHandler my-file-type .xyz<br />
  82       Action my-file-type /cgi-bin/program.cgi<br />
  83     </example>
  84
  85     <p>In the first example, requests for files with a MIME content
  86     type of <code>image/gif</code> will be handled by the
  87     specified cgi script <code>/cgi-bin/images.cgi</code>.</p>
  88
  89     <p>In the second example, requests for files with a file extension of
  90     <code>.xyz</code> are handled by the specified cgi script
  91     <code>/cgi-bin/program.cgi</code>.</p>
  92
  93     <p>The optional <code>virtual</code> modifier turns off the check
  94     whether the requested file really exists. This is useful, for example,
  95     if you want to use the <directive>Action</directive> directive in
  96     virtual locations.</p>
  97
  98     <example><title>Example</title>
  99       &lt;Location /news&gt;<br />
 100       <indent>
 101         SetHandler news-handler<br />
 102         Action news-handler /cgi-bin/news.cgi virtual<br />
 103       </indent>
 104       &lt;/Location&gt;
 105     </example>
 106 </usage>
 107
 108 <seealso><directive module="mod_mime">AddHandler</directive></seealso>
 109 </directivesynopsis>
 110
 111 <directivesynopsis>
 112 <name>Script</name>
 113 <description>Activates a CGI script for a particular request
 114 method.</description>
 115 <syntax>Script <var>method</var> <var>cgi-script</var></syntax>
 116 <contextlist>
 117 <context>server config</context><context>virtual host</context>
 118 <context>directory</context></contextlist>
 119 <usage>
 120     <p>This directive adds an action, which will activate
 121     <var>cgi-script</var> when a file is requested using the method of
 122     <var>method</var>. The <var>cgi-script</var> is the URL-path to a
 123     resource that has been designated as a CGI script using <directive
 124     module="mod_alias">ScriptAlias</directive> or <directive
 125     module="mod_mime">AddHandler</directive>.  The URL and
 126     file path of the requested document is sent using the standard CGI
 127     <code>PATH_INFO</code> and <code>PATH_TRANSLATED</code> environment
 128     variables.</p>
 129
 130     <note>
 131       Any arbitrary method name may be used. <strong>Method names are
 132       case-sensitive</strong>, so <code>Script PUT</code> and
 133       <code>Script put</code> have two entirely different
 134       effects.
 135     </note>
 136
 137     <p>Note that the <directive>Script</directive> command defines default
 138     actions only. If a CGI script is called, or some other resource that is
 139     capable of handling the requested method internally, it will do
 140     so. Also note that <directive>Script</directive> with a method of
 141     <code>GET</code> will only be called if there are query arguments present
 142     (<em>e.g.</em>, foo.html?hi). Otherwise, the request will
 143     proceed normally.</p>
 144
 145     <example><title>Examples</title>
 146       # For &lt;ISINDEX&gt;-style searching<br />
 147       Script GET /cgi-bin/search<br />
 148       <br />
 149       # A CGI PUT handler<br />
 150       Script PUT /~bob/put.cgi<br />
 151     </example>
 152 </usage>
 153 </directivesynopsis>
 154
 155 </modulesynopsis>