michael@2: .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. michael@2: .TH TWINKLE "1" "May 2008" "Twinkle 1.2 - 09 March 2008" "User Commands" michael@2: .SH NAME michael@2: Twinkle \- Voice over Internet Protocol (VoIP) SIP Phone michael@2: .SH SYNOPSIS michael@2: .B twinkle michael@2: [\fIoptions\fR] michael@2: .SH OPTIONS michael@2: .TP michael@2: \fB\-c\fR michael@2: Run in command line interface (CLI) mode michael@2: .TP michael@2: \fB\-\-share\fR michael@2: Set the share directory. michael@2: .TP michael@2: \fB\-f\fR michael@2: Startup with a specific profile. You will not be requested michael@2: to choose a profile at startup. The profiles that you created michael@2: are the .cfg files in your .twinkle directory. michael@2: You may specify multiple profiles separated by spaces. michael@2: .TP michael@2: \fB\-\-force\fR michael@2: If a lock file is detected at startup, then override it michael@2: and startup. michael@2: .HP michael@2: \fB\-\-sip\-port\fR michael@2: .IP michael@2: Port for SIP signalling. michael@2: This port overrides the port from the system settings. michael@2: .HP michael@2: \fB\-\-rtp\-port\fR michael@2: .IP michael@2: Port for RTP. michael@2: This port overrides the port from the system settings. michael@2: .HP michael@2: \fB\-\-call\fR
michael@2: .IP michael@2: Instruct Twinkle to call the address. michael@2: When Twinkle is already running, this will instruct the running michael@2: process to call the address. michael@2: The address may be a full or partial SIP URI. A partial SIP URI michael@2: will be completed with the information from the user profile. michael@2: .IP michael@2: A subject may be passed by appending '?subject=' michael@2: to the address. michael@2: .IP michael@2: Examples: michael@2: twinkle \fB\-\-call\fR 123456 michael@2: twinkle \fB\-\-call\fR sip:example@example.com?subject=hello michael@2: .HP michael@2: \fB\-\-cmd\fR michael@2: .IP michael@2: Instruct Twinkle to execute the CLI command. You can run michael@2: all commands from the command line interface mode. michael@2: When Twinkle is already running, this will instruct the running michael@2: process to execute the CLI command. michael@2: .IP michael@2: Examples: michael@2: twinkle \fB\-\-cmd\fR answer michael@2: twinkle \fB\-\-cmd\fR mute michael@2: twinkle \fB\-\-cmd\fR 'transfer 12345' michael@2: .TP michael@2: \fB\-\-immediate\fR michael@2: This option can be used in conjunction with \fB\-\-call\fR or \fB\-\-cmd\fR michael@2: It indicates the the command or call is to be performed michael@2: immediately without asking the user for any confirmation. michael@2: .HP michael@2: \fB\-\-set\-profile\fR michael@2: .IP michael@2: Make the active profile. michael@2: When using this option in conjuction with \fB\-\-call\fR and \fB\-\-cmd\fR, michael@2: then the profile is activated before executing \fB\-\-call\fR or michael@2: \fB\-\-cmd\fR. michael@2: .TP michael@2: \fB\-\-show\fR michael@2: Instruct a running instance of Twinkle to show the main window michael@2: and take focus. michael@2: .TP michael@2: \fB\-\-hide\fR michael@2: Instruct a running instance of Twinkle to hide in the sytem tray. michael@2: If no system tray is used, then Twinkle will minimize. michael@2: .HP michael@2: \fB\-\-help\-cli\fR [cli command] michael@2: .IP michael@2: Without a cli command this option lists all available CLI michael@2: commands. With a CLI command this option prints help on michael@2: the CLI command. michael@2: .TP michael@2: \fB\-\-version\fR michael@2: Get version information. michael@2: .SH COPYRIGHT michael@2: Copyright \(co 2005-2008 Michel de Boer michael@2: http://www.twinklephone.com michael@2: .PP michael@2: Built with support for: ALSA, KDE, Speex, ZRTP michael@2: .PP michael@2: Contributions: michael@2: * ALSA \- Rickard Petzall michael@2: * ZRTP/SRTP \- Werner Dittmann michael@2: .PP michael@2: This software contains the following software from 3rd parties: michael@2: * GSM codec from Jutta Degener and Carsten Bormann, University of Berlin michael@2: * G.711/G.726 codecs from Sun Microsystems (public domain) michael@2: * Parts of the STUN project at http://sourceforge.net/projects/stun michael@2: * Parts of libsrv at http://libsrv.sourceforge.net/ michael@2: .PP michael@2: For RTP the following dynamic libraries are linked: michael@2: * GNU ccRTP \- http://www.gnu.org/software/ccrtp michael@2: * GNU CommonC++ \- http://www.gnu.org/software/commoncpp michael@2: .PP michael@2: Twinkle comes with ABSOLUTELY NO WARRANTY. michael@2: This program is free software; you can redistribute it and/or modify michael@2: it under the terms of the GNU General Public License as published by michael@2: the Free Software Foundation; either version 2 of the License, or michael@2: (at your option) any later version.