summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rwxr-xr-xREADME78
1 files changed, 78 insertions, 0 deletions
diff --git a/README b/README
new file mode 100755
index 0000000..4e5310f
--- /dev/null
+++ b/README
@@ -0,0 +1,78 @@
1Hi!
2
3this is vchat-client, a GPLed (SSL) client for the vchat protocol.
4
5You can get the most recent version of vchat-client via CVS, e.g:
6
7cvs -d:pserver:anonymous@pulse.flatline.de:/home/cvsroot login
8cvs -z3 -d:pserver:anonymous@pulse.flatline.de:/home/cvsroot co vchat-client
9
10(press return at password prompt)
11
12no autoconf yet, sorry. required libs:
13
14openssl (0.9.6+ preferred)
15readline (4.2+ preferred)
16ncurses (5.2 preferred)
17
18please adjust the Makefile according to your need, then run 'make' to compile,
19./vchat-client to start the binary. nope, I don't have any intention to use
20autoconf for this hack.
21
22run 'fakeroot make -f debian/rules binary' to build a debian package from the
23source.
24
25Keyboard commands:
26
27^J - clear private window
28^O - clear channel window
29^L - redraw screen
30^F - scroll window up
31^B - scroll window down
32^R - change active scrolling window
33 (see rightmost character of topic/console lines)
34^T - shrink private window size
35^G - grow private window size
36^X - toggle private window
37 (pops up on private messages)
38TAB - nick completion
39
40We also do provide a set of IRC like / - commands, there are:
41
42/CONFIG - not implemented yet, but will be used for configuration
43/QUIT reason - issue .x reason
44/USER regex - list users matching regex
45/FLT C regex - add regex to filter list... read ./filters for details
46/RMFLT regex|id - remove filter regex or id from filter list
47/LSFLT (C) - list all filter rules (matching C)
48/CLFLT (C) - remove all filter rules (matching C)
49/M(SG) user msg - issue .m user msg
50/LH - print hilitelist
51/ME action - issue .a action
52
53if you want to use an own window for messages set "messages" to a value in
54~./vchat/config ..
55
56if you want to use an SSL certificate with the default configuration you need
57to put the key in ~/.vchat/key and the certificate in ~/.vchat/cert, both in
58PEM format. You can generate a key and a certificate by calling vchat-keygen,
59but the server you connect needs to know the anon CA provided by vchat-keygen,
60which currently isn't the case anywhere.
61
62FILES:
63
64 README - you're reading it.
65 TODO - list of things to do
66 vchat-client.c - main() and utility functions
67 vchat-config.h - configuration defaults
68 vchat-keygen - key generator with anon CA - server support required
69 vchat-messages.h - server messages <-> function correlation
70 vchat-protocol.c - handling of server connection & messages
71 vchat-ui.c - user-interface and readline handling
72 vchat-user.c - userlist handling
73 vchat.h - global structures and functions
74
75everything should be self-explantory, but please don't refrain to ask and/or
76give bug reports, feature requests, hints and tricks, etc etc ..
77
78 Andreas Kotes <count@flatline.de>