1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/twinkle/twinkle.1 Mon Feb 23 18:09:09 2009 +0100
1.3 @@ -0,0 +1,115 @@
1.4 +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
1.5 +.TH TWINKLE "1" "May 2008" "Twinkle 1.2 - 09 March 2008" "User Commands"
1.6 +.SH NAME
1.7 +Twinkle \- Voice over Internet Protocol (VoIP) SIP Phone
1.8 +.SH SYNOPSIS
1.9 +.B twinkle
1.10 +[\fIoptions\fR]
1.11 +.SH OPTIONS
1.12 +.TP
1.13 +\fB\-c\fR
1.14 +Run in command line interface (CLI) mode
1.15 +.TP
1.16 +\fB\-\-share\fR <dir>
1.17 +Set the share directory.
1.18 +.TP
1.19 +\fB\-f\fR <profile>
1.20 +Startup with a specific profile. You will not be requested
1.21 +to choose a profile at startup. The profiles that you created
1.22 +are the .cfg files in your .twinkle directory.
1.23 +You may specify multiple profiles separated by spaces.
1.24 +.TP
1.25 +\fB\-\-force\fR
1.26 +If a lock file is detected at startup, then override it
1.27 +and startup.
1.28 +.HP
1.29 +\fB\-\-sip\-port\fR <port>
1.30 +.IP
1.31 +Port for SIP signalling.
1.32 +This port overrides the port from the system settings.
1.33 +.HP
1.34 +\fB\-\-rtp\-port\fR <port>
1.35 +.IP
1.36 +Port for RTP.
1.37 +This port overrides the port from the system settings.
1.38 +.HP
1.39 +\fB\-\-call\fR <address>
1.40 +.IP
1.41 +Instruct Twinkle to call the address.
1.42 +When Twinkle is already running, this will instruct the running
1.43 +process to call the address.
1.44 +The address may be a full or partial SIP URI. A partial SIP URI
1.45 +will be completed with the information from the user profile.
1.46 +.IP
1.47 +A subject may be passed by appending '?subject=<subject>'
1.48 +to the address.
1.49 +.IP
1.50 +Examples:
1.51 +twinkle \fB\-\-call\fR 123456
1.52 +twinkle \fB\-\-call\fR sip:example@example.com?subject=hello
1.53 +.HP
1.54 +\fB\-\-cmd\fR <cli command>
1.55 +.IP
1.56 +Instruct Twinkle to execute the CLI command. You can run
1.57 +all commands from the command line interface mode.
1.58 +When Twinkle is already running, this will instruct the running
1.59 +process to execute the CLI command.
1.60 +.IP
1.61 +Examples:
1.62 +twinkle \fB\-\-cmd\fR answer
1.63 +twinkle \fB\-\-cmd\fR mute
1.64 +twinkle \fB\-\-cmd\fR 'transfer 12345'
1.65 +.TP
1.66 +\fB\-\-immediate\fR
1.67 +This option can be used in conjunction with \fB\-\-call\fR or \fB\-\-cmd\fR
1.68 +It indicates the the command or call is to be performed
1.69 +immediately without asking the user for any confirmation.
1.70 +.HP
1.71 +\fB\-\-set\-profile\fR <profile>
1.72 +.IP
1.73 +Make <profile> the active profile.
1.74 +When using this option in conjuction with \fB\-\-call\fR and \fB\-\-cmd\fR,
1.75 +then the profile is activated before executing \fB\-\-call\fR or
1.76 +\fB\-\-cmd\fR.
1.77 +.TP
1.78 +\fB\-\-show\fR
1.79 +Instruct a running instance of Twinkle to show the main window
1.80 +and take focus.
1.81 +.TP
1.82 +\fB\-\-hide\fR
1.83 +Instruct a running instance of Twinkle to hide in the sytem tray.
1.84 +If no system tray is used, then Twinkle will minimize.
1.85 +.HP
1.86 +\fB\-\-help\-cli\fR [cli command]
1.87 +.IP
1.88 +Without a cli command this option lists all available CLI
1.89 +commands. With a CLI command this option prints help on
1.90 +the CLI command.
1.91 +.TP
1.92 +\fB\-\-version\fR
1.93 +Get version information.
1.94 +.SH COPYRIGHT
1.95 +Copyright \(co 2005-2008 Michel de Boer
1.96 +http://www.twinklephone.com
1.97 +.PP
1.98 +Built with support for: ALSA, KDE, Speex, ZRTP
1.99 +.PP
1.100 +Contributions:
1.101 +* ALSA \- Rickard Petzall
1.102 +* ZRTP/SRTP \- Werner Dittmann
1.103 +.PP
1.104 +This software contains the following software from 3rd parties:
1.105 +* GSM codec from Jutta Degener and Carsten Bormann, University of Berlin
1.106 +* G.711/G.726 codecs from Sun Microsystems (public domain)
1.107 +* Parts of the STUN project at http://sourceforge.net/projects/stun
1.108 +* Parts of libsrv at http://libsrv.sourceforge.net/
1.109 +.PP
1.110 +For RTP the following dynamic libraries are linked:
1.111 +* GNU ccRTP \- http://www.gnu.org/software/ccrtp
1.112 +* GNU CommonC++ \- http://www.gnu.org/software/commoncpp
1.113 +.PP
1.114 +Twinkle comes with ABSOLUTELY NO WARRANTY.
1.115 +This program is free software; you can redistribute it and/or modify
1.116 +it under the terms of the GNU General Public License as published by
1.117 +the Free Software Foundation; either version 2 of the License, or
1.118 +(at your option) any later version.
