diff options
| author | Gustav Sörnäs <gustav@sornas.net> | 2021-04-03 11:30:04 +0200 |
|---|---|---|
| committer | Gustav Sörnäs <gustav@sornas.net> | 2021-04-03 11:44:21 +0200 |
| commit | 989b3f6d858ecde8e08c923db528bb0116e1a91c (patch) | |
| tree | c7194884480d2f430e5837cef5faaceac392ef6c /documentation | |
| parent | e173cb3bfee0a5aad1a615957e4519c63519c09e (diff) | |
| download | mum-989b3f6d858ecde8e08c923db528bb0116e1a91c.tar.gz | |
update mumctl documentation
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/mumctl.1 | 20 | ||||
| -rw-r--r-- | documentation/mumctl.txt | 14 |
2 files changed, 17 insertions, 17 deletions
diff --git a/documentation/mumctl.1 b/documentation/mumctl.1 index 2752ad6..16360bb 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.12 -.\" Date: 2021-03-29 +.\" Date: 2021-04-03 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "MUMCTL" "1" "2021-03-29" "\ \&" "\ \&" +.TH "MUMCTL" "1" "2021-04-03" "\ \&" "\ \&" .ie \n(.g .ds Aq \(aq .el .ds Aq ' .ss \n[.ss] 0 @@ -66,9 +66,9 @@ mumctl completions [\-\-bash|\-\-fish|\-\-zsh] Generate a completion file for the specified shell. .RE .sp -mumctl config <name> <value> +mumctl config <key> <value> .RS 4 -Set a configuration value in the mumd(1) config\-file. +Set a configuration value in the mumd(1) config\-file. See mumdrc(5). .RE .sp mumctl config\-reload @@ -76,10 +76,10 @@ mumctl config\-reload Force a reload of the configuration file (e.g. after editing it externally. .RE .sp -mumctl connect [\-p|\-\-port <port>] <host> [username] +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 or a URL (in which case username needs to be passed +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 @@ -105,12 +105,12 @@ 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 [\-\-password <password>] [\-\-port <port>] [\-\-username <username>] [<name>] <host> +mumctl server add <name> <host> [\-\-port <port>] [<username> | <username> <password>] .RS 4 Add a saved server configuration. .RE .sp -mumctl server config <server> <name> <value> +mumctl server config <server> <key> <value> .RS 4 Configure a variable in a saved server configuration. .RE @@ -163,9 +163,9 @@ Gustav Sörnäs and Eskil Queseth. .SH "REPORTING BUGS" .sp Please report bugs to the Github repository at \c -.URL "https://github.com/sornas/mum/" "" +.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) +mumd(1), mumdrc(5)
\ No newline at end of file diff --git a/documentation/mumctl.txt b/documentation/mumctl.txt index 5b1607c..b9f083f 100644 --- a/documentation/mumctl.txt +++ b/documentation/mumctl.txt @@ -40,15 +40,15 @@ mumctl channel list :: mumctl completions [--bash|--fish|--zsh] :: Generate a completion file for the specified shell. -mumctl config <name> <value> :: - Set a configuration value in the mumd(1) config-file. +mumctl config <key> <value> :: + Set a configuration value in the mumd(1) config-file. See mumdrc(5). mumctl config-reload :: Force a reload of the configuration file (e.g. after editing it externally. -mumctl connect [-p|--port <port>] <host> [username] :: +mumctl connect <host> [-p|--port <port>] [username] :: Connect to a server on the specified port. The host may be either the name - of a saved server or an IP or a URL (in which case username needs to be passed + 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. @@ -65,10 +65,10 @@ mumctl mute [user] :: Mute yourself or someone else. If user is omitted, you mute yourself. Otherwise, the user with the username [user] is muted. -mumctl server add [--password <password>] [--port <port>] [--username <username>] [<name>] <host> :: +mumctl server add <name> <host> [--port <port>] [<username> | <username> <password>] :: Add a saved server configuration. -mumctl server config <server> <name> <value> :: +mumctl server config <server> <key> <value> :: Configure a variable in a saved server configuration. mumctl server list :: @@ -106,7 +106,7 @@ Gustav Sörnäs and Eskil Queseth. Reporting bugs -------------- -Please report bugs to the Github repository at https://github.com/sornas/mum/ +Please report bugs to the Github repository at https://github.com/mum-rs/mum/ or by e-mail to gustav@sornas.net. See also |
