manual/mod/mod_actions.html

	mod_actions.html revision 72d8c9a30f25171e5c85eeae21e0b87331bac2d9
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_actions - Apache HTTP Server</title>
<link href="/style/manual.css" type="text/css" rel="stylesheet">
</head>
<body>
<blockquote>
<div align="center">
<img alt="[APACHE DOCUMENTATION]" src="/images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
</div>
<h1 align="center">Apache Module mod_actions</h1>
<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
<tr>
<td>
<table bgcolor="#ffffff">
<tr>
<td><span class="help">Description:</span></td><td>
<description>This module provides for executing CGI scripts based on
media type or request method.</description>
</td>
</tr>
<tr>
<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
</tr>
<tr>
<td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>actions_module</td>
</tr>
</table>
</td>
</tr>
</table>
<h2>Summary</h2>
<summary>

<p>This module has two directives. The <code class="directive"><a href="#action" class="directive">Action</a></code> directive lets you run CGI
    scripts whenever a file of a certain type is requested. The
    <code class="directive"><a href="#script" class="directive">Script</a></code> directive lets
    you run CGI scripts whenever a particular method is used in a
    request. This makes it much easier to execute scripts that process
    files.</p>

</summary>
<h2>Directives</h2>
<ul>
<li>
<a href="#action">Action</a>
</li>
<li>
<a href="#script">Script</a>
</li>
</ul>
<hr>
<h2>
<a name="Action">Action</a> <a name="action">Directive</a>
</h2>
<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
<tr>
<td>
<table width="100%" bgcolor="#ffffff">
<tr>
<td><strong>Description: </strong></td><td>Activates a CGI script for a particular handler or
content-type</td>
</tr>
<tr>
<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
<syntax>Action <em>action-type cgi-script</em>
</syntax>
</td>
</tr>
<tr>
<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
</tr>
<tr>
<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td>
</tr>
<tr>
<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
</tr>
<tr>
<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_actions</td>
</tr>
</table>
</td>
</tr>
</table>
<usage>

<p>This directive adds an action, which will activate
    <em>cgi-script</em> when <em>action-type</em> is triggered by
    the request. The <em>action-type</em> can be either a <a href="/handler.html">handler</a> or a MIME content type. It
    sends the URL and file path of the requested document using the
    standard CGI PATH_INFO and PATH_TRANSLATED environment
    variables.</p>


<blockquote>
<table cellpadding="10">
<tr>
<td bgcolor="#eeeeee">
<p align="center">
<strong>Examples</strong>
</p>
<code>


    # Requests for files of a particular type:<br>
    Action image/gif /cgi-bin/images.cgi<br>

<br>
    # Files of a particular file extension<br>
    AddHandler my-file-type .xyz<br>
    Action my-file-type /cgi-bin/program.cgi<br>

</code></td>
</tr>
</table>
</blockquote>


<p>In the first example, requests for files with a MIME content
    type of <code>image/gif</code> will instead be handled by the
    specified cgi script <code>/cgi-bin/images.cgi</code>.</p>


<p>In the second example, requests for files with a file extension of
    <code>.xyz</code> are handled instead by the specified cgi script
    <code>/cgi-bin/program.cgi</code>.</p>

</usage>
<p>
<strong>See also:</strong>
</p>
<ul>
<li>
<code class="directive"><a href="mod_mime.html#addhandler" class="directive">AddHandler</a></code>
</li>
</ul>
<hr>
<h2>
<a name="Script">Script</a> <a name="script">Directive</a>
</h2>
<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
<tr>
<td>
<table width="100%" bgcolor="#ffffff">
<tr>
<td><strong>Description: </strong></td><td>Activates a CGI script for a particular request
method.</td>
</tr>
<tr>
<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
<syntax> Script <em>method cgi-script</em>
</syntax>
</td>
</tr>
<tr>
<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory</td>
</tr>
<tr>
<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
</tr>
<tr>
<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_actions</td>
</tr>
</table>
</td>
</tr>
</table>
<usage>

<p>This directive adds an action, which will activate
    <em>cgi-script</em> when a file is requested using the method of
    <em>method</em>. It sends the URL and file path of the requested
    document using the standard CGI PATH_INFO and PATH_TRANSLATED
    environment variables.</p>


<blockquote>
<table>
<tr>
<td bgcolor="#e0e5f5">
      Any arbitrary method name may be used. <strong>Method names are
      case-sensitive</strong>, so <code>Script&nbsp;PUT</code> and
      <code>Script&nbsp;put</code> have two entirely different
      effects.
</td>
</tr>
</table>
</blockquote>


<p>Note that the Script command defines default actions only.
    If a CGI script is called, or some other resource that is
    capable of handling the requested method internally, it will do
    so. Also note that Script with a method of <code>GET</code>
    will only be called if there are query arguments present
    (<em>e.g.</em>, foo.html?hi). Otherwise, the request will
    proceed normally.</p>


<blockquote>
<table cellpadding="10">
<tr>
<td bgcolor="#eeeeee">
<p align="center">
<strong>Examples</strong>
</p>
<code>

    # For &lt;ISINDEX&gt;-style searching<br>
    Script GET /cgi-bin/search<br>
    # A CGI PUT handler<br>
    Script PUT /~bob/put.cgi<br>

</code></td>
</tr>
</table>
</blockquote>

</usage>
<hr>
<h3 align="center">Apache HTTP Server Version 2.0</h3>
<a href="./"><img alt="Index" src="/images/index.gif"></a><a href="../"><img alt="Home" src="/images/home.gif"></a>
</blockquote>
</body>
</html>