twisted.tap.web.Options.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.tap.web.Options</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.tap.html">Package tap</a> ::
<a href="twisted.tap.web.html">Module web</a> ::
Class Options
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.tap.web.Options.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Options</h2>
<pre class="base-tree">
<code>dict</code> --+
|
<a href="twisted.python.usage.Options.html"><code>Options</code></a> --+
|
<b>Options</b>
</pre><br />
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_allow_ignore_ext" class="summary-sig-name"><code>opt_allow_ignore_ext</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Specify whether or not a request for 'foo' should return 'foo.ext'</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_class" class="summary-sig-name"><code>opt_class</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>className</span>)</span></code>
<br />
Create a Resource subclass with a zero-argument constructor.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_flashconduit" class="summary-sig-name"><code>opt_flashconduit</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>port</span>)</span></code>
<br />
Start a flashconduit on the specified port.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_index" class="summary-sig-name"><code>opt_i</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>indexName</span>)</span></code>
<br />
Add the name of a file used to check for directory indexes.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_ignore_ext" class="summary-sig-name"><code>opt_ignore_ext</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>ext</span>)</span></code>
<br />
Specify an extension to ignore.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_index" class="summary-sig-name"><code>opt_index</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>indexName</span>)</span></code>
<br />
Add the name of a file used to check for directory indexes.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_mime_type" class="summary-sig-name"><code>opt_m</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>defaultType</span>)</span></code>
<br />
Specify the default mime-type for static files.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_mime_type" class="summary-sig-name"><code>opt_mime_type</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>defaultType</span>)</span></code>
<br />
Specify the default mime-type for static files.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_path" class="summary-sig-name"><code>opt_path</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
<br />
<path> is either a specific file or a directory to be set as the
root of the web server.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_processor" class="summary-sig-name"><code>opt_processor</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>proc</span>)</span></code>
<br />
`ext=class' where `class' is added as a Processor for files ending
with `ext'.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_resource_script" class="summary-sig-name"><code>opt_resource_script</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
An .rpy file to be used as the root resource of the webserver.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_static" class="summary-sig-name"><code>opt_s</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
<br />
Same as --path, this is deprecated and will be removed in a future
release.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_static" class="summary-sig-name"><code>opt_static</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
<br />
Same as --path, this is deprecated and will be removed in a future
release.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_user" class="summary-sig-name"><code>opt_u</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Makes a server with ~/public_html and ~/.twistd-web-pb support for
users.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#opt_user" class="summary-sig-name"><code>opt_user</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Makes a server with ~/public_html and ~/.twistd-web-pb support for
users.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.tap.web.Options.html#postOptions" class="summary-sig-name"><code>postOptions</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
I am called after the options are parsed.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Options</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>width</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#_gather_flags" class="summary-sig-name"><code>_gather_flags</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gather up boolean (flag) options.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#_gather_handlers" class="summary-sig-name"><code>_gather_handlers</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gather up options with their own handler methods.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#_gather_parameters" class="summary-sig-name"><code>_gather_parameters</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gather options which take a value.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#_generic_flag" class="summary-sig-name"><code>_generic_flag</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>flagName</span>,
<span class=summary-sig-arg>value</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#_generic_parameter" class="summary-sig-name"><code>_generic_parameter</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parameterName</span>,
<span class=summary-sig-arg>value</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#getSynopsis" class="summary-sig-name"><code>getSynopsis</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#getUsage" class="summary-sig-name"><code>getUsage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>width</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#opt_help" class="summary-sig-name"><code>opt_help</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Display this help and exit.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#opt_version" class="summary-sig-name"><code>opt_version</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#parseArgs" class="summary-sig-name"><code>parseArgs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
I am called with any leftover arguments which were not options.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.usage.Options.html#parseOptions" class="summary-sig-name"><code>parseOptions</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>options</span>)</span></code>
<br />
The guts of the command-line parser.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from dict</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__cmp__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__contains__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__delitem__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__eq__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__ge__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__getattribute__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__getitem__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__gt__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__iter__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__le__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__len__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__lt__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__ne__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__setitem__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">clear</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">copy</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">get</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">has_key</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">items</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">iteritems</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">iterkeys</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">itervalues</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">keys</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">popitem</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">setdefault</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">update</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">values</span>(...)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from object</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__delattr__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__reduce__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__setattr__</span>(...)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from type</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__new__</span>(...)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.tap.web.Options.html#longdesc"><code>longdesc</code></a></b> = <span title="'This creates a web.tap file that can be used by twistd. If you specify\nno arguments, it will be a demo webserver that has the Test class from\ntwisted.web.test in it.'"><code><span class="variable-quote">'</span>This creates a web.tap file that can be used<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.tap.web.Options.html#optFlags"><code>optFlags</code></a></b> = <span title="[['personal', '', 'Instead of generating a webserver, generate a ResourcePublisher which listens on ~/.twistd-web-pb'], ['notracebacks', 'n', 'Display tracebacks in broken web pages. Displaying tracebacks to users may be security risk!']]"><code>[['personal', '', 'Instead of generating a we<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.tap.web.Options.html#optParameters"><code>optParameters</code></a></b> = <span title="[['port', 'p', '8080', 'Port to start the server on.'], ['logfile', 'l', None, 'Path to web CLF (Combined Log Format) log file.'], ['https', None, None, 'Port to listen on for Secure HTTP.'], ['certificate', 'c', 'server.pem', 'SSL certificate to use for HTTPS.'], ['privkey', 'k', 'server.pem', 'SSL certificate to use for HTTPS.']]"><code>[['port', 'p', '8080', 'Port to start th<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.tap.web.Options.html#synopsis"><code>synopsis</code></a></b> = <span title="'Usage: mktap web [options]'"><code><span class="variable-quote">'</span>Usage: mktap web [options]<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Options</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.python.usage.Options.html#defaultSubCommand"><code>defaultSubCommand</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.python.usage.Options.html#parent"><code>parent</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.python.usage.Options.html#subCommand"><code>subCommand</code></a></b> = <span title="None">None </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="opt_allow_ignore_ext"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_allow_ignore_ext</span>(<span class=sig-arg>self</span>)</span>
</h3>
Specify whether or not a request for 'foo' should return
'foo.ext'
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_class"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_class</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>className</span>)</span>
</h3>
Create a Resource subclass with a zero-argument constructor.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_flashconduit"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_flashconduit</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>port</span>=<span class=sig-default>None</span>)</span>
</h3>
Start a flashconduit on the specified port.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_index"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_i</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>indexName</span>)</span>
</h3>
Add the name of a file used to check for directory indexes.
[default: index, index.html]
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_ignore_ext"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_ignore_ext</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>ext</span>)</span>
</h3>
Specify an extension to ignore. These will be processed in
order.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_index"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_index</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>indexName</span>)</span>
</h3>
Add the name of a file used to check for directory indexes.
[default: index, index.html]
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_mime_type"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_m</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>defaultType</span>)</span>
</h3>
Specify the default mime-type for static files.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_mime_type"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_mime_type</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>defaultType</span>)</span>
</h3>
Specify the default mime-type for static files.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_path"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_path</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>path</span>)</span>
</h3>
<path> is either a specific file or a directory to be set as
the root of the web server. Use this if you have a directory full of
HTML, cgi, php3, epy, or rpy files or any other files that you want to
be served up raw.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_processor"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_processor</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>proc</span>)</span>
</h3>
`ext=class' where `class' is added as a Processor for files ending
with `ext'.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_resource_script"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_resource_script</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
An .rpy file to be used as the root resource of the webserver.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_static"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_s</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>path</span>)</span>
</h3>
Same as --path, this is deprecated and will be removed in a future
release.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_static"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_static</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>path</span>)</span>
</h3>
Same as --path, this is deprecated and will be removed in a future
release.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_user"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_u</span>(<span class=sig-arg>self</span>)</span>
</h3>
Makes a server with ~/public_html and ~/.twistd-web-pb support for
users.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="opt_user"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_user</span>(<span class=sig-arg>self</span>)</span>
</h3>
Makes a server with ~/public_html and ~/.twistd-web-pb support for
users.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="postOptions"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">postOptions</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>I am called after the options are parsed.</p>
Override this method in your subclass to do something after the
options have been parsed and assigned, like validate that all options
are sane.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.python.usage.Options.html#postOptions"><code>twisted.python.usage.Options.postOptions</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="longdesc"></a>
<h3>longdesc</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'This creates a web.tap file that can be used by twistd. If you specify\nno arguments, it will be a demo webserver that has the Test class from\ntwisted.web.test in it.'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'''</span>This creates a web.tap file that can be used by twistd. If you spe<span class="variable-linewrap">\</span>
cify
no arguments, it will be a demo webserver that has the Test class from
twisted.web.test in it.<span class="variable-quote">'''</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="optFlags"></a>
<h3>optFlags</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[['personal', '', 'Instead of generating a webserver, generate a ResourcePublisher which listens on ~/.twistd-web-pb'], ['notracebacks', 'n', 'Display tracebacks in broken web pages. Displaying tracebacks to users may be security risk!']]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[['personal',
'',
'Instead of generating a webserver, generate a ResourcePublisher whi<span class="variable-linewrap">\</span>
ch listens on ~/.twistd-web-pb'],
['notracebacks',
'n',
'Display tracebacks in broken web pages. Displaying tracebacks to us<span class="variable-linewrap">\</span>
ers may be security risk!']] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="optParameters"></a>
<h3>optParameters</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[['port', 'p', '8080', 'Port to start the server on.'], ['logfile', 'l', None, 'Path to web CLF (Combined Log Format) log file.'], ['https', None, None, 'Port to listen on for Secure HTTP.'], ['certificate', 'c', 'server.pem', 'SSL certificate to use for HTTPS.'], ['privkey', 'k', 'server.pem', 'SSL certificate to use for HTTPS.']]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[['port', 'p', '8080', 'Port to start the server on.'],
['logfile', 'l', None, 'Path to web CLF (Combined Log Format) log fil<span class="variable-linewrap">\</span>
e.'],
['https', None, None, 'Port to listen on for Secure HTTP.'],
['certificate', 'c', 'server.pem', 'SSL certificate to use for HTTPS.<span class="variable-linewrap">\</span>
'],
['privkey', 'k', 'server.pem', 'SSL certificate to use for HTTPS.']] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="synopsis"></a>
<h3>synopsis</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'Usage: mktap web [options]'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>Usage: mktap web [options]<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:51 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>