diff options
| author | Gustav Sörnäs <gustav@sornas.net> | 2020-10-09 03:47:10 +0200 |
|---|---|---|
| committer | Gustav Sörnäs <gustav@sornas.net> | 2020-10-09 03:50:00 +0200 |
| commit | 3d230b594f297d10d0d8a0fadb3e4b15398bb644 (patch) | |
| tree | 3b838f41f02f3a2d993a7fd8add0b1cbf3ae7e7b /usage.org | |
| parent | e94d79cf06590d9e2695c60c1139a590298890fc (diff) | |
| download | mum-3d230b594f297d10d0d8a0fadb3e4b15398bb644.tar.gz | |
more commands
Diffstat (limited to 'usage.org')
| -rw-r--r-- | usage.org | 56 |
1 files changed, 52 insertions, 4 deletions
@@ -1,7 +1,7 @@ This file contains the current targeted usage. It works as both a design document and a feature tracker. New commands and flags go here. -* Basic usage overview +* Usage overview Start the daemon with either one of: @@ -17,16 +17,19 @@ The daemon doesn't do anything by itself. Interfacing with it is done through `mumctl`. * Basic commands +The basic commands are the smallest subset of commands that allow the user to +actually use mum for something. In this case it means connecting to a server, +listing channels and connecting to channels. ** TODO server *** TODO connect #+BEGIN_SRC bash -$ mumctl server connect localhost +$ mumctl server connect localhost your_name connecting to localhost... -connected +connected as your_name root │ another person │ some person -| you +| your_name #+END_SRC ** TODO channel *** TODO list @@ -81,3 +84,48 @@ you@localhost:65387/root (3) some person you #+END_SRC + +* More commands +** server +*** add +Add a server with a name: +#+BEGIN_SRC bash +$ mumctl server add 127.0.0.1 loopback +username: *** +password: *** +#+END_SRC + +Add a server without a name: +#+BEGIN_SRC bash +$ mumctl server add 127.0.0.1 +username: *** +password: *** +#+END_SRC + +Password can be skipped by entering blank. +*** list +#+BEGIN_SRC bash +$ mumctl server list +loopback [4 / 100] +127.0.0.1 [4 / 100] +127.0.0.3 [OFFLINE] +#+END_SRC +*** config +**** username +#+BEGIN_SRC bash +$ mumctl server config loopback set username xX_gamerboy_Xx +#+END_SRC +**** password +#+BEGIN_SRC bash +$ mumctl server config loopback set password *** +#+END_SRC + +Optionally ask stdin +#+BEGIN_SRC bash +$ mumctl server config loopback set password +enter password: *** +#+END_SRC +*** rename +#+BEGIN_SRC bash +$ mumctl server rename loopback my_server +#+END_SRC |
