MUMCTL(1)

πŸ“¦ version 0.5.1, in nixos 26.05, nixpkgs unstable

🌸 mumctl(1) β€” the mumd(1) controller, bestie edition 🌸

okay so you're looking at mumctl in the manual pages β€” yes, that's mumctl(1), manual section 1, and trust me, this one's a whole vibe πŸ’…

mumctl [OPTIONS] SUBCOMMAND [ARG...]

✨ NAME ✨

mumctl β€” the controller for mumd(1) πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

mumctl [OPTIONS] SUBCOMMAND [ARG...]

πŸ’– DESCRIPTION πŸ’–

So mumctl is literally a CLI controller for mumd(1) β€” and mumd(1) is a client daemon for Mumble, which is a free and open source voice chat system. that's the whole thing. you talk to the daemon, the daemon talks to Mumble, everyone's happy 🫢


⭐ OPTIONS ⭐

  • -h, --help β€” prints help information. your little safety net, we love her πŸ’«
  • --version β€” prints version information. iconic.
heads up bestie: the subcommands have their own extra options too, so keep scrolling πŸ‘€

πŸ‘‘ SUBCOMMANDS πŸ‘‘

mumctl channel connect NAME

Hop into another channel. just like, walk in. main character entrance only πŸšͺ✨

mumctl channel list [-s|--short]

Lists all the channels in the server you're connected to. the -s/--short variant keeps it snappy.

mumctl completions [bash|fish|zsh]

Generates a completion file for whichever shell you name β€” bash, fish, or zsh. tab-completion slay πŸ”₯

mumctl config KEY VALUE

Sets a configuration value in the mumd(1) configuration file.

see mumdrc(5) for the available keys and what they actually mean πŸ‘€

mumctl config-reload

Forces the configuration file to reload β€” use this when you edited it externally, like some kind of rogue config goblin πŸ™ˆ

mumctl connect HOST [-p|--port PORT] [--accept-invalid-cert] [USERNAME] [PASSWORD]

Connects you to a server on the specified port. let's gooo 🌈

  • HOST can be either the name of a saved server in the config file or an IP/URL β€” and if you go the IP/URL route, you gotta pass a username as well. no username, no entry, sorry babe.
  • -p, --port PORT β€” the port.
  • --accept-invalid-cert β€” accept an invalid certificate. it's giving "living dangerously" πŸ’€
  • If the port is omitted, it defaults to 64738. memorise her.

mumctl deafen

Deafens you. bye to the noise 🎧

mumctl disconnect

Disconnects from the server you're currently connected to. it's not a vibe, it's a goodbye 😭

mumctl events

Prints a list of events that have occured. the lore, the timeline, the receipts 🧾

mumctl help

Shows a help message. she's helpful, she's humble, she's a legend.

mumctl message channel [-r|--recursive] MESSAGE [CHANNEL...]

Sends a message to all the channels you list in CHANNEL....

  • If --recursive (-r) is set, the message also goes out to all subchannels. every last one. no channel left behind πŸ“£
  • If you give no channels at all, the message goes to the channel you're currently connected to. comfy default, love that for you πŸ’–

mumctl message user MESSAGE USER...

Sends a message to one or more users. slide into those DMs, respectfully πŸ’Œ

mumctl messages [-f|--follow]

Prints all the messages received since the last time you ran this command. the missed-messages recap, the group chat catch-up ✨

  • With --follow (-f), it waits for new messages and prints them as they come in. to escape this loop, hit ctrl+C β€” not me getting stuck in a --follow loop, couldn't be me 🫠

mumctl mute [USER]

Mutes yourself or someone else.

  • No USER? you mute yourself. self-care πŸŽ€
  • Got a USER? that user gets muted. respectfully. πŸ’…

mumctl server add NAME HOST [--port PORT] [USERNAME] [PASSWORD]

Adds a brand new saved server configuration. new server, new era πŸ‘‘

mumctl server config SERVER KEY VALUE

Configures a variable inside a saved server configuration.

see mumdrc(5) for the available keys πŸ“–

mumctl server list

Lists all your saved servers and how many connections each one has. the full roster 🧚

mumctl server remove NAME

Removes a saved server. it's over, she's gone πŸ’”

mumctl server rename OLD_NAME NEW_NAME

Renames a saved server. rebrand era 🌟

mumctl status

Shows the channel and server you're currently connected to. the "where am I" check-in πŸ“

mumctl undeafen

Undeafens you. welcome back to the sound, king πŸ‘‚

mumctl unmute [USER]

Unmutes yourself or someone else.

  • No USER? you unmute yourself. 🫢
  • Got a USER? that user gets unmuted. the comeback arc πŸ’«

mumctl volume VOLUME

Sets the volume of your outgoing audio. 1.0 is the default β€” that's the baseline, the reference point, the moment 🎚️

mumctl volume USER VOLUME

Sets the volume of another user's incoming audio. 1.0 is the default here too. turn your friends up, turn your friends down, you're the DJ now 🎧πŸ”₯


πŸŽ€ AUTHORS πŸŽ€

Gustav SârnÀs and Eskil Queseth. the co-founders of the vibe, we stan 🫢


πŸ’€ REPORTING BUGS πŸ’€

Please report bugs to the Github repository at https://github.com/mum-rs/mum/ or by e-mail to gustav@sornas.net. spotted a bug? don't suffer in silence bestie, tell them πŸ’Œ


🌸 SEE ALSO 🌸

mumd(1), mumdrc(5) β€” read those too, iykyk πŸ“šβœ¨


okay so that's the whole page πŸ’– this was mumctl from mumctl 1, dated 2022-10-03 β€” go forth and control your daemon, bestie, you're gonna absolutely ate it πŸ‘‘πŸ’…

πŸ“¦ where this page comes from