Initial checkin of a native Mac OS X port, sharing most of its code
[u/mdw/putty] / macosx / README.OSX
1 This directory contains a Mac OS X port of PuTTY/pterm, running as a
2 native Aqua GUI application.
3
4 THIS PORT IS CURRENTLY UNFINISHED AND EXPERIMENTAL. You are welcome
5 to use it, but don't be surprised at unexpected behaviour. I'm not
6 kidding.
7
8 In particular, I have not yet decided where OS X PuTTY should store
9 its configuration data. Options include storing it in ~/.putty to be
10 compatible with Unix PuTTY, storing it wherever is compatible with
11 Mac Classic PuTTY, storing it in a natively OS X location, or
12 sorting out the `config-locations' wishlist item and doing all
13 three. Therefore, if you start using this port and create a whole
14 load of saved sessions, you should not be surprised if a future
15 version of the port decides to look somewhere completely different
16 for the data and therefore loses them all. If that happens, don't
17 say you weren't warned!
18
19 Even more importantly, the alert box that confirms host keys is not
20 yet implemented, and the application will bomb out and exit if it
21 should be needed. This means you cannot make an SSH connection to a
22 new host using the GUI PuTTY in this port: you must first run
23 `plink' (which should be exactly identical to the version in the
24 Unix port) and tell it to confirm the host key.
25
26 Other ways in which the port is currently unfinished include:
27
28 - terminal display is horribly slow
29
30 - fatal errors are currently output via printf, which is obviously
31 wrong for a GUI application
32
33 - fonts aren't configurable
34
35 - several features are unimplemented in the terminal display:
36 underlining, non-solid-block cursors, double-width and
37 double-height line attributes, bold as font rather than as
38 colour, wide (CJK) characters, combining characters.
39
40 - there's no scrollbar
41
42 - terminal window resizing isn't implemented yet
43
44 - proper window placement (cascading down and right from the
45 starting position, plus remembering previous window positions per
46 the Apple HIG) is not implemented
47
48 - close-on-exit isn't implemented
49
50 - warn-on-close isn't implemented
51
52 - SessionWindow's dealloc method does nothing yet, so leaks memory
53
54 - use of Alt+numberpad to enter arbitrary numeric character codes
55 is not yet supported
56
57 - cut and paste isn't supported
58
59 - there's no Meta key yet. (I think it will have to be Command
60 rather than Option since the latter is necessary to send some
61 characters, including the rather important # on Apple UK
62 keyboards; but trapping Command-<key> and sending it to the
63 window rather than the application menu requires me to make a
64 positive effort of some sort and I haven't got round to it yet.)
65
66 - there's no specials menu
67
68 - currently no support for server-side window management requests
69 (i.e. escape sequences to minimise or maximise the window,
70 request or change its position and size, change its title etc)
71
72 - window title is currently fixed
73
74 - no Event Log
75
76 - no mid-session Change Settings
77
78 - no icon (surprisingly important in an OS X app!)