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 xml - Output as a .tax XML file.
48 source - Output as a .tas (AOT Python source) file.
49 apptype Can be 'web', 'portforward', 'toc', 'coil', 'words', 'manhole',
51 'im', 'news', 'socks', 'telnet', 'parent', 'sibling', 'ftp', and
52 'mail'. Each of those support different options.
53
55 -h, --host <host>
56 Proxy connections to <host>
57 -d, --dest_port <port>
59 Proxy connections to <port> on remote host.
60 -p, --port <port>
62 Listen locally on <port>
63
65 -u, --user
66 Makes a server with ~/public_html and ~/.twistd-web-pb support
67 for users.
68 --personal
70 Instead of generating a webserver, generate a ResourcePublisher
71 which listens on ~/.twistd-web-pb
72 --path <path>
74 <path> is either a specific file or a directory to be set as the
75 root of the web server. Use this if you have a directory full of
76 HTML, cgi, php3, epy, or rpy files or any other files that you
77 want to be served up raw.
78 -p, --port <port>
80 <port> is a number representing which port you want to start the
81 server on.
82 -m, --mime_type <mimetype>
84 <mimetype> is the default MIME type to use for files in a --path
85 web server when none can be determined for a particular exten‐
86 sion. The default is 'text/html'.
87 --allow_ignore_ext
89 Specify whether or not a request for 'foo' should return
90 'foo.ext'. Default is off.
91 --ignore-ext .<extension>
93 Specify that a request for 'foo' should return 'foo.<exten‐
94 sion>'.
95 -t, --telnet <port>
97 Run a telnet server on <port>, for additional configuration
98 later.
99 -i, --index <name>
101 Use an index name other than "index.html"
102 --https <port>
104 Port to listen on for Secure HTTP.
105 -c, --certificate <filename>
107 SSL certificate to use for HTTPS. [default: server.pem]
108 -k, --privkey <filename>
110 SSL certificate to use for HTTPS. [default: server.pem]
111 --processor <ext>=<class name>
113 Adds a processor to those file names. (Only usable if after
114 --path)
115 --resource-script <script name>
117 Sets the root as a resource script. This script will be re-eval‐
118 uated on every request.
119 This creates a web.tap file that can be used by twistd. If you specify
121 no arguments, it will be a demo webserver that has the Test class from
122 twisted.web.test in it.
123
125 -p <port>
126 <port> is a number representing which port you want to start the
127 server on.
128
130 -r, --relay <ip>,<port>=<queue directory>
131 Relay mail to all unknown domains through given IP and port,
132 using queue directory as temporary place to place files.
133 -d, --domain <domain>=<path>
135 generate an SMTP/POP3 virtual maildir domain named "domain"
136 which saves to "path"
137 -u, --username <name>=<password>
139 add a user/password to the last specified domains
140 -b, --bounce_to_postmaster
142 undelivered mails are sent to the postmaster, instead of being
143 rejected.
144 -p, --pop <port>
146 <port> is a number representing which port you want to start the
147 pop3 server on.
148 -s, --smtp <port>
150 <port> is a number representing which port you want to start the
151 smtp server on.
152 This creates a mail.tap file that can be used by twistd(1)
154
156 -p, --port <port>
157 Run the telnet server on <port>
158 -u, --username <name>
160 set the username to <name>
161 -w, --password <password>
163 set the password to <password>
164
166 -i, --interface <interface>
167 Listen on interface <interface>
168 -p, --port <port>
170 Run the SOCKSv4 server on <port>
171 -l, --log <filename>
173 log connection data to <filename>
174
176 -a, --anonymous
177 Allow anonymous logins
178 -3, --thirdparty
180 Allow third party connections
181 --otp Use one time passwords (OTP)
183 -p, --port <port>
185 Run the FTP server on <port>
186 -r, --root <path>
188 Define the local root of the FTP server
189 --anonymoususer <username>
191 Define the the name of the anonymous user
192
194 -p, --port <port>
195 Run the manhole server on <port>
196 -u, --user <name>
198 set the username to <name>
199 -w, --password <password>
201 set the password to <password>
202
204 -p, --port <port>
205 Run the Words server on <port>
206 -i, --irc <port>
208 Run IRC server on port <port>
209 -w, --web <port>
211 Run web server on port <port>
212
214 Written by Moshe Zadka, based on mktap's help messages
215
217 To report a bug, visit http://twistedmatrix.com/bugs/
218
220 Copyright © 2000-2008 Twisted Matrix Laboratories.
221 This is free software; see the source for copying conditions. There is
222 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
223 PURPOSE.
224
226 twistd(1)
227 July 2001 MKTAP(1)