Usage information

[vors.git] / cmd / client / main.go

diff --git a/cmd/client/main.go b/cmd/client/main.go
index d41b8d9987dc95236845cc7e2bdf8a9065bdd2b25d3cbaf947bd294be22db5e1..00ccce1ff5b449382a1d78a4211ae591444e7a2c878073648fd54a3d46b5a5f3 100644 (file)
--- a/cmd/client/main.go
+++ b/cmd/client/main.go
@@ -101,6 +101,25 @@ func main() {
                "Prefer obsolete legacy IPv4 address during name resolution")
        version := flag.Bool("version", false, "print version")
        warranty := flag.Bool("warranty", false, "print warranty information")
+       flag.Usage = func() {
+               fmt.Fprintln(os.Stderr, "Usage: vors-client [opts] -name NAME -pub PUB -srv HOST:PORT")
+               flag.PrintDefaults()
+               fmt.Fprintln(os.Stderr, `
+Press Tab to cycle through peers and chat windows. Pressing Enter in a
+peer window toggles silencing (no audio will be played from it). Chat
+windows allows you to enter the text and send it to everyone in the room
+by pressing Enter.
+
+Press F1 to toggle mute -- no sending of microphone audio to server).
+Press F10 to quit.
+
+Each peer contains various statistics: number of packets received from
+it (or sent, if it is you), traffic amount, number of silence seconds,
+number of bad packets (malformed or altered, number of lost packets,
+number of reordered packets. "TALK" means that recently an audio packet
+was received. "MUTE" means that peer is in muted mode. "SILENT" means
+that peer is locally muted.`)
+       }
        flag.Parse()
        log.SetFlags(log.Lmicroseconds)