← Back to branch summary

~ntt-pf-lab/nova/monkey_patch_notification

« back to all changes in this revision

Viewing changes to vendor/Twisted-10.0.0/doc/core/man/mktap.1

  • Committer: Jesse Andrews
  • Date: 2010-05-28 06:05:26 UTC
  • Revision ID: git-v1:bf6e6e718cdc7488e2da87b21e258ccc065fe499
initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
vendor/Twisted-10.0.0/doc/core/man/mktap.1
 
1
.TH MKTAP "1" "July 2001" "" ""
 
2
.SH NAME
 
3
mktap \- create twisted.servers
 
4
.SH SYNOPSIS
 
5
.B mktap
 
6
[\fIoptions\fR] \fIapptype\fR [\fIapplication_option\fR]...
 
7
.PP
 
8
.B mktap
 
9
\fIapptype\fR --help
 
10
.SH DESCRIPTION
 
11
.PP
 
12
The \fB\--help\fR prints out a usage message to standard output.
 
13
.TP
 
14
\fB\--debug\fR, \fB\-d\fR
 
15
Show debug information for plugin loading.
 
16
.TP
 
17
\fB\--progress\fR, \fB\-p\fR
 
18
Show progress information for plugin loading.
 
19
.TP
 
20
\fB\--encrypted\fR, \fB\-e\fR
 
21
Encrypt file before writing (will make the extension of the resultant file begin with 'e').
 
22
.TP
 
23
\fB\--uid\fR, \fB\-u\fR \fI<uid>\fR
 
24
Application belongs to this uid, and should run with its permissions.
 
25
.TP
 
26
\fB\--gid\fR, \fB\-d\fR \fI<gid>\fR
 
27
Application belongs to this gid, and should run with its permissions.
 
28
.TP
 
29
\fB\--append\fR, \fB\-a\fR \fI<file>\fR
 
30
Append given servers to given file, instead of creating a new one.
 
31
File should be be a tap file.
 
32
.TP
 
33
\fB\--appname\fR, \fB\-n\fR \fI<name>\fR
 
34
Use the specified name as the process name when the application is run with
 
35
\fItwistd(1)\fR.  This option also causes some initialization code to be
 
36
duplicated when \fItwistd(1)\fR is run.
 
37
.TP
 
38
\fB\--type\fR, \fB\-t\fR \fI<type>\fR
 
39
Specify the output file type. Available types are:
 
40
.IP
 
41
pickle - (default) Output as a python pickle file.
 
42
.br
 
43
source - Output as a .tas (AOT Python source) file.
 
44
.P
 
45
\fIapptype\fR
 
46
Can be 'web', 'portforward', 'toc', 'coil', 'words', \
 
47
'manhole', 'im', 'news', 'socks', 'telnet', 'parent', 'sibling', \
 
48
'ftp', and 'mail'. Each of those support different options.
 
49
.PP
 
50
.SH \fBportforward\fR options
 
51
.TP
 
52
\fB\-h\fR, \fB\--host\fR \fI<host>\fR
 
53
Proxy connections to \fI<host>\fR
 
54
.TP
 
55
\fB\-d\fR, \fB\--dest_port\fR \fI<port>\fR
 
56
Proxy connections to \fI<port>\fR on remote host.
 
57
.TP
 
58
\fB\-p\fR, \fB\--port\fR \fI<port>\fR
 
59
Listen locally on \fI<port>\fR
 
60
.PP
 
61
.SH \fBweb\fR options
 
62
.TP
 
63
\fB\-u\fR, \fB\--user\fR
 
64
Makes a server with ~/public_html and
 
65
~/.twistd-web-pb support for users.
 
66
.TP
 
67
\fB\--personal\fR
 
68
Instead of generating a webserver, generate a
 
69
ResourcePublisher which listens on ~/.twistd-web-pb
 
70
.TP
 
71
\fB\--path\fR \fI<path>\fR
 
72
<path> is either a specific file or a directory to be
 
73
set as the root of the web server. Use this if you
 
74
have a directory full of HTML, cgi, php3, epy, or rpy files or
 
75
any other files that you want to be served up raw.
 
76
.TP
 
77
\fB\-p\fR, \fB\--port\fR \fI<port>\fR
 
78
<port> is a number representing which port you want to
 
79
start the server on.
 
80
.TP
 
81
\fB\-m\fR, \fB\--mime_type\fR \fI<mimetype>\fR
 
82
<mimetype> is the default MIME type to use for
 
83
files in a --path web server when none can be determined
 
84
for a particular extension. The default is 'text/html'.
 
85
.TP
 
86
\fB\--allow_ignore_ext\fR
 
87
Specify whether or not a request for 'foo' should return 'foo.ext'.
 
88
Default is off.
 
89
.TP
 
90
\fB\--ignore-ext\fR \fI.<extension>\fR
 
91
Specify that a request for 'foo' should return 'foo.\fI<extension>\fR'.
 
92
.TP
 
93
\fB\-t\fR, \fB\--telnet\fR \fI<port>\fR
 
94
Run a telnet server on <port>, for additional
 
95
configuration later.
 
96
.TP
 
97
\fB\-i\fR, \fB\--index\fR \fI<name>\fR
 
98
Use an index name other than "index.html"
 
99
.TP
 
100
\fB--https\fR \fI<port>\fR
 
101
Port to listen on for Secure HTTP.
 
102
.TP
 
103
\fB-c\fR, \fB--certificate\fR \fI<filename>\fR
 
