aniani/irssi
1
0
Fork 0
mirror of https://github.com/irssi/irssi.git synced 2024-11-03 04:27:19 -05:00
Code
57e247f8e6
irssi/README
Timo Sirainen 53b248f6de Sorry for a big update - I still don't have internet connection at home 
and this is what I've been doing a few weeks now.. :) You really shouldn't
upgrade to this version without keeping a backup of the working one, since
this will break everything and at least notify list is broken - probably
something else too.

* On the way to 0.8.0 .. Major rewriting/rearranging code. There's
  some changes in behaviour because I'm trying to make Irssi a bit
  more compatible with EPIC.

* libPropList isn't needed anymore - I'm using my own configuration
  library. This is mostly because different proplists worked a bit
  differently everywhere and several people had problems with it.
  It's also yet another extra library that you needed to compile
  Irssi. New configuration library has several advantages:

  You can add comments to configuration file and they also stay
  there when it's saved.

  It's not nearly as vulnerable as proplist. If some error occurs,
  instead of just not reading anything it will try to continue if
  possible. Also the error messages are written to irssi's text
  window instead of stdout.

  It can be managed more easily than proplist - setting/getting the
  configuration is a lot more easier.

* Coding style changes - I'm not using gint, gchar etc. anymore,
  they're just extra pain when moving code to non-glib projects and
  syntax hilighting doesn't work by default with most editors ;)

  Indentation style was also changed to K&R because of some political
  reasons ;) And I'm already starting to like it.. :) It forces me
  to split code to different functions more often and the result is
  that the code gets more readable.

  And finally I'm also using nst' all over the place.

+ /EVAL <commands> - Expand all the special variables from string and
  run it. Commands can be split with ; character. See
  docs/SPECIAL_VARS for more info.
+ Aliases are parsed just like /EVAL - arguments are in $0..$9.
+ Text formats are also parsed like /EVAL, arguments used to be in
  $1..$9, now they're in $0..$8 so it messes up existing themes..
+ /SET [key [value]] - no more the '=' character. Boolean values
  also need to be changed with ON/OFF/TOGGLE values (not yes/no).
  Settings aren't saved to disk until you use /SAVE.
+ /TOGGLE <key> [ON/OFF] - same as /SET <key> TOGGLE


git-svn-id: http://svn.irssi.org/repos/irssi/trunk@163 dbcabf3a-b0e7-0310-adc4-f8d773084564
2000-04-14 11:27:14 +00:00

106 lines
3.7 KiB
Plaintext
Raw Blame History

irssi
* ABOUT
Irssi is an IRC client made with GTK+ toolkit and (optional) GNOME
libraries. A small text mode version is also somewhat working, there's
also a really simple daemon version which just loads "bot" plugin. I'd
also like to see KDE version.
* FEATURES
See docs/COMMANDS file for list of (almost) all commands irssi knows.
See docs/PERL for some documentation of Perl scripting.
I've been asked quite a lot about why should one use irssi, what does it do
that other IRC clients don't? Well, to tell you the truth, I have no idea :)
Still I've got a lot of mails saying it's the best GUI IRC client they've
ever used :) Let's see.. It should be easy to use, it has most of the
features IRC client needs and it's pretty stable. Here's a small list of what
it does:
- Nice configuration :) Especially the color settings.
- You can connect to multiple servers. Irssi is also IRC network aware so
you can specify some settings to work only in specified IRC networks.
- Automatically connect to IRC server(s) at startup, automatically join to
channels when connected.
- All code is nonblocking, it won't hang while connecting to server or
opening DCC connection. Host lookups are done in separate processes.
- DCC send, receive and chat with GUI
- GNOME panel support, channels and queries are displayed in GNOME panel
where you can easily see which channels have been updated (label turns to
red) and click in them to open the channel.
- Doubleclicking URL in text widget launches specified web/ftp/email client,
also doubleclicking channel/nick join to channel or creates query.
- Aliases, ignores, autoignoring when flooding, notify lists, completing
specified words with tab (like home<tab> -> http://my.home.page),
hilighting lines with specified texts
- Smart nick completion
- Configurable logging support
- Plugins support, creating plugins is really easy.
- Extremely flexible Perl scripting support.
- Lots of nice GUI stuff :)
* PROXY PLUGIN
Usage:
Start irssi-text in screen,
connect to some irc server
/load proxy <password> [ip address to listen [port to listen]]
Finished, default port to listen in is 2777 and default ip is the ip
where your irc server is connected. Now just connect your clients to
the proxy. There's not much features yet, if you want to use multiple
servers you'll need to start multiple irssi-texts now..
* INSTALLATION
./configure
make
make install
Configure can use these parameters (all of these defaults to yes):
--with-servertest Build test irc server which you can use to try crash
irc clients
--with-socks Build with socks library
--with-mysql=dir Build with mysql plugin
--without-gtk Build without GTK frontend
--without-textui Build without text frontend
--without-bot Build without irssibot
--without-gnome Build without GNOME libraries
--without-gnome-panel Build without GNOME panel
--without-imlib Build without Imlib library (you can use only .xpm
files as backgrounds)
--enable-memdebug Enable memory debugging, great for finding memory
leaks
--enable-gtk-hebrew Enable Hebrew support - see README-HEBREW
--disable-perl Disable Perl support
There's also some others, you can get a full list with ./configure --help
* COMMAND LINE PARAMETERS
--no-applet Don't start gnome panel applet
--connect -c <server> Connect to server at startup
--port -p <port> - specify port
--noconnect -! Don't autoconnect to any servers at startup
--nick -n Specify what nick to use
* BUGS / SUGGESTIONS
See TODO file if it is already listed in there - if not send me email..
* AUTHOR
Timo Sirainen, tss@iki.fi, cras/ircnet/#irssi, http://xlife.dhs.org/irssi/
View Git Blame Copy Permalink