climm - cli-based multi-messenger
$Id: README 2434 2007-10-13 22:21:51Z kuhlmann $ -*- coding: utf-8 -*-

current stable version: 0.6.1
====================================

a) About climm

climm is a very portable ICQ Console Client originally written by Matthew D.
Smith. climm is known to compile on many systems, including (but not limited
to) Linux, BSD, AIX, HPUX, BeOS, Windows and AmigaOS.

When the Author passed away 2001-01-05, some of us users overtook the
"leadership" of the project and its now actively developed by some of us
freaks.

For some time, Rico Glöckner <rg@climm.org> maintained the code. He also set
up the mailing list and hosts www.climm.org.

Right now, Rüdiger Kuhlmann maintains the code. All code to implement the
new v8 ICQ protocol is from him. In fact, huge parts of climm have been
rewritten completely by him.

b) Features

Features of climm include:

   * login          - login with both the old v6 and the new v8 protocol
   * register       - register new uins and setup configuration with an easy to
                      use setup wizard
   * password       - changing password
   * reconnect      - reconnects when kicked by server
   * contact list   - complete contact list with several ways for a concise
                      display of online/offline users
   * contact groups - arrange contacts into groups
   * server side contact list
                    - download server side contact list and show, diff or import
   * status         - set status arbitrarily
   * messages       - send and receive messages and urls
   * utf-8 messages - first non-official client to support sending and receiving
                      of unicode encoded messages (acknowledged _AND_ non-acknoledged)
   * sms            - send SMS to user's cell phone
   * user info      - request and update all user an dpersonal information
   * search         - easy search command, can search by (nearly) any information
   * visibility     - be visible to certain users even when invisible, or
                      be invisible to certain users at any time
   * ignore         - ignore certain users completely
   * chat group     - request user from interest group and set own's interest group
   * events         - can beep or execute arbitrary commands when other users go online,
                      offline or send a message.
   * remote control - can be operated from other programs via a FIFO
   * connections    - can show a users connection info and last seen online time
   * peek           - check whether someone is offline or just invisible
   * tcp            - full support of v8 direct connections
   * auto messages  - auto replys if away, request and send auto messages
   * file transfer  - v6, v7, v8 file transfer
   * identification - recognizes mICQ/climm, licq, Miranda, StrICQ, &RQ, vICQ
                      including version number, and YSM, Trillian, Kopete,
                      sim and some of the official client versions
   * history        - writes a log of all messages to and from a user
   * debugging      - easy debugging by selecting what data to display, including
                      concise packet monitor
   * i18n           - translations include English, German, Russian, French,
                      partially Spanish, Polish, Swedish, Hungarian.
   * transcoding    - transcode texts into arbitrary character encodings,
                      in particular for Russian and Japanese users.
   * utf-8          - can handle unicode input and output of arbitrary
                      single-charactercell unicode characters
   * birthday flag  - show if it is user's birthday
   * socks5         - supports connections via socks5

c) Translations

climm, its man page and the www.climm.org website are translated into several
languages, including English, German, Spanish and Russian. See the web page
for downloads of new translations.

d) Mailinglist

They are hosted by <rg@climm.org>.

Currently you:
    post	   
                                           <climm-list@climm.org>

    subscribe, unsubscribe, help
                   <URL:http://climm.org/mailman/listinfo/climm-list>

    An Archive might be found at:
                   <URL:http://climm.org/pipermail/climm-list/>


e) Download

Download climm sources and binaries from

    <URL:http://www.climm.org/>

f) SVN (subversion)

Required is the svn client, autoconf 2.59 or greater and automake 1.9 or
greater. automake 1.10 is recommended, however.

svn co http://svn.climm.org/climm/

To prepare the maintainer generated files:

$ ./prepare

This will run aclocal, autoheader, automake -ac and autoconf.

Note that if you don't have current autotools, there is a SVN snapshot that
you can download the includes the generated files just like in the release.
It does, however, contain .svn directories, so you can still use "svn up" to
update the checkout. Usually I upload a new snapshot when I make changes
to configure.ac or any of the Makefile.am files.

If that isn't enough because you made too much changes, you can link the
generated files from a SVN snapshot to a SVN checkout like this:

  cd climm  # the SVN check-out
  ln -s ../climm-svn/{install-sh,config.guess,config.sub,configure,depend,mkinstalldirs} .
  cd ../climm-svn  # the SVN snapshot
  find . -name "*.in" -exec ln -s ../climm-svn/\{\} ../climm/\{\}

g) Compile

$ ./configure --help
    Please read the help carefully. Particularly, if you are not "root",
    please watch the --prefix parameter.
$ ./configure 
$ make
$ su
# make install


h) Usage

Although climm has some command line options, for a quick start just type
'climm'. If you don't have a valid configuration, the setup wizard will guide
you through the process of creating one for you.

i) NOTE!

climm is in a phase of being re-organized, thus things may change
very fast. When in doubt, have a Look at http://www.climm.org/ or
the mailing list or contact me via ICQ.
However, look out for announcements on Freshmeat.net.
