silc-client: SILC Plugin compilation changes

[silc.git] / README.PLUGIN

diff --git a/README.PLUGIN b/README.PLUGIN
index ad8f1a6546a98dd14b66d855643fdefe83ede306..f5023687df46c32850f9d5e54c7bd53099551289 100644 (file)
--- a/README.PLUGIN
+++ b/README.PLUGIN
@@ -1,17 +1,68 @@
-In order to compile the SILC Plugin (instead of the SILC Client), pass the
+Compiling SILC Plugin for Irssi
+===============================
+
+In order to compile the SILC Plugin (instead of the SILC Client), pass 
+the following options to configure, if your Irssi is installed into
+/usr/bin/irssi and /usrlib/irssi:
+
+       --prefix=/usr
+       --with-silc-plugin
+       --without-silc-includes
+       --enable-shared
+
+If your Irssi is installed in some other location than /usr/lib, then 
+pass its location to --prefix and --with-silc-plugin, for example:
+
+       --prefix=/usr/local
+       --with-silc-plugin=/usr/local/lib/irssi
+       --without-silc-includes
+       --enable-shared
+
+On some Linux systems Irssi libs may actually be in /usr/lib64/irssi.
+In that case pass that path as argument to --with-silc-plugin.
+
+Depending on your OS/architecture you may also need to pass the 
 following options to configure:
 
-       --enable-silc-plugin --without-silc-includes
+       --with-pic
+       --without-pthreads
 
-Depending on your OS/architecture you may also need to pass:
 
-       --with-pic --without-pthreads
+Using SILC Plugin with Irssi
+============================
 
-For installing the SILC Plugin to the appropriate directories, you have to
-define the following paths (assuming Irssi is installed to /usr)
+After you have compiled and installed the plugin, you can load the 
+plugin in Irssi using:
 
-       --prefix=/usr
-       --with-simdir=/usr/lib/irssi
+        /LOAD silc
+
+You can configure the SILC plugin run time with the /SILC command.  See
+the help with:
+
+        /HELP silc/silc
+
+To list all SILC commands available, use normal /HELP command.  To get 
+help about specific SILC command, use (replace <command> with the command 
+of your choice):
+
+        /HELP silc/<command>
+
+For a more detailed help on SILC commands or some FAQs, please refer to 
+the SILCNet homepage. Once you have successfully load the SILC plugin, 
+you can connect to the SILCNet:
+
+        /SERVER silc.silcnet.org
+
+or,
+
+        /CONNECT -silcnet SILCNet silc.silcnet.org
+
+You might want to join the channel "silc" then...
+
+        /JOIN -silcnet silc
+
+If you have compiled Irssi with perl support, you should also load the 
+silc and silc-mime scripts:
 
-If you're using Irssi 0.8.10, you may need to rename libfe_common_silc.so to
-libfe_silc.so
+        /SCRIPT LOAD silc
+        /SCRIPT LOAD silc-mime