]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - Recipe
Show the git commit hash in local dev builds too.
[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.mgw
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 devcppproj windows/DEVCPP
24 !makefile vstudio10 windows/VS2010
25 !makefile vstudio12 windows/VS2012
26 # Source directories.
27 !srcdir charset/
28 !srcdir windows/
29 !srcdir unix/
30
31 # Help text added to the top of each Makefile, with /D converted
32 # into -D as appropriate for the particular Makefile.
33
34 !begin help
35 #
36 # Extra options you can set:
37 #
38 #  - COMPAT=/DAUTO_WINSOCK (Windows only)
39 #      Causes PuTTY to assume that <windows.h> includes its own WinSock
40 #      header file, so that it won't try to include <winsock.h>.
41 #
42 #  - COMPAT=/DWINSOCK_TWO (Windows only)
43 #      Causes the PuTTY utilities to include <winsock2.h> instead of
44 #      <winsock.h>, except Plink which _needs_ WinSock 2 so it already
45 #      does this.
46 #
47 #  - COMPAT=/DNO_SECURITY (Windows only)
48 #      Disables use of <aclapi.h>, which is not available with some
49 #      development environments (such as very old versions of the
50 #      mingw/Cygwin GNU toolchain). This has the following effects:
51 #       - Pageant won't care about the local user ID of processes
52 #         accessing it; a version of Pageant built with this option
53 #         will therefore refuse to run under NT-series OSes on
54 #         security grounds (although it will run fine on Win95-series
55 #         OSes where there is no access control anyway).
56 #       - SSH connection sharing is disabled.
57 #       - There is no restriction of the process ACLs (on all versions
58 #         of Windows, without warning), as if UNPROTECT below were set.
59 #
60 #  - COMPAT=/DNO_MULTIMON (Windows only)
61 #      Disables PuTTY's use of <multimon.h>, which is not available
62 #      with some development environments. This means that PuTTY's
63 #      full-screen mode (configurable to work on Alt-Enter) will
64 #      not behave usefully in a multi-monitor environment.
65 #
66 #  - COMPAT=/DNO_HTMLHELP (Windows only)
67 #      Disables PuTTY's use of <htmlhelp.h>, which is not available
68 #      with some development environments. The resulting binary
69 #      will only look for an old-style WinHelp file (.HLP/.CNT), and
70 #      will ignore any .CHM file.
71 #
72 #      If you don't have this header, you may be able to use the copy
73 #      supplied with HTML Help Workshop.
74 #
75 #  - RCFL=/DNO_MANIFESTS (Windows only)
76 #      Disables inclusion of XML application manifests in the PuTTY
77 #      binaries. This may be necessary to build for 64-bit Windows;
78 #      the manifests are only included to use the XP GUI style on
79 #      Windows XP, and the architecture tags are a lie on 64-bit.
80 #
81 #  - COMPAT=/DNO_IPV6
82 #      Disables PuTTY's ability to make IPv6 connections, enabling
83 #      it to compile under development environments which do not
84 #      support IPv6 in their header files.
85 #
86 #  - COMPAT=/DNO_GSSAPI
87 #      Disables PuTTY's ability to use GSSAPI functions for
88 #      authentication and key exchange.
89 #
90 #  - COMPAT=/DSTATIC_GSSAPI
91 #      Causes PuTTY to try to link statically against the GSSAPI
92 #      library instead of the default of doing it at run time.
93 #
94 #  - COMPAT=/DMSVC4 (Windows only)
95 #  - RCFL=/DMSVC4
96 #      Makes a couple of minor changes so that PuTTY compiles using
97 #      MSVC 4. You will also need /DNO_SECURITY and /DNO_MULTIMON.
98 #
99 #  - COMPAT=/DNO_SECUREZEROMEMORY (Windows only)
100 #      Disables PuTTY's use of SecureZeroMemory(), which is missing
101 #      from some environments' header files.
102 #
103 #  - XFLAGS=/DTELNET_DEFAULT
104 #      Causes PuTTY to default to the Telnet protocol (in the absence
105 #      of Default Settings and so on to the contrary). Normally PuTTY
106 #      will default to SSH.
107 #
108 #  - XFLAGS=/DDEBUG
109 #      Causes PuTTY to enable internal debugging.
110 #
111 #  - XFLAGS=/DUNPROTECT
112 #      Disable tightened ACL on PuTTY process so that e.g. debuggers
113 #      can attach to it.
114 #
115 #  - XFLAGS=/DMALLOC_LOG
116 #      Causes PuTTY to emit a file called putty_mem.log, logging every
117 #      memory allocation and free, so you can track memory leaks.
118 #
119 #  - XFLAGS=/DMINEFIELD (Windows only)
120 #      Causes PuTTY to use a custom memory allocator, similar in
121 #      concept to Electric Fence, in place of regular malloc(). Wastes
122 #      huge amounts of RAM, but should cause heap-corruption bugs to
123 #      show up as GPFs at the point of failure rather than appearing
124 #      later on as second-level damage.
125 #
126 #  - XFLAGS=/DFUZZING
127 #      Builds a version of PuTTY with some tweaks to make fuzz testing
128 #      easier: the SSH random number generator is replaced by one that
129 #      always returns the same thing.  Note that this makes SSH
130 #      completely insecure -- a FUZZING build should never be used to
131 #      connect to a real server.
132 !end
133
134 # ------------------------------------------------------------
135 # Additional text added verbatim to each individual Makefile.
136
137 !cflags am version -DSOURCE_COMMIT=\"`git rev-parse HEAD 2>/dev/null`\"
138 !begin am
139 BUILT_SOURCES = empty.h
140 CLEANFILES = empty.h
141 empty.h: $(allsources)
142         echo '/* Empty file touched by automake makefile to force rebuild of version.o */' >$@
143
144 !end
145 !begin >empty.h
146 /* Empty file touched by automake makefile to force rebuild of version.o */
147 !end
148
149 !begin vc vars
150 CFLAGS = $(CFLAGS) /DHAS_GSSAPI
151 !end
152
153 # `make install' target for Unix.
154 !begin gtk
155 install:
156         mkdir -p $(DESTDIR)$(bindir) $(DESTDIR)$(man1dir)
157         $(INSTALL_PROGRAM) -m 755 plink $(DESTDIR)$(bindir)/plink
158         $(INSTALL_PROGRAM) -m 755 pscp $(DESTDIR)$(bindir)/pscp
159         $(INSTALL_PROGRAM) -m 755 psftp $(DESTDIR)$(bindir)/psftp
160         $(INSTALL_PROGRAM) -m 755 pterm $(DESTDIR)$(bindir)/pterm
161         if test -n "$(UTMP_GROUP)"; then \
162           chgrp $(UTMP_GROUP) $(DESTDIR)$(bindir)/pterm && \
163             chmod 2755 $(DESTDIR)$(bindir)/pterm; \
164         elif test -n "$(UTMP_USER)"; then \
165           chown $(UTMP_USER) $(DESTDIR)$(bindir)/pterm && \
166             chmod 4755 $(DESTDIR)$(bindir)/pterm; \
167         fi
168         $(INSTALL_PROGRAM) -m 755 putty $(DESTDIR)$(bindir)/putty
169         $(INSTALL_PROGRAM) -m 755 puttygen $(DESTDIR)$(bindir)/puttygen
170         $(INSTALL_PROGRAM) -m 755 puttytel $(DESTDIR)$(bindir)/puttytel
171         $(INSTALL_DATA) -m 644 ../doc/plink.1 $(DESTDIR)$(man1dir)/plink.1
172         $(INSTALL_DATA) -m 644 ../doc/pscp.1 $(DESTDIR)$(man1dir)/pscp.1
173         $(INSTALL_DATA) -m 644 ../doc/psftp.1 $(DESTDIR)$(man1dir)/psftp.1
174         $(INSTALL_DATA) -m 644 ../doc/pterm.1 $(DESTDIR)$(man1dir)/pterm.1
175         $(INSTALL_DATA) -m 644 ../doc/putty.1 $(DESTDIR)$(man1dir)/putty.1
176         $(INSTALL_DATA) -m 644 ../doc/puttygen.1 $(DESTDIR)$(man1dir)/puttygen.1
177         $(INSTALL_DATA) -m 644 ../doc/puttytel.1 $(DESTDIR)$(man1dir)/puttytel.1
178
179 install-strip:
180         $(MAKE) install INSTALL_PROGRAM="$(INSTALL_PROGRAM) -s"
181 !end
182
183 # List the man pages for the automake makefile.
184 !begin am
185 man1_MANS = doc/plink.1 doc/pscp.1 doc/psftp.1 doc/pterm.1 \
186             doc/putty.1 doc/puttygen.1 doc/puttytel.1
187 !end
188
189 # In automake, chgrp/chmod pterm after installation, if configured to.
190 !begin am
191 if HAVE_SETID_CMD
192 install-exec-local:
193         @SETID_CMD@ $(bindir)/pterm
194         chmod @SETID_MODE@ $(bindir)/pterm
195 endif
196 !end
197
198 # In automake makefile, build the OS X app bundle, if configured in
199 # Quartz mode.
200 !begin am
201 if HAVE_QUARTZ
202 noinst_SCRIPTS = unix/PuTTY.app unix/Pterm.app
203 unix/PuTTY.app: unix/putty.bundle puttyapp osxlaunch
204         rm -rf $@ && gtk-mac-bundler $<
205 unix/Pterm.app: unix/pterm.bundle ptermapp osxlaunch
206         rm -rf $@ && gtk-mac-bundler $<
207 endif
208 !end
209
210 # Random symbols.
211 !begin cygwin vars
212 # _WIN32_IE is required to expose identifiers that only make sense on
213 # systems with IE5+ installed, such as some arguments to SHGetFolderPath().
214 # WINVER etc perform a similar function for FlashWindowEx().
215 CFLAGS += -D_WIN32_IE=0x0500
216 CFLAGS += -DWINVER=0x0500 -D_WIN32_WINDOWS=0x0410 -D_WIN32_WINNT=0x0500
217 !end
218
219 # ------------------------------------------------------------
220 # Definitions of object groups. A group name, followed by an =,
221 # followed by any number of objects or other already-defined group
222 # names. A line beginning `+' is assumed to continue the previous
223 # line.
224
225 # Terminal emulator and its (platform-independent) dependencies.
226 TERMINAL = terminal wcwidth ldiscucs logging tree234 minibidi
227          + config dialog conf
228
229 # GUI front end and terminal emulator (putty, puttytel).
230 GUITERM  = TERMINAL window windlg winctrls sizetip winucs winprint
231          + winutils wincfg sercfg winhelp winjump miscucs
232
233 # Same thing on Unix.
234 UXTERM   = TERMINAL uxcfg sercfg uxucs uxprint timing callback miscucs
235 GTKTERM  = UXTERM gtkwin gtkcfg gtkdlg gtkfont gtkcols gtkmisc xkeysym
236          + x11misc gtkcomm
237
238 # Non-SSH back ends (putty, puttytel, plink).
239 NONSSH   = telnet raw rlogin ldisc pinger
240
241 # SSH back end (putty, plink, pscp, psftp).
242 SSH      = ssh sshcrc sshdes sshmd5 sshrsa sshrand sshsha sshblowf
243          + sshdh sshcrcda sshpubk sshzlib sshdss x11fwd portfwd
244          + sshaes sshccp sshsh256 sshsh512 sshbn wildcard pinger ssharcf
245          + sshgssc pgssapi sshshare sshecc
246 WINSSH   = SSH winnoise wincapi winpgntc wingss winshare winnps winnpc
247          + winhsock errsock
248 UXSSH    = SSH uxnoise uxagentc uxgss uxshare
249
250 # SFTP implementation (pscp, psftp).
251 SFTP     = sftp int64 logging
252
253 # Miscellaneous objects appearing in all the network utilities (not
254 # Pageant or PuTTYgen).
255 MISC     = timing callback misc version settings tree234 proxy conf be_misc
256 WINMISC  = MISC winstore winnet winhandl cmdline windefs winmisc winproxy
257          + wintime winhsock errsock winsecur
258 UXMISC   = MISC uxstore uxsel uxnet uxpeer cmdline uxmisc uxproxy time
259
260 # import.c and dependencies, for PuTTYgen-like utilities that have to
261 # load foreign key files.
262 IMPORT   = import sshbcrypt sshblowf
263
264 # Character set library, for use in pterm.
265 CHARSET  = sbcsdat slookup sbcs utf8 toucs fromucs xenc mimeenc macenc localenc
266
267 # Standard libraries.
268 LIBS     = advapi32.lib user32.lib gdi32.lib comctl32.lib comdlg32.lib
269          + shell32.lib winmm.lib imm32.lib winspool.lib ole32.lib
270
271 # Network backend sets. This also brings in the relevant attachment
272 # to proxy.c depending on whether we're crypto-avoidant or not.
273 BE_ALL   = be_all cproxy
274 BE_NOSSH = be_nossh nocproxy
275 BE_SSH   = be_ssh cproxy
276 BE_NONE  = be_none nocproxy
277 # More backend sets, with the additional Windows serial-port module.
278 W_BE_ALL = be_all_s winser cproxy
279 W_BE_NOSSH = be_nos_s winser nocproxy
280 # And with the Unix serial-port module.
281 U_BE_ALL = be_all_s uxser cproxy
282 U_BE_NOSSH = be_nos_s uxser nocproxy
283
284 # ------------------------------------------------------------
285 # Definitions of actual programs. The program name, followed by a
286 # colon, followed by a list of objects. Also in the list may be the
287 # keywords [G] for Windows GUI app, [C] for Console app, [X] for
288 # X/GTK Unix app, [U] for command-line Unix app.
289
290 putty    : [G] GUITERM NONSSH WINSSH W_BE_ALL WINMISC winx11 putty.res LIBS
291 puttytel : [G] GUITERM NONSSH W_BE_NOSSH WINMISC puttytel.res nogss LIBS
292 plink    : [C] winplink wincons NONSSH WINSSH W_BE_ALL logging WINMISC
293          + winx11 plink.res winnojmp noterm LIBS
294 pscp     : [C] pscp winsftp wincons WINSSH BE_SSH SFTP wildcard WINMISC
295          + pscp.res winnojmp LIBS
296 psftp    : [C] psftp winsftp wincons WINSSH BE_SSH SFTP wildcard WINMISC
297          + psftp.res winnojmp LIBS
298
299 pageant  : [G] winpgnt pageant sshrsa sshpubk sshdes sshbn sshmd5 version
300          + tree234 misc sshaes sshsha winsecur winpgntc sshdss sshsh256
301          + sshsh512 winutils sshecc winmisc winhelp conf pageant.res LIBS
302
303 puttygen : [G] winpgen sshrsag sshdssg sshprime sshdes sshbn sshmd5 version
304          + sshrand winnoise sshsha winstore misc winctrls sshrsa sshdss winmisc
305          + sshpubk sshaes sshsh256 sshsh512 IMPORT winutils puttygen.res
306          + tree234 notiming winhelp winnojmp conf LIBS wintime sshecc
307          + sshecdsag winsecur
308
309 pterm    : [X] GTKTERM uxmisc misc ldisc settings uxpty uxsel BE_NONE uxstore
310          + uxsignal CHARSET cmdline uxpterm version time xpmpterm xpmptcfg
311          + nogss gtkmain
312 putty    : [X] GTKTERM uxmisc misc ldisc settings uxsel U_BE_ALL uxstore
313          + uxsignal CHARSET uxputty NONSSH UXSSH UXMISC ux_x11 xpmputty
314          + xpmpucfg gtkmain
315 puttytel : [X] GTKTERM uxmisc misc ldisc settings uxsel U_BE_NOSSH
316          + uxstore uxsignal CHARSET uxputty NONSSH UXMISC xpmputty xpmpucfg
317          + nogss gtkmain
318
319 plink    : [U] uxplink uxcons NONSSH UXSSH U_BE_ALL logging UXMISC uxsignal
320          + ux_x11 noterm
321
322 PUTTYGEN_UNIX = sshrsag sshdssg sshprime sshdes sshbn sshmd5 version
323          + sshrand uxnoise sshsha misc sshrsa sshdss uxcons uxstore uxmisc
324          + sshpubk sshaes sshsh256 sshsh512 IMPORT puttygen.res time tree234
325          + uxgen notiming conf sshecc sshecdsag
326 puttygen : [U] cmdgen PUTTYGEN_UNIX
327 cgtest   : [UT] cgtest PUTTYGEN_UNIX
328
329 pscp     : [U] pscp uxsftp uxcons UXSSH BE_SSH SFTP wildcard UXMISC
330 psftp    : [U] psftp uxsftp uxcons UXSSH BE_SSH SFTP wildcard UXMISC
331
332 pageant  : [X] uxpgnt uxagentc pageant sshrsa sshpubk sshdes sshbn sshmd5
333          + version tree234 misc sshaes sshsha sshdss sshsh256 sshsh512 sshecc
334          + conf uxsignal nocproxy nogss be_none x11fwd ux_x11 uxcons gtkask
335          + gtkmisc UXMISC
336
337 ptermapp : [XT] GTKTERM uxmisc misc ldisc settings uxpty uxsel BE_NONE uxstore
338          + uxsignal CHARSET cmdline uxpterm version time xpmpterm xpmptcfg
339          + nogss gtkapp
340 puttyapp : [XT] GTKTERM uxmisc misc ldisc settings uxsel U_BE_ALL uxstore
341          + uxsignal CHARSET uxputty NONSSH UXSSH UXMISC ux_x11 xpmputty
342          + xpmpucfg gtkapp
343 osxlaunch : [UT] osxlaunch
344
345 fuzzterm : [UT] UXTERM CHARSET misc version uxmisc uxucs fuzzterm time settings
346          + uxstore be_none
347 testbn   : [UT] testbn sshbn misc version conf tree234 uxmisc
348 testbn   : [C] testbn sshbn misc version conf tree234 winmisc LIBS
349
350 # ----------------------------------------------------------------------
351 # On Windows, provide a means of removing local test binaries that we
352 # aren't going to actually ship. (I prefer this to not building them
353 # in the first place, so that we find out about build breakage early.)
354 !begin vc
355 cleantestprogs:
356         -del $(BUILDDIR)testbn.exe
357 !end