home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278221_mod_actions.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  5KB  |  136 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.8.2.4 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_actions.xml.meta">
  23.  
  24. <name>mod_actions</name> 
  25.  
  26. <description>This module provides for executing CGI scripts based on
  27. media type or request method.</description>
  28.  
  29. <status>Base</status>
  30. <sourcefile>mod_actions.c</sourcefile>
  31. <identifier>actions_module</identifier>
  32.  
  33. <summary>
  34.     <p>This module has two directives. The <directive
  35.     module="mod_actions">Action</directive> directive lets you run CGI
  36.     scripts whenever a file of a certain type is requested. The
  37.     <directive module="mod_actions">Script</directive> directive lets
  38.     you run CGI scripts whenever a particular method is used in a
  39.     request. This makes it much easier to execute scripts that process
  40.     files.</p>
  41. </summary>
  42.  
  43. <seealso><module>mod_cgi</module></seealso>
  44. <seealso><a href="../howto/cgi.html">Dynamic Content with CGI</a></seealso>
  45. <seealso><a href="../handler.html">Apache's Handler Use</a></seealso>
  46.  
  47. <directivesynopsis>
  48. <name>Action</name>
  49. <description>Activates a CGI script for a particular handler or
  50. content-type</description>
  51. <syntax>Action <var>action-type</var> <var>cgi-script</var></syntax>
  52. <contextlist>
  53. <context>server config</context><context>virtual host</context>
  54. <context>directory</context><context>.htaccess</context>
  55. </contextlist>
  56. <override>FileInfo</override>
  57.  
  58. <usage>
  59.     <p>This directive adds an action, which will activate
  60.     <var>cgi-script</var> when <var>action-type</var> is triggered by the
  61.     request.  The <var>cgi-script</var> is the URL-path to a resource
  62.     that has been designated as a CGI script using <directive
  63.     module="mod_alias">ScriptAlias</directive> or <directive
  64.     module="mod_mime">AddHandler</directive>.  The
  65.     <var>action-type</var> can be either a <a
  66.     href="../handler.html">handler</a> or a MIME content type. It
  67.     sends the URL and file path of the requested document using the
  68.     standard CGI PATH_INFO and PATH_TRANSLATED environment
  69.     variables.</p>
  70.  
  71.     <example><title>Examples</title>
  72.       # Requests for files of a particular type:<br />
  73.       Action image/gif /cgi-bin/images.cgi<br />
  74.       <br />
  75.       # Files of a particular file extension<br />
  76.       AddHandler my-file-type .xyz<br />
  77.       Action my-file-type /cgi-bin/program.cgi<br />
  78.     </example>
  79.  
  80.     <p>In the first example, requests for files with a MIME content
  81.     type of <code>image/gif</code> will instead be handled by the
  82.     specified cgi script <code>/cgi-bin/images.cgi</code>.</p>
  83.  
  84.     <p>In the second example, requests for files with a file extension of
  85.     <code>.xyz</code> are handled instead by the specified cgi script 
  86.     <code>/cgi-bin/program.cgi</code>.</p>
  87. </usage>
  88.  
  89. <seealso><directive module="mod_mime">AddHandler</directive></seealso>
  90. </directivesynopsis>
  91.  
  92. <directivesynopsis>
  93. <name>Script</name>
  94. <description>Activates a CGI script for a particular request
  95. method.</description>
  96. <syntax>Script <var>method</var> <var>cgi-script</var></syntax>
  97. <contextlist>
  98. <context>server config</context><context>virtual host</context>
  99. <context>directory</context></contextlist>
  100. <usage>
  101.     <p>This directive adds an action, which will activate
  102.     <var>cgi-script</var> when a file is requested using the method of
  103.     <var>method</var>. The <var>cgi-script</var> is the URL-path to a
  104.     resource that has been designated as a CGI script using <directive
  105.     module="mod_alias">ScriptAlias</directive> or <directive
  106.     module="mod_mime">AddHandler</directive>.  The URL and
  107.     file path of the requested document is sent using the standard CGI
  108.     PATH_INFO and PATH_TRANSLATED environment variables.</p>
  109.  
  110.     <note>
  111.       Any arbitrary method name may be used. <strong>Method names are
  112.       case-sensitive</strong>, so <code>Script PUT</code> and
  113.       <code>Script put</code> have two entirely different
  114.       effects.
  115.     </note>
  116.  
  117.     <p>Note that the Script command defines default actions only.
  118.     If a CGI script is called, or some other resource that is
  119.     capable of handling the requested method internally, it will do
  120.     so. Also note that Script with a method of <code>GET</code>
  121.     will only be called if there are query arguments present
  122.     (<em>e.g.</em>, foo.html?hi). Otherwise, the request will
  123.     proceed normally.</p>
  124.  
  125.     <example><title>Examples</title>
  126.       # For <ISINDEX>-style searching<br />
  127.       Script GET /cgi-bin/search<br />
  128.       <br />
  129.       # A CGI PUT handler<br />
  130.       Script PUT /~bob/put.cgi<br />
  131.     </example>
  132. </usage>
  133. </directivesynopsis>
  134.  
  135. </modulesynopsis>
  136.