Skip to content

Commit

Permalink
Import from CVS
Browse files Browse the repository at this point in the history
  • Loading branch information
Colin Didier authored and astro committed Jan 21, 2009
0 parents commit 95c7b3c
Show file tree
Hide file tree
Showing 118 changed files with 10,534 additions and 0 deletions.
339 changes: 339 additions & 0 deletions COPYING

Large diffs are not rendered by default.

33 changes: 33 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# $Id: Makefile,v 1.7 2008/06/23 14:37:16 cdidier Exp $

include config.mk

all clean user-install user-uninstall:
@cd src/ && ${MAKE} $@

install:
@cd src/ && ${MAKE} $@
@${MAKE} doc-install help-install

uninstall: doc-uninstall help-uninstall
@cd src/ && ${MAKE} $@

doc-install:
@echo installing documentation files to ${DESTDIR}${IRSSI_DOC}/irssi-xmpp
@install -d ${DESTDIR}${IRSSI_DOC}/irssi-xmpp
@cd docs/ && install FAQ GENERAL MUC STARTUP XEP ${DESTDIR}${IRSSI_DOC}/irssi-xmpp

doc-uninstall:
@echo uninstalling documentation files from ${DESTDIR}${IRSSI_DOC}/irssi-xmpp
@rm -rf ${DESTDIR}${IRSSI_DOC}/irssi-xmpp

help-install:
@echo installing command help files to ${DESTDIR}${IRSSI_HELP}
@install -d ${DESTDIR}${IRSSI_HELP}
@cd help/ && install -m 644 roster xmppconnect xmppserver ${DESTDIR}${IRSSI_HELP}

help-uninstall:
@echo uninstalling command help files from ${DESTDIR}${IRSSI_HELP}
@cd ${DESTDIR}${IRSSI_HELP} && rm -f roster xmppconnect xmppserver

.PHONY: all clean install uninstall user-install user-uninstall doc-install doc-uninstall help-install help-uninstall
27 changes: 27 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
1.0 - ??/??/2008

+ Complete rewrite with a modular architecture
+ Better integration in irssi, many bug fixes and a big code cleanup
+ Better support of XMPP
+ Multi-User Chat (XEP-0045), Entity Use Cases and Occupant Use Cases
+ Message Events (XEP-0022) and Chat State Notifications (XEP-0085)
showed in the status-bar (status-bar "xmpp_composing"), you can
disable events sending (setting "xmpp_send_composing")
+ XMPP Ping (XEP-0199) support using the command /PING, it also allows
the lag-meter to work
+ Software Version (XEP-0092) support using /VER and vCard (XEP-0054)
using /WHOIS (partial retrieve)
+ Better UTF-8 support
+ HTTP proxy support
+ commands /XMPPCONNECT and /XMPPSERVER to connect easily to an
account
+ command /XMPPREGISTER to register an account using the In-Band
Registration (XEP-0077)
- /ME command on queries and rooms
- tab completion of JIDs, resources, user names and groups
(even with spaces)
- changing the priority (setting "xmpp_priority") takes effect
immediately
- basic status changes window (setting "xmpp_status_window") and raw
window (setting "xmpp_raw_window")
- and many others minor changes and fixes
84 changes: 84 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
irssi-xmpp:
===========

homepage: http://cybione.org/~irssi-xmpp/

About:
======

irssi-xmpp is an irssi plugin to connect to the Jabber network.

Its main features are:
o Sending and receiving messages in irssi's query windows
o A roster with contact & resource tracking (contact list)
o Contact management (add, remove, manage subscriptions)
o MUC (Multi-User Chat)
o Tab completion of commands, JIDs and resources
o Message Events ("composing")
o Support for multiple accounts
o Unicode support (UTF-8)
o SSL and HTTP proxy support
o ...

To deal with the XMPP protocol, it uses of the Loudmouth library.
Written in C and released under the GNU General Public License version 2.

Installation:
=============

Requirement:
o Loudmouth (>= 1.2.x): http://www.loudmouth-project.org/
o Irssi (>= 0.8.12) and its sources unpacked and configured:
http://irssi.org/

Procedure:
o edit the file "config.mk" if needed and export this environment
variable:
$ export IRSSI_INCLUDE=/path/to/irssi/sources
o build the sources:
$ make
o install the module:
- in your home directory:
$ make user-install
- in the base system:
# make install

Documentation:
==============

In the directory "docs/":
o STARTUP: Getting started
o GENERAL: How to use irssi-xmpp and related commands
o MUC: How to use Multi-User Chat and related commands
o FAQ: Frequently Asked Questions and Troubleshooting
o XEP: XMPP Extensions supported
o INTERNAL: How irssi-xmpp works

