Add a simple manual page generated with help2man (fixes #24)

1 files changed, 131 insertions, 0 deletions

diff --git a/data/twinkle.1 b/data/twinkle.1
new file mode 100644
index 0000000..3745e57
--- /dev/null
+++ b/data/twinkle.1
@@ -0,0 +1,131 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.2.
+.TH TWINKLE "1" "January 2016" "Twinkle 1.9.0 - 10 July 2015" "User Commands"
+.SH NAME
+Twinkle \- Twinkle 1.9.0
+.SH SYNOPSIS
+.B twinkle
+[\fI\,options\/\fR]
+.SH OPTIONS
+.TP
+\fB\-c\fR
+Run in command line interface (CLI) mode
+.TP
+\fB\-\-share\fR <dir>
+Set the share directory.
+.TP
+\fB\-f\fR <profile>
+Startup with a specific profile. You will not be requested
+to choose a profile at startup. The profiles that you created
+are the .cfg files in your .twinkle directory.
+You may specify multiple profiles separated by spaces.
+.TP
+\fB\-\-force\fR
+If a lock file is detected at startup, then override it
+and startup.
+.HP
+\fB\-\-sip\-port\fR <port>
+.IP
+Port for SIP signalling.
+This port overrides the port from the system settings.
+.HP
+\fB\-\-rtp\-port\fR <port>
+.IP
+Port for RTP.
+This port overrides the port from the system settings.
+.HP
+\fB\-\-call\fR <address>
+.IP
+Instruct Twinkle to call the address.
+When Twinkle is already running, this will instruct the running
+process to call the address.
+The address may be a full or partial SIP URI. A partial SIP URI
+will be completed with the information from the user profile.
+.IP
+A subject may be passed by appending '?subject=<subject>'
+to the address.
+.IP
+Examples:
+twinkle \fB\-\-call\fR 123456
+twinkle \fB\-\-call\fR sip:example@example.com?subject=hello
+.HP
+\fB\-\-cmd\fR <cli command>
+.IP
+Instruct Twinkle to execute the CLI command. You can run
+all commands from the command line interface mode.
+When Twinkle is already running, this will instruct the running
+process to execute the CLI command.
+.IP
+Examples:
+twinkle \fB\-\-cmd\fR answer
+twinkle \fB\-\-cmd\fR mute
+twinkle \fB\-\-cmd\fR 'transfer 12345'
+.TP
+\fB\-\-immediate\fR
+This option can be used in conjunction with \fB\-\-call\fR or \fB\-\-cmd\fR
+It indicates the the command or call is to be performed
+immediately without asking the user for any confirmation.
+.HP
+\fB\-\-set\-profile\fR <profile>
+.IP
+Make <profile> the active profile.
+When using this option in conjunction with \fB\-\-call\fR and \fB\-\-cmd\fR,
+then the profile is activated before executing \fB\-\-call\fR or
+\fB\-\-cmd\fR.
+.TP
+\fB\-\-show\fR
+Instruct a running instance of Twinkle to show the main window
+and take focus.
+.TP
+\fB\-\-hide\fR
+Instruct a running instance of Twinkle to hide in the system tray.
+If no system tray is used, then Twinkle will minimize.
+.HP
+\fB\-\-help\-cli\fR [cli command]
+.IP
+Without a cli command this option lists all available CLI
+commands. With a CLI command this option prints help on
+the CLI command.
+.TP
+\fB\-\-version\fR
+Get version information.
+.SH COPYRIGHT
+Copyright \(co 2005\-2015  Michel de Boer and contributors
+http://twinkle.dolezel.info
+.PP
+Built with support for: ALSA, Speex, iLBC, ZRTP
+.PP
+Contributions:
+* Werner Dittmann (ZRTP/SRTP)
+* Bogdan Harjoc (AKAv1\-MD5, Service\-Route)
+* Roman Imankulov (command line editing)
+* Ondrej Moris (codec preprocessing)
+* Rickard Petzall (ALSA)
+.PP
+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/
+.PP
+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
+.B Twinkle
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B Twinkle
+programs are properly installed at your site, the command
+.IP
+.B info Twinkle
+.PP
+should give you access to the complete manual.