twinkle/twinkle.1@d2271dd2b481 (annotated)
twinkle/twinkle.1
Mon, 23 Feb 2009 18:09:09 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Mon, 23 Feb 2009 18:09:09 +0100
- changeset 2
- d2271dd2b481
- permissions
- -rw-r--r--
Import custom package specs to build for undistributed platforms.
| michael@2 | 1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. |
| michael@2 | 2 | .TH TWINKLE "1" "May 2008" "Twinkle 1.2 - 09 March 2008" "User Commands" |
| michael@2 | 3 | .SH NAME |
| michael@2 | 4 | Twinkle \- Voice over Internet Protocol (VoIP) SIP Phone |
| michael@2 | 5 | .SH SYNOPSIS |
| michael@2 | 6 | .B twinkle |
| michael@2 | 7 | [\fIoptions\fR] |
| michael@2 | 8 | .SH OPTIONS |
| michael@2 | 9 | .TP |
| michael@2 | 10 | \fB\-c\fR |
| michael@2 | 11 | Run in command line interface (CLI) mode |
| michael@2 | 12 | .TP |
| michael@2 | 13 | \fB\-\-share\fR <dir> |
| michael@2 | 14 | Set the share directory. |
| michael@2 | 15 | .TP |
| michael@2 | 16 | \fB\-f\fR <profile> |
| michael@2 | 17 | Startup with a specific profile. You will not be requested |
| michael@2 | 18 | to choose a profile at startup. The profiles that you created |
| michael@2 | 19 | are the .cfg files in your .twinkle directory. |
| michael@2 | 20 | You may specify multiple profiles separated by spaces. |
| michael@2 | 21 | .TP |
| michael@2 | 22 | \fB\-\-force\fR |
| michael@2 | 23 | If a lock file is detected at startup, then override it |
| michael@2 | 24 | and startup. |
| michael@2 | 25 | .HP |
| michael@2 | 26 | \fB\-\-sip\-port\fR <port> |
| michael@2 | 27 | .IP |
| michael@2 | 28 | Port for SIP signalling. |
| michael@2 | 29 | This port overrides the port from the system settings. |
| michael@2 | 30 | .HP |
| michael@2 | 31 | \fB\-\-rtp\-port\fR <port> |
| michael@2 | 32 | .IP |
| michael@2 | 33 | Port for RTP. |
| michael@2 | 34 | This port overrides the port from the system settings. |
| michael@2 | 35 | .HP |
| michael@2 | 36 | \fB\-\-call\fR <address> |
| michael@2 | 37 | .IP |
| michael@2 | 38 | Instruct Twinkle to call the address. |
| michael@2 | 39 | When Twinkle is already running, this will instruct the running |
| michael@2 | 40 | process to call the address. |
| michael@2 | 41 | The address may be a full or partial SIP URI. A partial SIP URI |
| michael@2 | 42 | will be completed with the information from the user profile. |
| michael@2 | 43 | .IP |
| michael@2 | 44 | A subject may be passed by appending '?subject=<subject>' |
| michael@2 | 45 | to the address. |
| michael@2 | 46 | .IP |
| michael@2 | 47 | Examples: |
| michael@2 | 48 | twinkle \fB\-\-call\fR 123456 |
| michael@2 | 49 | twinkle \fB\-\-call\fR sip:example@example.com?subject=hello |
| michael@2 | 50 | .HP |
| michael@2 | 51 | \fB\-\-cmd\fR <cli command> |
| michael@2 | 52 | .IP |
| michael@2 | 53 | Instruct Twinkle to execute the CLI command. You can run |
| michael@2 | 54 | all commands from the command line interface mode. |
| michael@2 | 55 | When Twinkle is already running, this will instruct the running |
| michael@2 | 56 | process to execute the CLI command. |
| michael@2 | 57 | .IP |
| michael@2 | 58 | Examples: |
| michael@2 | 59 | twinkle \fB\-\-cmd\fR answer |
| michael@2 | 60 | twinkle \fB\-\-cmd\fR mute |
| michael@2 | 61 | twinkle \fB\-\-cmd\fR 'transfer 12345' |
| michael@2 | 62 | .TP |
| michael@2 | 63 | \fB\-\-immediate\fR |
| michael@2 | 64 | This option can be used in conjunction with \fB\-\-call\fR or \fB\-\-cmd\fR |
| michael@2 | 65 | It indicates the the command or call is to be performed |
| michael@2 | 66 | immediately without asking the user for any confirmation. |
| michael@2 | 67 | .HP |
| michael@2 | 68 | \fB\-\-set\-profile\fR <profile> |
| michael@2 | 69 | .IP |
| michael@2 | 70 | Make <profile> the active profile. |
| michael@2 | 71 | When using this option in conjuction with \fB\-\-call\fR and \fB\-\-cmd\fR, |
| michael@2 | 72 | then the profile is activated before executing \fB\-\-call\fR or |
| michael@2 | 73 | \fB\-\-cmd\fR. |
| michael@2 | 74 | .TP |
| michael@2 | 75 | \fB\-\-show\fR |
| michael@2 | 76 | Instruct a running instance of Twinkle to show the main window |
| michael@2 | 77 | and take focus. |
| michael@2 | 78 | .TP |
| michael@2 | 79 | \fB\-\-hide\fR |
| michael@2 | 80 | Instruct a running instance of Twinkle to hide in the sytem tray. |
| michael@2 | 81 | If no system tray is used, then Twinkle will minimize. |
| michael@2 | 82 | .HP |
| michael@2 | 83 | \fB\-\-help\-cli\fR [cli command] |
| michael@2 | 84 | .IP |
| michael@2 | 85 | Without a cli command this option lists all available CLI |
| michael@2 | 86 | commands. With a CLI command this option prints help on |
| michael@2 | 87 | the CLI command. |
| michael@2 | 88 | .TP |
| michael@2 | 89 | \fB\-\-version\fR |
| michael@2 | 90 | Get version information. |
| michael@2 | 91 | .SH COPYRIGHT |
| michael@2 | 92 | Copyright \(co 2005-2008 Michel de Boer |
| michael@2 | 93 | http://www.twinklephone.com |
| michael@2 | 94 | .PP |
| michael@2 | 95 | Built with support for: ALSA, KDE, Speex, ZRTP |
| michael@2 | 96 | .PP |
| michael@2 | 97 | Contributions: |
| michael@2 | 98 | * ALSA \- Rickard Petzall |
| michael@2 | 99 | * ZRTP/SRTP \- Werner Dittmann |
| michael@2 | 100 | .PP |
| michael@2 | 101 | This software contains the following software from 3rd parties: |
| michael@2 | 102 | * GSM codec from Jutta Degener and Carsten Bormann, University of Berlin |
| michael@2 | 103 | * G.711/G.726 codecs from Sun Microsystems (public domain) |
| michael@2 | 104 | * Parts of the STUN project at http://sourceforge.net/projects/stun |
| michael@2 | 105 | * Parts of libsrv at http://libsrv.sourceforge.net/ |
| michael@2 | 106 | .PP |
| michael@2 | 107 | For RTP the following dynamic libraries are linked: |
| michael@2 | 108 | * GNU ccRTP \- http://www.gnu.org/software/ccrtp |
| michael@2 | 109 | * GNU CommonC++ \- http://www.gnu.org/software/commoncpp |
| michael@2 | 110 | .PP |
| michael@2 | 111 | Twinkle comes with ABSOLUTELY NO WARRANTY. |
| michael@2 | 112 | This program is free software; you can redistribute it and/or modify |
| michael@2 | 113 | it under the terms of the GNU General Public License as published by |
| michael@2 | 114 | the Free Software Foundation; either version 2 of the License, or |
| michael@2 | 115 | (at your option) any later version. |
