1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
'\" t
.\" Title: mumd
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.15
.\" Date: 2021-06-08
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "MUMCTL" "1" "2021-06-08" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
. mso www.tmac
. am URL
. ad l
. .
. am MTO
. ad l
. .
. LINKSTYLE blue R < >
.\}
.SH "NAME"
mumctl \- mumd(1) controller
.SH "SYNOPSIS"
.sp
mumctl <subcommand> [<args>]
.SH "DESCRIPTION"
.sp
mumctl is a CLI controller for mumd(1), a client daemon for Mumble, a free and
open source voice chat system.
.SH "OPTIONS"
.sp
\-h, \-\-help
.RS 4
Prints help information.
.RE
.sp
\-\-version
.RS 4
Prints version information.
.RE
.sp
Subcommands contain additional options.
.SH "SUBCOMMANDS"
.sp
mumctl channel connect <name>
.RS 4
Connect to another channel.
.RE
.sp
mumctl channel list
.RS 4
List all channels in the connected server.
.RE
.sp
mumctl completions [\-\-bash|\-\-fish|\-\-zsh]
.RS 4
Generate a completion file for the specified shell.
.RE
.sp
mumctl config <key> <value>
.RS 4
Set a configuration value in the mumd(1) config\-file. See mumdrc(5).
.RE
.sp
mumctl config\-reload
.RS 4
Force a reload of the configuration file (e.g. after editing it externally.
.RE
.sp
mumctl connect <host> [\-p|\-\-port <port>] [username]
.RS 4
Connect to a server on the specified port. The host may be either the name
of a saved server or an IP/URL (in which case username needs to be passed
as well).
If omitted, the port defaults to 64738.
.RE
.sp
mumctl deafen
.RS 4
Deafen yourself.
.RE
.sp
mumctl disconnect
.RS 4
Disconnect from the currently connected server.
.RE
.sp
mumctl events
.RS 4
Print all events that have occured since mumd was started.
.RE
.sp
mumctl help
.RS 4
Show a help message.
.RE
.sp
mumctl mute [user]
.RS 4
Mute yourself or someone else.
If user is omitted, you mute yourself. Otherwise, the user with the username [user] is muted.
.RE
.sp
mumctl server add <name> <host> [\-\-port <port>] [<username> | <username> <password>]
.RS 4
Add a saved server configuration.
.RE
.sp
mumctl server config <server> <key> <value>
.RS 4
Configure a variable in a saved server configuration.
.RE
.sp
mumctl server list
.RS 4
List all saved servers and how many are connected to them.
.RE
.sp
mumctl server remove <name>
.RS 4
Remove a saved server.
.RE
.sp
mumctl server rename <old name> <new name>
.RS 4
Rename a saved server.
.RE
.sp
mumctl status
.RS 4
Show the currently conneced channel and server.
.RE
.sp
mumctl undeafen
.RS 4
Undeafen yourself.
.RE
.sp
mumctl unmute [user]
.RS 4
Unmute yourself or someone else.
If user is omitted, unmute yourself. Otherwise, the user with the username [user] is unmuted.
.RE
.sp
mumctl volume set <volume>
.RS 4
Set the outgoing volume level.
1.0 is the default.
.RE
.sp
mumctl volume <user> set <volume>
.RS 4
Set the volume of another user\(cqs incoming audio.
1.0 is the default.
.RE
.sp
mumctl messages [\-f|\-\-follow]
Prints all received messages since mumd was started, or since this command last was issued,
whichever happens first.
If the follow flag is set, mumctl will instead wait for new messages to come in and print
them as they come in. To exit this loop, issue a Ctrl\-C.
.sp
mumctl message user <message> <users>
Sends a message to all users specified in the list of users.
.sp
mumctl message channel [\-r|\-\-recursive] <message> <channels>
Sends a message to all channels specified in the list of channels.
If the recursive flag is set, the message is also sent to all subchannels in a recursive manner.
.SH "AUTHORS"
.sp
Gustav Sörnäs and Eskil Queseth.
.SH "REPORTING BUGS"
.sp
Please report bugs to the Github repository at \c
.URL "https://github.com/mum\-rs/mum/" ""
or by e\-mail to \c
.MTO "gustav\(atsornas.net" "" "."
.SH "SEE ALSO"
.sp
mumd(1), mumdrc(5)
|
