1MKTAP(1)                                                              MKTAP(1)
2
3
4

NAME

6       mktap - create twisted.servers
7

SYNOPSIS

9       mktap [options] apptype [application_option]...
10
11       mktap apptype --help
12

DESCRIPTION

14       The --help prints out a usage message to standard output.
15
16       --debug, -d
17              Show debug information for plugin loading.
18
19       --progress, -p
20              Show progress information for plugin loading.
21
22       --encrypted, -e
23              Encrypt  file  before  writing  (will  make the extension of the
24              resultant file begin with 'e').
25
26       --uid, -u <uid>
27              Application belongs to this uid, and should run with its permis‐
28              sions.
29
30       --gid, -d <gid>
31              Application belongs to this gid, and should run with its permis‐
32              sions.
33
34       --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
38       --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
43       --type, -t <type>
44              Specify the output file type. Available types are:
45
46              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
50       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

portforward options

55       -h, --host <host>
56              Proxy connections to <host>
57
58       -d, --dest_port <port>
59              Proxy connections to <port> on remote host.
60
61       -p, --port <port>
62              Listen locally on <port>
63

web options

65       -u, --user
66              Makes  a  server with ~/public_html and ~/.twistd-web-pb support
67              for users.
68
69       --personal
70              Instead of generating a webserver, generate a  ResourcePublisher
71              which listens on ~/.twistd-web-pb
72
73       --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
79       -p, --port <port>
80              <port> is a number representing which port you want to start the
81              server on.
82
83       -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
88       --allow_ignore_ext
89              Specify  whether  or  not  a  request  for  'foo'  should return
90              'foo.ext'.  Default is off.
91
92       --ignore-ext .<extension>
93              Specify that a request  for  'foo'  should  return  'foo.<exten‐
94              sion>'.
95
96       -t, --telnet <port>
97              Run  a  telnet  server  on  <port>, for additional configuration
98              later.
99
100       -i, --index <name>
101              Use an index name other than "index.html"
102
103       --https <port>
104              Port to listen on for Secure HTTP.
105
106       -c, --certificate <filename>
107              SSL certificate to use for HTTPS. [default: server.pem]
108
109       -k, --privkey <filename>
110              SSL certificate to use for HTTPS. [default: server.pem]
111
112       --processor <ext>=<class name>
113              Adds a processor to those file  names.  (Only  usable  if  after
114              --path)
115
116       --resource-script <script name>
117              Sets the root as a resource script. This script will be re-eval‐
118              uated on every request.
119
120       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

toc options

125       -p <port>
126              <port> is a number representing which port you want to start the
127              server on.
128

mail options

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
134       -d, --domain <domain>=<path>
135              generate an SMTP/POP3  virtual  maildir  domain  named  "domain"
136              which saves to "path"
137
138       -u, --username <name>=<password>
139              add a user/password to the last specified domains
140
141       -b, --bounce_to_postmaster
142              undelivered  mails  are sent to the postmaster, instead of being
143              rejected.
144
145       -p, --pop <port>
146              <port> is a number representing which port you want to start the
147              pop3 server on.
148
149       -s, --smtp <port>
150              <port> is a number representing which port you want to start the
151              smtp server on.
152
153       This creates a mail.tap file that can be used by twistd(1)
154

telnet options

156       -p, --port <port>
157              Run the telnet server on <port>
158
159       -u, --username <name>
160              set the username to <name>
161
162       -w, --password <password>
163              set the password to <password>
164

socks options

166       -i, --interface <interface>
167              Listen on interface <interface>
168
169       -p, --port <port>
170              Run the SOCKSv4 server on <port>
171
172       -l, --log <filename>
173              log connection data to <filename>
174

ftp options

176       -a, --anonymous
177              Allow anonymous logins
178
179       -3, --thirdparty
180              Allow third party connections
181
182       --otp  Use one time passwords (OTP)
183
184       -p, --port <port>
185              Run the FTP server on <port>
186
187       -r, --root <path>
188              Define the local root of the FTP server
189
190       --anonymoususer <username>
191              Define the the name of the anonymous user
192

manhole options

194       -p, --port <port>
195              Run the manhole server on <port>
196
197       -u, --user <name>
198              set the username to <name>
199
200       -w, --password <password>
201              set the password to <password>
202

words options

204       -p, --port <port>
205              Run the Words server on <port>
206
207       -i, --irc <port>
208              Run IRC server on port <port>
209
210       -w, --web <port>
211              Run web server on port <port>
212

AUTHOR

214       Written by Moshe Zadka, based on mktap's help messages
215

REPORTING BUGS

217       To report a bug, visit http://twistedmatrix.com/bugs/
218
220       Copyright © 2000 Matthew W. Lefkowitz
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

SEE ALSO

226       twistd(1)
227
228
229
230                                   July 2001                          MKTAP(1)
Impressum