twisted.application.app.ServerOptions.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.application.app.ServerOptions</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.application.html">Package application</a> ::
<a href="twisted.application.app.html">Module app</a> ::
Class ServerOptions
</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.application.app.ServerOptions.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class ServerOptions</h2>
<pre class="base-tree">
<code>dict</code> --+
|
<a href="twisted.python.usage.Options.html"><code>Options</code></a> --+
|
<b>ServerOptions</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.scripts.twistd.ServerOptions.html"><code>ServerOptions</code></a>,
<a href="twisted.scripts.twistw.ServerOptions.html"><code>ServerOptions</code></a></dd></dl>
<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><span class="summary-sig"><a href="twisted.application.app.ServerOptions.html#opt_spew" class="summary-sig-name"><code>opt_spew</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Print an insanely verbose log of everything that happens.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.application.app.ServerOptions.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 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#__init__" class="summary-sig-name"><code>__init__</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#__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#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 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>list</code></font></td>
<td><b><a href="twisted.application.app.ServerOptions.html#optFlags"><code>optFlags</code></a></b> = <span title="[['savestats', None, 'save the Stats object rather than the text output of the profiler.'], ['debug', 'b', 'run the application in the Python Debugger (implies nodaemon), sending SIGUSR2 will drop into debugger'], ['no_save', 'o', 'do not save state on shutdown'], ['encrypted', 'e', 'The specified tap/aos/xml file is encrypted.'], ['nothotshot', None, "Don't use the 'hotshot' profiler even if it's available."]]"><code>[['savestats', None, 'save the Stats object r<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.application.app.ServerOptions.html#optParameters"><code>optParameters</code></a></b> = <span title="[['logfile', 'l', None, 'log to a specified file, - for stdout'], ['profile', 'p', None, 'Run in profile mode, dumping results to specified file'], ['file', 'f', 'twistd.tap', 'read the given .tap file'], ['python', 'y', None, 'read an application from within a Python file'], ['xml', 'x', None, 'Read an application from a .tax file (Marmalade format).'], ['source', 's', None, 'Read an application from a .tas file (AOT format).'], ['rundir', 'd', '.', 'Change to a supplied directory before running'], ['reactor', 'r', None, 'Which reactor to use out of: kqueue, qt, default, win, gtk, cf, gtk2..."><code>[['logfile', 'l', None, 'log to a specif<span class="variable-ellipsis">...</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_spew"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">opt_spew</span>(<span class=sig-arg>self</span>)</span>
</h3>
Print an insanely verbose log of everything that happens. Useful
when debugging freezes or locks in complex code.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parseOptions"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parseOptions</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>options</span>=<span class=sig-default>None</span>)</span>
</h3>
The guts of the command-line parser.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.python.usage.Options.html#parseOptions"><code>twisted.python.usage.Options.parseOptions</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="optFlags"></a>
<h3>optFlags</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[['savestats', None, 'save the Stats object rather than the text output of the profiler.'], ['debug', 'b', 'run the application in the Python Debugger (implies nodaemon), sending SIGUSR2 will drop into debugger'], ['no_save', 'o', 'do not save state on shutdown'], ['encrypted', 'e', 'The specified tap/aos/xml file is encrypted.'], ['nothotshot', None, "Don't use the 'hotshot' profiler even if it's available."]]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[['savestats',
None,
'save the Stats object rather than the text output of the profiler.'<span class="variable-linewrap">\</span>
],
['debug',
'b',
'run the application in the Python Debugger (implies nodaemon), send<span class="variable-linewrap">\</span>
ing SIGUSR2 will drop into debugger'],
<span class="variable-ellipsis">...</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="optParameters"></a>
<h3>optParameters</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[['logfile', 'l', None, 'log to a specified file, - for stdout'], ['profile', 'p', None, 'Run in profile mode, dumping results to specified file'], ['file', 'f', 'twistd.tap', 'read the given .tap file'], ['python', 'y', None, 'read an application from within a Python file'], ['xml', 'x', None, 'Read an application from a .tax file (Marmalade format).'], ['source', 's', None, 'Read an application from a .tas file (AOT format).'], ['rundir', 'd', '.', 'Change to a supplied directory before running'], ['reactor', 'r', None, 'Which reactor to use out of: kqueue, qt, default, win, gtk, cf, gtk2..."> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[['logfile', 'l', None, 'log to a specified file, - for stdout'],
['profile',
'p',
None,
'Run in profile mode, dumping results to specified file'],
['file', 'f', 'twistd.tap', 'read the given .tap file'],
['python', 'y', None, 'read an application from within a Python file'<span class="variable-linewrap">\</span>
],
<span class="variable-ellipsis">...</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:55 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>