OS Manuals

/opt/synapse/bin/twistd

Matrix reference homeserver

From synapse 1.164.2-r0 (enterprise-packages), captured 2026-11-08 by running twistd --help (exit 0). permalink

Usage: twistd [options]
Options:
  -b, --debug          Run the application in the Python Debugger (implies nodaemon), sending
                       SIGUSR2 will drop into debugger
      --chroot=        Chroot to a supplied directory before running
  -d, --rundir=        Change to a supplied directory before running [default: .]
  -e, --encrypted      The specified tap/aos 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.)
  -f, --file=          read the given .tap file [default: twistd.tap]
  -g, --gid=           The gid to run as.  If not specified, the default gid associated with the
                       specified --uid is used.
      --help           Display this help and exit.
      --help-reactors  Display a list of possibly available reactor names.
  -l, --logfile=       log to a specified file, - for stdout
      --logger=        A fully-qualified name to a log observer factory to use for the initial log
                       observer.  Takes precedence over --logfile and --syslog (when available).
  -n, --nodaemon       don't daemonize, don't use default umask of 0077
  -o, --no_save        do not save state on shutdown
      --originalname   Don't try to change the process name
  -p, --profile=       Run in profile mode, dumping results to specified file.
      --pidfile=       Name of the pidfile [default: twistd.pid]
      --prefix=        use the given prefix when syslogging [default: twisted]
      --profiler=      Name of the profiler to use (profile, cprofile). [default: cprofile]
  -r, --reactor=       Which reactor to use (see --help-reactors for a list of possibilities)
  -s, --source=        Read an application from a .tas file (AOT format).
      --savestats      save the Stats object rather than the text output of the profiler.
      --spew           Print an insanely verbose log of everything that happens. Useful when
                       debugging freezes or locks in complex code.
      --syslog         Log to syslog, not to file
  -u, --uid=           The uid to run as.
      --umask=         The (octal) file creation mask to apply.
      --version        Print version information and exit.
  -y, --python=        read an application from within a Python file (implies -o)

twistd reads a twisted.application.service.Application out of a file and runs it.
Commands:
    conch            A Conch SSH service.
    dns              A domain name server.
    ftp              An FTP server.
    inetd            An inetd(8) replacement.
    mail             An email service
    manhole          An interactive remote debugger service accessible via telnet and ssh and
                     providing syntax coloring and basic line editing functionality.
    portforward      A simple port-forwarder.
    procmon          A process watchdog / supervisor
    socks            A SOCKSv4 proxy service.
    web              A general-purpose web server which can serve from a filesystem or application
                     resource.
    words            A modern words server
    xmpp-router      An XMPP Router server
Options (27)
OptionDescriptionSource
-b, --debugRun the application in the Python Debugger (implies nodaemon), sending SIGUSR2 will drop into debuggerhelp
--chrootChroot to a supplied directory before runninghelp
-d, --rundirChange to a supplied directory before running [default: .]help
-e, --encryptedThe specified tap/aos file is encrypted.help
--euidSet only effective user-id rather than real user-id.help
-f, --fileread the given .tap file [default: twistd.tap]help
-g, --gidThe gid to run as.help
--helpDisplay this help and exit.help
--help-reactorsDisplay a list of possibly available reactor names.help
-l, --logfilelog to a specified file, - for stdouthelp
--loggerA fully-qualified name to a log observer factory to use for the initial log observer.help
-n, --nodaemondon't daemonize, don't use default umask of 0077help
-o, --no_savedo not save state on shutdownhelp
--originalnameDon't try to change the process namehelp
-p, --profileRun in profile mode, dumping results to specified file.help
--pidfileName of the pidfile [default: twistd.pid]help
--prefixuse the given prefix when syslogging [default: twisted]help
--profilerName of the profiler to use (profile, cprofile).help
-r, --reactorWhich reactor to use (see --help-reactors for a list of possibilities)help
-s, --sourceRead an application from a .tas file (AOT format).help
--savestatssave the Stats object rather than the text output of the profiler.help
--spewPrint an insanely verbose log of everything that happens.help
--syslogLog to syslog, not to filehelp
-u, --uidThe uid to run as.help
--umaskThe (octal) file creation mask to apply.help
--versionPrint version information and exit.help
-y, --pythonread an application from within a Python file (implies -o)help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.