Fix installation for silc-client and silc-toolkit packages
[silc.git] / README.PLUGIN
1 Compiling SILC Plugin for Irssi
2 ===============================
3
4 In order to compile the SILC Plugin (instead of the SILC Client), pass 
5 the following options to configure, if your Irssi is installed into
6 /usr/bin/irssi and /usr/lib/irssi:
7
8         --prefix=/usr
9         --with-silc-plugin
10         --without-silc-includes
11         --enable-shared
12
13 If your Irssi is installed in some other location than /usr/lib, then 
14 pass its location to --prefix and --with-silc-plugin, for example:
15
16         --prefix=/usr/local
17         --with-silc-plugin=/usr/local/lib/irssi
18         --without-silc-includes
19         --enable-shared
20
21 On some Linux systems Irssi libs may actually be in /usr/lib64/irssi.
22 In that case pass that path as argument to --with-silc-plugin.
23
24 Depending on your OS/architecture you may also need to pass the 
25 following options to configure:
26
27         --with-pic
28         --without-pthreads
29
30
31 Using SILC Plugin with Irssi
32 ============================
33
34 After you have compiled and installed the plugin, you can load the 
35 plugin in Irssi using:
36
37         /LOAD silc
38
39 You can configure the SILC plugin run time with the /SILC command.  See
40 the help with:
41
42         /HELP silc/silc
43
44 To list all SILC commands available, use normal /HELP command.  To get 
45 help about specific SILC command, use (replace <command> with the command 
46 of your choice):
47
48         /HELP silc/<command>
49
50 For a more detailed help on SILC commands or some FAQs, please refer to 
51 the SILCNet homepage. Once you have successfully load the SILC plugin, 
52 you can connect to the SILCNet:
53
54         /SERVER silc.silcnet.org
55
56 or,
57
58         /CONNECT -silcnet SILCNet silc.silcnet.org
59
60 You might want to join the channel "silc" then...
61
62         /JOIN -silcnet silc
63
64 If you have compiled Irssi with perl support, you should also load the 
65 silc and silc-mime scripts:
66
67         /SCRIPT LOAD silc
68         /SCRIPT LOAD silc-mime