Oops - that tweak had bad Buttress syntax. D'oh!
[sgt/putty] / doc / config.but
index 35c9ed4..12ac02b 100644 (file)
@@ -22,12 +22,13 @@ filled in before PuTTY can open a session at all.
 address, of the server you want to connect to.
 
 \b The \e{Protocol} radio buttons let you choose what type of
-connection you want to make: a raw connection, a Telnet connection,
-or an SSH connection. \#{ FIXME: link to sections on these? }
+connection you want to make: a raw connection, a Telnet connection, an
+rlogin connection or an SSH connection. \#{ FIXME: link to sections on
+these? }
 
 \b The \e{Port} box lets you specify which port number on the server
-to connect to. If you select Telnet or SSH, this box will be filled
-in automatically to the usual value, and you will only need to
+to connect to. If you select Telnet, Rlogin, or SSH, this box will be
+filled in automatically to the usual value, and you will only need to
 change it if you have an unusual server. If you select Raw mode, you
 will almost certainly need to fill in the \e{Port} box.
 
@@ -277,6 +278,15 @@ terminals.
 mode, but the actual top row of the numeric keypad generates \c{ESC
 OP} through to \c{ESC OS}.
 
+\b In VT100+ mode, the function keys generate \c{ESC OP} through to
+\c{ESC O[}
+
+\b In SCO mode, the function keys F1 to F12 generate \c{ESC [M}
+through to \c{ESC [X}.  Together with shift, they generate \c{ESC [Y}
+through to \c{ESC [j}.  With control they generate \c{ESC [k} through
+to \c{ESC [v}, and with shift and control together they generate
+\c{ESC [w} through to \c{ESC [\{}.
+
 If you don't know what any of this means, you probably don't need to
 fiddle with it.
 
@@ -346,6 +356,46 @@ If you enable the \q{Application and AltGr act as Compose key}
 option, the Windows Application key and the AltGr key will both have
 this behaviour.
 
+\H{config-bell} The Bell panel
+
+The Bell configuration panel allows you to control how PuTTY should
+respond to a terminal bell.
+
+\S{config-bellstyle} Set the style of bell
+
+When a terminal bell occurs, PuTTY can do one of the following things:
+
+\b Nothing.  The bell is disabled.  Taskbar bell indication still
+works, however.
+
+\b Play Windows Default Sound.  The Windows Default Sound (which can
+be configured from the Sounds control panel) will be played.
+
+\b Play a custom sound file.  Select a \c{.wav} sound file using the
+\e{Custom sound file to play as a bell} text box, or browse for the
+file to play using the \e{Browse...} button.
+
+\b Flash the terminal window as a visual bell.  No sound will be
+played.
+
+In addition, the PuTTY window's title bar and its entry in the taskbar
+can be configured to flash or invert to indicate that a terminal bell
+has occurred.
+
+\S{config-belloverload} Control the bell overload behaviour
+
+Sometimes mistakes, for example trying to \c{cat} a binary file on a
+Unix machine, can lead to a large number of terminal bells being
+received by PuTTY.  It might take a long time for PuTTY to catch up
+with reacting to these bells, and the noise or flashing could be very
+irritating for the user.
+
+PuTTY's bell overload handling is designed to avoid this problem.  If
+turned on using the \e{Bell is temporarily disabled when over-used}
+tick box, the bell will be disabled if it occurs more than a specified 
+number of times in a specified number of seconds.  When no bells have
+occurred for a number of seconds, PuTTY re-enables the bell.
+
 \H{config-window} The Window panel
 
 The Window configuration panel allows you to control aspects of the
@@ -405,6 +455,12 @@ PuTTY window's menu, like clicking on the top left corner. If it is
 disabled, then pressing ALT-Space will just send \c{ESC SPACE} to
 the server.
 
+Some accessibility programs for Windows may need this option
+enabling to be able to control PuTTY's window successfully. For
+instance, Dragon NaturallySpeaking requires it both to open the
+system menu via voice, and to close, minimise, maximise and restore
+the window.
+
 \S{config-altonly} \q{System menu appears on Alt alone}
 
 If this option is enabled, then pressing and releasing ALT will
@@ -424,13 +480,18 @@ PuTTY's appearance.
 
 \S{config-cursor} Controlling the appearance of the cursor
 
-\# this will look considerably less silly when we bring in
-\# underline-versus-block-versus-vertical-line cursor configuration
-\# and also allow the cursor to vanish on keypress a la Word. Until
-\# then, this box does look silly with only one thing in it. Deal.
+The \q{Cursor appearance} option lets you configure the cursor to be
+a block, an underline, or a vertical line. A block cursor becomes an
+empty box when the window loses focus; an underline or a vertical
+line becomes dotted.
+
+The \q{Cursor blinks} option makes the cursor blink on and off. This
+works in any of the cursor modes.
 
 \S{config-font} Controlling the font used in the terminal window
 
+
+
 \S{config-title} Controlling the window title
 
 \H{config-translation} The Translation panel
@@ -475,6 +536,48 @@ more than one type of connection.
 
 \S{config-keepalive} Using keepalives to prevent disconnection
 
+If you find your sessions are closing unexpectedly (\q{Connection
+reset by peer}) after they have been idle for a while, you might
+want to try using this option.
+
+Some network routers and firewalls need keep track of all
+connections through them. Usually, these firewalls will assume a
+connection is dead if no data is transferred in either direction
+after a certain time interval. This can cause PuTTY sessions to be
+unexpectedly closed by the firewall if no traffic is seen in the
+session for some time.
+
+The keepalive option (\q{Seconds between keepalives}) allows you to
+configure PuTTY to send data through the session at regular
+intervals, in a way that does not disrupt the actual terminal
+session. If you find your firewall is cutting idle connections off,
+you can try entering a non-zero value in this field. The value is
+measured in seconds; so, for example, if your firewall cuts
+connections off after ten minutes then you might want to enter 300
+seconds (5 minutes) in the box.
+
+Note that keepalives are not always helpful. They help if you have a
+firewall which drops your connection after an idle period; but if
+the network between you and the server suffers from breaks in
+connectivity then keepalives can actually make things worse. If a
+session is idle, and connectivity is temporarily lost between the
+endpoints, but the connectivity is restored before either side tries
+to send anything, then there will be no problem - neither endpoint
+will notice that anything was wrong. However, if one side does send
+something during the break, it will repeatedly try to re-send, and
+eventually give up and abandon the connection. Then when
+connectivity is restored, the other side will find that the first
+side doesn't believe there is an open connection any more.
+Keepalives can make this sort of problem worse, because they
+increase the probability that PuTTY will attempt to send data during
+a break in connectivity. Therefore, you might find they help
+connection loss, or you might find they make it worse, depending on
+what \e{kind} of network problems you have between you and the
+server.
+
+Keepalives are only supported in Telnet and SSH; the Rlogin and Raw
+protocols offer no way of implementing them.
+
 \H{config-telnet} The Telnet panel
 
 The Telnet panel allows you to configure options that only apply to
@@ -496,3 +599,48 @@ SSH sessions.
 \S{config-auth} SSH authentication options
 
 \S{config-protocol} SSH protocol options
+
+\H{config-file} Storing configuration in a file
+
+PuTTY does not currently support storing its configuration in a file
+instead of the Registry. However, you can work around this with a
+couple of batch files.
+
+You will need a file called (say) \c{PUTTY.BAT} which imports the
+contents of a file into the Registry, then runs PuTTY, exports the
+contents of the Registry back into the file, and deletes the
+Registry entries. This can all be done using the Regedit command
+line options, so it's all automatic. Here is what you need in
+\c{PUTTY.BAT}:
+
+\c @ECHO OFF
+\c regedit /s putty.reg
+\c regedit /s puttyrnd.reg
+\c start /w putty.exe
+\c regedit /e puttynew.reg HKEY_CURRENT_USER\Software\SimonTatham\PuTTY
+\c copy puttynew.reg putty.reg
+\c del puttynew.reg
+\c regedit /s puttydel.reg
+
+This batch file needs two auxiliary files: \c{PUTTYRND.REG} which
+sets up an initial safe location for the \c{PUTTY.RND} random seed
+file, and \c{PUTTYDEL.REG} which destroys everything in the Registry
+once it's been successfully saved back to the file.
+
+Here is \c{PUTTYDEL.REG}:
+
+\c REGEDIT4
+\c  
+\c [-HKEY_CURRENT_USER\Software\SimonTatham\PuTTY]
+
+Here is an example \c{PUTTYRND.REG} file:
+
+\c REGEDIT4
+\c  
+\c [HKEY_CURRENT_USER\Software\SimonTatham\PuTTY]
+\c "RandSeedFile"="a:\putty.rnd"
+
+You should replace \c{a:\\putty.rnd} with the location where you
+want to store your random number data. If the aim is to carry around
+PuTTY and its settings on one floppy, you probably want to store it
+on the floppy.