summaryrefslogtreecommitdiff
path: root/vchat-client.sgml
blob: 3d6fbc7596b7feaf461765bfc0c3d68894a6acc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook2man to generate an nroff manual
     page: `docbook2man manpage.sgml'.  You may view
     the manual page with: `man ./manpage.1'.  A typical entry in a 
     Makefile or Makefile.am is:

manpage.1: manpage.sgml
docbook2man $<
  -->

  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>macrotron@president.eu.org</email>">
  <!ENTITY dhusername  "Hans Freitag">
]>

<refentry>

<refentryinfo>
	<address>
	&dhemail;
	</address>
	<author>
	<firstname>Hans</firstname>
	<surname>Freitag</surname>
	</author>
	<copyright>
	<year>2001</year>
	<holder>Andreas Kotes</holder>
	</copyright>
</refentryinfo>


<refmeta>
	<refentrytitle>vchat-client</refentrytitle>
	&dhsection;
</refmeta>


<refnamediv><refname>vchat-client</refname><refpurpose>this is vchat-client, a GPLed (SSL) 
client for the vchat protocol.</refpurpose></refnamediv>


<refsynopsisdiv>
<cmdsynopsis>
<command>vchat-client</command>
<arg>-C <replaceable>configfile</replaceable></arg>
<arg>-l</arg> 
<arg>-z</arg> 
<arg>-s <replaceable>host</replaceable></arg>
<arg>-p <replaceable>port</replaceable></arg> 
<arg>-c <replaceable>channel</replaceable></arg>
<arg>-n <replaceable>nickname</replaceable></arg>
<arg>-f <replaceable>from</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>


<refsect1>
<title>DESCRIPTION</title>
<para>vchat-client connects to vchat chat system via ssl</para>
</refsect1>


<refsect1>
<title>OPTIONS</title>
<variablelist>

<varlistentry>
<term><option>-C</option> <replaceable>configfile</replaceable></term>
<listitem><para>load an alternative configuration file, 
overiding the parameters in the default config files. -C should 
be the first parameter, options set before this parameter can be 
overridden in the configfile.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-l</option></term>
<listitem><para>local connect (no SSL + connects localhost:2323)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-z</option></term>
<listitem><para>don't use certificate files</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-s</option> <replaceable>host</replaceable></term>
<listitem><para>local connect (no SSL + connects localhost:2323)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-p</option> <replaceable>port</replaceable></term>
<listitem><para>set port (default 2325)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-n</option> <replaceable>nickname</replaceable></term>
<listitem><para>set nickname</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-f</option> <replaceable>from</replaceable></term>
<listitem><para>set from (default "vc-alpha-0.19")</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-h</option></term>
<listitem><para>prints out a help screen</para></listitem>
</varlistentry>

</variablelist>
</refsect1>



<refsect1>
<title>CONFIGFILE</title>
<para><command>/etc/vchatrc</command> and <command>~/.vchat/config</command> 
are the default config files of vchat-client. A third config file can be 
given as command line Parameter.</para>

<literallayout>

Hierachie of config files and Options.
   1. /etc/vchatrc
   2. ~/vchat/config
   3. options set before -C option
   4. options in the config 
      file set with -C option
   5. options set after -C option

</literallayout>
	
<para>The config file syntax is "option=value"! it can be used to 
configure the behavior of vchat-client</para>

<variablelist>

<varlistentry>
<term><option>nick</option></term>
<listitem><para>Sets the nickname (default is NULL)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>from</option></term>
<listitem><para>Sets the from (default is "vc-alpha-0.19")</para></listitem>
</varlistentry>

<varlistentry>
<term><option>host</option></term>
<listitem><para>Sets the host to connect to (default is pulse.flatline.de)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>port</option></term>
<listitem><para>Set the port (default 2325)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>ciphers</option></term>
<listitem><para>Set ciphers (autodetected)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>certfile</option></term>
<listitem><para>Set the certfile (default ~/.vchat/cert)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>keyfile</option></term>
<listitem><para>Set the keyfile (default ~/.vchat/key)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>formatfile</option></term>
<listitem><para>Set the formatfile (default ~/.vchat/formats) not impemented yet!</para></listitem>
</varlistentry>

<varlistentry>
<term><option>usessl</option></term>
<listitem><para>1|0 default=1</para></listitem>
</varlistentry>

