path: root/vchat-client.sgml

<!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.15")</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.15")</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 ("HIGH:MEDIUM")</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 CVS, e.g:
<screen>
<prompt>$ </prompt><userinput>cvs -d:pserver:anonymous@pulse.flatline.de:/home/cvsroot login</userinput>
<prompt>$ </prompt><userinput>cvs -z3 -d:pserver:anonymous@pulse.flatline.de:/home/cvsroot co vchat-client</userinput>
</screen>
</para>

<para>(press return at password prompt) no autoconf yet, sorry. required libs:
<literallayout>
   - openssl (0.9.6+ 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), cvs (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:
-->