Add doc/Contributing.txt to distribution archive
[ngircd-alex.git] / doc / README-Interix.txt
1
2                      ngIRCd - Next Generation IRC Server
3                            http://ngircd.barton.de/
4
5                (c)2001-2012 Alexander Barton and Contributors.
6                ngIRCd is free software and published under the
7                    terms of the GNU General Public License.
8
9                          -- README-Interix.txt --
10
11
12 ngIRCd release 15 has successfully been tested on Microsoft Windows XP
13 Professional using the Services for UNIX (SFU) version 3.5 and Microsoft
14 Windows 7 with the bundled Subsystem for UNIX Applications (SUA).
15
16 SFU are supported on Windows 2000, Windows 2000 Server, Windows XP, and
17 Windows Server 2003. SUA is supported on Windows Server 2003 R2, Windows
18 Server 2008 & 2008 R2, Windows Vista, and Windows 7 -- so ngIRCd should be
19 able to run on all of these platforms.
20
21 But please note that two things:
22
23 1. Don't use the poll() IO API
24
25 The poll() API function is not fully implemented by SFU/SUA and therefore
26 can't be used by ngIRCd -- which normally would be the default. Please see
27 <http://www.suacommunity.com/faqs.aspx> section 4.25 for details:
28
29   "If you do try to use the poll() API your program will block on the
30   API call forever. You must direct your program to build using the
31   select() API."
32
33 So when running the ./configure script, you HAVE TO DISABLE poll() support:
34
35   ./configure --without-poll
36
37 ngIRCd then defaults to using the select() API function which works fine.
38
39 2. Use GNU make(1)
40
41 Starting with ngIRCd 18, our build system doesn't work with the default
42 make(1) binary of Interix, you should use GNU make instead (tested with
43 version 3.82 built from source).
44