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

   1 <html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
   2           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   3                 This file is generated from xml source: DO NOT EDIT
   4           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5         --><title>mod_actions- Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]"/><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 valign="top"><span class="help">Description:</span></td><td>This module provides for executing CGI scripts based on
   6 media type or request method.</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>
   7     <p>This module has two directives. The <a href="#action" class="directive"><code class="directive">Action</code></a> directive lets you run CGI
   8     scripts whenever a file of a certain type is requested. The
   9     <a href="#script" class="directive"><code class="directive">Script</code></a> directive lets
  10     you run CGI scripts whenever a particular method is used in a
  11     request. This makes it much easier to execute scripts that process
  12     files.</p>
  13 <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 bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Activates a CGI script for a particular handler or
  14 content-type</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>Action <em>action-type cgi-script</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_actions</td></tr></table></td></tr></table>
  15     <p>This directive adds an action, which will activate
  16     <em>cgi-script</em> when <em>action-type</em> is triggered by the
  17     request.  The <em>cgi-script</em> is the URL-path to a resource
  18     that has been designated as a CGI script using <a href="mod_alias.html#scriptaliase" class="directive"><code class="directive">ScriptAliase</code></a> or <a href="mod_mime.html#addhandler" class="directive"><code class="directive">AddHandler</code></a>.  The
  19     <em>action-type</em> can be either a <a href="../handler.html">handler</a> or a MIME content type. It
  20     sends the URL and file path of the requested document using the
  21     standard CGI PATH_INFO and PATH_TRANSLATED environment
  22     variables.</p>
  23
  24 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Examples</strong></p><code>
  25
  26
  27     # Requests for files of a particular type:<br>
  28     Action image/gif /cgi-bin/images.cgi<br>
  29 <br>
  30     # Files of a particular file extension<br>
  31     AddHandler my-file-type .xyz<br>
  32     Action my-file-type /cgi-bin/program.cgi<br>
  33 </code></td></tr></table></blockquote>
  34
  35     <p>In the first example, requests for files with a MIME content
  36     type of <code>image/gif</code> will instead be handled by the
  37     specified cgi script <code>/cgi-bin/images.cgi</code>.</p>
  38
  39     <p>In the second example, requests for files with a file extension of
  40     <code>.xyz</code> are handled instead by the specified cgi script
  41     <code>/cgi-bin/program.cgi</code>.</p>
  42 <p><strong>See also </strong></p><ul><li><a href="mod_mime.html#addhandler" class="directive"><code class="directive">AddHandler</code></a></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 bgcolor="#ffffff"><tr><td nowrap="nowrap"><strong>Description: </strong></td><td>Activates a CGI script for a particular request
  43 method.</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> Script <em>method cgi-script</em></td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td nowrap="nowrap"><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_actions</td></tr></table></td></tr></table>
  44     <p>This directive adds an action, which will activate
  45     <em>cgi-script</em> when a file is requested using the method of
  46     <em>method</em>. The <em>cgi-script</em> is the URL-path to a
  47     resource that has been designated as a CGI script using <a href="mod_alias.html#scriptaliase" class="directive"><code class="directive">ScriptAliase</code></a> or <a href="mod_mime.html#addhandler" class="directive"><code class="directive">AddHandler</code></a>.  The URL and
  48     file path of the requested document is sent using the standard CGI
  49     PATH_INFO and PATH_TRANSLATED environment variables.</p>
  50
  51 <blockquote><table><tr><td bgcolor="#e0e5f5">
  52       Any arbitrary method name may be used. <strong>Method names are
  53       case-sensitive</strong>, so <code>Script&nbsp;PUT</code> and
  54       <code>Script&nbsp;put</code> have two entirely different
  55       effects.
  56 </td></tr></table></blockquote>
  57
  58     <p>Note that the Script command defines default actions only.
  59     If a CGI script is called, or some other resource that is
  60     capable of handling the requested method internally, it will do
  61     so. Also note that Script with a method of <code>GET</code>
  62     will only be called if there are query arguments present
  63     (<em>e.g.</em>, foo.html?hi). Otherwise, the request will
  64     proceed normally.</p>
  65
  66 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><p align="center"><strong>Examples</strong></p><code>
  67
  68     # For &lt;ISINDEX&gt;-style searching<br>
  69     Script GET /cgi-bin/search<br>
  70     # A CGI PUT handler<br>
  71     Script PUT /~bob/put.cgi<br>
  72 </code></td></tr></table></blockquote>
  73 <hr/></blockquote><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="../images/index.gif" alt="Index"/></a><a href="../"><img src="../images/home.gif" alt="Home"/></a></body></html>