w32installer/shared/README.txt

* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>.


Introduction
~~~

Thank you for using irssi-win32-0.8.15.

This package includes Perl scripting support, as well as mintty 1.0.3.


Important Usage Information
~~~

When running Irssi for Windows, Irssi's Perl functionality, /help and /away commands may exhibit strange behavior.

To ensure that this functionality works properly, run the following Irssi commands:

        /set awaylog_file ~/.irssi/away.log
        /set help_path share/irssi/help
        /set perl_use_lib lib/perl5/5.10/i686-cygwin
        /save

You only have to run these commands once after starting from a fresh/default Irssi configuration.

Note that you currently cannot quit Irssi by clicking the mintty window's "X" icon.
This is because mintty sends the SIGHUP signal when the "X" is clicked, and Irssi reloads its configuration when it receives SIGHUP (this is as designed).
Instead, please quit Irssi by using its built-in /quit command.


Build Instructions
~~~

If you wish to compile Irssi 0.8.15 for Windows yourself, here are build instructions:

        1) Install Cygwin (available at http://cygwin.com), adding the following packages to the default configuration:

                Devel/gcc4
                Devel/gcc-core
                Devel/gcc-g++
                Devel/gettext
                Devel/gettext-devel (missing libintl.a)
                Devel/libncurses-devel (terminfo support)
                Devel/make
                Devel/pkg-config (detects glib2)
                Devel/zlib-devel
                Interpreters/perl
                Libs/glib2.0
                Libs/libglib2.0_0
                Libs/libglib2.0-devel
                Libs/libopenssl098
                Libs/openssl-devel
                   
        2) Download the Irssi source code from http://irssi.org and save it to C:/cygwin/home/<username>
        
        3) Open a Cygwin terminal, and run the following commands:

                tar xzvf irssi-*.tar.gz
                cd ./irssi-*

                (If you'd like Perl support:)
                CFLAGS='-DUSEIMPORTLIB' ./configure --with-proxy --with-perl-staticlib --prefix=/cygdrive/c/irssi

                (If you don't want Perl support:)
                CFLAGS='-DUSEIMPORTLIB' ./configure --with-proxy --with-perl=no --prefix=/cygdrive/c/irssi

                make
                make install
                        
        4) Now you can start Irssi with C:/irssi/bin/irssi.exe from inside the Cygwin terminal.
        
        5) If you didn't opt for Perl support, skip to step 6. If you did opt for Perl support, and you want to distribute your compiled binary, you can copy/merge the contents of the /lib/perl5/5.10 folder from your Cygwin installation into the corresponding folder in your Irssi directory tree (irssi/lib/perl5/5.10).

        6) Copy:
                
                a. The .cmd and .vbs files included in this package to your irssi\bin directory
                b. The 'startup' file included in this package to your irssi root directory
                c. The \usr\share\terminfo directory from your Cygwin installation to your Irssi root directory,
                   so that the Irssi root directory contains its own usr\share\terminfo directory

        Note that appropriate Cygwin DLLs and mintty need to be copied to irssi\bin in order for Irssi to be distributable.


Credits
~~~

This package is a modified, updated version of the irssi-win32-0.8.10 package assembled by Nei, available at
        
        http://anti.teamidiot.de/nei/2007/01/irssi_0810_for_windows_cygwinw/index.html

This README is based on Nei's informative original README, which is included below.

The Irssi binary included in this package was compiled under Cygwin and assembled by Josh Dick.
The NSIS installer script for this package was created by Sebastian Pipping and Josh Dick. 

