From dea6bf757aa9a875eab35b2b650412e7605f1308 Mon Sep 17 00:00:00 2001 From: erdgeist <> Date: Wed, 12 Feb 2003 17:48:37 +0000 Subject: CVS moved to erdgeist.org --- vchat-client.sgml | 376 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 376 insertions(+) create mode 100755 vchat-client.sgml (limited to 'vchat-client.sgml') 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"> + macrotron@president.eu.org"> + +]> + + + + +
+ &dhemail; +
+ + Hans + Freitag + + + 2001 + Andreas Kotes + + + + + + vchat-client + &dhsection; + + + +vchat-clientthis is vchat-client, a GPLed (SSL) +client for the vchat protocol. + + + + +vchat-client +-C configfile +-l +-z +-s host +-p port +-c channel +-n nickname +-f from + + + + + +DESCRIPTION +vchat-client connects to vchat chat system via ssl + + + + +OPTIONS + + + + configfile +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. + + + + +local connect (no SSL + connects localhost:2323) + + + + +don't use certificate files + + + + host +local connect (no SSL + connects localhost:2323) + + + + port +set port (default 2325) + + + + nickname +set nickname + + + + from +set from (default "vc-alpha-0.15") + + + + +prints out a help screen + + + + + + + + +CONFIGFILE +/etc/vchatrc and ~/.vchat/config +are the default config files of vchat-client. A third config file can be +given as command line Parameter. + + + +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 + + + +The config file syntax is "option=value"! it can be used to +configure the behavior of vchat-client + + + + + +Sets the nickname (default is NULL) + + + + +Sets the from (default is "vc-alpha-0.15") + + + + +Sets the host to connect to (default is pulse.flatline.de) + + + + +Set the port (default 2325) + + + + +Set ciphers ("HIGH:MEDIUM") + + + + +Set the certfile (default ~/.vchat/cert) + + + + +Set the keyfile (default ~/.vchat/key) + + + + +Set the formatfile (default ~/.vchat/formats) not impemented yet! + + + + +1|0 default=1 + + + + +1|0 default=1 + + + + +1|0 default=1 + + + + +set the heigth of the messages window default +is 0 (no messages window) + + + + +default=5 I don't know what this does, but I will +know in future. maybe you want to tell me. + + + + +number (default=0) + + + + +default=2048 + + + + +default=8192 + + + + +default=0 + + + + +default=86400 + + + + + + + + +KEYS + + +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 + + + + + + + + + +DEVEL + +You can get the most recent version of vchat-client via CVS, e.g: + +$ cvs -d:pserver:anonymous@pulse.flatline.de:/home/cvsroot login +$ cvs -z3 -d:pserver:anonymous@pulse.flatline.de:/home/cvsroot co vchat-client + + + +(press return at password prompt) no autoconf yet, sorry. required libs: + + - openssl (0.9.6+ preferred) + - readline (4.2+ preferred) + - ncurses (5.2 preferred) + + + +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. + +run 'fakeroot make -f debian/rules binary' or +'dpkg-buildpackage -rfakeroot' to build a debian +package from the source. + +The Makefile knows the targets "all, install, uninstall, clean" + + + +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 + + +everything should be self-explantory, but please don't refrain to ask and/or +give bug reports, feature requests, hints and tricks, etc etc .. + +Andreas Kotes count@flatline.de + + + + + + +SSL + +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. + +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. + + + + + + + +SEE ALSO +gcc (1), cvs (1). + + + + + + +AUTHOR +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 +GNU 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. + + + + + + + -- cgit v1.2.3