← Back to branch summary

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

« back to all changes in this revision

Viewing changes to vendor/Twisted-10.0.0/doc/core/man/twistd.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/twistd.1
 
1
.TH TWISTD "1" "Dec 2003" "" ""
 
2
.SH NAME
 
3
twistd \- run Twisted applications (TACs, TAPs)
 
4
.SH SYNOPSIS
 
5
.B twistd
 
6
[options]
 
7
.SH DESCRIPTION
 
8
Read a twisted.application.service.Application out of a file and run it.
 
9
.SH OPTIONS
 
10
\fB\-n\fR, \fB\--nodaemon\fR
 
11
Don't daemonize (stay in foreground).
 
12
.TP
 
13
\fB\-q\fR, \fB\--quiet\fR
 
14
No-op for backwards compatibility.
 
15
.TP
 
16
\fB\-p\fR, \fB\--profile\fR \fI<profile output>\fR
 
17
Run the application under the profiler, dumping results to the specified file.
 
18
.TP
 
19
\fB\--profiler\fR \fI<profiler name>\fR
 
20
Specify the profiler to use. Defaults to the 'hotshot' profiler.
 
21
.TP
 
22
\fB--savestats\fR
 
23
Save the Stats object rather than the text output of the profiler.
 
24
.TP
 
25
\fB\-b\fR, \fB\--debug\fR
 
26
Run the application in the Python Debugger (implies \fB\--nodaemon\fR option).
 
27
Sending a SIGINT or SIGUSR2 signal to the process will drop it into the
 
28
debugger.
 
29
.TP
 
30
\fB\-e\fR, \fB\--encrypted\fR \fI<file>\fR
 
31
The specified tap/aos file is encrypted.
 
32
.TP
 
33
\fB--euid\fR
 
34
Set only effective user-id rather than real user-id. This option has no  
 
35
effect unless the server is running as root, in which case it means not  
 
36
to shed all privileges after binding ports, retaining the option to regain 
 
37
privileges in cases such as spawning processes. Use with caution. 
 
38
.TP
 
39
\fB\-o\fR, \fB\--no_save\fR
 
40
Do not save shutdown state.
 
41
.TP
 
42
\fB\--originalname\fR
 
43
Behave as though the specified Application has no process name set, and run
 
44
with the standard process name (the Python binary in most cases).
 
45
.TP
 
46
\fB\-l\fR, \fB\--logfile\fR \fI<logfile>\fR
 
47
Log to a specified file, - for stdout (default: twistd.log).
 
48
The log file will be rotated on SIGUSR1.
 
49
.TP
 
50
\fB\--pidfile\fR \fI<pidfile>\fR
 
51
Save pid in specified file (default: twistd.pid).
 
52
.TP
 
53
\fB\--chroot\fR \fI<directory>\fR
 
54
Chroot to a supplied directory before running (default: don't chroot).
 
55
Chrooting is done before changing the current directory.
 
56
.TP
 
57
\fB\-d\fR, \fB\--rundir\fR \fI<directory>\fR
 
58
Change to a supplied directory before running (default: .).
 
59
.TP
 
60
\fB\-u\fR, \fB\--uid\fR \fI<uid>\fR
 
61
The uid to run as (default: don't change).
 
62
.TP
 
63
\fB\-g\fR, \fB\--gid\fR \fI<gid>\fR
 
64
The gid to run as (default: don't change).
 
65
.TP
 
66
\fB--umask\fR \fI<mask>\fR
 
67
The (octal) file creation mask to apply. (default: 0077 for daemons, no
 
68
change otherwise).
 
69
.TP
 
70
\fB\-r\fR, \fB\--reactor\fR \fI<reactor>\fR
 
71
Choose which reactor to use. See \fB\--help-reactors\fR for a list of
 
72
possibilities.
 
73
.TP
 
74
\fB--help-reactors\fR
 
75
List the names of possibly available reactors.
 
76
.TP
 
77
\fB\--spew\fR
 
78
Write an extremely verbose log of everything that happens. Useful for
 
79
debugging freezes or locks in complex code.
 
80
.TP
 
81
\fB\-f\fR, \fB\--file\fR \fI<tap file>\fR
 
82
Read the given .tap file (default: twistd.tap).
 
83
.TP
 
84
\fB\-s\fR, \fB\--source\fR \fI<tas file>\fR
 
85
Load an Application from the given .tas (AOT Python source) file.
 
86
.TP
 
87
\fB\-y\fR, \fB\--python\fR \fI<python file>\fR
 
88
Use the variable "application" from the given Python file. This option overrides
 
89
\fB\-f\fR. This option implies \fB\--no_save\fR.
 
90
.TP
 
91
\fB\-g\fR, \fB\--plugin\fR \fI<plugin name>\fR
 
92
Read config.tac from a plugin package, as with \fB\-y\fR.
 
93
.TP
 
94
\fB\--syslog\fR
 
95
Log to syslog instead of a file.
 
96
.TP
 
97
\fB\-u\fR, \fB\--uid\fR \fI<uid>\fR
 
98
The uid to run as.
 
99
.TP
 
100
\fB\-g\fR, \fB\--gid\fR \fI<gid>\fR
 
101
The gid to run as.
 
102
.TP
 
103
\fB\--version\fR
 
104
Print version information and exit.
 
105
.TP
 
106
\fB\--prefix\fR \fI<prefix>\fR
 
107
Use the specified prefix when logging to logfile. Default is "twisted".
 
108
.PP
 
109
Note that if \fBtwistd\fR is run as root, the working directory is \fInot\fR
 
110
searched for Python modules.
 
111
.SH SIGNALS
 
112
A running twistd accepts SIGINT for a clean shutdown and SIGUSR1 to rotate log
 
113
files.
 
114
.SH AUTHOR
 
115
Written by Moshe Zadka, based on twistd's help messages.
 
116
.SH "REPORTING BUGS"
 
117
To report a bug, visit
 
118
\fIhttp://twistedmatrix.com/trac/wiki/TwistedDevelopment#DevelopmentProcess\fR
 
119
.SH COPYRIGHT
 
120
Copyright \(co 2001-2010 Twisted Matrix Laboratories.
 
121
.br
 
122
This is free software; see the source for copying conditions. There is NO
 
123
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.