This package was made possible by:
        The Irssi team (http://www.irssi.org/)
        #irssi at IRCnet (irc://open.ircnet.net/#irssi),
        Cygwin (http://www.cygwin.com),
        NSIS (http://nsis.sourceforge.net),
        and of course, Nei (http://anti.teamidiot.de/nei/2007/01/irssi_0810_for_windows_cygwinw/index.html).

Enjoy!

-Josh Dick <josh@joshdick.net>
-Sebastian Pipping <webmaster@hartwork.org>


Old README
~~~
        
Below the README originally distributed with Nei's irssi-win32-0.8.10 package.

--------------------------------------------

Build instructions are available on

        http://anti.teamidiot.de/nei/2007/01/irssi_0810_for_windows_cygwinw/#more

Running
~~~

Simply start irssi.cmd to run Irssi in PuTTY or irssi-cmd.cmd to
run Irssi in the default Windows terminal emulator.
The *.bat files are for Windows 9x / ME, but see below.


Titlebar
~~~~

If you want to have a meaningful titlebar, you can copy the
startup file to

        N:/Documents and Settings/Yourname/.irssi/startup
        %USERPROFILE%/.irssi/startup
        %HOMEPATH%/.irssi/startup

Alternatively you can get a more featured titlebar script on

        http://scripts.irssi.org/


Windows 9x / ME
~~~~~~~

This package does not officially support Windows 9x / ME. But I
have included Old-Windows start files nonetheless.
You can try to get it running by starting irssi.bat to run Irssi
in PuTTY or irssi-cmd.bat to run Irssi in the default Windows
terminal emulator.
If the Irssi crashes on /quit, just ignore it :).


About Cygwin paths
~~~~~~~~~

A note to computer users without Cygwin experience:
You can find your drive contents in /cygdrive/driveletter/, for
example:

        /cygdrive/n/Documents and Settings/Nei/Desktop/hello.mp3

Please note that Irssi's file completion is broken for filenames
containing spaces. You CAN use these files e.g. in DCC sends,
but you have to come up with the whole path on your own. Ex.:

        /dcc send Nei "/cygrive/n/Documents and Settings/Nei/x.y"

Note the required "" to enclose your filename if it contains
spaces.


Responsible
~~~~~

This Irssi/Cygwin package was created by Nei. Reachable on
QuakeNet with the account name ailin.

http://anti.teamidiot.de/
1	* This program is free software: you can redistribute it and/or modify
2	* it under the terms of the GNU General Public License as published by
3	* the Free Software Foundation, either version 2 of the License, or
4	* (at your option) any later version.
5	*
6	* This program is distributed in the hope that it will be useful,
7	* but WITHOUT ANY WARRANTY; without even the implied warranty of
8	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9	* GNU General Public License for more details.
10	*
11	* You should have received a copy of the GNU General Public License
12	* along with this program. If not, see <http://www.gnu.org/licenses/>.
13
14
15
16	Introduction
17	~~~
18
19	Thank you for using irssi-win32-0.8.15.
20
21	This package includes Perl scripting support, as well as mintty 1.0.3.
22
23
24
25	Important Usage Information
26	~~~
27
28	When running Irssi for Windows, Irssi's Perl functionality, /help and /away commands may exhibit strange behavior.
29
30	To ensure that this functionality works properly, run the following Irssi commands:
31
32	/set awaylog_file ~/.irssi/away.log
33	/set help_path share/irssi/help
34	/set perl_use_lib lib/perl5/5.10/i686-cygwin
35	/save
36
37	You only have to run these commands once after starting from a fresh/default Irssi configuration.
38
39	Note that you currently cannot quit Irssi by clicking the mintty window's "X" icon.
40	This is because mintty sends the SIGHUP signal when the "X" is clicked, and Irssi reloads its configuration when it receives SIGHUP (this is as designed).
41	Instead, please quit Irssi by using its built-in /quit command.
42
43
44	Build Instructions
45	~~~
46
47	If you wish to compile Irssi 0.8.15 for Windows yourself, here are build instructions:
48
49	1) Install Cygwin (available at http://cygwin.com), adding the following packages to the default configuration:
50
51	Devel/gcc4
52	Devel/gcc-core
53	Devel/gcc-g++
54	Devel/gettext
55	Devel/gettext-devel (missing libintl.a)
56	Devel/libncurses-devel (terminfo support)
57	Devel/make
58	Devel/pkg-config (detects glib2)
59	Devel/zlib-devel
60	Interpreters/perl
61	Libs/glib2.0
62	Libs/libglib2.0_0
63	Libs/libglib2.0-devel
64	Libs/libopenssl098
65	Libs/openssl-devel
66
67	2) Download the Irssi source code from http://irssi.org and save it to C:/cygwin/home/<username>
68
69	3) Open a Cygwin terminal, and run the following commands:
70
71	tar xzvf irssi-*.tar.gz
72	cd ./irssi-*
73
74	(If you'd like Perl support:)
75	CFLAGS='-DUSEIMPORTLIB' ./configure --with-proxy --with-perl-staticlib --prefix=/cygdrive/c/irssi
76
77	(If you don't want Perl support:)
78	CFLAGS='-DUSEIMPORTLIB' ./configure --with-proxy --with-perl=no --prefix=/cygdrive/c/irssi
79
80	make
81	make install
82
83	4) Now you can start Irssi with C:/irssi/bin/irssi.exe from inside the Cygwin terminal.
84
85	5) If you didn't opt for Perl support, skip to step 6. If you did opt for Perl support, and you want to distribute your compiled binary, you can copy/merge the contents of the /lib/perl5/5.10 folder from your Cygwin installation into the corresponding folder in your Irssi directory tree (irssi/lib/perl5/5.10).
86
87	6) Copy:
88
89	a. The .cmd and .vbs files included in this package to your irssi\bin directory
90	b. The 'startup' file included in this package to your irssi root directory
91	c. The \usr\share\terminfo directory from your Cygwin installation to your Irssi root directory,
92	so that the Irssi root directory contains its own usr\share\terminfo directory
93
94	Note that appropriate Cygwin DLLs and mintty need to be copied to irssi\bin in order for Irssi to be distributable.
95
96
97
98	Credits
99	~~~
100
101	This package is a modified, updated version of the irssi-win32-0.8.10 package assembled by Nei, available at
102
103	http://anti.teamidiot.de/nei/2007/01/irssi_0810_for_windows_cygwinw/index.html
104
105	This README is based on Nei's informative original README, which is included below.
106
107	The Irssi binary included in this package was compiled under Cygwin and assembled by Josh Dick.
108	The NSIS installer script for this package was created by Sebastian Pipping and Josh Dick.
109
110	This package was made possible by:
111	The Irssi team (http://www.irssi.org/)
112	#irssi at IRCnet (irc://open.ircnet.net/#irssi),
113	Cygwin (http://www.cygwin.com),
114	NSIS (http://nsis.sourceforge.net),
115	and of course, Nei (http://anti.teamidiot.de/nei/2007/01/irssi_0810_for_windows_cygwinw/index.html).
116
117	Enjoy!
118
119	-Josh Dick <josh@joshdick.net>
120	-Sebastian Pipping <webmaster@hartwork.org>
121
122
123
124	Old README
125	~~~
126
127	Below the README originally distributed with Nei's irssi-win32-0.8.10 package.
128
129	--------------------------------------------
130
131	Build instructions are available on
132
133	http://anti.teamidiot.de/nei/2007/01/irssi_0810_for_windows_cygwinw/#more
134
135	Running
136	~~~
137
138	Simply start irssi.cmd to run Irssi in PuTTY or irssi-cmd.cmd to
139	run Irssi in the default Windows terminal emulator.
140	The *.bat files are for Windows 9x / ME, but see below.
141
142
143	Titlebar
144	~~~~
145
146	If you want to have a meaningful titlebar, you can copy the
147	startup file to
148
149	N:/Documents and Settings/Yourname/.irssi/startup
150	%USERPROFILE%/.irssi/startup
151	%HOMEPATH%/.irssi/startup
152
153	Alternatively you can get a more featured titlebar script on
154
155	http://scripts.irssi.org/
156
157
158	Windows 9x / ME
159	~~~~~~~
160
161	This package does not officially support Windows 9x / ME. But I
162	have included Old-Windows start files nonetheless.
163	You can try to get it running by starting irssi.bat to run Irssi
164	in PuTTY or irssi-cmd.bat to run Irssi in the default Windows
165	terminal emulator.
166	If the Irssi crashes on /quit, just ignore it :).
167
168
169	About Cygwin paths
170	~~~~~~~~~
171
172	A note to computer users without Cygwin experience:
173	You can find your drive contents in /cygdrive/driveletter/, for
174	example:
175
176	/cygdrive/n/Documents and Settings/Nei/Desktop/hello.mp3
177
178	Please note that Irssi's file completion is broken for filenames
179	containing spaces. You CAN use these files e.g. in DCC sends,
180	but you have to come up with the whole path on your own. Ex.:
181
182	/dcc send Nei "/cygrive/n/Documents and Settings/Nei/x.y"
183
184	Note the required "" to enclose your filename if it contains
185	spaces.
186
187
188	Responsible
189	~~~~~
190
191	This Irssi/Cygwin package was created by Nei. Reachable on
192	QuakeNet with the account name ailin.
193
194	http://anti.teamidiot.de/