summaryrefslogtreecommitdiff
path: root/vchat-client.sgml
diff options
context:
space:
mode:
authorerdgeist <>2003-02-12 17:48:37 +0000
committererdgeist <>2003-02-12 17:48:37 +0000
commitdea6bf757aa9a875eab35b2b650412e7605f1308 (patch)
tree14ed8374c3a3862529313088375693a7de70d3a7 /vchat-client.sgml
CVS moved to erdgeist.org
Diffstat (limited to 'vchat-client.sgml')
-rwxr-xr-xvchat-client.sgml376
1 files changed, 376 insertions, 0 deletions
diff --git a/vchat-client.sgml b/vchat-client.sgml
new file mode 100755
index 0000000..ee0dc36
--- /dev/null
+++ b/vchat-client.sgml
@@ -0,0 +1,376 @@
1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3<!-- Process this file with docbook2man to generate an nroff manual
4 page: `docbook2man manpage.sgml'. You may view
5 the manual page with: `man ./manpage.1'. A typical entry in a
6 Makefile or Makefile.am is:
7
8manpage.1: manpage.sgml
9docbook2man $<
10 -->
11
12 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
13 <!ENTITY dhemail "<email>macrotron@president.eu.org</email>">
14 <!ENTITY dhusername "Hans Freitag">
15]>
16
17<refentry>
18
19<refentryinfo>
20 <address>
21 &dhemail;
22 </address>
23 <author>
24 <firstname>Hans</firstname>
25 <surname>Freitag</surname>
26 </author>
27 <copyright>
28 <year>2001</year>
29 <holder>Andreas Kotes</holder>
30 </copyright>
31</refentryinfo>
32
33
34<refmeta>
35 <refentrytitle>vchat-client</refentrytitle>
36 &dhsection;
37</refmeta>
38
39
40<refnamediv><refname>vchat-client</refname><refpurpose>this is vchat-client, a GPLed (SSL)
41client for the vchat protocol.</refpurpose></refnamediv>
42
43
44<refsynopsisdiv>
45<cmdsynopsis>
46<command>vchat-client</command>
47<arg>-C <replaceable>configfile</replaceable></arg>
48<arg>-l</arg>
49<arg>-z</arg>
50<arg>-s <replaceable>host</replaceable></arg>
51<arg>-p <replaceable>port</replaceable></arg>
52<arg>-c <replaceable>channel</replaceable></arg>
53<arg>-n <replaceable>nickname</replaceable></arg>
54<arg>-f <replaceable>from</replaceable></arg>
55</cmdsynopsis>
56</refsynopsisdiv>
57
58
59<refsect1>
60<title>DESCRIPTION</title>
61<para>vchat-client connects to vchat chat system via ssl</para>
62</refsect1>
63
64
65<refsect1>
66<title>OPTIONS</title>
67<variablelist>
68
69<varlistentry>
70<term><option>-C</option> <replaceable>configfile</replaceable></term>
71<listitem><para>load an alternative configuration file,
72overiding the parameters in the default config files. -C should
73be the first parameter, options set before this parameter can be
74overridden in the configfile.</para></listitem>
75</varlistentry>
76
77<varlistentry>
78<term><option>-l</option></term>
79<listitem><para>local connect (no SSL + connects localhost:2323)</para></listitem>
80</varlistentry>
81
82<varlistentry>
83<term><option>-z</option></term>
84<listitem><para>don't use certificate files</para></listitem>
85</varlistentry>
86
87<varlistentry>
88<term><option>-s</option> <replaceable>host</replaceable></term>
89<listitem><para>local connect (no SSL + connects localhost:2323)</para></listitem>
90</varlistentry>
91
92<varlistentry>
93<term><option>-p</option> <replaceable>port</replaceable></term>
94<listitem><para>set port (default 2325)</para></listitem>
95</varlistentry>
96
97<varlistentry>
98<term><option>-n</option> <replaceable>nickname</replaceable></term>
99<listitem><para>set nickname</para></listitem>
100</varlistentry>
101
102<varlistentry>
103<term><option>-f</option> <replaceable>from</replaceable></term>
104<listitem><para>set from (default "vc-alpha-0.15")</para></listitem>
105</varlistentry>
106
107<varlistentry>
108<term><option>-h</option></term>
109<listitem><para>prints out a help screen</para></listitem>
110</varlistentry>
111
112</variablelist>
113</refsect1>
114
115
116
117<refsect1>
118<title>CONFIGFILE</title>
119<para><command>/etc/vchatrc</command> and <command>~/.vchat/config</command>
120are the default config files of vchat-client. A third config file can be
121given as command line Parameter.</para>
122
123<literallayout>
124
125Hierachie of config files and Options.
126 1. /etc/vchatrc
127 2. ~/vchat/config
128 3. options set before -C option
129 4. options in the config
130 file set with -C option
131 5. options set after -C option
132
133</literallayout>
134
135<para>The config file syntax is "option=value"! it can be used to
136configure the behavior of vchat-client</para>
137
138<variablelist>
139
140<varlistentry>
141<term><option>nick</option></term>
142<listitem><para>Sets the nickname (default is NULL)</para></listitem>
143</varlistentry>
144
145<varlistentry>
146<term><option>from</option></term>
147<listitem><para>Sets the from (default is "vc-alpha-0.15")</para></listitem>
148</varlistentry>
149
150<varlistentry>
151<term><option>host</option></term>
152<listitem><para>Sets the host to connect to (default is pulse.flatline.de)</para></listitem>
153</varlistentry>
154
155<varlistentry>
156<term><option>port</option></term>
157<listitem><para>Set the port (default 2325)</para></listitem>
158</varlistentry>
159
160<varlistentry>
161<term><option>ciphers</option></term>
162<listitem><para>Set ciphers ("HIGH:MEDIUM")</para></listitem>
163</varlistentry>
164
165<varlistentry>
166<term><option>certfile</option></term>
167<listitem><para>Set the certfile (default ~/.vchat/cert)</para></listitem>
168</varlistentry>
169
170<varlistentry>
171<term><option>keyfile</option></term>
172<listitem><para>Set the keyfile (default ~/.vchat/key)</para></listitem>
173</varlistentry>
174
175<varlistentry>
176<term><option>formatfile</option></term>
177<listitem><para>Set the formatfile (default ~/.vchat/formats) not impemented yet!</para></listitem>
178</varlistentry>
179
180<varlistentry>
181<term><option>usessl</option></term>
182<listitem><para>1|0 default=1</para></listitem>
183</varlistentry>
184
185<varlistentry>
186<term><option>usecert</option></term>
187<listitem><para>1|0 default=1</para></listitem>
188</varlistentry>
189
190<varlistentry>
191<term><option>usetime</option></term>
192<listitem><para>1|0 default=1</para></listitem>
193</varlistentry>
194
195<varlistentry>
196<term><option>messages</option></term>
197<listitem><para>set the heigth of the messages window default
198is 0 (no messages window)</para></listitem>
199</varlistentry>
200
201<varlistentry>
202<term><option>hscroll</option></term>
203<listitem><para>default=5 I don't know what this does, but I will
204know in future. maybe you want to tell me.</para></listitem>
205</varlistentry>
206
207<varlistentry>
208<term><option>channel</option></term>
209<listitem><para>number (default=0)</para></listitem>
210</varlistentry>
211
212<varlistentry>
213<term><option>privscrollb</option></term>
214<listitem><para>default=2048</para></listitem>
215</varlistentry>
216
217<varlistentry>
218<term><option>scrollback</option></term>
219<listitem><para>default=8192</para></listitem>
220</varlistentry>
221
222<varlistentry>
223<term><option>privscrollt</option></term>
224<listitem><para>default=0</para></listitem>
225</varlistentry>
226
227<varlistentry>
228<term><option>scrolltime</option></term>
229<listitem><para>default=86400</para></listitem>
230</varlistentry>
231
232</variablelist>
233
234</refsect1>
235
236
237<refsect1>
238<title>KEYS</title>
239
240<literallayout>
241Ctrl+J clear private window
242Ctrl+O clear channel window
243Ctrl+L redraw screen
244Ctrl+F scroll window up
245Ctrl+B scroll window down
246Ctrl+R change active scrolling window
247 (see rightmost character of
248 topic/console lines)
249Ctrl-T shrink private window size
250Ctrl-G grow private window size
251Ctrl+X toggle private window
252 (pops up on private messages)
253TAB nick completion
254</literallayout>
255
256</refsect1>
257
258
259
260
261
262<refsect1>
263<title>DEVEL</title>
264
265<para>You can get the most recent version of vchat-client via CVS, e.g:
266<screen>
267<prompt>$ </prompt><userinput>cvs -d:pserver:anonymous@pulse.flatline.de:/home/cvsroot login</userinput>
268<prompt>$ </prompt><userinput>cvs -z3 -d:pserver:anonymous@pulse.flatline.de:/home/cvsroot co vchat-client</userinput>
269</screen>
270</para>
271
272<para>(press return at password prompt) no autoconf yet, sorry. required libs:
273<literallayout>
274 - openssl (0.9.6+ preferred)
275 - readline (4.2+ preferred)
276 - ncurses (5.2 preferred)
277</literallayout>
278</para>
279
280<para>please adjust the Makefile according to your need, then run 'make' to compile,
281'make install' to install and ./vchat-client to start the binary.
282nope, I don't have any intention to use autoconf for this hack.</para>
283
284<para>run '<command>fakeroot make -f debian/rules binary</command>' or
285'<command>dpkg-buildpackage -rfakeroot</command>' to build a debian
286package from the source.</para>
287
288<para>The Makefile knows the targets "all, install, uninstall, clean"</para>
289
290<literallayout>
291
292FILES:
293 README - you're reading it.
294 TODO - list of things to do
295 vchat-client.c - main() and utility functions
296 vchat-config.h - configuration defaults
297 vchat-keygen - key generator with anon CA -
298 server support required
299 vchat-messages.h - server messages -- function
300 correlation
301 vchat-protocol.c - handling of server
302 connection & messages
303 vchat-ui.c - user-interface and readline
304 handling
305 vchat-user.c - userlist handling
306 vchat.h - global structures and functions
307 debian/ - the debian package build
308 directory
309</literallayout>
310
311<para>everything should be self-explantory, but please don't refrain to ask and/or
312give bug reports, feature requests, hints and tricks, etc etc ..</para>
313
314<para>Andreas Kotes <email>count@flatline.de</email></para>
315
316</refsect1>
317
318
319
320<refsect1>
321<title>SSL</title>
322
323<para>if you want to use an SSL certificate with the default configuration you need
324to put the key in ~/.vchat/key and the certificate in ~/.vchat/cert, both in
325PEM format. You can generate a key and a certificate by calling vchat-keygen,
326but the server you connect needs to know same anon CA provided by
327vchat-keygen, which currently isn't supported anywhere.</para>
328
329<para>to upload your certificate use nick-request.pl from the vchat-server
330source available at ftp://vchat.vaxbusters.org. Thisfor at least one of
331the admins has to be logged in.</para>
332
333</refsect1>
334
335
336
337<refsect1>
338
339<title>SEE ALSO</title>
340<para>gcc (1), cvs (1).</para>
341
342</refsect1>
343
344
345
346<refsect1>
347<title>AUTHOR</title>
348<para>This manual page was written by Hans Freitag &dhemail; for
349vchat-client system. Permission is granted to copy, distribute
350and/or modify this document under the terms of the
351<acronym>GNU</acronym> Free Documentation License, Version 1.1
352or any later version published by the Free Software Foundation;
353with no Invariant Sections, no Front-Cover
354Texts and no Back-Cover Texts.</para>
355</refsect1>
356
357
358
359</refentry>
360
361<!-- Keep this comment at the end of the file
362Local variables:
363mode: sgml
364sgml-omittag:t
365sgml-shorttag:t
366sgml-minimize-attributes:nil
367sgml-always-quote-attributes:t
368sgml-indent-step:2
369sgml-indent-data:t
370sgml-parent-document:nil
371sgml-default-dtd-file:nil
372sgml-exposed-tags:nil
373sgml-local-catalogs:nil
374sgml-local-ecat-files:nil
375End:
376-->
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 08:25:59 +0000