@node Usage
@unnumbered Usage

@itemize

@item
    Generate server's keypair. And share its public key among users.
    Fact of server's public key knowledge means ability to connect to it.

@example
$ vors-keygen | tee key | vors-keygen -pub | read pub
$ vors-server -key key -bind [2001:db8::1]:12978
@end example

@item
    Client uses external commands for reading from microphone and
    playing it back. By default it uses SoX'es @command{rec} and
    @command{play} commands.

    Pay attention that VoRS expects @strong{ONLY} one channel, 48kHz,
    16-bit signed little-endian audio format. Empty strings in
    @option{-rec}/@option{-play} options mean no recording/playback
    attempts.

    @command{-play} command is spawned for each participant. Your OS
    should mix their output together.

@item
    Start the client, providing server's public key and our username:

@example
$ vors-client -srv "[2001:db8::1]:12978" -pub $pub -name NAME
@end example

    Pressing F10 in server/client TUIs means quitting.
    Pressing F1 in client means "mute" toggling.
    Cycling through chat windows and peers in client is done by Tab.
    Pressing Enter on the peer silences it locally.

@item
    @option{-room} allows you to join non-root room.
    @option{-passwd} allows you to protect it with provided password.

@item
    @option{-mute-toggle} allows you to toggle mute by external
    utilities. For example you can use suckless minimalistic
    @url{https://github.com/baskerville/sxhkd, sxhkd} daemon to capture
    X11 key events and execute commands:

@example
$ mkfifo /tmp/vors-mute-toggle.fifo
$ cat >sxhkd.cfg <<EOF
XF86AudioMute
    herbe $(cat /tmp/vors-mute-toggle.fifo)
EOF
$ [run sxhkd]
$ vors-client [...] -mute-toggle /tmp/vors-mute-toggle.fifo
@end example

    That will toggle mute on "audio mute" event and print its current
    state as a @url{https://github.com/dudik/herbe, herbe} notification.

@end itemize