source: protocols/skype/skyped.1 @ 4e0e590

Last change on this file since 4e0e590 was 09bd226, checked in by dequis <dx@…>, at 2015-05-18T02:23:56Z

Include prebuilt skyped manpage, remove asciidoc dependency

  • Property mode set to 100644
File size: 4.1 KB
Line 
1'\" t
2.\"     Title: skyped
3.\"    Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\"      Date: 123
6.\"    Manual: BitlBee manual
7.\"    Source: BitlBee
8.\"  Language: English
9.\"
10.TH "SKYPED" "1" "123" "BitlBee" "BitlBee manual"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el       .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31skyped \- allows remote control of the Skype GUI client
32.SH "SYNOPSIS"
33.sp
34skyped [<options>]
35.SH "DESCRIPTION"
36.sp
37Skype supports remote control of the GUI client only via X11 or DBus messages\&. This is hard in case you want remote control\&. This daemon listens on a TCP port and runs on the same machine where the GUI client runs\&. It passes all the input it gets to Skype directly, except for a few commands which is related to authentication\&. The whole communication is done via SSL\&.
38.SH "CONFIGURATION"
39.sp
40.RS 4
41.ie n \{\
42\h'-04'\(bu\h'+03'\c
43.\}
44.el \{\
45.sp -1
46.IP \(bu 2.3
47.\}
48Set up
49~/\&.skyped/skyped\&.conf: Create the
50~/\&.skyped
51directory, copy
52skyped\&.conf
53and
54skyped\&.cnf
55from
56/usr/local/etc/skyped/
57to
58~/\&.skyped, adjust
59username
60and
61password\&. The
62username
63should be your Skype login and the
64password
65can be whatever you want, but you will have to specify that one when adding the Skype account to BitlBee (see later)\&.
66.RE
67.if n \{\
68.sp
69.\}
70.RS 4
71.it 1 an-trap
72.nr an-no-space-flag 1
73.nr an-break-flag 1
74.br
75.ps +1
76\fBNote\fR
77.ps -1
78.br
79.sp
80Here, and later \- /usr/local/etc can be different on your installation if you used the \-\-sysconfdir switch when running the configure of BitlBee\&.
81.sp .5v
82.RE
83.sp
84.RS 4
85.ie n \{\
86\h'-04'\(bu\h'+03'\c
87.\}
88.el \{\
89.sp -1
90.IP \(bu 2.3
91.\}
92Generate the SSL pem files:
93.RE
94.sp
95.if n \{\
96.RS 4
97.\}
98.nf
99$ cd ~/\&.skyped
100$ openssl req \-new \-x509 \-days 365 \-nodes \-config skyped\&.cnf \-out skyped\&.cert\&.pem \e
101        \-keyout skyped\&.key\&.pem
102.fi
103.if n \{\
104.RE
105.\}
106.sp
107.RS 4
108.ie n \{\
109\h'-04'\(bu\h'+03'\c
110.\}
111.el \{\
112.sp -1
113.IP \(bu 2.3
114.\}
115Start
116skyped
117(the TCP server), initially without detaching and enabling debug messages:
118.RE
119.sp
120.if n \{\
121.RS 4
122.\}
123.nf
124$ skyped \-d \-n
125.fi
126.if n \{\
127.RE
128.\}
129.sp
130.RS 4
131.ie n \{\
132\h'-04'\(bu\h'+03'\c
133.\}
134.el \{\
135.sp -1
136.IP \(bu 2.3
137.\}
138Start your
139IRC
140client, connect to BitlBee and add your account:
141.RE
142.sp
143.if n \{\
144.RS 4
145.\}
146.nf
147account add skype <user> <pass>
148.fi
149.if n \{\
150.RE
151.\}
152.sp
153<user> should be your Skype account name, <pass> should be the one you declared in skyped\&.conf\&.
154.SH "OPTIONS"
155.PP
156\-c, \-\-config
157.RS 4
158Path to configuration file (default: $HOME/\&.skyped/skyped\&.conf)
159.RE
160.PP
161\-d, \-\-debug
162.RS 4
163Enable debug messages
164.RE
165.PP
166\-h, \-\-help
167.RS 4
168Show short summary of options
169.RE
170.PP
171\-H, \-\-host
172.RS 4
173Set the tcp host (default: 0\&.0\&.0\&.0)
174.RE
175.PP
176\-l, \-\-log
177.RS 4
178Set the log file in background mode (default: none)
179.RE
180.PP
181\-m, \-\-mock=<file>
182.RS 4
183Mock mode: replay session from file, instead of connecting to Skype\&.
184.RE
185.PP
186\-n, \-\-nofork
187.RS 4
188Don\(cqt run as daemon in the background
189.RE
190.PP
191\-s, \-\-dont\-start\-skype
192.RS 4
193Assume that skype is running independently, don\(cqt try to start/stop it\&.
194.RE
195.PP
196\-p, \-\-port
197.RS 4
198Set the tcp port (default: 2727)
199.RE
200.PP
201\-v, \-\-version
202.RS 4
203Display version information
204.RE
205.SH "AUTHOR"
206.sp
207Written by Miklos Vajna <vmiklos@vmiklos\&.hu>
Note: See TracBrowser for help on using the repository browser.