TWISTD

Section: (1)
Updated: Dec 2003
Index Return to Main Contents
 

NAME

twistd - run Twisted applications (TACs, TAPs)  

SYNOPSIS

twistd [options]  

DESCRIPTION

Read an twisted.application.service.Application out of a file and runs it.
-n, --nodaemon
Don't daemonize (stay in foreground)
-q, --quiet
No-op for backwards compatibility.
-p, --profile <profile output>
Run the application under the profiler, dumping results to the specified file.
--profiler <profiler name>
Specify the profiler to use, default to the 'hotshot' profiler.
--savestats
Save the Stats object rather than the text output of the profiler.
-b, --debug
Run the application in the Python Debugger (implies nodaemon option). Sending a SIGUSR2 signal to the process will drop it into the debugger.
-e, --encrypted <file>
The specified tap/aos/xml file is encrypted.
--euid
Set only effective user-id rather than real user-id. This option has no effect unless the server is running as root, in which case it means not to shed all privileges after binding ports, retaining the option to regain privileges in cases such as spawning processes. Use with caution.
-o, --no_save
Do not save shutdown state
--originalname
Behave as though the specified Application has no process name set, and run with the standard process name (the python binary in most cases).
-l, --logfile <logfile>
Log to a specified file, - for stdout (default: twistd.log). The log file will be rotated on SIGUSR1.
--pidfile <pidfile>
Save pid in specified file (default: twistd.pid)
--chroot <directory>
Chroot to a supplied directory before running (default: don't chroot). Chrooting is done before changing the current directory.
-d, --rundir <directory>
Change to a supplied directory before running (default: .)
-u, --uid <uid>
The uid to run as. (default: don't change)
-g, --gid <gid>
The gid to run as. (default: don't change)
--umask <mask>
The (octal) file creation mask to apply. (default: 0077 for daemons, no change otherwise).
-r, --reactor <reactor>
Choose which reactor to use. See --help-reactors for a list of possibilties.
--help-reactors
List the names of possibly available reactors.
--spew
Write an extremely verbose log of everything that happens. Useful for debugging freezes or locks in complex code.
-f, --file <tap file>
Read the given .tap file (default: twistd.tap)
-x, --xml <tax file>
Load an Application from the given .tax (XML) file.
-s, --source <tas file>
Load an Application from the given .tas (AOT Python source) file.
-y, --python <python file>
Use the variable "application" from the given Python file. This setting, if given, overrides -f. This option implies --no_save.
-g, --plugin <plugin name>
Read config.tac from a plugin package, as with -y.
--syslog
Log to syslog, not to file.
-u, --uid <uid>
The uid to run as.
-g, --gid <gid>
The gid to run as.
--version
Print version information and exit.
--prefix <prefix>
Use the specified prefix when logging to logfile. Default is "twisted".

Note that if twistd is run as root, the working directory is not searched for Python modules.  

AUTHOR

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

REPORTING BUGS

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

COPYRIGHT

Copyright © 2001-2008 Twisted Matrix Laboratories.
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.