Adds manpage for twinkle-console application

data/twinkle-console.1

@@ -0,0 +1,264 @@
+.\" Text automatically generated by txt2man
+.TH twinkle-console 1 "01 December 2022" "Twinkle 1.10.3" "User Commands"
+.SH NAME
+\fBtwinkle-console \fP- Twinkle 1.10.3
+\fB
+.SH SYNOPSIS
+.nf
+.fam C
+\fBtwinkle-console\fP [\fIoptions\fP]
+
+.fam T
+.fi
+.fam T
+.fi
+.SH OPTIONS
+.TP
+.B
+call [\fB-s\fP subject] [\fB-d\fP display] [\fB-h\fP] dst
+Call someone. Arguments:  
+.RS
+.TP
+.B
+\fB-s\fP <subject>
+Add a subject header to the INVITE \  
+.TP
+.B
+\fB-d\fP <display>
+Add display name to To-header
+.TP
+.B
+\fB-h\fP
+Hide your identity
+.TP
+.B
+dst
+SIP uri of party to invite
+.RE
+.TP
+.B
+answer
+Answer an incoming call
+.TP
+.B
+answerbye
+Answer an incoming call or end a call
+.TP
+.B
+reject
+Reject an incoming call
+.TP
+.B
+redirect [\fB-s\fP] [\fB-t\fP type] [\fB-a\fP on|off] [dst \.\.\. dst]
+Redirect an incoming call. A 302 Moved Temporarily response will be sent. You can redirect the current incoming call by specifying one or more destinations without any other arguments.
+Arguments:
+.RS
+.TP
+.B
+\fB-s\fP
+Show which redirections are active.
+.TP
+.B
+\fB-t\fP type
+Type for permanent redirection of calls.
+Values: always, busy, noanswer.
+.TP
+.B
+\fB-a\fP on|off
+Enable/disable permanent redirection.
+The default action is 'on'.
+You can disable all redirections with the
+\(cqoff' action and no type.
+.TP
+.B
+dst
+SIP uri where the call should be redirected.
+You can specify up to 5 destinations.
+The destinations will be tried in sequence.
+.TP
+.B
+Examples:
+.IP \(bu 3
+Redirect current incoming call to michel@twinklephone.com: redirect michel@twinklephone.com
+.IP \(bu 3
+Redirect busy calls permanently to michel@twinklephone.com: redirect \fB-t\fP busy michel@twinklephone.com
+.IP \(bu 3
+Disable redirection of busy calls: redirect \fB-t\fP busy \fB-a\fP off
+.RE
+.TP
+.B
+transfer [\fB-c\fP] [\fB-l\fP] [dst]
+Transfer a standing call to another destination. For a transfer with consultation, first use the \fB-c\fP flag with a destination. This sets up the consultation call. When the consulted party agrees, give the command with the \fB-c\fP flag once more, but now without a destination. This transfers the call. Arguments:  
+.RS
+.TP
+.B
+\fB-c\fP
+Consult destination before transferring call.
+.TP
+.B
+\fB-l\fP
+Transfer call to party on other line.
+.TP
+.B
+dst
+SIP uri of transfer destination
+.RE
+.TP
+.B
+bye
+End a call
+.TP
+.B
+hold
+Put a call on-hold
+.TP
+.B
+retrieve
+Retrieve a held call
+.TP
+.B
+conference
+Join 2 calls in a 3-way conference
+.TP
+.B
+mute
+Mute a line
+.TP
+.B
+dtmf
+Send DTMF
+.TP
+.B
+redial
+Repeat last call
+.TP
+.B
+register
+Register your phone at a registrar
+.TP
+.B
+deregister
+De-register your phone at a registrar
+.TP
+.B
+fetch_reg
+Fetch registrations from registrar
+.TP
+.B
+options
+Get capabilities of another SIP endpoint
+.TP
+.B
+line
+Toggle between phone lines
+.TP
+.B
+dnd [\fB-s\fP] [\fB-a\fP on|off]
+Enable/disable the do not disturb service. If dnd is enabled then a 480 Temporarily Unavailable response is given on incoming calls. Arguments:  
+.RS
+.TP
+.B
+\fB-s\fP
+Show if dnd is active.
+.TP
+.B
+\fB-a\fP on|off
+Enable/disable dnd.
+.PP
+Notes:
+Without any arguments you can toggle the status.
+.RE
+.TP
+.B
+auto_answer [\fB-s\fP] [\fB-a\fP on|off]
+Enable/disable the auto answer service. Arguments:  
+.RS
+.TP
+.B
+\fB-s\fP
+Show if auto answer is active.
+.TP
+.B
+\fB-a\fP on|off
+Enable/disable auto answer.
+.PP
+Notes:
+Without any arguments you can toggle the status.
+.RE
+.TP
+.B
+user
+Show users / set active user
+.TP
+.B
+message [\fB-s\fP subject] [\fB-f\fP file name] [\fB-d\fP display] dst [text]
+Send an instant message. Arguments:  
+.RS
+.TP
+.B
+\fB-s\fP subject
+Subject of the message.
+.TP
+.B
+\fB-f\fP file name
+File name of the file to send.
+.TP
+.B
+\fB-d\fP display
+Add display name to To-header
+.TP
+.B
+dst
+SIP uri of party to message
+.TP
+.B
+text
+Message text to send. Surround with double quotes when your text contains  whitespace.  When you send a file, then the text is ignored.
+.RE
+.TP
+.B
+presence \fB-b\fP [online|offline]
+Publish your presence state to a presence agent.
+Arguments:
+.RS
+.TP
+.B
+\fB-b\fP
+A basic presence state: online or offline
+.RE
+.TP
+.B
+quit
+Quit
+.TP
+.B
+help
+Get help on a command
+.SH COPYRIGHT    
+.TP
+.B
+Copyright © 2005-2015 Michel de Boer and contributors http://twinkle.dolezel.info
+.TP
+.B
+Built with support for: ALSA, Speex, iLBC, ZRTP
+.TP
+.B
+Contributions: * Werner Dittmann (ZRTP/SRTP) * Bogdan Harjoc (AKAv1-MD5, Service-Route) * Roman Imankulov (command line editing) * Ondrej Moris (codec preprocessing) * Rickard Petzall (ALSA)
+.TP
+.B
+This software contains the following software from 3rd parties: * GSM codec from Jutta Degener and Carsten Bormann, University of Berlin * G.711/G.726 codecs from Sun Microsystems (public domain) * iLBC implementation from RFC 3951 (www.ilbcfreeware.org) * Parts of the STUN project at http://sourceforge.net/projects/stun * Parts of libsrv at http://libsrv.sourceforge.net/
+.TP
+.B
+For RTP the following dynamic libraries are linked: * GNU ccRTP - http://www.gnu.org/software/ccrtp * GNU uCommon C++ - http://www.gnutelephony.org/index.php/Category:Software
+.PP
+Twinkle comes with ABSOLUTELY NO WARRANTY. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+.SH SEE ALSO
+The full documentation for Twinkle is maintained as a Texinfo manual. If the info and Twinkle programs are properly installed at your site, the command
+.PP
+.nf
+.fam C
+              info Twinkle
+
+.fam T
+.fi
+should give you access to the complete manual.