Files
tuimble/docs/USAGE.md

29 lines
607 B
Markdown

# Usage
## Running
```sh
tuimble # uses ~/.config/tuimble/config.toml
tuimble --host mumble.example.com --user myname
```
## Key Bindings
| Key | Action |
|-----|--------|
| `F1` | Toggle self-deafen |
| `F4` | Push-to-talk (configurable) |
| `Enter` | Send message |
| `q` | Quit |
| `Ctrl+C` | Quit |
## Push-to-Talk Modes
- **toggle** — press to start, press again to stop (default)
- **hold** — hold key to transmit, release to stop (requires evdev)
## Configuration
See `~/.config/tuimble/config.toml`. All fields are optional;
defaults connect to localhost:64738.