Files
barnard/README.md

65 lines
1.7 KiB
Markdown

# barnard
barnard is a terminal-based client for the [Mumble](https://mumble.info) voice
chat software.
![Screenshot](https://i.imgur.com/B8ldT5k.png)
## Installation
Requirements:
1. [Go](https://golang.org/)
2. [Git](https://git-scm.com/)
3. [Opus](https://opus-codec.org/) development headers
4. [OpenAL](http://kcat.strangesoft.net/openal.html) development headers
To fetch and build:
git clone https://layeh.com/barnard
cd barnard
make build
Or install system-wide:
make install
The server password can be provided via the `MUMBLE_PASSWORD` environment
variable (preferred over the `-password` flag, which is visible in process
listings). Use `-password-prompt` to read the password interactively from
stdin.
## Options
- `-server host[:port]` — server to connect to (default: `localhost:64738`)
- `-username name` — client username
- `-password pass` — server password (prefer `MUMBLE_PASSWORD` env var)
- `-password-prompt` — prompt for password on stdin
- `-certificate path` — PEM encoded certificate and private key
- `-insecure` — skip server certificate verification
- `-tree-width n` — width of the channel tree pane (default: `20`)
- `-log path` — append chat messages to file
- `-debug` — enable debug logging to stderr
## Manual
### Key bindings
- <kbd>F1</kbd>: toggle deafen (mute + deaf)
- <kbd>F4</kbd>: toggle voice transmission
- <kbd>Ctrl+L</kbd>: clear chat log
- <kbd>Tab</kbd>: toggle focus between chat and user tree
- <kbd>Page Up</kbd>: scroll chat up
- <kbd>Page Down</kbd>: scroll chat down
- <kbd>Home</kbd>: scroll chat to the top
- <kbd>End</kbd>: scroll chat to the bottom
- <kbd>F10</kbd>: quit
## License
GPLv2
## Author
Tim Cooper (<tim.cooper@layeh.com>)