ncurses 5.8 - patch 20110226
[ncurses.git] / README.MinGW
1 -------------------------------------------------------------------------------
2 -- Copyright (c) 2008-2010,2011 Free Software Foundation, Inc.               --
3 --                                                                           --
4 -- Permission is hereby granted, free of charge, to any person obtaining a   --
5 -- copy of this software and associated documentation files (the             --
6 -- "Software"), to deal in the Software without restriction, including       --
7 -- without limitation the rights to use, copy, modify, merge, publish,       --
8 -- distribute, distribute with modifications, sublicense, and/or sell copies --
9 -- of the Software, and to permit persons to whom the Software is furnished  --
10 -- to do so, subject to the following conditions:                            --
11 --                                                                           --
12 -- The above copyright notice and this permission notice shall be included   --
13 -- in all copies or substantial portions of the Software.                    --
14 --                                                                           --
15 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS   --
16 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF                --
17 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN --
18 -- NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,       --
19 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR     --
20 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE --
21 -- USE OR OTHER DEALINGS IN THE SOFTWARE.                                    --
22 --                                                                           --
23 -- Except as contained in this notice, the name(s) of the above copyright    --
24 -- holders shall not be used in advertising or otherwise to promote the      --
25 -- sale, use or other dealings in this Software without prior written        --
26 -- authorization.                                                            --
27 -------------------------------------------------------------------------------
28 -- $Id: README.MinGW,v 1.5 2011/02/26 16:57:17 tom Exp $
29 -- Author: Juergen Pfeifer
30 -------------------------------------------------------------------------------
31
32 This is work in progress, but it's in an state where one can see it
33 works at least on the Windows Console.
34
35 You should install the MSYS package, so that you've a shell environment that
36 allows you to run the scripts, especially configure etc.  You can get that
37 from http://www.mingw.org
38
39 To build ncurses for native Windows, you need the MinGW toolchain.  The
40 original MinGW toolchain from the above site is only for 32-Bit Windows.  As
41 Windows Server - and also regular workstations - are moving to 64-Bit, it
42 seems to be reasonable to have a toolchain that supports both architectures. 
43 I recommend to use the TDM gcc toolchain which you can find at
44 http://tdm-gcc.tdragon.net/download.  Go to the download section and select
45 the bundle installer for tdm64 (MinGW-w64).  This installs a multilib version
46 of the gcc toolchain that can compile for native 32- and 64-Bit Windows
47 versions.  It also comes with a working pthread implementation.
48
49 The latest config and build scripts we use for MinGW have only been tested
50 for the gcc-4.4 compiler toolchain (or better).
51
52 Using MinGW is a pragmatic decision, it's the easiest way to port this
53 heavily UNIX based sourcebase to native Windows. The goal is of course
54 to provide the includes, libraries and DLLs to be used with the more
55 common traditional development environments on Windows, mainly with
56 Microsoft Visual Studio.
57
58 If you start a bash from the MSYS environment, please make sure that the
59 Microsoft Development tools are in your PATH right after the MinGW
60 tools. The LIB.EXE tool is the only one needed. You need this only if 
61 you want to build DLLs that work with native Windows programs. If you 
62 don't have any Microsoft  Development tools on your machine, consider 
63 at least to get the free "Visual C++ 2010 Express Edition". 
64 It contains the LIB.EXE tool. You may also use this compiler to test 
65 writing native Windows programs using the ncurses DLLs without using 
66 MinGW then for writing apps.
67
68 It is necessary to unset the TERM environment variable, to activate the
69 Windows console-driver.
70
71 Please also make sure that MSYS links to the correct directory containing
72 your MinGW toolchain. For TDM this is usually C:\MinGW64. In your Windows
73 CMD.EXE command shell go to the MSYS root directory (most probably 
74 C:\MSYS or C:\MSYS\1.0) and verify, that there is a junction point mingw
75 that points to the MinGW toolchain directory. If not, delete the mingw
76 directory and use the mklink command (or the linkd.exe utility on older
77 Windows) to create the junction point.
78
79 This code requires WindowsNT 5.1 or better, which means on the client
80 Windows XP or better, on the server Windows Server 2003 or better.
81
82 In order to build ncurses for the planned interop layer with .NET, we
83 recommend to use these options with configure
84
85           --disable-home-terminfo
86           --enable-reentrant
87           --enable-sp-funcs
88           --enable-term-driver
89           --enable-interop
90           --with-pthread         (if using TDM toolchain as recommended)
91
92 This is the configuration commandline as I'm using it at the moment:
93
94 ./configure \
95         --prefix=/mingw \
96         --without-cxx-binding \
97         --without-ada \
98         --enable-warnings \
99         --enable-assertions \
100         --enable-reentrant \
101         --with-debug \
102         --with-normal \
103         --disable-home-terminfo \
104         --enable-sp-funcs \
105         --enable-term-driver \
106         --enable-interop \
107         --with-pthread
108
109 If you are on a 64-Bit Windows system and want to build a 32-Bit version
110 of ncurses, you may use this commandline for configuration (when using
111 the TDM toolchain):
112
113 CC="gcc -m32" LD="ld -m32" ./configure \
114         --prefix=/mingw \
115         --without-cxx-binding \
116         --without-ada \
117         --enable-warnings \
118         --enable-assertions \
119         --enable-reentrant \
120         --with-debug \
121         --with-normal \
122         --disable-home-terminfo \
123         --enable-sp-funcs \
124         --enable-term-driver \
125         --enable-interop \
126         --with-pthread
127
128 All the options above are - like the whole Windows support -
129 experimental.
130
131 In order to build the DLLs, after your regular make you must call
132
133    make dlls
134
135 A lot is still TODO, e.g.:
136
137   - Wide Character support
138     The Win32Con driver should actually only use Unicode in the
139     future.
140   - Thread support (locking). If using TDM toolchain this is done by
141     configuring pthreads.
142   - A GUI console driver
143   - Support for Terminals attached via a serial port (via terminfo)
144   - Support for networked Terminal connections (via terminfo)
145   - Workarounds for MinGW's filesystem access are necessary to make infocmp
146     work (though tic works).
147
148 To support terminfo, we need to have an ioctl() simulation for the
149 serial and networked Terminals.