gaim-citadel/README

   1                           CITADEL GAIM PLUGIN V0.3.1
   2                           ==========================
   3
   4                          Copyright © 2006 David Given
   5
   6 INTRODUCTION
   7 ============
   8
   9 Gaim-Citadel is a plugin for Gaim that allows you to connect to the Citadel
  10 groupware suite. It enables you to see who else is logged in to the Citadel
  11 server, and to communicate with them via instant messages (pages in Citadel
  12 terminology).
  13
  14 Needless to say, you need Gaim to make this work. You also need access to
  15 a Citadel server to connect to.
  16
  17 INSTALLATION
  18 ============
  19
  20 Gaim-Citadel depends on the following software:
  21
  22         gaim: currently, Gaim-Citadel only works on Gaim 1.5. It may work on
  23             2.0, but it has not been tested.
  24
  25         lua 5.0: available from http://www.lua.org/download.html.
  26
  27     tolua 5.0: available from http://www.tecgraf.puc-rio.br/~celes/tolua.
  28
  29 Gaim-Citadel uses Prime Mover as its build tool. To build, do:
  30
  31     ./pm
  32
  33 This will compile Gaim-Citadel and install it into your ~/.gaim directory.
  34 The installation directory and other aspects of the build process are
  35 configurable by editing pmfile; the configuration variables are defined
  36 near the top and should be self-explanatory.
  37
  38 USING GAIM-CITADEL
  39 ==================
  40
  41 Once installed, Gaim should see the plugin automatically. You can now tell
  42 Gaim about your Citadel account.
  43
  44 There are three special settings (in the Extra Options section of the
  45 account preferences page):
  46
  47     Use TLS
  48         Tells the plugin to use encryption when connecting to the Citadel
  49         server. Defaults to on. STRONGLY RECOMMENDED! If you don't have
  50         this set, your password will be sent in the clear across the
  51         internet.
  52
  53     Everyone's a buddy
  54         Citadel is commonly used for fairly small groups of people, all
  55         of whom know each other. Setting this option causes everybody
  56         seen on the Citadel server to be automatically added to your
  57         buddy list.
  58
  59     Polling interval
  60         The Citadel server protocol does not directly support
  61         asynchronous presence updates. This means that Gaim has to repeatedly
  62         poll the server to find out who's currently online. This setting
  63         lets you control how often this happens (in seconds). For LAN
  64         environments, 30 is probably appropriate. For servers across the
  65         internet, leave it at 60 (the default).
  66
  67 SUPPORT
  68 =======
  69
  70 Gaim-Citadel was written by me, David Given and is not officially endorsed by
  71 the authors of the Citadel groupware suite. However, the best place to get
  72 support is probably on the official Citadel Support forum. This can be found
  73 on the Uncensored Citadel BBS. You can sign up for free by visiting:
  74
  75     http://uncensored.citadel.org
  76
  77 My handle there is hjalfi. And yes, Gaim-Citadel works on Uncensored.
  78
  79 LICENSE
  80 =======
  81
  82 Gaim-Citadel is © 2006 by David Given and is distributed under a version 2 of
  83 the General Public License. You can find the full license text in the file
  84 'COPYING', supplied with this source package.
  85
  86 -----------------------------------------------------------------------------
  87 David Given
  88 dg@cowlark.com
  89 2006-02-19
  90
  91 /* $Id$ */