]> code.citadel.org Git - citadel.git/commitdiff
Initial import.
authorH Jalfi <hjalfi@uncensored.citadel.org>
Sat, 18 Feb 2006 19:32:09 +0000 (19:32 +0000)
committerH Jalfi <hjalfi@uncensored.citadel.org>
Sat, 18 Feb 2006 19:32:09 +0000 (19:32 +0000)
gaim-citadel/.project [new file with mode: 0644]
gaim-citadel/README [new file with mode: 0644]
gaim-citadel/mkdistr.sh [new file with mode: 0755]

diff --git a/gaim-citadel/.project b/gaim-citadel/.project
new file mode 100644 (file)
index 0000000..9c2d60f
--- /dev/null
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+       <name>gaim-citadel</name>
+       <comment></comment>
+       <projects>
+       </projects>
+       <buildSpec>
+       </buildSpec>
+       <natures>
+       </natures>
+</projectDescription>
diff --git a/gaim-citadel/README b/gaim-citadel/README
new file mode 100644 (file)
index 0000000..5536c4d
--- /dev/null
@@ -0,0 +1,91 @@
+                           CITADEL GAIM PLUGIN V0.3
+                           ========================
+
+                         Copyright © 2006 David Given
+
+INTRODUCTION
+============
+
+Gaim-Citadel is a plugin for Gaim that allows you to connect to the Citadel
+groupware suite. It enables you to see who else is logged in to the Citadel
+server, and to communicate with them via instant messages (pages in Citadel
+terminology).
+
+Needless to say, you need Gaim to make this work. You also need access to
+a Citadel server to connect to.
+
+INSTALLATION
+============
+
+Gaim-Citadel depends on the following software:
+
+       gaim: currently, Gaim-Citadel only works on Gaim 1.5. It may work on
+           2.0, but it has not been tested.
+       
+       lua 5.0: available from http://www.lua.org/download.html.
+
+    tolua 5.0: available from http://www.tecgraf.puc-rio.br/~celes/tolua.
+
+Gaim-Citadel uses Prime Mover as its build tool. To build, do:
+
+    ./pm
+
+This will compile Gaim-Citadel and install it into your ~/.gaim directory.
+The installation directory and other aspects of the build process are
+configurable by editing pmfile; the configuration variables are defined
+near the top and should be self-explanatory.
+
+USING GAIM-CITADEL
+==================
+
+Once installed, Gaim should see the plugin automatically. You can now tell
+Gaim about your Citadel account.
+
+There are three special settings (in the Extra Options section of the
+account preferences page):
+
+    Use TLS
+        Tells the plugin to use encryption when connecting to the Citadel
+        server. Defaults to on. STRONGLY RECOMMENDED! If you don't have
+        this set, your password will be sent in the clear across the
+        internet.
+        
+    Everyone's a buddy
+        Citadel is commonly used for fairly small groups of people, all
+        of whom know each other. Setting this option causes everybody
+        seen on the Citadel server to be automatically added to your
+        buddy list.
+    
+    Polling interval
+        The Citadel server protocol does not directly support
+        asynchronous presence updates. This means that Gaim has to repeatedly
+        poll the server to find out who's currently online. This setting
+        lets you control how often this happens (in seconds). For LAN
+        environments, 30 is probably appropriate. For servers across the
+        internet, leave it at 60 (the default).
+
+SUPPORT
+=======
+
+Gaim-Citadel was written by me, David Given and is not officially endorsed by
+the authors of the Citadel groupware suite. However, the best place to get
+support is probably on the official Citadel Support forum. This can be found
+on the Uncensored Citadel BBS. You can sign up for free by visiting:
+
+    http://uncensored.citadel.org
+
+My handle there is hjalfi. And yes, Gaim-Citadel works on Uncensored.
+
+LICENSE
+=======
+
+Gaim-Citadel is © 2006 by David Given and is distributed under a version 2 of
+the General Public License. You can find the full license text in the file
+'COPYING', supplied with this source package.
+
+-----------------------------------------------------------------------------
+David Given
+dg@cowlark.com
+2006-02-18
+
+/* $Id$ */
\ No newline at end of file
diff --git a/gaim-citadel/mkdistr.sh b/gaim-citadel/mkdistr.sh
new file mode 100755 (executable)
index 0000000..d8f069c
--- /dev/null
@@ -0,0 +1,37 @@
+#!/bin/sh
+# $Id$
+#
+# Script to build a distribution package.
+
+APPNAME=gaim-citadel
+
+set -e
+       
+if [ "$1" = "" ]; then
+       echo "Please specify a version number!"
+       exit 1
+fi
+
+if [ -d ../$APPNAME-$1 ]; then
+       echo "I think you've already generated version $1."
+       exit 1
+fi
+
+mkdir ../$APPNAME-$1
+cp -a --parents \
+       pm \
+       c.pm \
+       pmfile \
+       citadel.c \
+       citadel.lua \
+       gaim.pkg \
+       interface.h \
+       README \
+       COPYING \
+\
+       ../gaim-citadel-$1
+
+(cd .. && tar cvf $APPNAME-$1.tar.bz2 --bzip2 $APPNAME-$1)
+
+echo ""
+echo "Done --- but did you remember to update the version number?"