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