mod_actions.html.en revision f0fa55ff14fa0bf8fd72d989f6625de6dc3260c8
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_actions - Apache HTTP Server</title>
<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
</script>
<body>
<div id="page-header">
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
<p class="apache">Apache HTTP Server Version 2.5</p>
<div id="path">
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Apache Module mod_actions</h1>
<div class="toplang">
<p><span>Available Languages: </span><a href="/de/mod/mod_actions.html" hreflang="de" rel="alternate" title="Deutsch"> de </a> |
<a href="/fr/mod/mod_actions.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
<a href="/ja/mod/mod_actions.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="/ko/mod/mod_actions.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>This module provides for executing CGI scripts based on
media type or request method.</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>actions_module</td></tr>
<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_actions.c</td></tr></table>
<h3>Summary</h3>
<p>This module has two directives. The <code class="directive"><a href="#action">Action</a></code> directive lets you run CGI
scripts whenever a file of a certain <a class="glossarylink" href="/glossary.html#mime-type" title="see glossary">MIME content type</a> is requested. The
<code class="directive"><a href="#script">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> </div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
</ul>
<h3>See also</h3>
<ul class="seealso">
</ul></div>
<div class="directive-section"><h2><a name="Action" id="Action">Action</a> <a name="action" id="action">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Activates a CGI script for a particular handler or
content-type</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Action <var>action-type</var> <var>cgi-script</var> [virtual]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The <code>virtual</code> modifier and handler passing were
introduced in Apache 2.1</td></tr>
</table>
<p>This directive adds an action, which will activate
<var>cgi-script</var> when <var>action-type</var> is triggered by
the request. The <var>cgi-script</var> is the URL-path to a
resource that has been designated as a CGI script using <code class="directive"><a href="/mod/mod_alias.html#scriptalias">ScriptAlias</a></code> or <code class="directive"><a href="/mod/mod_mime.html#addhandler">AddHandler</a></code>. The
<var>action-type</var> can be either a <a href="/handler.html">handler</a> or a <a class="glossarylink" href="/glossary.html#mime-type" title="see glossary">MIME content type</a>. It sends the URL and
file path of the requested document using the standard CGI
<code>PATH_INFO</code> and <code>PATH_TRANSLATED</code>
environment variables. The handler used for the particular request
is passed using the <code>REDIRECT_HANDLER</code> variable.</p>
<div class="example"><h3>Example: MIME type</h3><p><code>
<pre class="prettyprint lang-config">
# Requests for files of a particular MIME content type:
</pre>
</code></p></div>
<p>In this example, requests for files with a MIME content
<div class="example"><h3>Example: File extension</h3><p><code>
<pre class="prettyprint lang-config">
# Files of a particular file extension
AddHandler my-file-type .xyz
Action my-file-type /cgi-bin/program.cgi
</pre>
</code></p></div>
<p>In this example, requests for files with a file extension of
<code>.xyz</code> are handled by the specified cgi script
<p>The optional <code>virtual</code> modifier turns off the check
whether the requested file really exists. This is useful, for example,
if you want to use the <code class="directive">Action</code> directive in
virtual locations.</p>
<pre class="prettyprint lang-config">
<Location /news>
SetHandler news-handler
</Location>
</pre>
<h3>See also</h3>
<ul>
</ul>
</div>
<div class="directive-section"><h2><a name="Script" id="Script">Script</a> <a name="script" id="script">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Activates a CGI script for a particular request
method.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Script <var>method</var> <var>cgi-script</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
</table>
<p>This directive adds an action, which will activate
<var>cgi-script</var> when a file is requested using the method of
<var>method</var>. The <var>cgi-script</var> is the URL-path to a
resource that has been designated as a CGI script using <code class="directive"><a href="/mod/mod_alias.html#scriptalias">ScriptAlias</a></code> or <code class="directive"><a href="/mod/mod_mime.html#addhandler">AddHandler</a></code>. The URL and
file path of the requested document is sent using the standard CGI
<code>PATH_INFO</code> and <code>PATH_TRANSLATED</code> environment
variables.</p>
<div class="note">
Any arbitrary method name may be used. <strong>Method names are
case-sensitive</strong>, so <code>Script PUT</code> and
<code>Script put</code> have two entirely different
effects.
</div>
<p>Note that the <code class="directive">Script</code> 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 <code class="directive">Script</code> with a method of
<code>GET</code> will only be called if there are query arguments present
proceed normally.</p>
<pre class="prettyprint lang-config">
# All GET requests go here
# A CGI PUT handler
</pre>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/de/mod/mod_actions.html" hreflang="de" rel="alternate" title="Deutsch"> de </a> |
<a href="/fr/mod/mod_actions.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
<a href="/ja/mod/mod_actions.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="/ko/mod/mod_actions.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
</div><div id="footer">
<p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript">
if (typeof(prettyPrint) !== undefined) {
prettyPrint();
}
</script>
</body></html>