1MKTAP(1) MKTAP(1)
2
6 mktap - create twisted.servers
7
9 mktap [options] apptype [application_option]...
10 mktap apptype --help
12
14 The --help prints out a usage message to standard output.
15 --debug, -d
17 Show debug information for plugin loading.
18 --progress, -p
20 Show progress information for plugin loading.
21 --encrypted, -e
23 Encrypt file before writing (will make the extension of the
24 resultant file begin with 'e').
25 --uid, -u <uid>
27 Application belongs to this uid, and should run with its permis‐
28 sions.
29 --gid, -d <gid>
31 Application belongs to this gid, and should run with its permis‐
32 sions.
33 --append, -a <file>
35 Append given servers to given file, instead of creating a new
36 one. File should be be a tap file.
37 --appname, -n <name>
39 Use the specified name as the process name when the application
40 is run with twistd(1). This option also causes some initializa‐
41 tion code to be duplicated when twistd(1) is run.
42 --type, -t <type>
44 Specify the output file type. Available types are:
45 pickle - (default) Output as a python pickle file.
47 source - Output as a .tas (AOT Python source) file.
48 apptype Can be 'web', 'portforward', 'toc', 'coil', 'words', 'manhole',
50 'im', 'news', 'socks', 'telnet', 'parent', 'sibling', 'ftp', and
51 'mail'. Each of those support different options.
52
54 -h, --host <host>
55 Proxy connections to <host>
56 -d, --dest_port <port>
58 Proxy connections to <port> on remote host.
59 -p, --port <port>
61 Listen locally on <port>
62
64 -u, --user
65 Makes a server with ~/public_html and ~/.twistd-web-pb support
66 for users.
67 --personal
69 Instead of generating a webserver, generate a ResourcePublisher
70 which listens on ~/.twistd-web-pb
71 --path <path>
73 <path> is either a specific file or a directory to be set as the
74 root of the web server. Use this if you have a directory full of
75 HTML, cgi, php3, epy, or rpy files or any other files that you
76 want to be served up raw.
77 -p, --port <port>
79 <port> is a number representing which port you want to start the
80 server on.
81 -m, --mime_type <mimetype>
83 <mimetype> is the default MIME type to use for files in a --path
84 web server when none can be determined for a particular exten‐
85 sion. The default is 'text/html'.
86 --allow_ignore_ext
88 Specify whether or not a request for 'foo' should return
89 'foo.ext'. Default is off.
90 --ignore-ext .<extension>
92 Specify that a request for 'foo' should return 'foo.<exten‐
93 sion>'.
94 -t, --telnet <port>
96 Run a telnet server on <port>, for additional configuration
97 later.
98 -i, --index <name>
100 Use an index name other than "index.html"
101 --https <port>
103 Port to listen on for Secure HTTP.
104 -c, --certificate <filename>
106 SSL certificate to use for HTTPS. [default: server.pem]
107 -k, --privkey <filename>
109 SSL certificate to use for HTTPS. [default: server.pem]
110 --processor <ext>=<class name>
112 Adds a processor to those file names. (Only usable if after
113 --path)
114 --resource-script <script name>
116 Sets the root as a resource script. This script will be re-eval‐
117 uated on every request.
118 This creates a web.tap file that can be used by twistd. If you specify
120 no arguments, it will be a demo webserver that has the Test class from
121 twisted.web.test in it.
122
124 -p <port>
125 <port> is a number representing which port you want to start the
126 server on.
127
129 -r, --relay <ip>,<port>=<queue directory>
130 Relay mail to all unknown domains through given IP and port,
131 using queue directory as temporary place to place files.
132 -d, --domain <domain>=<path>
134 generate an SMTP/POP3 virtual maildir domain named "domain"
135 which saves to "path"
136 -u, --username <name>=<password>
138 add a user/password to the last specified domains
139 -b, --bounce_to_postmaster
141 undelivered mails are sent to the postmaster, instead of being
142 rejected.
143 -p, --pop <port>
145 <port> is a number representing which port you want to start the
146 pop3 server on.
147 -s, --smtp <port>
149 <port> is a number representing which port you want to start the
150 smtp server on.
151 This creates a mail.tap file that can be used by twistd(1)
153
155 -p, --port <port>
156 Run the telnet server on <port>
157 -u, --username <name>
159 set the username to <name>
160 -w, --password <password>
162 set the password to <password>
163
165 -i, --interface <interface>
166 Listen on interface <interface>
167 -p, --port <port>
169 Run the SOCKSv4 server on <port>
170 -l, --log <filename>
172 log connection data to <filename>
173
175 -a, --anonymous
176 Allow anonymous logins
177 -3, --thirdparty
179 Allow third party connections
180 --otp Use one time passwords (OTP)
182 -p, --port <port>
184 Run the FTP server on <port>
185 -r, --root <path>
187 Define the local root of the FTP server
188 --anonymoususer <username>
190 Define the the name of the anonymous user
191
193 -p, --port <port>
194 Run the manhole server on <port>
195 -u, --user <name>
197 set the username to <name>
198 -w, --password <password>
200 set the password to <password>
201
203 -p, --port <port>
204 Run the Words server on <port>
205 -i, --irc <port>
207 Run IRC server on port <port>
208 -w, --web <port>
210 Run web server on port <port>
211
213 Written by Moshe Zadka, based on mktap's help messages
214
216 To report a bug, visit http://twistedmatrix.com/bugs/
217
219 Copyright © 2000-2008 Twisted Matrix Laboratories.
220 This is free software; see the source for copying conditions. There is
221 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
222 PURPOSE.
223
225 twistd(1)
226 July 2001 MKTAP(1)