104
SSL certificate to use for HTTPS. [default: server.pem]
 
105
.TP
 
106
\fB-k\fR, \fB--privkey\fR \fI<filename>\fR
 
107
SSL certificate to use for HTTPS. [default: server.pem]
 
108
.TP
 
109
\fB--processor\fR \fI<ext>=<class name>\fR
 
110
Adds a processor to those file names. (Only usable if after
 
111
.B --path)
 
112
.TP
 
113
\fB--resource-script\fR \fI<script name>\fR
 
114
Sets the root as a resource script. This script will be re-evaluated on
 
115
every request.
 
116
.PP
 
117
This creates a web.tap file that can be used by twistd. If you
 
118
specify no arguments, it will be a demo webserver that has the Test
 
119
class from twisted.web.test in it.
 
120
.SH \fBtoc\fR options
 
121
.TP
 
122
\fB\-p\fR \fI<port>\fR
 
123
<port> is a number representing which port you want to
 
124
start the server on.
 
125
.SH \fBmail\fR options
 
126
.TP
 
127
\fB\-r\fR, \fB\--relay\fR \fI<ip>,<port>=<queue directory>\fR
 
128
Relay mail to all unknown domains through given IP and port,
 
129
using queue directory as temporary place to place files.
 
130
.TP
 
131
\fB\-d\fR, \fB\--domain\fR \fI<domain>\fR=\fI<path>\fR
 
132
generate an SMTP/POP3 virtual maildir domain named "domain" which saves to
 
133
"path"
 
134
.TP
 
135
\fB\-u\fR, \fB\--username\fR \fI<name>\fR=\fI<password>\fR
 
136
add a user/password to the last specified domains
 
137
.TP
 
138
\fB\-b\fR, \fB\--bounce_to_postmaster\fR
 
139
undelivered mails are sent to the postmaster, instead of being rejected.
 
140
.TP
 
141
\fB\-p\fR, \fB\--pop\fR \fI<port>\fR
 
142
<port> is a number representing which port you want to
 
143
start the pop3 server on.
 
144
.TP
 
145
\fB\-s\fR, \fB\--smtp\fR \fI<port>\fR
 
146
<port> is a number representing which port you want to
 
147
start the smtp server on.
 
148
.PP
 
149
This creates a mail.tap file that can be used by twistd(1)
 
150
.SH \fBtelnet\fR options
 
151
.TP
 
152
\fB\-p\fR, \fB\--port\fR \fI<port>\fR
 
153
Run the telnet server on <port>
 
154
.TP
 
155
\fB\-u\fR, \fB\--username\fR \fI<name>\fR
 
156
set the username to <name>
 
157
.TP
 
158
\fB\-w\fR, \fB\--password\fR \fI<password>\fR
 
159
set the password to <password>
 
160
.SH \fBsocks\fR options
 
161
.TP
 
162
\fB\-i\fR, \fB\--interface\fR \fI<interface>\fR
 
163
Listen on interface <interface>
 
164
.TP
 
165
\fB\-p\fR, \fB\--port\fR \fI<port>\fR
 
166
Run the SOCKSv4 server on <port>
 
167
.TP
 
168
\fB\-l\fR, \fB\--log\fR \fI<filename>\fR
 
169
log connection data to <filename>
 
170
.SH \fBftp\fR options
 
171
.TP
 
172
\fB\-a\fR, \fB\--anonymous\fR
 
173
Allow anonymous logins
 
174
.TP
 
175
\fB\-3\fR, \fB\--thirdparty\fR
 
176
Allow third party connections
 
177
.TP
 
178
\fB\--otp\fR
 
179
Use one time passwords (OTP)
 
180
.TP
 
181
\fB\-p\fR, \fB\--port\fR \fI<port>\fR
 
182
Run the FTP server on <port>
 
183
.TP
 
184
\fB\-r\fR, \fB\--root\fR \fI<path>\fR
 
185
Define the local root of the FTP server
 
186
.TP
 
187
\fB\--anonymoususer\fR \fI<username>\fR
 
188
Define the the name of the anonymous user
 
189
.SH \fBmanhole\fR options
 
190
.TP
 
191
\fB\-p\fR, \fB\--port\fR \fI<port>\fR
 
192
Run the manhole server on <port>
 
193
.TP
 
194
\fB\-u\fR, \fB\--user\fR \fI<name>\fR
 
195
set the username to <name>
 
196
.TP
 
197
\fB\-w\fR, \fB\--password\fR \fI<password>\fR
 
198
set the password to <password>
 
199
.SH \fBwords\fR options
 
200
.TP
 
201
\fB\-p\fR, \fB\--port\fR \fI<port>\fR
 
202
Run the Words server on <port>
 
203
.TP
 
204
\fB\-i\fR, \fB\--irc\fR \fI<port>\fR
 
205
Run IRC server on port <port>
 
206
.TP
 
207
\fB\-w\fR, \fB\--web\fR \fI<port>\fR
 
208
Run web server on port <port>
 
209
.SH AUTHOR
 
210
Written by Moshe Zadka, based on mktap's help messages
 
211
.SH "REPORTING BUGS"
 
212
To report a bug, visit \fIhttp://twistedmatrix.com/bugs/\fR
 
213
.SH COPYRIGHT
 
214
Copyright \(co 2000-2008 Twisted Matrix Laboratories.
 
215
.br
 
216
This is free software; see the source for copying conditions.  There is NO
 
217
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
218
.SH "SEE ALSO"
 
219
twistd(1)