mirror of
https://github.com/apache/httpd.git
synced 2025-11-03 17:53:20 +03:00
27f1591e5b
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@100854 13f79535-47bb-0310-9956-ffa450edef68
136 lines
5.3 KiB
XML
136 lines
5.3 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
|
|
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
|
|
<modulesynopsis metafile="mod_actions.xml.meta">
|
|
|
|
<name>mod_actions</name>
|
|
|
|
<description>This module provides for executing CGI scripts based on
|
|
media type or request method.</description>
|
|
|
|
<status>Base</status>
|
|
<sourcefile>mod_actions.c</sourcefile>
|
|
<identifier>actions_module</identifier>
|
|
|
|
<summary>
|
|
<p>This module has two directives. The <directive
|
|
module="mod_actions">Action</directive> directive lets you run CGI
|
|
scripts whenever a file of a certain MIME content type is requested. The
|
|
<directive module="mod_actions">Script</directive> 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>
|
|
|
|
<seealso><module>mod_cgi</module></seealso>
|
|
<seealso><a href="../howto/cgi.html">Dynamic Content with CGI</a></seealso>
|
|
<seealso><a href="../handler.html">Apache's Handler Use</a></seealso>
|
|
|
|
<directivesynopsis>
|
|
<name>Action</name>
|
|
<description>Activates a CGI script for a particular handler or
|
|
content-type</description>
|
|
<syntax>Action <var>action-type</var> <var>cgi-script</var> [virtual]</syntax>
|
|
<contextlist>
|
|
<context>server config</context><context>virtual host</context>
|
|
<context>directory</context><context>.htaccess</context>
|
|
</contextlist>
|
|
<override>FileInfo</override>
|
|
<compatibility>The <code>virtual</code> modifier and handler passing were
|
|
introduced in Apache 2.1</compatibility>
|
|
|
|
<usage>
|
|
<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 <directive
|
|
module="mod_alias">ScriptAlias</directive> or <directive
|
|
module="mod_mime">AddHandler</directive>. The
|
|
<var>action-type</var> 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 <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>
|
|
|
|
<example><title>Examples</title>
|
|
# Requests for files of a particular MIME content 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 />
|
|
</example>
|
|
|
|
<p>In the first example, requests for files with a MIME content
|
|
type of <code>image/gif</code> will 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 by the specified cgi script
|
|
<code>/cgi-bin/program.cgi</code>.</p>
|
|
|
|
<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 <directive>Action</directive> directive in
|
|
virtual locations.</p>
|
|
|
|
<example><title>Example</title>
|
|
<Location /news><br />
|
|
<indent>
|
|
SetHandler news-handler<br />
|
|
Action news-handler /cgi-bin/news.cgi virtual<br />
|
|
</indent>
|
|
</Location>
|
|
</example>
|
|
</usage>
|
|
|
|
<seealso><directive module="mod_mime">AddHandler</directive></seealso>
|
|
</directivesynopsis>
|
|
|
|
<directivesynopsis>
|
|
<name>Script</name>
|
|
<description>Activates a CGI script for a particular request
|
|
method.</description>
|
|
<syntax>Script <var>method</var> <var>cgi-script</var></syntax>
|
|
<contextlist>
|
|
<context>server config</context><context>virtual host</context>
|
|
<context>directory</context></contextlist>
|
|
<usage>
|
|
<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 <directive
|
|
module="mod_alias">ScriptAlias</directive> or <directive
|
|
module="mod_mime">AddHandler</directive>. 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>
|
|
|
|
<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.
|
|
</note>
|
|
|
|
<p>Note that the <directive>Script</directive> 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 <directive>Script</directive> 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>
|
|
|
|
<example><title>Examples</title>
|
|
# For <ISINDEX>-style searching<br />
|
|
Script GET /cgi-bin/search<br />
|
|
<br />
|
|
# A CGI PUT handler<br />
|
|
Script PUT /~bob/put.cgi<br />
|
|
</example>
|
|
</usage>
|
|
</directivesynopsis>
|
|
|
|
</modulesynopsis>
|