mod_actions.xml revision 4a70643d125a450bb3f611c1265e44607b140040
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<?xml version="1.0"?>
d24d4c5159bcb11c25bb294926cfe7105c789ea9slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<modulesynopsis>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<name>mod_actions</name>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<description>This module provides for executing CGI scripts based on
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslivemedia type or request method.</description>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<status>Base</status>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<sourcefile>mod_actions.c</sourcefile>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<identifier>actions_module</identifier>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<summary>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <p>This module has two directives. The <directive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive module="mod_actions">Action</directive> directive lets you run CGI
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive scripts whenever a file of a certain type is requested. The
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <directive module="mod_actions">Script</directive> directive lets
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive you run CGI scripts whenever a particular method is used in a
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive request. This makes it much easier to execute scripts that process
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive files.</p>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive</summary>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<directivesynopsis>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<name>Action</name>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<description>Activates a CGI script for a particular handler or
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslivecontent-type</description>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<syntax>Action <em>action-type cgi-script</em></syntax>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<contextlist>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<context>server config</context><context>virtual host</context>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<context>directory</context><context>.htaccess</context>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive</contextlist>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<override>FileInfo</override>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<usage>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <p>This directive adds an action, which will activate
217246fb83555fa4dfc1d791758a93ec4230f5bfslive <em>cgi-script</em> when <em>action-type</em> is triggered by the
217246fb83555fa4dfc1d791758a93ec4230f5bfslive request. The <em>cgi-script</em> is the URL-path to a resource
217246fb83555fa4dfc1d791758a93ec4230f5bfslive that has been designated as a CGI script using <directive
4a70643d125a450bb3f611c1265e44607b140040gregames module="mod_alias">ScriptAlias</directive> or <directive
217246fb83555fa4dfc1d791758a93ec4230f5bfslive module="mod_mime">AddHandler</directive>. The
217246fb83555fa4dfc1d791758a93ec4230f5bfslive <em>action-type</em> can be either a <a
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive href="/handler.html">handler</a> or a MIME content type. It
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive sends the URL and file path of the requested document using the
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive standard CGI PATH_INFO and PATH_TRANSLATED environment
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive variables.</p>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<example>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<title>Examples</title>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive # Requests for files of a particular type:<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive Action image/gif /cgi-bin/images.cgi<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive # Files of a particular file extension<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive AddHandler my-file-type .xyz<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive Action my-file-type /cgi-bin/program.cgi<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive</example>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <p>In the first example, requests for files with a MIME content
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive type of <code>image/gif</code> will instead be handled by the
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive specified cgi script <code>/cgi-bin/images.cgi</code>.</p>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <p>In the second example, requests for files with a file extension of
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <code>.xyz</code> are handled instead by the specified cgi script
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <code>/cgi-bin/program.cgi</code>.</p>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive</usage>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<seealso><directive module="mod_mime">AddHandler</directive></seealso>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive</directivesynopsis>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<directivesynopsis>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<name>Script</name>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<description>Activates a CGI script for a particular request
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslivemethod.</description>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<syntax> Script <em>method cgi-script</em></syntax>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<contextlist>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<context>server config</context><context>virtual host</context>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<context>directory</context></contextlist>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<usage>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <p>This directive adds an action, which will activate
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <em>cgi-script</em> when a file is requested using the method of
217246fb83555fa4dfc1d791758a93ec4230f5bfslive <em>method</em>. The <em>cgi-script</em> is the URL-path to a
217246fb83555fa4dfc1d791758a93ec4230f5bfslive resource that has been designated as a CGI script using <directive
217246fb83555fa4dfc1d791758a93ec4230f5bfslive module="mod_alias">ScriptAliase</directive> or <directive
217246fb83555fa4dfc1d791758a93ec4230f5bfslive module="mod_mime">AddHandler</directive>. The URL and
217246fb83555fa4dfc1d791758a93ec4230f5bfslive file path of the requested document is sent using the standard CGI
217246fb83555fa4dfc1d791758a93ec4230f5bfslive PATH_INFO and PATH_TRANSLATED environment variables.</p>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<note>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive Any arbitrary method name may be used. <strong>Method names are
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive case-sensitive</strong>, so <code>Script&nbsp;PUT</code> and
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <code>Script&nbsp;put</code> have two entirely different
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive effects.
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive</note>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive <p>Note that the Script command defines default actions only.
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive If a CGI script is called, or some other resource that is
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive capable of handling the requested method internally, it will do
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive so. Also note that Script with a method of <code>GET</code>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive will only be called if there are query arguments present
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive (<em>e.g.</em>, foo.html?hi). Otherwise, the request will
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive proceed normally.</p>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<example>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive<title>Examples</title>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive # For &lt;ISINDEX&gt;-style searching<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive Script GET /cgi-bin/search<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive # A CGI PUT handler<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive Script PUT /~bob/put.cgi<br />
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive</example>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive</usage>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive</directivesynopsis>
1c47b0c72c991a6f0ad172c74df0936fe13d6fbfslive
4a70643d125a450bb3f611c1265e44607b140040gregames</modulesynopsis>