X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/putty/blobdiff_plain/beefa433b8268f0a7bf334ce37563dd3361a4177..6c8727b278dd434f6df753da750c99c1134bdd84:/doc/config.but diff --git a/doc/config.but b/doc/config.but index c237aa74..3128f056 100644 --- a/doc/config.but +++ b/doc/config.but @@ -1,4 +1,4 @@ -\versionid $Id: config.but,v 1.22 2001/12/15 12:15:24 simon Exp $ +\versionid $Id: config.but,v 1.31 2002/04/03 18:24:59 simon Exp $ \C{config} Configuring PuTTY @@ -330,6 +330,11 @@ multiple times at the keyboard. If you set the answerback string to be empty, this problem should go away, but doing so might cause other problems. +Note that this is \e{not} the feature of PuTTY which the server will +typically use to determine your terminal type. That feature is the +\q{Terminal-type string} in the Connection panel; see +\k{config-termtype} for details. + \S{config-localecho} \q{Local echo} \cfg{winhelp-topic}{terminal.localecho} @@ -375,6 +380,38 @@ this configuration option to override its choice: you can force local line editing to be turned on, or force it to be turned off, instead of relying on the automatic detection. +\S{config-printing} Remote-controlled printing + +\cfg{winhelp-topic}{terminal.printing} + +A lot of VT100-compatible terminals support printing under control +of the remote server. PuTTY supports this feature as well, but it is +turned off by default. + +To enable remote-controlled printing, choose a printer from the +\q{Printer to send ANSI printer output to} drop-down list box. This +should allow you to select from all the printers you have installed +drivers for on your computer. Alternatively, you can type the +network name of a networked printer (for example, +\c{\\\\printserver\\printer1}) even if you haven't already +installed a driver for it on your own machine. + +When the remote server attempts to print some data, PuTTY will send +that data to the printer \e{raw} - without translating it, +attempting to format it, or doing anything else to it. It is up to +you to ensure your remote server knows what type of printer it is +talking to. + +Since PuTTY sends data to the printer raw, it cannot offer options +such as portrait versus landscape, print quality, or paper tray +selection. All these things would be done by your PC printer driver +(which PuTTY bypasses); if you need them done, you will have to find +a way to configure your remote server to do them. + +To disable remote printing again, choose \q{None (printing +disabled)} from the printer selection list. This is the default +state. + \H{config-keyboard} The Keyboard panel The Keyboard configuration panel allows you to control the behaviour @@ -464,8 +501,11 @@ they send \c{ESC OA} through to \c{ESC OD}. Application Cursor Keys mode can be turned on and off by the server, depending on the application. PuTTY allows you to configure the -initial state, and also allows you to disable application mode -completely. +initial state. + +You can also disable application cursor keys mode completely, using +the \q{Features} configuration panel; see +\k{config-features-application}. \S{config-appkeypad} Controlling Application Keypad mode @@ -489,8 +529,11 @@ function key. This is unavoidable. Application keypad mode can be turned on and off by the server, depending on the application. PuTTY allows you to configure the -initial state, and also allows you to disable application mode -completely. +initial state. + +You can also disable application keypad mode completely, using the +\q{Features} configuration panel; see +\k{config-features-application}. \S{config-nethack} Using NetHack keypad mode @@ -636,6 +679,106 @@ constitute an overload, how short a time period they have to arrive in to do so, and how much silent time is required before the overload feature will deactivate itself. +\H{config-features} The Features panel + +PuTTY's terminal emulation is very highly featured, and can do a lot +of things under remote server control. Some of these features can +cause problems due to buggy or strangely configured server +applications. + +The Features configuration panel allows you to disable some of +PuTTY's more advanced terminal features, in case they cause trouble. + +\S{config-features-application} Disabling application keypad and cursor keys + +\cfg{winhelp-topic}{features.application} + +Application keypad mode (see \k{config-appkeypad}) and application +cursor keys mode (see \k{config-appcursor}) alter the behaviour of +the keypad and cursor keys. Some applications enable these modes but +then do not deal correctly with the modified keys. You can force +these modes to be permanently disabled no matter what the server +tries to do. + +\S{config-features-mouse} Disabling \cw{xterm}-style mouse reporting + +\cfg{winhelp-topic}{features.mouse} + +PuTTY allows the server to send control codes that let it take over +the mouse and use it for purposes other than copy and paste. +Applications which use this feature include the text-mode web +browser \c{links}, the Usenet newsreader \c{trn} version 4, and the +file manager \c{mc} (Midnight Commander). + +If you find this feature inconvenient, you can disable it using the +\q{Disable xterm-style mouse reporting} control. With this box +ticked, the mouse will \e{always} do copy and paste in the normal +way. + +Note that even if the application takes over the mouse, you can +still manage PuTTY's copy and paste by holding down the Shift key +while you select and paste, unless you have deliberately turned this +feature off (see \k{config-mouseshift}). + +\S{config-features-resize} Disabling remote terminal resizing + +\cfg{winhelp-topic}{features.resize} + +PuTTY has the ability to change the terminal's size and position in +response to commands from the server. If you find PuTTY is doing +this unexpectedly or inconveniently, you can tell PuTTY not to +respond to those server commands. + +\S{config-features-altscreen} Disabling switching to the alternate screen + +\cfg{winhelp-topic}{features.altscreen} + +Many terminals, including PuTTY, support an \q{alternate screen}. +This is the same size as the ordinary terminal screen, but separate. +Typically a screen-based program such as a text editor might switch +the terminal to the alternate screen before starting up. Then at the +end of the run, it switches back to the primary screen, and you see +the screen contents just as they were before starting the editor. + +Some people prefer this not to happen. If you want your editor to +run in the same screen as the rest of your terminal activity, you +can disable the alternate screen feature completely. + +\S{config-features-retitle} Disabling remote window title changing + +\cfg{winhelp-topic}{features.retitle} + +PuTTY has the ability to change the window title in response to +commands from the server. If you find PuTTY is doing this +unexpectedly or inconveniently, you can tell PuTTY not to respond to +those server commands. + +\S{config-features-dbackspace} Disabling destructive backspace + +\cfg{winhelp-topic}{features.dbackspace} + +Normally, when PuTTY receives character 127 (^?) from the server, it +will perform a \q{destructive backspace}: move the cursor one space +left and delete the character under it. This can apparently cause +problems in some applications, so PuTTY provides the ability to +configure character 127 to perform a normal backspace (without +deleting a character) instead. + +\S{config-features-charset} Disabling remote character set +configuration + +\cfg{winhelp-topic}{features.charset} + +PuTTY has the ability to change its character set configuration in +response to commands from the server. Some programs send these +commands unexpectedly or inconveniently. In particular, BitchX (an +IRC client) seems to have a habit of reconfiguring the character set +to something other than the user intended. + +If you find that accented characters are not showing up the way you +expect them to, particularly if you're running BitchX, you could try +disabling the remote character set configuration commands. + \H{config-window} The Window panel The Window configuration panel allows you to control aspects of the @@ -886,6 +1029,11 @@ the server is interpreted as being in the UTF-8 encoding of Unicode. If you select \q{UTF-8} as a character set you can use this mode. Not all server-side applications will support it. +If you need support for a numeric code page which is not listed in +the drop-down list, such as code page 866, then you should be able +to enter its name manually (\c{CP866} for example) in the list box +and get the right result. + \S{config-cyr} \q{Caps Lock acts as Cyrillic switch} \cfg{winhelp-topic}{translation.cyrillic} @@ -1007,6 +1155,10 @@ unchecking the \q{Shift overrides application's use of mouse} checkbox will cause Shift + mouse clicks to go to the server as well (so that mouse-driven copy and paste will be completely disabled). +If you want to prevent the application from taking over the mouse at +all, you can do this using the Features control panel; see +\k{config-features-mouse}. + \S{config-rectselect} Default selection mode \cfg{winhelp-topic}{selection.rect} @@ -1059,6 +1211,12 @@ box below, and press the \q{Set} button. This mechanism currently only covers ASCII characters, because it isn't feasible to expand the list to cover the whole of Unicode. +Character class definitions can be modified by control sequences +sent by the server. This configuration option only controls the +\e{default} state. If you modify this option in mid-session using +\q{Change Settings}, you will need to reset the terminal (see +\k{reset-terminal}) before the change takes effect. + \H{config-colours} The Colours panel The Colours panel allows you to control PuTTY's use of colour. @@ -1204,6 +1362,96 @@ types of server. The Nagle algorithm is disabled by default. +\H{config-proxy} The Proxy panel + +The Proxy panel allows you to configure PuTTY to use various types +of proxy in order to make its network connections. The settings in +this panel affect the primary network connection forming your PuTTY +session, but also any extra connections made as a result of SSH port +forwarding (see \k{using-port-forwarding}). + +\S{config-proxy-type} Setting the proxy type + +The \q{Proxy type} radio buttons allow you to configure what type of +proxy you want PuTTY to use for its network connections. The default +setting is \q{None}; in this mode no proxy is used for any +connection. + +\b Selecting \q{HTTP} allows you to proxy your connections through a +web server supporting the HTTP \cw{CONNECT} command, as documented +in \W{http://www.ietf.org/rfc/rfc2817.txt}{RFC 2817}. + +\b Selecting \q{SOCKS} allows you to proxy your connections through +a SOCKS server. + +\b Many firewalls implement a less formal type of proxy in which a +user can make a Telnet connection directly to the firewall machine +and enter a command such as \c{connect myhost.com 22} to connect +through to an external host. Selecting \q{Telnet} allows you to tell +PuTTY to use this type of proxy. + +Note [FIXME] that SOCKS is not yet supported, although it should be +by the time we make our next release. + +\S{config-proxy-exclude} Excluding parts of the network from proxying + +Typically you will only need to use a proxy to connect to non-local +parts of your network; for example, your proxy might be required for +connections outside your company's internal network. In the +\q{Exclude Hosts/IPs} box you can enter ranges of IP addresses, or +ranges of DNS names, for which PuTTY will avoid using the proxy and +make a direct connection instead. + +The \q{Exclude Hosts/IPs} box may contain more than one exclusion +range, separated by commas. Each range can be an IP address or a DNS +name, with a \c{*} character allowing wildcards. For example: + +\c *.example.com + +This excludes any host with a name ending in \c{.example.com} from +proxying. + +\c 192.168.88.* + +This excludes any host with an IP address starting with 192.168.88 +from proxying. + +\c 192.168.88.*,*.example.com + +This excludes both of the above ranges at once. + +\S{config-proxy-auth} Username and password + +If your proxy requires authentication, you can enter a username and +a password in the \q{Username} and \q{Password} boxes. + +Currently these boxes have no effect ( [FIXME] presumably they're +for SOCKS only). + +\S{config-proxy-command} Specifying the Telnet proxy command + +If you are using the Telnet proxy type, the usual command required +by the firewall's Telnet server is \c{connect}, followed by a host +name and a port number. If your proxy needs a different command, +you can enter an alternative here. + +In this string, you can use \c{\\n} to represent a new-line, \c{\\r} +to represent a carriage return, \c{\\t} to represent a tab +character, and \c{\\x} followed by two hex digits to represent any +other character. \c{\\\\} is used to encode the \c{\\} character +itself. + +Also, the special strings \c{%host} and \c{%port} will be replaced +by the host name and port number you want to connect to. To get a +literal \c{%} sign, enter \c{%%}. + +\S{config-proxy-socksver} Selecting the version of the SOCKS protocol + +SOCKS servers exist in two versions: version 5 +(\W{http://www.ietf.org/rfc/rfc1928.txt}{RFC 1928}) and the earlier +version 4. The \q{SOCKS Version} radio buttons allow you to select +which one to use, if you have selected the SOCKS proxy type. + \H{config-telnet} The Telnet panel The Telnet panel allows you to configure options that only apply to @@ -1293,6 +1541,22 @@ the Telnet special backspace code, and Control-C will send the Telnet special interrupt code. You probably shouldn't enable this unless you know what you're doing. +\S{config-telnetnl} \q{Return key sends telnet New Line instead of ^M} + +\cfg{winhelp-topic}{telnet.newline} + +Unlike most other remote login protocols, the Telnet protocol has a +special \q{new line} code that is not the same as the usual line +endings of Control-M or Control-J. By default, PuTTY sends the +Telnet New Line code when you press Return, instead of sending +Control-M as it does in most other protocols. + +Most Unix-style Telnet servers don't mind whether they receive +Telnet New Line or Control-M; some servers do expect New Line, and +some servers prefer to see ^M. If you are seeing surprising +behaviour when you press Return in a Telnet session, you might try +turning this option off to see if it helps. + \H{config-rlogin} The Rlogin panel The Rlogin panel allows you to configure options that only apply to