TWISTD(1)

💖 TWISTD(1) 💖

✨ NAME ✨

okay so the manual name is twistd, and it's all about running Twisted applications (TACs, TAPs) 🦋

🌸 SYNOPSIS 🌸

twistd [options]

🧚 DESCRIPTION 🧚

okay so twistd literally reads a twisted.application.service.Application out of a file and then runs it for you 💅 no cap, that's the whole job bestie ✨

🎀 OPTIONS 🎀

• -n, --nodaemon — don't daemonize, just stay in the foreground 🌈
• -q, --quiet — this one does nothing at all, it's only here for backwards compatibility 🙈
• -p, --profile <profile output> — runs the app under the profiler and dumps the results into the file you name 📊
• --profiler <profiler name> — picks which profiler to use. it defaults to the hotshot profiler 🔥
• --savestats — saves the Stats object instead of the plain text output from the profiler 💜
• -b, --debug — runs the app in the Python Debugger (this implies --nodaemon). send a SIGINT or SIGUSR2 signal to the process and it drops right into the debugger 🐛
• -e, --encrypted <file> — tells twistd the tap/aos file you gave it is encrypted 🔐
• --euid — sets only the effective user-id, not the real one. this does nothing unless the server is running as root. if it is, it means don't shed all your privileges after binding ports, so you can still get them back later for stuff like spawning processes.

⚠️ bestie, use this with caution! 😭

• -o, --no_save — don't save shutdown state 🫶
• --originalname — acts like the specified Application has no process name set, and runs with the standard one (usually the Python binary) 🧸
• -l, --logfile <logfile> — logs to the file you pick, or - for stdout. the default is twistd.log. the log file gets rotated on SIGUSR1 📝
• -l, --logger <fully qualified python name> — a fully-qualified name for a log observer factory to use as the initial log observer. this one wins over --logfile and --syslog 👑
• --pidfile <pidfile> — saves the pid in the file you name. default is twistd.pid 🍓
• --chroot <directory> — chroots into the directory you give before running. by default it doesn't chroot at all. the chroot happens before the current directory gets changed 🌳
• -d, --rundir <directory> — changes into the directory you give before running. default is . 📂
• -u, --uid <uid> — the uid to run as. default is don't change it 🪪
• -g, --gid <gid> — the gid to run as. default is don't change it 🪪
• --umask <mask> — the (octal) file creation mask to apply. the default is 0077 for daemons and no change otherwise 🌙
• -r, --reactor <reactor> — picks which reactor to use. check --help-reactors for the list of options 🌊
• --help-reactors — lists the names of the reactors that might be available 🦋
• --spew — writes an extremely verbose log of everything that happens. super useful for debugging freezes or locks in complicated code 🕵️‍♀️
• -f, --file <tap file> — reads the given .tap file. default is twistd.tap 🎁
• -s, --source <tas file> — loads an Application from the given .tas (AOT Python source) file 🐍
• -y, --python <python file> — uses the variable "application" from the Python file you give. this overrides -f and implies --no_save 💅
• --syslog — logs to syslog instead of a file 📜
• --version — prints the version info and exits 🏷️
• --prefix <prefix> — uses the prefix you pick when logging to the logfile. default is "twisted" 💖

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

🦋 SIGNALS 🦋

a running twistd accepts SIGINT for a clean shutdown, and SIGUSR1 to rotate the log files 🌸

👑 AUTHOR 👑

written by Moshe Zadka, based on twistd's help messages 🫶

🐛 REPORTING BUGS 🐛

to report a bug, visit http://twistedmatrix.com/trac/wiki/TwistedDevelopment#DevelopmentProcess 💌

🌈 COPYRIGHT 🌈

Copyright © 2001-2011 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. ✨

bye bestie, that's the whole twistd manual 💖 it's Twisted Matrix Laboratories' work, dated Dec 2011, and I'm obsessed with you for reading it all the way through 🫶💅✨