diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/mumctl.1 | 37 | ||||
| -rw-r--r-- | documentation/mumctl.txt | 31 |
2 files changed, 40 insertions, 28 deletions
diff --git a/documentation/mumctl.1 b/documentation/mumctl.1 index e875fd7..8d8ba72 100644 --- a/documentation/mumctl.1 +++ b/documentation/mumctl.1 @@ -2,12 +2,12 @@ .\" Title: mumd .\" Author: [see the "AUTHOR(S)" section] .\" Generator: Asciidoctor 2.0.15 -.\" Date: 2021-06-06 +.\" Date: 2021-06-08 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "MUMCTL" "1" "2021-06-06" "\ \&" "\ \&" +.TH "MUMCTL" "1" "2021-06-08" "\ \&" "\ \&" .ie \n(.g .ds Aq \(aq .el .ds Aq ' .ss \n[.ss] 0 @@ -94,11 +94,31 @@ mumctl disconnect 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 message channel [\-r|\-\-recursive] <message> [<channel>...] +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. +If no channels are given the message is sent to the channel currently +connected to. +.sp +mumctl message user <message> <users> +Sends a message to all users specified in the list of users. +.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 mute [user] .RS 4 Mute yourself or someone else. @@ -157,19 +177,6 @@ mumctl volume <user> set <volume> 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. diff --git a/documentation/mumctl.txt b/documentation/mumctl.txt index e513255..1c8ee8f 100644 --- a/documentation/mumctl.txt +++ b/documentation/mumctl.txt @@ -58,9 +58,27 @@ mumctl deafen :: mumctl disconnect :: Disconnect from the currently connected server. +mumctl events :: + Print all events that have occured since mumd was started. + mumctl help :: Show a help message. +mumctl message channel [-r|--recursive] <message> [<channel>...] + 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. + If no channels are given the message is sent to the channel currently + connected to. + +mumctl message user <message> <users> + Sends a message to all users specified in the list of users. + +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. + mumctl mute [user] :: Mute yourself or someone else. If user is omitted, you mute yourself. Otherwise, the user with the username [user] is muted. @@ -98,19 +116,6 @@ mumctl volume <user> set <volume> :: Set the volume of another user's incoming audio. 1.0 is the default. -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. - -mumctl message user <message> <users> - Sends a message to all users specified in the list of users. - -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. - Authors ------- |