blob: d819fcdd4f6ab74aca2392077c1f0b559b788e78 (
plain) (
blame)
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
|
* mum
Mumble daemon with controller (think mpd(1)/mpc(1)) written in Rust.
** Building
mumd and mumctl are available on crates.io and can be installed with
#+BEGIN_SRC sh
$ cargo install mumd
$ cargo install mumctl
#+END_SRC
They are also available
[[https://aur.archlinux.org/packages/mum-git/][available on the AUR]]. We also
publish [[https://github.com/sornas/mum/releases][compiled binaries on Github].
*** Requirements
These are for Arch Linux. You might need other packages on other distributions
and operating systems, or they might be named something different.
- rust (stable)
- alsa-lib
- openssl
- opus
- libnotify (optional)
Windows is not currently supported but could be in the future. macOS should work.
Other operating systems haven't been tested. The limiting factor on Windows
is IPC communication which is (currently) done via the crate ipc-channel.
*** Installation
1. Build the binaries
2. (wait)
3. Copy/symlink to somewhere nice (or don't).
#+BEGIN_SRC sh
$ cargo build --release
$ ln -s $PWD/target/release/mumctl $HOME/.local/bin/
$ ln -s $PWD/target/release/mumd $HOME/.local/bin/
#+END_SRC
*** Optional features
mum contains optional features that are enabled by default. To compile without
them, build with --no-default-features. Features can then be enabled with
--features "FEATURES".
The following features can be specified:
| Name | Needed for |
|--------------------+---------------+
| mumd/notifications | Notifications |
Awaiting -Z package-features, changing which features are compiled requires
you to compile mumd/ separately by entering its directory and specifying
its features.
To summarize with an example, the following compiles with only the
notifications-feature enabled.
#+BEGIN_SRC sh
$ cd mumd
$ cargo build --release --no-default-features --features "notifications"
$ cd ../mumctl
$ cargo build --release
#+END_SRC
*** man-pages
Man-pages for mumd, mumctl and mumdrc (the configuration file) are included as
both asciidoc txt-files and already formatted groff-files. They are generated
with
#+BEGIN_SRC
$ asciidoctor -b manpage *.txt
#+END_SRC
** Usage
This describes how to connect to a server and join different channels.
See mumctl --help or documentation/*.txt for more information.
*** mumd
Start the daemon with mumd. Currently it attaches to the terminal, so if you
want to run it in the background you can detach it with e.g. (zsh):
#+BEGIN_SRC sh
$ mumd &>/dev/null &|
#+END_SRC
Somewhere down the line we're aiming to have a --daemonize.
*** mumctl
Interfacing with the daemon is done through mumctl. Some examples:
#+BEGIN_SRC sh
$ mumctl connect 127.0.0.1 spock # connect to 127.0.0.1 with username 'spock'
$ mumctl channel list
ServerRoot
-user1
-user2
-user2
Channel2
Channel3
$ mumctl channel connect Channel2
#+END_SRC
** Why?
Mostly because it's a fun way of learning a new language. Also:
- Most mumble clients use a GUI. While GUIs aren't necessarily bad, there
should at least exist alternatives where possible.
- Memory and disk footprint. We haven't found a reliable way of testing memory
yet (suggestions welcome).
** Other projects
- [[https://github.com/bmmcginty/barnard.git][Barnard (go)]] - TUI mumble client
|
