GNU Gadu User Reference

Abstract


The aim of this document is to show and describe using GNU Gadu from the perspective of an end user.

Copyright Notice

Copyleft 2005, Marcin P. Kobierzycki

This document can be used and propagated under the terms of the GNU General Public License v2. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

Contents

1.1 What is GNU Gadu?
1.2 Plugins available in GNU Gadu
1.3 Plans for the future; TODO

2.1 Available binary packages for UNIX-like systems
2.2 Source packages and CVS Snapshots;
2.3 The `configure' script; installing GNU Gadu
2.4 Getting GNU Gadu source directly from CVS; Creating the `configure' script.

3.1 Plugins and configuration files
3.2 Basic conference/multichat handling
3.3 Themes & skins handling

4.1 How can I help?
4.2 Contact with the authors

Chapter 1 - Introduction

1.1 What is GNU Gadu?


GNU Gadu is an "Instant Messenger" programme created to work with protocols popular in Poland (but not only). This programme is based on extensible plug-in idea, moreover graphical user interface (written in GTK+) is a plugin. We support Gadu-Gadu, Tlen.pl and Jabber protocols currently.

1.2 Plugins available in GNU Gadu.


* GUI-GTK2
* GUI with gtkspell support
* Gadu-Gadu
* Tlen.pl
* Jabber
* XOSD
* docklet-system-tray
* docklet-dockapp
* sound ESD
* sound aRts
* sound OSS
* sound external
* SMS
* Auto Away
* Ignore
* update
* external history viewer
* remote (deprecated)
* DBUS
* gghist - history viewer
* perl support (experimental)

1.3 Plans for the future; TODO

Chapter 2 - Getting GNU Gadu working

2.1 Available binary packages for UNIX-like systems.

The easiest way to get GNU Gadu working is to fetch and install the apropriate binary package for your UNIX-like operating system. Below is the list of such packages:

* PLD Linux Distribution
* Fedora
* Mandrake
* Debian
* Ubuntu
* Slackware
* FreeBSD
* Yoper
* ArchLinux

2.2 Source packages and CVS Snapshots

The other way to get GNU Gadu is to download a source package either from SourceForge outlink. Keep in mind that it hosts only source packages of the final releases of GNU Gadu, while http://snap.gnugadu.org keeps daily generated CVS snapshots.

2.3 The configure script; installing GNU Gadu

Installing the programme from these packages is very easy -- all you have to do is to execute the

 configure
script and
 make && make install

In order to change the standard behaviour of the configure script you can use the following flags:
* --with-all-plugins Build all plugins with all features
* --with-perl perl support - experimental code
* --without-gghist Build without gghist
* --without-gui Build without gtk2 GUI plugin
* --with-x Use the X Window System
* --without-gtkspell Build without GUI plugin with gtkspell support
* --without-gadu Build without gadu-gadu plugin
* --with-external-libgadu Build with gadu-gadu plugin with external libgadu
* --with-gnutls Build with gnutls (default=yes)
* --without-tlen Build without tlen plugin
* --without-jabber Build without jabber plugin
* --without-xosd Build without XOSD plugin
* --without-sms Build without sms plugin
* --without-aaway Build without auto away plugin
* --without-ignore Build without ignore plugin
* --with-dbus Build with DBUS plugin
* --with-dbus-dir=DIR Prefix where D-BUS services are installed
* --without-docklet-system-tray Build without docklet plugin
* --without-docklet-dockapp Build without dockapp plugin
* --without-esd Build without esd sound plugin
* --with-esd-prefix=PFX Prefix where ESD is installed (optional)
* --with-esd-exec-prefix=PFX Exec prefix where ESD is installed (optional)
* --without-arts Build without aRts! sound plugin
* --without-oss Build without OSS sound plugin
* --without-external Build without external player sound plugin
* --without-history-external-viewer Build without external history plugin
* --without-update Build without update plugin

2.4 Getting GNU Gadu source directly from CVS; Creating the configure script

Sometimes you might want to obtain GNU Gadu source directly from CVS. In order to do that you should execute the following commands:

 cvs -d :pserver:anonymous@ggadu.cvs.sourceforge.net:/cvsroot/ggadu login
then
 cvs -d :pserver:anonymous@ggadu.cvs.sourceforge.net:/cvsroot/ggadu co ./

In such case you should moreover generate the configure script simply by executing the autogen.sh script. The rest of the installation process is the same as described in previous sections.

NOTE: If you have GNU Gadu compiled and installed from a source package and just want to update the source to the version from CVS you don't need to generate or execute the configure script -- just fetch the source and execute:
 make && make install

Chapter 3 - GNU Gadu interface.

This chapter may not be complete as we are waiting for suggestions what should be described here

3.1 Plugins and configuration files

Executing the configure script with option --with-FOO-PLUGIN doesn't necessarily mean that plugin FOO-PLUGIN is loaded at the start of GNU Gadu 2. You must also make sure that it's selected in: 'Preferences->Plugin manager'.

Configuration files and history logfiles are stored in

 ~/.gg2/
Remember not to mess with them if you don't know what you're doing.

3.2 Basic conference/multichat handling

This functionality is only available in gadu-gadu plugin. To use it you should select a few contacts on the list, right-click one of them and select 'Chat'.

3.3 Themes & skins handling

GNU Gadu supports GTK outlink theme switching -- it's available in 'Preferences->Advanced' as well as skins -- also available in 'Preferences->Advanced'. A directory for skins is:

 ~/.gg2/skins/

Chapter 4 - Miscellaneous.

4.1 How can I help?

In various ways:

* By sending suggestions, reporting bugs etc.
* By sending suggestions concerning this documentation.
* By writing bugfixes and implementing new features.
* By commiting new plugins for GNU Gadu.
* By donating money to authors :-)

4.2 Contact with the authors

You can contact authors by e-mail -- see AUTHORS file or by the mailing lists at SourceForge outlink.

GNU Gadu User Reference
v0.00; 30 September 2005

Marcin P. Kobierzycki, m-kobierzycki at debian.linux.org.pl