]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - Recipe
Document UNPROTECT define that disables tightened ACL.
[PuTTY.git] / Recipe
1 # -*- makefile -*-
2
3 # This file describes which PuTTY programs are made up from which
4 # object and resource files. It is processed into the various
5 # Makefiles by means of a Perl script. Makefile changes should
6 # really be made by editing this file and/or the Perl script, not
7 # by editing the actual Makefiles.
8
9 # ------------------------------------------------------------
10 # Top-level configuration.
11
12 # Overall project name.
13 !name putty
14 # Locations and types of output Makefiles.
15 !makefile vc windows/Makefile.vc
16 !makefile vcproj windows/MSVC
17 !makefile cygwin windows/Makefile.cyg
18 !makefile borland windows/Makefile.bor
19 !makefile lcc windows/Makefile.lcc
20 !makefile gtk unix/Makefile.gtk
21 !makefile unix unix/Makefile.ux
22 !makefile am Makefile.am
23 !makefile osx macosx/Makefile
24 !makefile devcppproj windows/DEVCPP
25 !makefile vstudio10 windows/VS2010
26 !makefile vstudio12 windows/VS2012
27 # Source directories.
28 !srcdir charset/
29 !srcdir windows/
30 !srcdir unix/
31 !srcdir macosx/
32
33 # Help text added to the top of each Makefile, with /D converted
34 # into -D as appropriate for the particular Makefile.
35
36 !begin help
37 #
38 # Extra options you can set:
39 #
40 #  - COMPAT=/DAUTO_WINSOCK (Windows only)
41 #      Causes PuTTY to assume that <windows.h> includes its own WinSock
42 #      header file, so that it won't try to include <winsock.h>.
43 #
44 #  - COMPAT=/DWINSOCK_TWO (Windows only)
45 #      Causes the PuTTY utilities to include <winsock2.h> instead of
46 #      <winsock.h>, except Plink which _needs_ WinSock 2 so it already
47 #      does this.
48 #
49 #  - COMPAT=/DNO_SECURITY (Windows only)
50 #      Disables Pageant's use of <aclapi.h>, which is not available
51 #      with some development environments (such as older versions of
52 #      the Cygwin/mingw GNU toolchain). This means that Pageant
53 #      won't care about the local user ID of processes accessing it; a
54 #      version of Pageant built with this option will therefore refuse
55 #      to run under NT-series OSes on security grounds (although it
56 #      will run fine on Win95-series OSes where there is no access
57 #      control anyway).
58 #
59 #  - COMPAT=/DNO_MULTIMON (Windows only)
60 #      Disables PuTTY's use of <multimon.h>, which is not available
61 #      with some development environments. This means that PuTTY's
62 #      full-screen mode (configurable to work on Alt-Enter) will
63 #      not behave usefully in a multi-monitor environment.
64 #
65 #      Note that this definition is always enabled in the Cygwin
66 #      build, since at the time of writing this <multimon.h> is
67 #      known not to be available in Cygwin.
68 #
69 #  - COMPAT=/DNO_HTMLHELP (Windows only)
70 #      Disables PuTTY's use of <htmlhelp.h>, which is not available
71 #      with some development environments. The resulting binary
72 #      will only look for an old-style WinHelp file (.HLP/.CNT), and
73 #      will ignore any .CHM file.
74 #
75 #      Note that this definition is always enabled in the Cygwin
76 #      build, since at the time of writing this <htmlhelp.h> is
77 #      known not to be available in Cygwin (although you can use
78 #      the htmlhelp.h supplied with HTML Help Workshop).
79 #
80 #  - RCFL=/DNO_MANIFESTS (Windows only)
81 #      Disables inclusion of XML application manifests in the PuTTY
82 #      binaries. This may be necessary to build for 64-bit Windows;
83 #      the manifests are only included to use the XP GUI style on
84 #      Windows XP, and the architecture tags are a lie on 64-bit.
85 #
86 #  - COMPAT=/DNO_IPV6
87 #      Disables PuTTY's ability to make IPv6 connections, enabling
88 #      it to compile under development environments which do not
89 #      support IPv6 in their header files.
90 #
91 #  - COMPAT=/DNO_GSSAPI
92 #      Disables PuTTY's ability to use GSSAPI functions for
93 #      authentication and key exchange.
94 #
95 #  - COMPAT=/DSTATIC_GSSAPI
96 #      Causes PuTTY to try to link statically against the GSSAPI
97 #      library instead of the default of doing it at run time.
98 #
99 #  - COMPAT=/DMSVC4 (Windows only)
100 #  - RCFL=/DMSVC4
101 #      Makes a couple of minor changes so that PuTTY compiles using
102 #      MSVC 4. You will also need /DNO_SECURITY and /DNO_MULTIMON.
103 #
104 #  - COMPAT=/DNO_SECUREZEROMEMORY (Windows only)
105 #      Disables PuTTY's use of SecureZeroMemory(), which is missing
106 #      from some environments' header files.  This is enabled by
107 #      default in the Cygwin Makefile.
108 #
109 #  - XFLAGS=/DTELNET_DEFAULT
110 #      Causes PuTTY to default to the Telnet protocol (in the absence
111 #      of Default Settings and so on to the contrary). Normally PuTTY
112 #      will default to SSH.
113 #
114 #  - XFLAGS=/DDEBUG
115 #      Causes PuTTY to enable internal debugging.
116 #
117 #  - XFLAGS=/DUNPROTECT
118 #      Disable tightened ACL on PuTTY process so that e.g. debuggers
119 #      can attach to it.
120 #
121 #  - XFLAGS=/DMALLOC_LOG
122 #      Causes PuTTY to emit a file called putty_mem.log, logging every
123 #      memory allocation and free, so you can track memory leaks.
124 #
125 #  - XFLAGS=/DMINEFIELD (Windows only)
126 #      Causes PuTTY to use a custom memory allocator, similar in
127 #      concept to Electric Fence, in place of regular malloc(). Wastes
128 #      huge amounts of RAM, but should cause heap-corruption bugs to
129 #      show up as GPFs at the point of failure rather than appearing
130 #      later on as second-level damage.
131 #
132 !end
133
134 # ------------------------------------------------------------
135 # Additional text added verbatim to each individual Makefile.
136
137 !begin vc vars
138 CFLAGS = $(CFLAGS) /DHAS_GSSAPI
139 !end
140
141 # `make install' target for Unix.
142 !begin gtk
143 install:
144         mkdir -p $(DESTDIR)$(bindir) $(DESTDIR)$(man1dir)
145         $(INSTALL_PROGRAM) -m 755 plink $(DESTDIR)$(bindir)/plink
146         $(INSTALL_PROGRAM) -m 755 pscp $(DESTDIR)$(bindir)/pscp
147         $(INSTALL_PROGRAM) -m 755 psftp $(DESTDIR)$(bindir)/psftp
148         $(INSTALL_PROGRAM) -m 755 pterm $(DESTDIR)$(bindir)/pterm
149         if test -n "$(UTMP_GROUP)"; then \
150           chgrp $(UTMP_GROUP) $(DESTDIR)$(bindir)/pterm && \
151             chmod 2755 $(DESTDIR)$(bindir)/pterm; \
152         elif test -n "$(UTMP_USER)"; then \
153           chown $(UTMP_USER) $(DESTDIR)$(bindir)/pterm && \
154             chmod 4755 $(DESTDIR)$(bindir)/pterm; \
155         fi
156         $(INSTALL_PROGRAM) -m 755 putty $(DESTDIR)$(bindir)/putty
157         $(INSTALL_PROGRAM) -m 755 puttygen $(DESTDIR)$(bindir)/puttygen
158         $(INSTALL_PROGRAM) -m 755 puttytel $(DESTDIR)$(bindir)/puttytel
159         $(INSTALL_DATA) -m 644 ../doc/plink.1 $(DESTDIR)$(man1dir)/plink.1
160         $(INSTALL_DATA) -m 644 ../doc/pscp.1 $(DESTDIR)$(man1dir)/pscp.1
161         $(INSTALL_DATA) -m 644 ../doc/psftp.1 $(DESTDIR)$(man1dir)/psftp.1
162         $(INSTALL_DATA) -m 644 ../doc/pterm.1 $(DESTDIR)$(man1dir)/pterm.1
163         $(INSTALL_DATA) -m 644 ../doc/putty.1 $(DESTDIR)$(man1dir)/putty.1
164         $(INSTALL_DATA) -m 644 ../doc/puttygen.1 $(DESTDIR)$(man1dir)/puttygen.1
165         $(INSTALL_DATA) -m 644 ../doc/puttytel.1 $(DESTDIR)$(man1dir)/puttytel.1
166
167 install-strip:
168         $(MAKE) install INSTALL_PROGRAM="$(INSTALL_PROGRAM) -s"
169 !end
170 !begin osx vars
171 CFLAGS += -DMACOSX
172 !end
173
174 # List the man pages for the automake makefile.
175 !begin am
176 man1_MANS = doc/plink.1 doc/pscp.1 doc/psftp.1 doc/pterm.1 \
177             doc/putty.1 doc/puttygen.1 doc/puttytel.1
178 !end
179
180 # In automake, chgrp/chmod pterm after installation, if configured to.
181 !begin am
182 if HAVE_SETID_CMD
183 install-exec-local:
184         @SETID_CMD@ $(bindir)/pterm
185         chmod @SETID_MODE@ $(bindir)/pterm
186 endif
187 !end
188
189 # Random symbols.
190 !begin cygwin vars
191 # _WIN32_IE is required to expose identifiers that only make sense on
192 # systems with IE5+ installed, such as some arguments to SHGetFolderPath().
193 # WINVER etc perform a similar function for FlashWindowEx().
194 CFLAGS += -D_WIN32_IE=0x0500
195 CFLAGS += -DWINVER=0x0500 -D_WIN32_WINDOWS=0x0410 -D_WIN32_WINNT=0x0500
196 !end
197
198 # ------------------------------------------------------------
199 # Definitions of object groups. A group name, followed by an =,
200 # followed by any number of objects or other already-defined group
201 # names. A line beginning `+' is assumed to continue the previous
202 # line.
203
204 # Terminal emulator and its (platform-independent) dependencies.
205 TERMINAL = terminal wcwidth ldiscucs logging tree234 minibidi
206          + config dialog conf
207
208 # GUI front end and terminal emulator (putty, puttytel).
209 GUITERM  = TERMINAL window windlg winctrls sizetip winucs winprint
210          + winutils wincfg sercfg winhelp winjump miscucs
211
212 # Same thing on Unix.
213 UXTERM   = TERMINAL uxcfg sercfg uxucs uxprint timing callback miscucs
214 GTKTERM  = UXTERM gtkwin gtkcfg gtkdlg gtkfont gtkcols xkeysym
215 OSXTERM  = UXTERM osxwin osxdlg osxctrls
216
217 # Non-SSH back ends (putty, puttytel, plink).
218 NONSSH   = telnet raw rlogin ldisc pinger
219
220 # SSH back end (putty, plink, pscp, psftp).
221 SSH      = ssh sshcrc sshdes sshmd5 sshrsa sshrand sshsha sshblowf
222          + sshdh sshcrcda sshpubk sshzlib sshdss x11fwd portfwd
223          + sshaes sshsh256 sshsh512 sshbn wildcard pinger ssharcf
224          + sshgssc pgssapi sshshare
225 WINSSH   = SSH winnoise wincapi winpgntc wingss winshare winnps winnpc
226          + winhsock errsock
227 UXSSH    = SSH uxnoise uxagentc uxgss uxshare
228
229 # SFTP implementation (pscp, psftp).
230 SFTP     = sftp int64 logging
231
232 # Miscellaneous objects appearing in all the network utilities (not
233 # Pageant or PuTTYgen).
234 MISC     = timing callback misc version settings tree234 proxy conf
235 WINMISC  = MISC winstore winnet winhandl cmdline windefs winmisc winproxy
236          + wintime winhsock errsock winsecur
237 UXMISC   = MISC uxstore uxsel uxnet uxpeer cmdline uxmisc uxproxy time
238 OSXMISC  = MISC uxstore uxsel osxsel uxnet uxpeer uxmisc uxproxy time
239
240 # Character set library, for use in pterm.
241 CHARSET  = sbcsdat slookup sbcs utf8 toucs fromucs xenc mimeenc macenc localenc
242
243 # Standard libraries.
244 LIBS     = advapi32.lib user32.lib gdi32.lib comctl32.lib comdlg32.lib
245          + shell32.lib winmm.lib imm32.lib winspool.lib ole32.lib
246
247 # Network backend sets. This also brings in the relevant attachment
248 # to proxy.c depending on whether we're crypto-avoidant or not.
249 BE_ALL   = be_all cproxy
250 BE_NOSSH = be_nossh nocproxy
251 BE_SSH   = be_ssh cproxy
252 BE_NONE  = be_none nocproxy
253 # More backend sets, with the additional Windows serial-port module.
254 W_BE_ALL = be_all_s winser cproxy
255 W_BE_NOSSH = be_nos_s winser nocproxy
256 # And with the Unix serial-port module.
257 U_BE_ALL = be_all_s uxser cproxy
258 U_BE_NOSSH = be_nos_s uxser nocproxy
259
260 # ------------------------------------------------------------
261 # Definitions of actual programs. The program name, followed by a
262 # colon, followed by a list of objects. Also in the list may be the
263 # keywords [G] for Windows GUI app, [C] for Console app, [X] for
264 # X/GTK Unix app, [U] for command-line Unix app.
265
266 putty    : [G] GUITERM NONSSH WINSSH W_BE_ALL WINMISC winx11 putty.res LIBS
267 puttytel : [G] GUITERM NONSSH W_BE_NOSSH WINMISC puttytel.res nogss LIBS
268 plink    : [C] winplink wincons NONSSH WINSSH W_BE_ALL logging WINMISC
269          + winx11 plink.res winnojmp noterm LIBS
270 pscp     : [C] pscp winsftp wincons WINSSH BE_SSH SFTP wildcard WINMISC
271          + pscp.res winnojmp LIBS
272 psftp    : [C] psftp winsftp wincons WINSSH BE_SSH SFTP wildcard WINMISC
273          + psftp.res winnojmp LIBS
274
275 pageant  : [G] winpgnt sshrsa sshpubk sshdes sshbn sshmd5 version tree234
276          + misc sshaes sshsha winsecur winpgntc sshdss sshsh256 sshsh512
277          + winutils winmisc winhelp conf pageant.res LIBS
278
279 puttygen : [G] winpgen sshrsag sshdssg sshprime sshdes sshbn sshmd5 version
280          + sshrand winnoise sshsha winstore misc winctrls sshrsa sshdss winmisc
281          + sshpubk sshaes sshsh256 sshsh512 import winutils puttygen.res
282          + tree234 notiming winhelp winnojmp conf LIBS wintime
283
284 pterm    : [X] GTKTERM uxmisc misc ldisc settings uxpty uxsel BE_NONE uxstore
285          + uxsignal CHARSET cmdline uxpterm version time xpmpterm xpmptcfg
286          + nogss
287 putty    : [X] GTKTERM uxmisc misc ldisc settings uxsel U_BE_ALL uxstore
288          + uxsignal CHARSET uxputty NONSSH UXSSH UXMISC ux_x11 xpmputty
289          + xpmpucfg
290 puttytel : [X] GTKTERM uxmisc misc ldisc settings uxsel U_BE_NOSSH
291          + uxstore uxsignal CHARSET uxputty NONSSH UXMISC xpmputty xpmpucfg
292          + nogss
293
294 plink    : [U] uxplink uxcons NONSSH UXSSH U_BE_ALL logging UXMISC uxsignal
295          + ux_x11 noterm
296
297 puttygen : [U] cmdgen sshrsag sshdssg sshprime sshdes sshbn sshmd5 version
298          + sshrand uxnoise sshsha misc sshrsa sshdss uxcons uxstore uxmisc
299          + sshpubk sshaes sshsh256 sshsh512 import puttygen.res time tree234
300          + uxgen notiming conf
301
302 pscp     : [U] pscp uxsftp uxcons UXSSH BE_SSH SFTP wildcard UXMISC
303 psftp    : [U] psftp uxsftp uxcons UXSSH BE_SSH SFTP wildcard UXMISC
304
305 PuTTY    : [MX] osxmain OSXTERM OSXMISC CHARSET U_BE_ALL NONSSH UXSSH
306          + ux_x11 uxpty uxsignal testback putty.icns info.plist