ncurses 5.9 - patch 20120107
[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.7 2012/01/07 21:26:05 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.6.1 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 It is necessary to unset the TERM environment variable, to activate the
59 Windows console-driver.
60
61 Please also make sure that MSYS links to the correct directory containing
62 your MinGW toolchain. For TDM this is usually C:\MinGW64. In your Windows
63 CMD.EXE command shell go to the MSYS root directory (most probably
64 C:\MSYS or C:\MSYS\1.0) and verify, that there is a junction point mingw
65 that points to the MinGW toolchain directory. If not, delete the mingw
66 directory and use the mklink command (or the linkd.exe utility on older
67 Windows) to create the junction point.
68
69 This code requires WindowsNT 5.1 or better, which means on the client
70 Windows XP or better, on the server Windows Server 2003 or better.
71
72 I recommend using libtool to build ncurses on MinGW, because libtool
73 knows exactly how to build dll's on Windows for use with MinGW.
74
75 To build a modern but still small footprint ncurses that provides
76 hooks for interop, I recommend using these options:
77
78           --with-libtool
79           --disable-home-terminfo
80           --enable-database
81           --disable-termcap
82           --enable-sp-funcs
83           --enable-term-driver
84           --enable-interop
85
86 This is the configuration commandline as I'm using it at the moment (assuming environment variable MINGW_ROOT to hold the root directory name of your MinGW build):
87
88 ./configure \
89         --prefix=$MINGW_ROOT \
90         --with-cxx \
91         --without-ada \
92         --enable-warnings \
93         --enable-assertions \
94         --disable-home-terminfo \
95         --enable-database \
96         --enable-sp-funcs \
97         --enable-term-driver \
98         --enable-interop \
99         --disable-termcap \
100         --with-progs \
101         --with-libtool \
102         --enable-pc-files \
103         --mandir=$MINGW_ROOT/share/man
104
105 Please note that it is also necessary to set this environment variable:
106
107 export PATH_SEPARATOR=";"
108
109 in order to parse the terminfo paths correctly. Terminfo paths should
110 always be separated by a seeeemicolon,even when running under MSYS.
111
112 To support regular expressions properly, ncurses under MinGW should be
113 linked against the gnurx regex library, which must be built separately
114 under MinGW.  See
115
116     ftp.gnome.org/pub/GNOME/binaries/win32/dependencies/libgnurx-src-2.5.zip
117
118 All the options above are - like the whole Windows support -
119 experimental.
120
121 A lot is still TODO, e.g.:
122
123   - Wide Character support
124     The Win32Con driver should actually only use Unicode in the
125     future.
126   - Thread support (locking). If using TDM toolchain this is done by
127     configuring pthreads.
128   - A GUI console driver
129   - Support for Terminals attached via a serial port (via terminfo)
130   - Support for networked Terminal connections (via terminfo)
131   - Workarounds for MinGW's filesystem access are necessary to make infocmp
132     work (though tic works).
133
134 To support terminfo, we need to have an ioctl() simulation for the
135 serial and networked Terminals.