openspeak.1

   1 .TH openSpeak 1 "June 2007" Linux "Users Manuals"
   2
   3 .SH NAME
   4 openSpeak \- A VoIP application for gamers
   5
   6 .SH SYNOPSIS
   7 .B openspeak
   8 [-h|--help] [-v|--version] [-s|--silent] [-n|--name NAME] [-a|--voice-activation] [-k|--key KEYNUMBER]
   9
  10 .SH DESCRIPTION
  11 .B openSpeak
  12 is a VoIP application which allowsc communication between several people through one server. It uses wxWidgets for the GUI, portaudio for sound in-/output and Speex for voice encoding.
  13
  14 .SH OPTIONS
  15 .IP --help
  16 Shows some helpful informations on how to use openSpeak.
  17 .IP --version
  18 Shows some version information.
  19 .IP --silent
  20 Don't display any debug messages (only needed if compiled in debug mode).
  21 .IP --name NAME
  22 Change the default name in the config file.
  23 .IP --voice-activation
  24 Trigger the voice activity detection (VAD) or use the specified key.
  25 .IP --key KEYNUMBER
  26 Overrides key settings in the config file where
  27 .B KEYNUMBER
  28 is a valid wxw key number.
  29
  30 .SH FILES
  31 .I ~/.openspeak/settings.client.xml
  32 .RS
  33 The per user xml config file for the openspeak client.
  34 .RE
  35 .I ~/.openspeak/log/client.log
  36 .RS
  37 Log file for the openspeak client.
  38
  39 .SH AUTHOR
  40 Philipp Gildein <rmbl@openspeak-project.org>
  41
  42 .SH "SEE ALSO"
  43 .BR openspeak_server(1)