root/trunk/licq/doc/README

Revision 6529, 4.0 kB (checked in by flynd, 3 months ago)

Bumped Licq version. Added Qt4-Gui as alternative to Qt-Gui. Added a few systems that I know can compile Licq.

  • Property svn:eol-style set to native
Line 
1LICQ v1.3.6
2
3An ICQ clone written in C and C++ using a plugin system to allow for
4many possible interfaces.
5See the webpage (http://www.licq.org) for more information.
6Licq implements messages (online and offline), urls, chat, full file
7transfer, gui configuration (with the qt-gui or qt4-gui plugin), history as
8well as a number of other features.
9
10
11LICENSE
12
13This program is licensed under the terms of the GNU GPL, a copy
14of which you should have received with this package.
15
16
17INSTALLATION:
18
19(If you have a binary distribution then see the FAQ for how to
20 do a manual install.  Don't worry it's very easy, any monkey
21 could do it.)
22
231. Type './configure' and it will determine all the right settings and
24   directories for your system.
252. Type 'make' and in theory it will build. If you are using a non-GNU system,
26   such as FreeBSD or Solaris, you will need the GNU version of make, often
27   installed as `gmake'.  If you get errors about "void *" see the FAQ.
283. Type
29   su -c 'make install'
30   and licq will be installed (defaults to /usr/local).
314. Depending on which GUI you want to use, go to plugins/qt-gui or
32   plugins/qt4-gui and follow the directions there (doc/README) to install
33   the Qt interface plugin (necessary).
34
35As each user:
365. When you run licq for the first time it will install all the necessary
37   files in ~/.licq.
386. You can import users from a number of other clients into Licq using
39   one of the conversion scripts found on the download section of the web
40   page or in the licq-data package.
41
42Licq requires the following:
43Some C++ compiler with proper standard c++ headers.
44
45SOCKS5 Proxy Support:
46Licq supports SOCKS5 proxies.  To enable this support, run configure with
47--enable-socks5, and optionally --with-socks5-inc=PATH and
48--with-socks5-lib=PATH.  Then just make sure all the right environment
49variables are set and it should work.  Also read the SOCKS.HOWTO file.
50
51Licq has been compiled and run successfully on the following systems at one
52point (note current versions may no longer compile without a bit of tweaking):
53Linux/amd64
54Linux/x86
55Linux/Alpha
56Linux/PPC
57FreeBSD/i386
58AIX/RS6000
59NetBSD/mk68000
60OpenBSD/sparc
61Sun3/mk68000
62Solaris/x86
63Unixware
64Solaris/sparc
65
66CONFIGURATION:
67
68Configuration is done through the file ~/.licq/licq.conf, which contains .ini
69style options.  The contact list is stored in users.conf.
70Each users info is stored as a simple text file called users/<uin>.Licq.
71Again, the options are pretty obvious. You can add/remove/edit a user inside
72the gui, or by editing the conf files.
73
74The History file is the file where the user history is stored...
75You can specify a filename for each user, or you can put one of the following
76keywords in users/<uin>.Licq:
77history = none      :keep no history file for this user
78history = default   :makes the history file history/<uin>.Licq.history
79
80
81USE:
82
83Type licq -h for commandline help.
84
85Using licq is fairly straight-forward.  Licq itself is merely a daemon
86designed to run various plugin interfaces.  I have written an advanted
87gui in qt (qt-gui) which should be used as the default plugin.  Once you
88have compiled and installed Licq, unpack the plugins you wish to use into
89the plugins/ directory, compile them, and then install them into
90/usr/local/share/licq/plugins (replace /usr/local with the prefix given
91to configure if necessary).  Then start licq with the -p option:
92$ licq -p qt-gui -- ...any options to the plugin...
93
94Note the -- which tells the system to pass any options after that on to the
95first plugin in the list.  Multiple plugins can be chained in this way:
96$ licq -p qt-gui -p email-forward -- <qt-gui options> -- <email-forward options>
97
98
99PROBLEMS:
100
101See the BUGS file for reports on known bugs and problems.
102
103
104TROUBLE-SHOOTING:
105
1061. RUNNING
107o  Segfault at startup.  If this occurs, run licq with the -d 15 switch and tell
108   me how far it gets before segfaulting and I'll try and help. You can report
109   such problems to the mailinglist licq-devel@lists.sourceforge.net.
110
111Good luck.
112
113
114CONTACTS:
115
116Send any questions, comments, or other complaints to
117licq-devel@lists.sourceforge.net.
Note: See TracBrowser for help on using the browser.