~ubuntu-branches/ubuntu/feisty/apache2/feisty

« back to all changes in this revision

Viewing changes to docs/manual/mod/mod_actions.html.en

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Barth
  • Date: 2006-12-09 21:05:45 UTC
  • mfrom: (0.6.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061209210545-h70s0xaqc2v8vqr2
Tags: 2.2.3-3.2
* Non-maintainer upload.
* 043_ajp_connection_reuse: Patch from upstream Bugzilla, fixing a critical
  issue with regard to connection reuse in mod_proxy_ajp.
  Closes: #396265

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="ISO-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
 
4
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
5
              This file is generated from xml source: DO NOT EDIT
 
6
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
7
      -->
 
8
<title>mod_actions - Apache HTTP Server</title>
 
9
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
 
10
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
 
11
<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
 
12
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
 
13
<body>
 
14
<div id="page-header">
 
15
<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>
 
16
<p class="apache">Apache HTTP Server Version 2.2</p>
 
17
<img alt="" src="../images/feather.gif" /></div>
 
18
<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
 
19
<div id="path">
 
20
<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.2</a> &gt; <a href="./">Modules</a></div>
 
21
<div id="page-content">
 
22
<div id="preamble"><h1>Apache Module mod_actions</h1>
 
23
<div class="toplang">
 
24
<p><span>Available Languages: </span><a href="../de/mod/mod_actions.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
 
25
<a href="../en/mod/mod_actions.html" title="English">&nbsp;en&nbsp;</a> |
 
26
<a href="../ja/mod/mod_actions.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 
27
<a href="../ko/mod/mod_actions.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 
28
</div>
 
29
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>This module provides for executing CGI scripts based on
 
30
media type or request method.</td></tr>
 
31
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
 
32
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>actions_module</td></tr>
 
33
<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_actions.c</td></tr></table>
 
34
<h3>Summary</h3>
 
35
 
 
36
    <p>This module has two directives. The <code class="directive"><a href="#action">Action</a></code> directive lets you run CGI
 
37
    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
 
38
    <code class="directive"><a href="#script">Script</a></code> directive lets
 
39
    you run CGI scripts whenever a particular method is used in a
 
40
    request. This makes it much easier to execute scripts that process
 
41
    files.</p> </div>
 
42
<div id="quickview"><h3 class="directives">Directives</h3>
 
43
<ul id="toc">
 
44
<li><img alt="" src="../images/down.gif" /> <a href="#action">Action</a></li>
 
45
<li><img alt="" src="../images/down.gif" /> <a href="#script">Script</a></li>
 
46
</ul>
 
47
<h3>See also</h3>
 
48
<ul class="seealso">
 
49
<li><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code></li>
 
50
<li><a href="../howto/cgi.html">Dynamic Content with CGI</a></li>
 
51
<li><a href="../handler.html">Apache's Handler Use</a></li>
 
52
</ul></div>
 
53
 
 
54
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
55
<div class="directive-section"><h2><a name="Action" id="Action">Action</a> <a name="action" id="action">Directive</a></h2>
 
56
<table class="directive">
 
57
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Activates a CGI script for a particular handler or
 
58
content-type</td></tr>
 
59
<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>
 
60
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 
61
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 
62
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 
63
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_actions</td></tr>
 
64
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The <code>virtual</code> modifier and handler passing were
 
65
introduced in Apache 2.1</td></tr>
 
66
</table>
 
67
    <p>This directive adds an action, which will activate
 
68
    <var>cgi-script</var> when <var>action-type</var> is triggered by
 
69
    the request.  The <var>cgi-script</var> is the URL-path to a
 
70
    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
 
71
    <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
 
72
    file path of the requested document using the standard CGI
 
73
    <code>PATH_INFO</code> and <code>PATH_TRANSLATED</code>
 
74
    environment variables. The handler used for the particular request
 
75
    is passed using the <code>REDIRECT_HANDLER</code> variable.</p>
 
76
 
 
77
    <div class="example"><h3>Examples</h3><p><code>
 
78
      # Requests for files of a particular MIME content type:<br />
 
79
      Action image/gif /cgi-bin/images.cgi<br />
 
80
      <br />
 
81
      # Files of a particular file extension<br />
 
82
      AddHandler my-file-type .xyz<br />
 
83
      Action my-file-type /cgi-bin/program.cgi<br />
 
84
    </code></p></div>
 
85
 
 
86
    <p>In the first example, requests for files with a MIME content
 
87
    type of <code>image/gif</code> will be handled by the
 
88
    specified cgi script <code>/cgi-bin/images.cgi</code>.</p>
 
89
 
 
90
    <p>In the second example, requests for files with a file extension of
 
91
    <code>.xyz</code> are handled by the specified cgi script 
 
92
    <code>/cgi-bin/program.cgi</code>.</p>
 
93
 
 
94
    <p>The optional <code>virtual</code> modifier turns off the check
 
95
    whether the requested file really exists. This is useful, for example,
 
96
    if you want to use the <code class="directive">Action</code> directive in
 
97
    virtual locations.</p>
 
98
 
 
99
    <div class="example"><h3>Example</h3><p><code>
 
100
      &lt;Location /news&gt;<br />
 
101
      <span class="indent">
 
102
        SetHandler news-handler<br />
 
103
        Action news-handler /cgi-bin/news.cgi virtual<br />
 
104
      </span>
 
105
      &lt;/Location&gt;
 
106
    </code></p></div>
 
107
 
 
108
<h3>See also</h3>
 
109
<ul>
 
110
<li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
 
111
</ul>
 
112
</div>
 
113
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
114
<div class="directive-section"><h2><a name="Script" id="Script">Script</a> <a name="script" id="script">Directive</a></h2>
 
115
<table class="directive">
 
116
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Activates a CGI script for a particular request
 
117
method.</td></tr>
 
118
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Script <var>method</var> <var>cgi-script</var></code></td></tr>
 
119
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 
120
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 
121
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_actions</td></tr>
 
122
</table>
 
123
    <p>This directive adds an action, which will activate
 
124
    <var>cgi-script</var> when a file is requested using the method of
 
125
    <var>method</var>. The <var>cgi-script</var> is the URL-path to a
 
126
    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
 
127
    file path of the requested document is sent using the standard CGI
 
128
    <code>PATH_INFO</code> and <code>PATH_TRANSLATED</code> environment 
 
129
    variables.</p>
 
130
 
 
131
    <div class="note">
 
132
      Any arbitrary method name may be used. <strong>Method names are
 
133
      case-sensitive</strong>, so <code>Script PUT</code> and
 
134
      <code>Script put</code> have two entirely different
 
135
      effects.
 
136
    </div>
 
137
 
 
138
    <p>Note that the <code class="directive">Script</code> command defines default 
 
139
    actions only. If a CGI script is called, or some other resource that is
 
140
    capable of handling the requested method internally, it will do
 
141
    so. Also note that <code class="directive">Script</code> with a method of 
 
142
    <code>GET</code> will only be called if there are query arguments present
 
143
    (<em>e.g.</em>, foo.html?hi). Otherwise, the request will
 
144
    proceed normally.</p>
 
145
 
 
146
    <div class="example"><h3>Examples</h3><p><code>
 
147
      # For &lt;ISINDEX&gt;-style searching<br />
 
148
      Script GET /cgi-bin/search<br />
 
149
      <br />
 
150
      # A CGI PUT handler<br />
 
151
      Script PUT /~bob/put.cgi<br />
 
152
    </code></p></div>
 
153
 
 
154
</div>
 
155
</div>
 
156
<div class="bottomlang">
 
157
<p><span>Available Languages: </span><a href="../de/mod/mod_actions.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
 
158
<a href="../en/mod/mod_actions.html" title="English">&nbsp;en&nbsp;</a> |
 
159
<a href="../ja/mod/mod_actions.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 
160
<a href="../ko/mod/mod_actions.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 
161
</div><div id="footer">
 
162
<p class="apache">Copyright 2006 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>
 
163
<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>
 
164
</body></html>
 
 
b'\\ No newline at end of file'