<varlistentry>
<term><option>usecert</option></term>
<listitem><para>1|0 default=1</para></listitem>
</varlistentry>

<varlistentry>
<term><option>usetime</option></term>
<listitem><para>1|0 default=1</para></listitem>
</varlistentry>

<varlistentry>
<term><option>messages</option></term>
<listitem><para>set the heigth of the messages window default 
is 0 (no messages window)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>hscroll</option></term>
<listitem><para>default=5 I don't know what this does, but I will 
know in future. maybe you want to tell me.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>channel</option></term>
<listitem><para>number (default=0)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>privscrollb</option></term>
<listitem><para>default=2048</para></listitem>
</varlistentry>

<varlistentry>
<term><option>scrollback</option></term>
<listitem><para>default=8192</para></listitem>
</varlistentry>

<varlistentry>
<term><option>privscrollt</option></term>
<listitem><para>default=0</para></listitem>
</varlistentry>

<varlistentry>
<term><option>scrolltime</option></term>
<listitem><para>default=86400</para></listitem>
</varlistentry>

</variablelist>

</refsect1>


<refsect1>
<title>KEYS</title>

<literallayout>
Ctrl+J	clear private window
Ctrl+O	clear channel window
Ctrl+L	redraw screen
Ctrl+F	scroll window up
Ctrl+B	scroll window down
Ctrl+R	change active scrolling window 
	(see rightmost character of 
	topic/console lines)
Ctrl-T  shrink private window size
Ctrl-G  grow private window size
Ctrl+X  toggle private window
        (pops up on private messages)
TAB	nick completion
</literallayout>

</refsect1> 





<refsect1>
<title>DEVEL</title>

<para>You can get the most recent version of vchat-client via git, e.g:
<screen>
<prompt>$ </prompt><userinput>git clone git://erdgeist.org/vchat-client</userinput>
</screen>
</para>

<para>(press return at password prompt) no autoconf yet, sorry. required libs:
<literallayout>
   - openssl (1.0.1g+ preferred)
   - readline (4.2+ preferred)
   - ncurses (5.2 preferred)
</literallayout>
</para>
	
<para>please adjust the Makefile according to your need, then run 'make' to compile,
'make install' to install and ./vchat-client to start the binary. 
nope, I don't have any intention to use autoconf for this hack.</para>

<para>run '<command>fakeroot make -f debian/rules binary</command>' or 
'<command>dpkg-buildpackage -rfakeroot</command>' to build a debian 
package from the source.</para>

<para>The Makefile knows the targets "all, install, uninstall, clean"</para>

<literallayout>

FILES:
   README           - you're reading it.
   TODO             - list of things to do
   vchat-client.c   - main() and utility functions
   vchat-config.h   - configuration defaults
   vchat-keygen     - key generator with anon CA - 
                      server support required
   vchat-messages.h - server messages -- function 
                      correlation
   vchat-protocol.c - handling of server 
                      connection & messages
   vchat-ui.c       - user-interface and readline 
                      handling
   vchat-user.c     - userlist handling
   vchat.h          - global structures and functions
   debian/          - the debian package build 
                      directory
</literallayout>
	
<para>everything should be self-explantory, but please don't refrain to ask and/or
give bug reports, feature requests, hints and tricks, etc etc ..</para>
	
<para>Andreas Kotes <email>count@flatline.de</email></para>

</refsect1>



<refsect1>
<title>SSL</title>
	
<para>if you want to use an SSL certificate with the default configuration you need
to put the key in ~/.vchat/key and the certificate in ~/.vchat/cert, both in
PEM format. You can generate a key and a certificate by calling vchat-keygen,
but the server you connect needs to know same anon CA provided by
vchat-keygen, which currently isn't supported anywhere.</para>
	
<para>to upload your certificate use nick-request.pl from the vchat-server 
source available at ftp://vchat.vaxbusters.org. Thisfor at least one of 
the admins has to be logged in.</para>

</refsect1>



<refsect1>

<title>SEE ALSO</title>
<para>gcc (1), git (1).</para>

</refsect1>



<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by Hans Freitag &dhemail; for
vchat-client system.  Permission is granted to copy, distribute 
and/or modify this document under the terms of the 
<acronym>GNU</acronym> Free Documentation License, Version 1.1 
or any later version published by the Free Software Foundation; 
with no Invariant Sections, no Front-Cover
Texts and no Back-Cover Texts.</para>
</refsect1>



</refentry>
	
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->