rpld(1)

📦 version 0.1.9, in ubuntu jammy

💖 rpld — the RoarAudio PlayList Daemon, bestie edition 💖

okay so you're reading the manual page for rpld (that's section 1 of the System User's Manual, for the record), and honestly? she's a lot. but she's also iconic, so let's get into it. 🎀

✨ NAME ✨

rpld — the RoarAudio PlayList Daemon. say it with your chest. 👑

🦋 SYNOPSIS 🦋

rpld [OPTIONS]

that's it. that's the whole vibe. options only, no positional args, we're not doing all that. 💅

🌸 DESCRIPTION 🌸

so rpld is a daemon — meaning she runs in the background and minds her own business like a main character — and what she does is manage playlists. and then, because she's not like other daemons, she can also play files or streams from those lists using a RoarAudio Sound Server. no cap. literally the whole job. 🫶

🎀 MISC OPTIONS 🎀

the general-purpose section. the "everything bagel" of flags.

  • -h, --help — shows a small help. tiny help. bite-sized. a lil snack of documentation. 🍓
  • --daemon — daemonize, aka go into the background like she just left the group chat. 🚪
  • --watchdog — start the watchdog. this will automatically terminate the daemon if it stops responding. she's got a babysitter and the babysitter has zero chill. 👀
  • --server SERVER — set the default server to the RoarAudio server (e.g. roard) at SERVER.
  • --server-queue SERV — the server to use for the Main Queue. normally you should just use --server though. fr fr.
  • --server-info SERV — copies the serverinfo data from the given server. use +default as the server to pull the data from the default server. the following data gets copied over: location, description, contact, serial and uiurl. a full glow-up transplant. ✨
  • --pidfile PIDFILE — write a pidfile at PIDFILE.
  • --histsize NUM — set the size of the default history playlist to NUM entries. heads up: this may be overwritten by restoring a store. the special value "default" can be used to not alter the value — init scripts use that to keep the default. so if you're an init script, be cool. 🧊
  • --location LOC — sets the lion-readable location of the server. examples: livingroom, room 32. yes, lion-readable. the lions are reading. 🦁
  • --description DESC — sets the lion-readable description of the server. examples: Stereo, UKW Transmitter.
  • --contact CONTACT — sets contact information for the server. so people can reach her. she's available. 💌
  • --serial SERIAL — sets the serial number for this device or server. normally only used by embedded systems. 🫡
  • --uiurl UIURL — sets the URL of the user interface for this device or server. normally only used by embedded systems. it's common to set this to an HTTP-type URL, but all protocols are considered valid — including ssh, telnet and others. she's open-minded like that.
  • --plugin-load PLUGIN — load plugin PLUGIN.
  • --plugin-args ARGS — set the plugin arguments for the plugin loaded next to ARGS. ⚠️ this must always be used before --plugin-load. order matters, bestie. it's giving prerequisites.

🔒 SECURITY OPTIONS 🔒

the "please be normal about privileges" section. 🌈

  • --user USER — sets UID to USER.
  • --group GROUP — sets GID to GROUP.
  • --allow-running-as-root — allows one to run as root.
🚨 okay STOP. this is a bad thing to do. do never set this option. this will open very bad security holes! do not do it. do not pass go. do not collect $200. i'm not being dramatic, the manual is being dramatic, and the manual is right. 💀

💾 STORE OPTIONS 💾

for when she needs to remember things (or conveniently forget them). 🧠

  • --restore — restore state from store.
  • --no-restore — do not restore state from store.
  • --auto-restore — will restore old state if possible. this is a non-fatal version of --restore. she'll try, she won't make it weird if it doesn't work. 🙈
  • --store — store state on exit.
  • --no-store — do not store state on exit.
  • --store-path DIR — the location where to store/restore from/to.

🎧 PLAYBACK OPTIONS 🎧

the "what is she doing when she wakes up" section. ⭐

  • --play — start in playing state. (the original spells it "playling", and honestly? same energy. 🔥)
  • --stopped — start in stopped state. this is the default.
  • --no-default-queue — do not create a default queue. if this is set, and no store is loaded or the loaded store doesn't contain any queues itself, then rpld will not connect to any RoarAudio server at startup at all. this is mainly for debugging and testing. 🧪
  • --role ROLE — set the role for streams (default: music). the special value "default" can be used to use the default. very meta of her.
  • --codec-helper-rate RATE — set the sample rate the codec helper uses as its output format.
  • --codec-helper-bits BITS — set the number of bits the codec helper uses as its output format.
  • --codec-helper-channels CHANNELS — set the number of channels the codec helper uses as its output format.
  • --codec-helper-codec CODEC — set the codec the codec helper uses as its output format.

🎵 PLAYLIST OPTIONS 🎵

where the playlists actually happen. the moment. 💜

  • --playlist-import PLAYLIST TYPE FILE — load playlist PLAYLIST of type TYPE from file FILE. the playlist is created if it does not exist. manifesting works. ✨
  • --playlist-export PLAYLIST TYPE FILE — save playlist PLAYLIST to file FILE in format TYPE.
  • --load-playlist PLAYLIST TYPE FILE — the old name of --playlist-import. should not be used. she's retired, let her rest. 😴

🌐 NETWORK OPTIONS 🌐

sockets, sockets, and more sockets. she's social. 🦋

  • --tcp — listen on a TCP Socket.
  • --unix — listen on a UNIX Socket.
  • --decnet — listen on a DECnet Socket.
  • --port PORT — listen on port PORT. this is only useful for TCP listen sockets.
  • --bind ADDR — listen on address ADDR.
  • --proto PROTO — set the protocol of the listen socket.
  • --acclev LEV — sets the accesslevel for this socket to LEV.
  • --new-sock — opens an additional listen socket. more sockets, more problems, more slay.
  • --slp — enable OpenSLP support.
  • --no-listen — do not add a default listening socket. this option is in general not very useful for any user. it's only useful for special tests and with --client-fh. so like, niche. iykyk.
  • --client-fh FH — adds a client at the given FH to rpld. again: in general not very useful for any user. 🙃
  • --close-fh FH — this closes a given FH at startup time. and once more for the people in the back: in general not very useful for any user.

🎛️ CODEC OPTIONS 🎛️

short section, big energy.

  • --bl-codec CODEC — use the helper for codec CODEC.

👀 SEE ALSO 👀

go read these too, they're the extended universe:

📜 HISTORY 📜

for history information, see RoarAudio(7). she contains multitudes. 💖

and that's the whole page, bestie. RoarAudio PlayList Daemon, from July 2010 — yeah, she's a 2010s baby and she's still serving. 💅✨ ily, go read roartips(7). 🫶🎀
📦 where this page comes from