~justin-fathomdb/nova/justinsb-openstack-api-volumes

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">

<head>

<title>Twisted Documentation: MKTAP.1</title>

</head>

<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>

mktap - create twisted.servers

<h2>SYNOPSIS<a name="auto1"/></h2>

mktap [options] apptype [application_option]...

mktap apptype --help

<h2>DESCRIPTION<a name="auto2"/></h2>

The --help prints out a usage message to standard output.

<dl><dt>--debug, -d

</dt><dd>Show debug information for plugin loading.

</dd>

<dt>--progress, -p

</dt><dd>Show progress information for plugin loading.

</dd>

<dt>--encrypted, -e

</dt><dd>Encrypt file before writing (will make the extension of the resultant file begin with 'e').

</dd>

</dt><dd>Application belongs to this uid, and should run with its permissions.

</dd>

</dt><dd>Application belongs to this gid, and should run with its permissions.

</dd>

<dt>--append, -a <file>

</dt><dd>Append given servers to given file, instead of creating a new one.

File should be be a tap file.

</dd>

<dt>--appname, -n <name>

</dt><dd>Use the specified name as the process name when the application is run with

twistd(1). This option also causes some initialization code to be

duplicated when twistd(1) is run.

</dd>

</dt><dd>Specify the output file type. Available types are:

pickle - (default) Output as a python pickle file.

source - Output as a .tas (AOT Python source) file.

apptype

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>portforward options<a name="auto3"/></h2>

</dt><dd>Proxy connections to <host>

</dd>

</dt><dd>Proxy connections to <port> on remote host.

</dd>

</dt><dd>Listen locally on <port>

</dd>

</dl>

<h2>web options<a name="auto4"/></h2>

<dl><dt>-u, --user

</dt><dd>Makes a server with ~/public_html and

~/.twistd-web-pb support for users.

</dd>

<dt>--personal

</dt><dd>Instead of generating a webserver, generate a

ResourcePublisher which listens on ~/.twistd-web-pb

</dd>

100

101

102

</dt><dd><path> is either a specific file or a directory to be

103

set as the root of the web server. Use this if you

104

have a directory full of HTML, cgi, php3, epy, or rpy files or

105

any other files that you want to be served up raw.

106

</dd>

107

108

109

</dt><dd><port> is a number representing which port you want to

110

start the server on.

111

</dd>

112

113

114

</dt><dd><mimetype> is the default MIME type to use for

115

files in a --path web server when none can be determined

116

for a particular extension. The default is 'text/html'.

117

</dd>

118

119

<dt>--allow_ignore_ext

120

</dt><dd>Specify whether or not a request for 'foo' should return 'foo.ext'.

121

Default is off.

122

</dd>

123

124

<dt>--ignore-ext .<extension>

125

</dt><dd>Specify that a request for 'foo' should return 'foo.<extension>'.

126

</dd>

127

128

<dt>-t, --telnet <port>

129

</dt><dd>Run a telnet server on <port>, for additional

130

configuration later.

131

</dd>

132

133

<dt>-i, --index <name>

134

</dt><dd>Use an index name other than <q>index.html</q>

135

</dd>

136

137

<dt>--https <port>

138

</dt><dd>Port to listen on for Secure HTTP.

139

</dd>

140

141

<dt>-c, --certificate <filename>

142

</dt><dd>SSL certificate to use for HTTPS. [default: server.pem]

143

</dd>

144

145

<dt>-k, --privkey <filename>

146

</dt><dd>SSL certificate to use for HTTPS. [default: server.pem]

147

</dd>

148

149

<dt>--processor <ext>=<class name>

150

</dt><dd>Adds a processor to those file names. (Only usable if after

151

--path) </dd>

152

153

<dt>--resource-script <script name>

154

</dt><dd>Sets the root as a resource script. This script will be re-evaluated on

155

every request.

156

</dd>

157

158

</dl>

159

160

This creates a web.tap file that can be used by twistd. If you

161

specify no arguments, it will be a demo webserver that has the Test

162

