SUPERNOVA(1)

πŸ’– SUPERNOVA β€” the manual, but make it cute πŸ’–

okay so bestie, you typed man supernova and now you're here, and honestly? iconic of you. this page lives in the General Commands Manual, section 1, and it's about supernova, the audio server of SuperCollider. yes, that SuperCollider. the real-time audio synthesis one. let's go πŸ¦‹


✨ NAME ✨

supernova β€” the SuperCollider audio synthesis server. that's it, that's the whole name. short. slay. πŸ’…


🌸 SYNOPSIS 🌸

supernova [options]

that's it. that's the summoning ritual. options go in, sound comes out. periodt ✨


πŸ’œ DESCRIPTION πŸ’œ

okay so, real talk: SuperCollider is a real time audio synthesis programming language. real time. as in, it does not wait. it does not chill. it does the thing while the thing is happening.

this manual page documents, briefly, the supernova command β€” which is the audio server of SuperCollider. it's the part that actually makes the noises while you vibe in the language part. bestie energy: one of them writes the poetry, the other one screams it into your speakers πŸ”₯

SuperCollider also has documentation in the HTML format, and it's chilling in the supercollider-doc package. go look, iykyk πŸ“šβœ¨


πŸŽ€ OPTIONS πŸŽ€

here's the summary of options, and listen β€” there's a rule, so pay attention:

⚠️ you must have a -u and/or a -t option, or -N for nonrealtime. there is no fourth option. there is no vibing without one of those. choose your fighter 🫢
  • -u <udp-port-number> β€” a port number (0–65535). pick wisely bestie πŸ’«
  • -t <tcp-port-number> β€” a port number (0–65535). yes, same range. yes, they're different protocols. no, we don't need to get into it right now 😌
  • -c <number-of-control-bus-channels> β€” default 4096. that's a LOT of control bus channels. go off πŸŽ›οΈ
  • -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. it's a yes/no, 1 or 0, that's the whole vibe πŸ’€
  • -R <publish to Rendezvous? 1 or 0> β€” default 1. again with the 1 or 0. Rendezvous gets a yes by default 🫢
  • -l <max-logins> β€” default 64. this one's doing double duty, bestie:
    • maximum number of named return addresses stored
    • also maximum number of tcp connections accepted
  • -p <session-password> β€” okay so when you're using TCP, the session password must be the first command sent. the default is no password. and listen: UDP ports never require passwords, so for security, use TCP. like, fr fr. πŸ”
  • -N <cmd-filename> <input-filename> <output-filename> <sample-rate> <header-format> <sample-format> β€” the nonrealtime mode. six whole arguments. she's high maintenance and she's worth it πŸ’…
  • -L β€” enable memory locking. lock it in πŸ”’
  • -H <hardware-device-name> β€” tell her which hardware device to use, queen πŸ‘‘
  • -v <verbosity> β€” how chatty is she feeling?
    • 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. and this part matters: if -U is specified, the standard paths are NOT searched for plugins. like, at all. you overrode it. own that πŸ¦‹
  • -P <restricted-path> β€” if you specify this, it prevents file-accessing OSC commands from accessing files outside <restricted-path>. it's giving protective bestie energy, and honestly? we love a boundary 🌸

😭 TO QUIT 😭

to quit, send a quit command via UDP or TCP, or press ctrl-C.

that's it. that's how you leave the party. say quit, or hit ctrl-C like a person in a hurry. no long goodbyes πŸ’€


πŸ‘€ SEE ALSO πŸ‘€

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

go read those too. be a well-rounded server bestie πŸ“šβœ¨


🫢 AUTHOR 🫢

this manual page was written by Paul Brossier <piem@altern.org> for the Debian project (but may be used by others).

Modified and updated by Artem Popov <artfwo@gmail.com>.

two authors. a collaboration. we love to see it πŸ’–


and that's the whole page, bestie!! this version is from Nov 18, 2008, and it's the SUPERNOVA(1) page from the General Commands Manual β€” shoutout to 2008 for being this ahead of its time. now go make some sounds, you main character πŸ”₯πŸ‘‘πŸ’