In the directory "help/" you can find the help files of each irssi-xmpp
specific commands, which can be viewed in irssi with the command /HELP.

Community/Bugs/Suggestions:
===========================

Mailing-list: irssi-xmpp-list@cybione.org
to subscribe: irssi-xmpp-list+subscribe@cybione.org
to unsuscibre: irssi-xmpp-list+unsubscribe@cybione.org

Commits-list: irssi-xmpp-commits@cybione.org
to subscribe: irssi-xmpp-commits+subscribe@cybione.org
to unsuscibre: irssi-xmpp-commits+unsubscribe@cybione.org

MUC room: irssi-xmpp@chat.jabberfr.org

Bug tracker: https://gna.org/bugs/?group=irssi-xmpp

If irssi crashes, please build irssi with debug symbols and the module
irssi-xmpp in debug mode (take a look at "config.mk" to activate it).
Then you can run irssi in gdb and print the backtrace ("bt full") when
irssi crashes. Paste the backtrace in your message would help to fix
this bug.

Author:
=======

Colin Didier (cdidier@cybione.org, xmpp:cdidier@im.cybione.org)
31 changes: 31 additions & 0 deletions config.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# paths
PREFIX ?= /usr/local

# where are the sources of irssi?
IRSSI_INCLUDE ?= ${PREFIX}/include/irssi
# where should be installed the module?
IRSSI_LIB ?= ${PREFIX}/lib/irssi
# where should be installed the documentation?
IRSSI_DOC ?= ${PREFIX}/share/doc/irssi
# where should be installed the help for commands ?
IRSSI_HELP ?= ${PREFIX}/share/irssi/help

# includes and libs
INCS = ${LIB_INCS} \
-I../../src/core \
-I${IRSSI_INCLUDE} \
-I${IRSSI_INCLUDE}/src \
-I${IRSSI_INCLUDE}/src/core \
-I$(IRSSI_INCLUDE)/src/fe-common/core \
`pkg-config --cflags loudmouth-1.0`
LIBS = ${LIB_LIBS}

# flags
CFLAGS = -fPIC -std=c99 -DUOFF_T_LONG ${INCS}
LDFLAGS = -shared ${LIBS}

# debug
CFLAGS += -W -ggdb -Wall

# compiler and linker
CC = cc
74 changes: 74 additions & 0 deletions docs/FAQ
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
1. Connection:
==============

1.1 How can I automatically load irssi-xmpp at irssi startup ?

Simply put "irssi-xmpp" in your startup file (~/.irssi/startup):
echo "irssi-xmpp" >> ~/.irssi/startup

1.2 How can I automatically connect to my account at irssi startup ?

You can put these things in your config file (The config file can be found
here : "~/.irssi/config"):

To create a XMPP network, add to chatnets section:
<network> = {
type = "XMPP";
nick = "<jid>";
};

Then you can add this at the end of the servers section:
{
address = "<address>";
port="<port>";
use_ssl = "{yes|no}";
chatnet = "<network>";
password = "<password>";
autoconnect = "{yes|no}";
};

Or in irssi, you can type this:
/SERVER ADD -xmppnet <network> <address> <port> <password> <jid>

If 0 is specified as port, the default port will be used (5222 for a regular
connection or 5223 for SSL).

Now you can connect to your jabber account by typing:
/CONNECT <network>
Or just restart irssi if you have set autoconnect to yes.

2. General:
===========

2.1 Why the lagmeter is not working ?

The server need to support the XEP-0199 (XMPP Ping). If it doesn't
support it, the lagmeter won't work.

If your server support the XMPP Ping, maybe you didn't add the composing
item in the statusbar. Take a look at the file GENERAL (section
"Composing in the statusbar:).

3. Scripting:
=============

3.1 How can I use or write scripts with irssi-xmpp ?

...

3.2 My script seems to be incompatible with irssi-xmpp and throws warnings
such as: Can't locate object method "xxx" via package "Irssi::Xmpp::Server".
How can I get rid of that ?

Basicly, it's because the script is IRC-specific and won't work with an
XMPP server. Try to add a condition in the functions of your script to
verify if the server is an IRC server and simply return if it is not.

4. Themes:
==========

4.1 How can I change the theme of the messages of irssi-xmpp ?

In the same way you can change the theme of the messages of irssi. Take
a look at the source file src/fe-common/module-formats.c to see the
whole list of irssi-xmpp messages.
Loading

0 comments on commit 95c7b3c

Please sign in to comment.