class from twisted.web.test in it.

163

164

165

<h2>toc options<a name="auto5"/></h2>

166

167

168

</dt><dd><port> is a number representing which port you want to

169

start the server on.

170

</dd>

171

172

</dl>

173

174

<h2>mail options<a name="auto6"/></h2>

175

176

<dl><dt>-r, --relay <ip>,<port>=<queue directory>

177

</dt><dd>Relay mail to all unknown domains through given IP and port,

178

using queue directory as temporary place to place files.

179

</dd>

180

181

<dt>-d, --domain <domain>=<path>

182

</dt><dd>generate an SMTP/POP3 virtual maildir domain named <q>domain</q> which saves to

183

184

</dd>

185

186

<dt>-u, --username <name>=<password>

187

</dt><dd>add a user/password to the last specified domains

188

</dd>

189

190

<dt>-b, --bounce_to_postmaster

191

</dt><dd>undelivered mails are sent to the postmaster, instead of being rejected.

192

</dd>

193

194

195

</dt><dd><port> is a number representing which port you want to

196

start the pop3 server on.

197

</dd>

198

199

200

</dt><dd><port> is a number representing which port you want to

201

start the smtp server on.

202

</dd>

203

204

</dl>

205

206

This creates a mail.tap file that can be used by twistd(1)

207

208

209

<h2>telnet options<a name="auto7"/></h2>

210

211

212

</dt><dd>Run the telnet server on <port>

213

</dd>

214

215

<dt>-u, --username <name>

216

</dt><dd>set the username to <name>

217

</dd>

218

219

<dt>-w, --password <password>

220

</dt><dd>set the password to <password>

221

</dd>

222

223

</dl>

224

225

<h2>socks options<a name="auto8"/></h2>

226

227

<dl><dt>-i, --interface <interface>

228

</dt><dd>Listen on interface <interface>

229

</dd>

230

231

232

</dt><dd>Run the SOCKSv4 server on <port>

233

</dd>

234

235

236

</dt><dd>log connection data to <filename>

237

</dd>

238

239

</dl>

240

241

<h2>ftp options<a name="auto9"/></h2>

242

243

<dl><dt>-a, --anonymous

244

</dt><dd>Allow anonymous logins

245

</dd>

246

247

<dt>-3, --thirdparty

248

</dt><dd>Allow third party connections

249

</dd>

250

251

<dt>--otp

252

</dt><dd>Use one time passwords (OTP)

253

</dd>

254

255

256

</dt><dd>Run the FTP server on <port>

257

</dd>

258

259

260

</dt><dd>Define the local root of the FTP server

261

</dd>

262

263

<dt>--anonymoususer <username>

264

</dt><dd>Define the the name of the anonymous user

265

</dd>

266

267

</dl>

268

269

<h2>manhole options<a name="auto10"/></h2>

270

271

272

</dt><dd>Run the manhole server on <port>

273

</dd>

274

275

276

</dt><dd>set the username to <name>

277

</dd>

278

279

<dt>-w, --password <password>

280

</dt><dd>set the password to <password>

281

</dd>

282

283

</dl>

284

285

<h2>words options<a name="auto11"/></h2>

286

287

288

</dt><dd>Run the Words server on <port>

289

</dd>

290

291

292

</dt><dd>Run IRC server on port <port>

293

</dd>

294

295

296

</dt><dd>Run web server on port <port>

297

</dd>

298

299

</dl>

300

301

<h2>AUTHOR<a name="auto12"/></h2>

302

303

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

304

305

306

<h2>REPORTING BUGS<a name="auto13"/></h2>

307

308

To report a bug, visit http://twistedmatrix.com/bugs/

309

310

311

<h2>COPYRIGHT<a name="auto14"/></h2>

312

313

314

This is free software; see the source for copying conditions. There is NO

315

warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

316

317

318

319

320

twistd(1)

321

322

323

</div>

324

325

<a href="../howto/index.html">Index</a>

326

Version: 10.0.0

327

</body>

328

</html>

b'\\ No newline at end of file'

Older »