roarpluginrunner(1)

📦 version 1.0~beta12, in ubuntu jammy

💖 NAME 💖

okay so bestie, meet roarpluginrunner — the System User's Manual: roarpluginrunner girlie whose whole job is running RoarAudio plugins. that's the tea. 🫶

✨ SYNOPSIS ✨

roarpluginrunner [OPTIONS]... PLUGIN

🦋 DESCRIPTION 🦋

so this tool? it either runs RoarAudio plugins or reports info about them. roarpluginrunner loads your plugins into a plugin container with whatever parameters you handed it. which means you can run all the universal plugins, plus a bunch of other plugins, outside a specific host. it's also genuinely great for testing plugins. lowkey iconic. 💅

there are three modes of operation: Running, Running as application, and Explaining.

Running is the one most host applications do. standard. no drama.

Running as application is different in that all the parameters left on the command line after the plugin name get parsed and passed to the plugin as plugin arguments.

in this mode, the parameters passed after the plugin name get split into key-value-pairs, like so:

  • an option beginning with two dashes is passed as a pair with the option name (the dashes removed) as the key and no value. if it contains an equality sign, the part after it is passed as the value.
  • options with a single dash get split — each letter becomes its own key-value-pair with only the key set.
  • non-option arguments (the ones with no dashes at all) are passed as value-only pairs.
  • after a pure double dash, all parameters are passed as non-options, with the double dash completely removed from the key-value-array.

in explain mode, the plugin gets loaded but not run. the meta information about the plugin gets reported instead. that includes true meta data like the name, authors and copyright, but also technical meta data like the name of the host application the plugin is written for. it's giving ✨receipts✨.

when the plugin uses symbols from the host directly, the plugin may not be loadable into roarpluginrunner, because of the system's library loader limits. on GNU/Linux (and other POSIX like implementations) this is only true if the plugin uses global variables of the host. plugins that use functions of the host can still be loaded in this mode. so like, know the difference bestie 😭

👑 OPTIONS 👑

  • -h, --help — prints a help message. bestie behaviour honestly.
  • -v, --verbose — be verbose. can be used multiple times (stack it, queen 👑).
  • --server SERVER — set the default server to SERVER.
  • --run — run the plugin.
  • --run-as-application — same as --run, except all tailing arguments are passed to the plugin. this is also the one used by roarpluginapplication(1).
  • --explain — explain the plugin. this lists all the details about the plugin without actually running it.
  • --appname NAME — sets the appname.
  • --abiversion ABI — set the ABI version.
  • --args ARGS — set plugin arguments.

🎀 RUNNER OPTIONS 🎀

  • --option-touch — do not keep the plugin running: do a single UPDATE cycle. one and done, periodt.
  • --option-no-touch — disable the touch option.
  • --option-about — show an about dialog after startup.
  • --option-no-about — disable the about option.
  • --option-help — show onlion help after startup.
  • --option-no-help — disable the help option.
  • --option-preferences — show the preferences dialog after startup.
  • --option-no-preferences — disable the preferences option.

🌈 CPI OPTIONS 🌈

  • -t, --tcp — use a TCP listen socket.
  • -u, --unix — use a UNIX Domain listen socket (default, iykyk).
  • -n, --decnet — use a DECnet listen socket.
  • --port PORT — TCP Port to bind to. only in case of TCP listen sockets.
  • --bind ADDR — Node/Hostname/Path to bind to.
  • --proto PROTO — use PROTO as the protocol on a listen or client socket.
  • --new-sock — parameters for the new socket follow.
  • --client-fh FH — comunicate with a client over this handle.

💀 BUGS 💀

--client-fh may not work as expected. 🙈 not me warning you though, it's right there in the manpage.

🦋 SEE ALSO 🦋

🌸 HISTORY 🌸

for history information see RoarAudio(7).

and that's the whole page, bestie 💖 this gorgeous little thing comes to you from RoarAudio, stamped with the date FIXME(DATE), and filed under roarpluginrunner(1) in the System User's Manual: roarpluginrunner. go run some plugins, you main character 🎀✨🫶

📦 where this page comes from