SCSYNTH(1)

πŸ’– SCSYNTH(1) πŸ’–

okay bestie, so this is the General Commands Manual page for scsynth, and I'm gonna walk you through it like we're texting at 2am, except every single fact stays exactly where it was. no cap. 🫢


✨ NAME ✨

scsynth β€” the SuperCollider audio synthesis server. that's her. that's the whole vibe. πŸ‘‘


✨ SYNOPSIS ✨

scsynth [options]

🌸 DESCRIPTION 🌸

SuperCollider is a real time audio synthesis programming language. this manual page documents, briefly, the scsynth command β€” which is the audio server of SuperCollider. she's the one actually making the sounds while everybody else is over there writing code. main character energy fr fr. πŸŽ€

SuperCollider has documentation in the HTML format, and it's available in the supercollider-doc package. go read it, i'm literally begging. πŸ“š


πŸ’… OPTIONS πŸ’…

a summary of the options is included below, slay. There must be a -u and/or a -t option, or -N for nonrealtime. like, that's not optional, that's the rule. 😀

  • -u <udp-port-number> β€” a port number (0‐65535)
  • -t <tcp-port-number> β€” a port number (0‐65535)
  • -c <number-of-control-bus-channels> β€” default 4096
  • -a <number-of-audio-bus-channels> β€” default 128
  • -i <number-of-input-bus-channels> β€” default 2
  • -o <number-of-output-bus-channels> β€” default 2
  • -z <block-size> β€” default 64
  • -Z <hardware-buffer-size> β€” default 0
  • -S <hardware-sample-rate> β€” default 0
  • -b <number-of-sample-buffers> β€” default 1024
  • -n <max-number-of-nodes> β€” default 1024
  • -d <max-number-of-synth-defs> β€” default 1024
  • -m <real-time-memory-size> β€” default 8192
  • -w <number-of-wire-buffers> β€” default 64
  • -r <number-of-random-seeds> β€” default 64
  • -D <load synthdefs? 1 or 0> β€” default 1
  • -R <publish to Rendezvous? 1 or 0> β€” default 1
  • -l <max-logins> β€” default 64. maximum number of named return addresses stored. also the maximum number of tcp connections accepted. two jobs, one flag, she's multitasking. πŸ’
  • -p <session-password> β€” when using TCP, the session password must be the first command sent. the default is no password. UDP ports never require passwords, so for security use TCP. (yes, listen to that one, bestie. it's giving "i told you so" energy.) πŸ”
  • -N <cmd-filename> <input-filename> <output-filename> <sample-rate> <header-format> <sample-format> β€” the nonrealtime mode, and yes it takes six whole arguments, she's high maintenance but worth it. ✨
  • -L β€” enable memory locking. πŸ”’
  • -H <hardware-device-name> β€” pick your hardware device by name. 🎧
  • -v <verbosity> β€” how chatty she is:
    • 0 is normal behaviour
    • -1 suppresses informational messages
    • -2 suppresses informational and many error messages
  • -U <ugen-plugins-path> β€” a colon-separated list of paths. If -U is specified, the standard paths are NOT searched for plugins. like, at all. zero. she said what she said. πŸ’€
  • -P <restricted-path> β€” if specified, prevents file-accessing OSC commands from accessing files outside <restricted-path>. keeping her in her lane, respectfully. 🚧

πŸ¦‹ TO QUIT πŸ¦‹

to quit, send a 'quit' command via UDP or TCP, or press ctrl-C. that's it, that's the goodbye. no dramatic exit needed. 😭


🌈 SEE ALSO 🌈

  • sclang(1)
  • /usr/share/doc/supercollider-server

πŸ‘‘ AUTHOR πŸ‘‘

this manual page was written by Paul Brossier <piem@altern.org> for the Debian project (but may be used by others). okay so, generous queen. πŸ’–

Modified and updated by Artem Popov <artfwo@gmail.com>. two icons, one manpage, we love to see it. ⭐


and that's the whole thing!! this page is dated Nov 18, 2008, and it came out of the General Commands Manual for version SCSYNTH(1). mwah, go make some sounds, bestie. πŸ§šπŸ“πŸ’œ