doc/usage.texi

   1 @node Usage
   2 @unnumbered Usage
   3
   4 @itemize
   5
   6 @item
   7     Generate server's keypair. And share its public key among users.
   8     Fact of server's public key knowledge means ability to connect to it.
   9
  10 @example
  11 $ vors-keygen | tee key | vors-keygen -pub | read pub
  12 $ vors-server -key key -bind [2001:db8::1]:12978
  13 @end example
  14
  15 @item
  16     Client uses external commands for reading from microphone and
  17     playing it back. By default it uses SoX'es @command{rec} and
  18     @command{play} commands.
  19
  20     Pay attention that VoRS expects @strong{ONLY} one channel, 48kHz,
  21     16-bit signed little-endian audio format. Empty strings in
  22     @option{-rec}/@option{-play} options mean no recording/playback
  23     attempts.
  24
  25     @command{-play} command is spawned for each participant. Your OS
  26     should mix their output together.
  27
  28 @item
  29     Start the client, providing server's public key and our username:
  30
  31 @example
  32 $ vors-client -srv "[2001:db8::1]:12978" -pub $pub -name NAME
  33 @end example
  34
  35     Pressing F10 in server/client TUIs means quitting. Pressing Enter in
  36     client means "mute" toggling.
  37
  38 @item
  39     @option{-room} allows you to join non-root room.
  40     @option{-passwd} allows you protecting it with provided password.
  41
  42 @item
  43     @option{-mute-toggle} allows you to toggle mute by external
  44     utilities. For example you can use suckless minimalistic
  45     @url{https://github.com/baskerville/sxhkd, sxhkd} daemon to capture
  46     X11 key events and execute commands:
  47
  48 @example
  49 $ mkfifo /tmp/vors-mute-toggle.fifo
  50 $ cat >sxhkd.cfg <<EOF
  51 XF86AudioMute
  52     herbe $(cat /tmp/vors-mute-toggle.fifo)
  53 EOF
  54 $ [run sxhkd]
  55 $ vors-client [...] -mute-toggle /tmp/vors-mute-toggle.fifo
  56 @end example
  57
  58     That will toggle mute on "audio mute" event and print its current
  59     state as a @url{https://github.com/dudik/herbe, herbe} notification.
  60
  61 @end itemize