diff options
| author | Gustav Sörnäs <gustav@sornas.net> | 2020-10-09 03:31:46 +0200 |
|---|---|---|
| committer | Gustav Sörnäs <gustav@sornas.net> | 2020-10-09 03:31:46 +0200 |
| commit | e94d79cf06590d9e2695c60c1139a590298890fc (patch) | |
| tree | ea3644dcf7d75a2d3e9bdbbccd2a2a615de37b84 | |
| parent | 3d8688718c1bd7bb07526a4acbd72498556ccbde (diff) | |
| download | mum-e94d79cf06590d9e2695c60c1139a590298890fc.tar.gz | |
update usage.org
| -rw-r--r-- | usage.org | 30 |
1 files changed, 16 insertions, 14 deletions
@@ -1,21 +1,24 @@ -This file contains the current targeted usage. +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 Start the daemon with either one of: -- `$ mumd` for debugging -- `$ mumd &|` (disowning) +- `$ mumd`. Writes to stdout, ignores stdin. Can easily be disowned/started in + a screen/tmux. + +We want to support / explain how to do the following at some point: + - `$ mumd --daemon` - systemd-service -- Run in a `screen`/`tmux`/... -- Other ways of keeping a binary running -The daemon doesn't do anything by itself. Interface using `mumctl`. +The daemon doesn't do anything by itself. Interfacing with it is done through +`mumctl`. * Basic commands -** server -*** connect +** TODO server +*** TODO connect #+BEGIN_SRC bash $ mumctl server connect localhost connecting to localhost... @@ -25,8 +28,8 @@ root │ some person | you #+END_SRC -** channel -*** list +** TODO channel +*** TODO list #+BEGIN_SRC bash $ mumctl channel list root [3](4) @@ -44,6 +47,7 @@ root [3](4) someone eating food #+END_SRC +**** TODO --short #+BEGIN_SRC bash $ mumctl channel list --short root [3](4) @@ -53,15 +57,13 @@ root [3](4) │ └─ subsubchannel [2] └─ AFK [1] #+END_SRC - -*** connect +*** TODO connect #+BEGIN_SRC bash $ mumctl channel connect some channel connecting to some channel... connected #+END_SRC - -** status +** TODO status #+BEGIN_SRC bash $ mumctl status connected to localhost:65837 |