<?xml version="1.0"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><title>Twisted Documentation: MKTAP.1</title><link href="../howto/stylesheet.css" type="text/css" rel="stylesheet" /></head><body bgcolor="white"><h1 class="title">MKTAP.1</h1><div class="toc"><ol><li><a href="#auto0">NAME</a></li><li><a href="#auto1">SYNOPSIS</a></li><li><a href="#auto2">DESCRIPTION</a></li><li><a href="#auto3">portforward options</a></li><li><a href="#auto4">web options</a></li><li><a href="#auto5">toc options</a></li><li><a href="#auto6">mail options</a></li><li><a href="#auto7">telnet options</a></li><li><a href="#auto8">socks options</a></li><li><a href="#auto9">ftp options</a></li><li><a href="#auto10">manhole options</a></li><li><a href="#auto11">words options</a></li><li><a href="#auto12">AUTHOR</a></li><li><a href="#auto13">REPORTING BUGS</a></li><li><a href="#auto14">COPYRIGHT</a></li><li><a href="#auto15">SEE ALSO</a></li></ol></div><div class="content"><span></span><h2>NAME<a name="auto0"></a></h2><p>mktap - create twisted.servers </p><h2>SYNOPSIS<a name="auto1"></a></h2><p><strong>mktap</strong> [<em>options</em>] <em>apptype</em> [<em>application_option</em>]... </p><p><strong>mktap</strong><em>apptype</em> --help </p><h2>DESCRIPTION<a name="auto2"></a></h2><p>The <strong>--help</strong> prints out a usage message to standard output. </p><dl><dt><strong>--uid</strong>, <strong>-u</strong><em><uid></em></dt><dd>Application belongs to this uid, and should run with its permissions. </dd><dt><strong>--gid</strong>, <strong>-d</strong><em><gid></em></dt><dd>Application belongs to this gid, and should run with its permissions. </dd><dt><strong>--append</strong>, <strong>-a</strong><em><file></em></dt><dd>Append given servers to given file, instead of creating a new one. File should be be a tap file. </dd><dt><strong>--appname</strong>, <strong>-n</strong><em><name></em></dt><dd>Use the specified name as the process name when the application is run with <em>twistd(1)</em>. This option also causes some initialization code to be duplicated when <em>twistd(1)</em> is run. </dd><dt><strong>--xml</strong>, <strong>-x</strong></dt><dd>Output as a .tax XML file rather than a pickle. </dd><dt><strong>--source</strong>, <strong>-s</strong></dt><dd>Output as a .tas (AOT Python source) file rather than a pickle. </dd><dt><em>apptype</em></dt><dd>Can be 'web', 'portforward', 'toc', 'coil', 'words', 'manhole', 'im', 'news', 'socks', 'telnet', 'parent', 'sibling', 'ftp', and 'mail'. Each of those support different options. </dd></dl><h2><strong>portforward</strong> options<a name="auto3"></a></h2><dl><dt><strong>-h</strong>, <strong>--host</strong><em><host></em></dt><dd>Proxy connections to <em><host></em></dd><dt><strong>-d</strong>, <strong>--dest_port</strong><em><port></em></dt><dd>Proxy connections to <em><port></em> on remote host. </dd><dt><strong>-p</strong>, <strong>--port</strong><em><port></em></dt><dd>Listen locally on <em><port></em></dd></dl><h2><strong>web</strong> options<a name="auto4"></a></h2><dl><dt><strong>-u</strong>, <strong>--user</strong></dt><dd>Makes a server with ~/public_html and ~/.twistd-web-pb support for users. </dd><dt><strong>--personal</strong></dt><dd>Instead of generating a webserver, generate a ResourcePublisher which listens on ~/.twistd-web-pb </dd><dt><strong>--path</strong><em><path></em></dt><dd><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. </dd><dt><strong>-p</strong>, <strong>--port</strong><em><port></em></dt><dd><port> is a number representing which port you want to start the server on. </dd><dt><strong>-m</strong>, <strong>--mime_type</strong><em><mimetype></em></dt><dd><mimetype> is the default MIME type to use for files in a --path web server when none can be determined for a particular extension. The default is 'text/html'. </dd><dt><strong>--allow_ignore_ext</strong></dt><dd>Specify whether or not a request for 'foo' should return 'foo.ext'. Default is off. </dd><dt><strong>--ignore-ext</strong><em>.<extension></em></dt><dd>Specify that a request for 'foo' should return 'foo.<em><extension></em>'. </dd><dt><strong>-t</strong>, <strong>--telnet</strong><em><port></em></dt><dd>Run a telnet server on <port>, for additional configuration later. </dd><dt><strong>-i</strong>, <strong>--index</strong><em><name></em></dt><dd>Use an index name other than <q>index.html</q></dd><dt><strong>--https</strong><em><port></em></dt><dd>Port to listen on for Secure HTTP. </dd><dt><strong>-c</strong>, <strong>--certificate</strong><em><filename></em></dt><dd>SSL certificate to use for HTTPS. [default: server.pem] </dd><dt><strong>-k</strong>, <strong>--privkey</strong><em><filename></em></dt><dd>SSL certificate to use for HTTPS. [default: server.pem] </dd><dt><strong>--processor</strong><em><ext>=<class name></em></dt><dd>Adds a processor to those file names. (Only usable if after <strong>--path)</strong></dd><dt><strong>--resource-script</strong><em><script name></em></dt><dd>Sets the root as a resource script. This script will be re-evaluated on every request. </dd></dl><p>This creates a web.tap file that can be used by twistd. If you specify no arguments, it will be a demo webserver that has the Test class from twisted.web.test in it. </p><h2><strong>toc</strong> options<a name="auto5"></a></h2><dl><dt><strong>-p</strong><em><port></em></dt><dd><port> is a number representing which port you want to start the server on. </dd></dl><h2><strong>mail</strong> options<a name="auto6"></a></h2><dl><dt><strong>-r</strong>, <strong>--relay</strong><em><ip>,<port>=<queue directory></em></dt><dd>Relay mail to all unknown domains through given IP and port, using queue directory as temporary place to place files. </dd><dt><strong>-d</strong>, <strong>--domain</strong><em><domain></em>=<em><path></em></dt><dd>generate an SMTP/POP3 virtual maildir domain named <q>domain</q> which saves to <q>path</q></dd><dt><strong>-u</strong>, <strong>--username</strong><em><name></em>=<em><password></em></dt><dd>add a user/password to the last specified domains </dd><dt><strong>-b</strong>, <strong>--bounce_to_postmaster</strong></dt><dd>undelivered mails are sent to the postmaster, instead of being rejected. </dd><dt><strong>-p</strong>, <strong>--pop</strong><em><port></em></dt><dd><port> is a number representing which port you want to start the pop3 server on. </dd><dt><strong>-s</strong>, <strong>--smtp</strong><em><port></em></dt><dd><port> is a number representing which port you want to start the smtp server on. </dd></dl><p>This creates a mail.tap file that can be used by twistd(1) </p><h2><strong>telnet</strong> options<a name="auto7"></a></h2><dl><dt><strong>-p</strong>, <strong>--port</strong><em><port></em></dt><dd>Run the telnet server on <port></dd><dt><strong>-u</strong>, <strong>--username</strong><em><name></em></dt><dd>set the username to <name></dd><dt><strong>-w</strong>, <strong>--password</strong><em><password></em></dt><dd>set the password to <password></dd></dl><h2><strong>socks</strong> options<a name="auto8"></a></h2><dl><dt><strong>-i</strong>, <strong>--interface</strong><em><interface></em></dt><dd>Listen on interface <interface></dd><dt><strong>-p</strong>, <strong>--port</strong><em><port></em></dt><dd>Run the SOCKSv4 server on <port></dd><dt><strong>-l</strong>, <strong>--log</strong><em><filename></em></dt><dd>log connection data to <filename></dd></dl><h2><strong>ftp</strong> options<a name="auto9"></a></h2><dl><dt><strong>-a</strong>, <strong>--anonymous</strong></dt><dd>Allow anonymous logins </dd><dt><strong>-3</strong>, <strong>--thirdparty</strong></dt><dd>Allow third party connections </dd><dt><strong>--otp</strong></dt><dd>Use one time passwords (OTP) </dd><dt><strong>-p</strong>, <strong>--port</strong><em><port></em></dt><dd>Run the FTP server on <port></dd><dt><strong>-r</strong>, <strong>--root</strong><em><path></em></dt><dd>Define the local root of the FTP server </dd><dt><strong>--anonymoususer</strong><em><username></em></dt><dd>Define the the name of the anonymous user </dd></dl><h2><strong>manhole</strong> options<a name="auto10"></a></h2><dl><dt><strong>-p</strong>, <strong>--port</strong><em><port></em></dt><dd>Run the manhole server on <port></dd><dt><strong>-u</strong>, <strong>--user</strong><em><name></em></dt><dd>set the username to <name></dd><dt><strong>-w</strong>, <strong>--password</strong><em><password></em></dt><dd>set the password to <password></dd></dl><h2><strong>words</strong> options<a name="auto11"></a></h2><dl><dt><strong>-p</strong>, <strong>--port</strong><em><port></em></dt><dd>Run the Words server on <port></dd><dt><strong>-i</strong>, <strong>--irc</strong><em><port></em></dt><dd>Run IRC server on port <port></dd><dt><strong>-w</strong>, <strong>--web</strong><em><port></em></dt><dd>Run web server on port <port></dd></dl><h2>AUTHOR<a name="auto12"></a></h2><p>Written by Moshe Zadka, based on mktap's help messages </p><h2>REPORTING BUGS<a name="auto13"></a></h2><p>Report bugs to <twisted-python@twistedmatrix.com>. </p><h2>COPYRIGHT<a name="auto14"></a></h2><p>Copyright © 2000 Matthew W. Lefkowitz This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. </p><h2>SEE ALSO<a name="auto15"></a></h2><p>twistd(1) </p></div><p><a href="../howto/index.html">Index</a></p><span class="version">Version: 1.3.0</span></body></html>