How to prepare a KiTTY configuration file

Session

- Logging
- Scripting

Destination HostName Hostname or IP address * Overridden by 1Remote with per-server setting value. If the Protocol is adb, this is interpreted as: -a or transport-any: any, -d or transport-usb: usb, -e or transport-local: emulator, or otherwise serial PortNumber Port number * Overridden by 1Remote with per-server setting value. Protocol Connection type * Overridden by 1Remote with fixed value. ssh (SSH), serial (Serial), telnet (Telnet), rlogin (Rlogin), supdup (SUPDUP), raw (Raw), adb (ADB), ssh-connection (Bare ssh-connection)
CloseOnExit Close window on exit 0: Never 1: Only on clean exit 2: Always

Session/Logging

LogType Session logging: 0: None 1: Printable output 2: All session output 3: SSH packets 4: SSH packets and raw data LogFileName Log file path The file name can contain &Y, &M, &D for date, &T for time, &H for host name, and &P for port nuymber. LogTimeRotation Log rotation delay (sec) LogTimestamp Timestamp LogFileClash What to do if the log file already exists: -1: Ask the user 0: Append 1: Overwrite LogFlush Flush log file frequently; 0: No, 1: Yes LogHeader Include header; 0: No, 1: Yes
Options specific to SSH packet logging SSHLogOmitPasswords Omit known password fields; 0: No, 1: Yes SSHLogOmitData Omit session data; 0: No, 1: Yes

Session/Scripting

ScriptFileName Script file path ScriptMode 0: Off 1: Replay 2: Record
ScriptLineDelay line delay (ms) ScriptCharDelay character delay (ms) ScriptCondLine start of condition/comment line ScriptCRLF CR/LF translation: 0: Off 1: no LF 2: CR 3: Rec ScriptHalt halt on (string) ScriptEnable wait for response from host; 0: No, 1: Yes ScriptExcept except for first command; 0: No, 1: Yes ScriptCondUse use conditions from file; 0: No, 1: Yes ScriptTimeout timeout (sec) ScriptWait wait for (string)

Terminal

- Keyboard
- Bell
- Features

Various terminal options AutoWrapMode Auto wrap mode initially on; 0: No, 1: Yes DECOriginMode DEC Origin Mode initially on; 0: No, 1: Yes LFImpliesCR Implicit CR in every LF; 0: No, 1: Yes CRImpliesLF Implicit LF in every CR; 0: No, 1: Yes BCE Use background colour to erase screen; 0: No, 1: Yes BlinkText Enable blinking text; 0: No, 1: Yes Answerback Answerback to ^E, e.g., KiTTY
Line discipline options LocalEcho Local echo: 0: Force on 1: Force off 2: Auto LocalEdit Local line editing: 0: Force on 1: Force off 2: Auto
Remote-controlled printing Printer Printer to send ANSI printer output to.

Terminal/Keyboard

Change the sequences sent by: BackspaceIsDelete The Backspace key 0: Control-H 1: Control-? (127) EnterSendsCrLf The Enter key 0: CR 1: CR LF RXVTHomeEnd The Home and End keys 0: Standard 1: rxvt 2: urxvt 3: xterm 4: FreeBSD1 5: FreeBSD2 LinuxFunctionKeys The Function keys and keypad 0: ESC[n~ 1: Linux 2: Xterm R6 3: VT400 4: VT100+ 5: SCO
Application keypad settings: ApplicationCursorKeys Initial state of cursor keys: 0: Normal 1: Application ApplicationKeypad NetHackKeypad Initial state of numeric keypad: NetHack if NetHackKeypad is non-zero, Application if ApplicationKeypad is non-zero, otherwise Normal
Enable extra keyboard features: ComposeKey AltGr acts as Compose key; 0: No, 1: Yes CtrlAltKeys Control-Alt is different from AltGr; 0: No, 1: Yes

Terminal/Bell

Style of bell Beep Action to happen when a bell occurs: 0: None (bell disabled) 1: Make default system alert sound 2: Visual bell (flash window) 3: Play a custom sound file 4: Beep using the PC speaker ForegroundOnBell Put window on foreground on bell; 0: No, 1: Yes BellWaveFile Custom sound file path to play as a bell BeepInd Taskbar/caption indication on bell: 0: Disabled 1: Flashing 2: Steady
Bell overload behaviour

BellOverload

Bell is temporarily disabled when over-used; 0: No, 1: Yes

BellOverloadN
BellOverloadT

Over-use means BellOverloadN bells in BellOverloadT seconds. (Integer both)

BellOverloadS

The bell is re-enabled after BellOverloadS seconds of silence. (Integer)

Terminal/Features

NoApplicationCursors Disable application cursor keys mode; 0: No, 1: Yes NoApplicationKeys Disable application keypad mode; 0: No, 1: Yes NoMouseReporting Disable xterm-style mouse reporting; 0: No, 1: Yes NoRemoteResize Disable remote-controlled terminal resizing; 0: No, 1: Yes NoAltScreen Disable switching to alternate terminal screen; 0: No, 1: Yes NoRemoteWinTitle Disable remote-controlled window title changing; 0: No, 1: Yes RemoteQTitleAction Response to remote title query (SECURITY): 0: None 1: Empty string 2: Window title NoRemoteClearScroll Disable remote-controlled clearing of scrollback; 0: No, 1: Yes NoDBackspace Disable destructive backspace on server sending ^?; 0: No, 1: Yes NoRemoteCharset Disable remote-controlled character set configuration; 0: No, 1: Yes DisableArabicShaping Disable Arabic text shaping; 0: No, 1: Yes DisableBidi Disable bidirectional text display; 0: No, 1: Yes NoFocusReporting Disable focus reporting; 0: No, 1: Yes

Window

- Appearance
- Transparency
- Behavior
- Translation
+ Selection
- Colours
- Hyperlinks

Size of the window TermWidth Columns TermHeight Rows LockSize When window is resized: 0: Change the number of rows and columns 1: Forbid resizing completely 2: Change font size only when maximised 3: Change the size of the font
Control the scrollback in the window ScrollbackLines Lines of scrollback LinesAtAScroll Lines scrolled per turn -- the number of lines to scroll back per wheel turn. Use -1 for half screen, -2 full screen ScrollBar Display scrollbar; 0: No, 1: Yes ScrollBarFullScreen Display scrollbar in full screen mode; 0: No, 1: Yes ScrollOnKey Reset scrollback on keypress; 0: No, 1: Yes ScrollOnDisp Reset scrollback on display activity; 0: No, 1: Yes EraseToScrollback Push erased text into scrollback; 0: No, 1: Yes

Window/Appearance

Adjust the use of the cursor CurType Cursor appearance: 0: Block 1: Underline 2: Vertical line BlinkCur Cursor blinks; 0: No, 1: Yes
Font settings Font Font used in the terminal window, e.g., Courier%20New FontIsBold Font is bold; 0: No, 1: Yes FontHeight Font size FontQuality Font quality: 0: Default 1: Antialiased 2: Non-Antialiased 3: ClearType
Adjust the use of the mouse pointer HideMousePtr Hide mouse pointer when typing in window; 0: No, 1: Yes
Adjust the window border WindowBorder Gap between text and window edge (Integer) SunkenEdge Sunken-edge border (slightly thicker); 0: No, 1: Yes
Remember Window Position SaveWindowPos Remember Window Positions; 0: No, 1: Yes TermYPos Top TermXPos Left

Window/Transparency

Transparency setting TransparencyValue Transparency setting from 0 (visible) to 255 (transparent) -1 to disable completely

Window/Behavior

Adjust the behaviour of the window title WinTitle Window title %%f: folder name %%h: hostname %%p: port number %%P: protocol name %%s: session name %%u: username %%l: forwarded local ports list %%d: forwarded dynamic ports list WinNameAlways Separate window and icon titles; 0: Yes, 1: No (*Boolean opposite to description)
WarnOnClose Warn before closing window; 0: No, 1: Yes DisableAltGr Disable AltGr menu; 0: No, 1: Yes AltF4 Window closes on ALT-F4; 0: No, 1: Yes WindowHasSysMenu Window has system menu (in upper left corner); 0: No, 1: Yes When WindowHasSysMenu is non-zero WindowClosable Window has Close button; 0: No, 1: Yes WindowMinimizable Window has Minimize button; 0: No, 1: Yes WindowMaximizable Window has Maximize button; 0: No, 1: Yes AltSpace System menu appears on ALT-Space; 0: No, 1: Yes AltOnly System menu appears on ALT alone; 0: No, 1: Yes AlwaysOnTop Ensure window is always on top; 0: No, 1: Yes SendToTray Send to tray on startup; 0: No, 1: Yes Maximize Maximize on startup; 0: No, 1: Yes Fullscreen Full screen on startup; 0: No, 1: Yes SaveOnExit Save position and size on exit; 0: No, 1: Yes FullScreenOnAltEnter Full screen on Alt-Enter; 0: No, 1: Yes

Window/Translation

Character set translation LineCodePage Remote character set: UTF-8 ISO-8859-1:1998 (Latin-1, West Europe) ISO-8859-2:1999 (Latin-2, East Europe) ISO-8859-3:1999 (Latin-3, South Europe) ISO-8859-4:1998 (Latin-4, North Europe) ISO-8859-5:1999 (Latin/Cyrillic) ISO-8859-6:1999 (Latin/Arabic) ISO-8859-7:1987 (Latin/Greek) ISO-8859-8:1999 (Latin/Hebrew) ISO-8859-9:1999 (Latin-5, Turkish) ISO-8859-10:1998 (Latin-6, Nordic) ISO-8859-11:2001 (Latin/Thai) ISO-8859-13:1998 (Latin-7, Baltic) ISO-8859-14:1998 (Latin-8, Celtic) ISO-8859-15:1999 (Latin-9, "euro") ISO-8859-16:2001 (Latin-10, Balkan) KOI8-U KOI8-R HP-ROMAN8 VSCII DEC-MCS Win1250 (Central European) Win1251 (Cyrillic) Win1252 (Western) Win1253 (Greek)" Win1254 (Turkish) Win1255 (Hebrew) Win1256 (Arabic) Win1257 (Baltic) Win1258 (Vietnamese) CP437 CP620 (Mazovia) CP819 CP852 CP878 Use font encoding (Codepages supported by Windows but not listed here, such as CP866 on many systems, can be specified)
CJKAmbigWide Treat CJK ambiguous characters as wide; 0: No, 1: Yes CapsLockCyr Caps Lock acts as Cyrillic switch; 0: No, 1: Yes
Adjust how to handle line drawing characters FontVTMode Handling of line drawing characters: 0: Font has XWindows encoding 1: Use font in both ANSI and OEM modes 2: Use font in OEM mode only 3: Use Unicode line drawing code points 4: Poor man's line drawing (+, - and |) RawCNP Copy and paste line drawing characters as lqqqk; 0: No, 1: Yes UTF8linedraw Enable VT100 line drawing even in UTF-8 mode; 0: No, 1: Yes

Window/Selection

- Copy

Control use of mouse MouseIsXterm Action of mouse buttons: 0: Compromise (Middle extends, Right pastes) 1: xterm (Right extends, Middle pastes) 2: Windows (Middle extends, Right brings up menu) MouseOverride Shift overrides application's use of mouse; 0: No, 1: Yes RectSelect Default selection mode (Alt+drag does the other one): 0: Normal 1: Rectangular block
Assign copy/paste actions to clipboards MouseAutocopy Auto-copy selected text to system clipboard; 0: No, 1: Yes MousePaste Mouse paste action: 0: No action 1: Last selected text 2: System clipboard CtrlShiftIns {Ctrl,Shift} + Ins: 0: No action 1: Last selected text 2: System clipboard CtrlShiftCV Ctrl + Shift + {C,V}: 0: No action 1: Last selected text 2: System clipboard
Control pasting of text from clipboard to terminal PasteControls Permit control characters in pasted text; 0: No, 1: Yes

Window/Selection/Copy

Classes of character that group together Wordness0 Wordness32 Wordness64 Wordness96 Wordness128 Wordness160 Wordness192 Wordness224 Character classes T.B.D.
Formatting of copied characters PasteRTF Copy to clipboard in RTF as well as plain text; 0: No, 1: Yes

Window/Colours

General options for colour usage ANSIColour Allow terminal to specify ANSI colours; 0: No, 1: Yes Xterm256Colour Allow terminal to use xterm 256-colour mode; 0: No, 1: Yes TrueColour Allow terminal to use 24-bit colours; 0: No, 1: Yes BoldAsColour Indicate bolded text by changing: 1: The font 2: The colour 3: Both TryPalette Attempt to use logical palettes; 0: No, 1: Yes UseSystemColours Use system colours; 0: No, 1: Yes
Colour table * Specify as R,G,B in decimal. Colour0 Default Foreground Colour1 Default Bold Foreground Colour2 Default Background Colour3 Default Bold Background Colour4 Cursor Text Colour5 Cursor Colour Colour6 ANSI Black Colour7 ANSI Black Bold Colour8 ANSI Red Colour9 ANSI Red Bold Colour10 ANSI Green Colour11 ANSI Green Bold Colour12 ANSI Yellow Colour13 ANSI Yellow Bold Colour14 ANSI Blue Colour15 ANSI Blue Bold Colour16 ANSI Magenta Colour17 ANSI Magenta Bold Colour18 ANSI Cyan Colour19 ANSI Cyan Bold Colour20 ANSI White Colour21 ANSI White Bold

Window/Hyperlinks

General options for hyperlinks HyperlinkUnderline Underline hyperlinks: 0: Always 1: When hovered upon 2: Never HyperlinkUseCtrlClick Use ctrl+click to launch hyperlinks; 0: No, 1: Yes
Browser application HyperlinkBrowserUseDefault Use the default browser; 0: No, 1: Yes HyperlinkBrowser Application to open hyperlinks with when HyperlinkBrowserUseDefault=0
Regular expression HyperlinkRegularExpressionUseDefault Use the default regular expression; 0: No, 1: Yes HyperlinkRegularExpression Regular expression that represents hyperlink when HyperlinkRegularExpressionUseDefault=0

Connection

- Data
- Proxy
+ SSH
- Serial
- Telnet
- Rlogin
- SUPDUP

Sending of null packets to keep session active PingInterval PingIntervalSecs Seconds between keepalives Specify seconds/60 and seconds%60 0 to turn off AntiIdle Anti-idle string
Low-level TCP connection options TCPNoDelay Disable Nagle's algorithm; 0: No, 1: Yes TCPKeepalives Enable TCP keepalives; 0: No, 1: Yes
Internet protocol version AddressFamily Internet protocol version 0: Auto 1: IPv4 2: IPv6
Reconnect options WakeupReconnect Attempt to reconnect on system wakeup; 0: No, 1: Yes FailureReconnect Attempt to reconnect on connection failure; 0: No, 1: Yes
Logical name of remote host LogHost Logical name of remote host (e.g. for SSH key lookup)
Port knocking sequence PortKnocking List of port:protocol separated by comma. Valid protocols are tcp and udp. Special protocol s is used to include pause between knocks. Ex: 2001:tcp, 1:s, 2002:udp

Connection/Data

Login details UserName Auto-login username UserNameFromEnvironment When username is not specified: 0: Prompt 1: Use system username Password Auto-login password (encrypted) Autocommand Command Scriptfile Auto-command/Login script file path ScriptfileContent Login script content
Terminal details TerminalType Terminal-type string, e.g., xterm TerminalSpeed Terminal speeds, e.g., 38400,38400
Environment variables Emvironment Environment variables List of Variable=Value separated by comma. Percent encoding can be used for characters with special meanings.

Connection/Proxy

ProxyMethod Proxy type: 0: None 1: SOCKS 4 2: SOCKS 5 3: HTTP 4: Telnet 5: Local ProxyHost Proxy hostname ProxyPort Port ProxyExcludeList Exclude Hosts/IPs T.B.D. ProxyLocalhost Consider proxying local host connections; 0: No, 1: Yes ProxyDNS Do DNS name lookup at proxy end: 0: No 1: Auto 2: Yes ProxyUsername Username ProxyPassword Password (uncrypted) ProxyTelnetCommand Telnet command ProxyLogToTerm Print proxy diagnostics in the terminal window 0: Yes 1: No 2: Only until session starts

Connection/SSH

- Kex
- Host keys
- Cipher
+ Auth
- TTY
- X11
- Tunnels
- Bugs
- More bugs
- RSCP and WinSCP

Data to send to the server RemoteCommand Remote command
Protocol options SshNoShell Don't start a shell or command at all; 0: No, 1: Yes Compression Enable compression; 0: No, 1: Yes SshProt SSH protocol version: 3: 2 0: 1 (INSECURE)
Sharing an SSH connection between PuTTY tools ConnectionSharing Share SSH connections if possible; 0: No, 1: Yes ConnectionSharingUpstream Upstream (connecting to the real server); 0: No, 1: Yes ConnectionSharingDownstream Downstream (connecting to the upstream PuTTY); 0: No, 1: Yes

Connection/SSH/Kex

Key exchange algorithm options KEX Algorithm selection policy: T.B.D. AuthGSSAPIKEX Attempt GSSAPI key exchange; 0: No, 1: Yes
Options controlling key re-exchange RekeyTime Max minutes before rekey (0 for no limit) GssapiRekey Minutes between GSS checks (0 for never) RekeyBytes Max data before rekey (0 for no limit) (Use 1M for 1 megabyte, 1G for 1 gigabyte etc)

Connection/SSH/Host keys

Host key algorithm preference HostKey Algorithm selection policy: T.B.D. PreferKnownHostKeys Prefer algorithms for which a host key is known; 0: No, 1: Yes
Manually configure host keys for this connection SSHManualHostKeys Host keys or fingerprints to accept: T.B.D.

Connection/SSH/Cipher

Encryption options Cipher Encryption cipher selection policy: T.B.D. SSH2DES Enable legacy use of single-DES in SSH-2; 0: No, 1: Yes

Connection/SSH/Auth

- GSSAPI

SshBanner Display pre-authentication banner (SSH-2 only); 0: No, 1: Yes SshNoAuth Bypass authentication entirely (SSH-2 only); 0: No, 1: Yes SshNoTrivialAuth Disconnect if authentication succeeds trivially; 0: No, 1: Yes
Authentication methods TryAgent Attempt authentication using Pageant; 0: No, 1: Yes AuthTIS Attempt TIS or CryptoCard auth (SSH-1); 0: No, 1: Yes AuthKI Attempt "keyboard-interactive" auth (SSH-2); 0: No, 1: Yes
Authentication parameters AgentFwd Allow agent forwarding; 0: No, 1: Yes ChangeUsername Allow attempted changes of username in SSH-2; 0: No, 1: Yes PublicKeyFile Private key file path for authentication

Connection/SSH/Auth/GSSAPI

AuthGSSAPI Attempt GSSAPI authentication (SSH-2 only); 0: No, 1: Yes AuthGSSAPIKEX Attempt GSSAPI key exchange (SSH-2 only); 0: No, 1: Yes GssapiFwd Allow GSSAPI credential delegation; 0: No, 1: Yes GSSLibs Preference order for GSSAPI libraries: T.B.D. GSSCustom User-supplied GSSAPI library path

Connection/SSH/TTY

NoPTY Don't allocate a pseudo-terminal; 0: No (allocate it), 1: Yes (don't allocate it)
Terminal modes TerminalModes Terminal modes to send T.B.D.

Connection/SSH/X11

X11 forwarding X11Forward Enable X11 forwarding; 0: No, 1: Yes X11Display X display location X11AuthType Remote X11 authentication protocol 1: MIT-Magic-Cookie-1 2: XDM-Authorization-1 X11AuthFile X authority file path for local display

Connection/SSH/Tunnels

Port forwarding LocalPortAcceptAll Local ports accept connections from other hosts; 0: No, 1: Yes RemotePortAcceptAll Remote ports do the same (SSH-2 only); 0: No, 1: Yes SSHTunnelInTitle Print Dynamic ports in window title; 0: No, 1: Yes PortForwardings Forwarded ports: T.B.D.

Connection/SSH/Bugs

Detection of known bugs in SSH servers BugIgnore2 Chokes on SSH-2 ignore messages; 0: On, 1: Off, 2: Auto BugRekey2 Handles SSH-2 key re-exchange badly; 0: On, 1: Off, 2: Auto BugWinadj Chokes on PuTTY's SSH-2 'winadj' requests; 0: On, 1: Off, 2: Auto BugChanReq Replies to requests on closed channels; 0: On, 1: Off, 2: Auto BugMaxPkt2 Ignores SSH-2 maximum packet size; 0: On, 1: Off, 2: Auto

Connection/SSH/More bugs

Detection of known bugs in SSH servers BugRSAPad2 Requires padding on SSH-2 RSA signatures; 0: On, 1: Off, 2: Auto BugOldGex2 Only supports pre-RFC4419 SSH-2 DH GEX; 0: On, 1: Off, 2: Auto BugHMAC2 Miscomputes SSH-2 HMAC keys; 0: On, 1: Off, 2: Auto BugPKSessID2 Misuses the session ID in SSH-2 PK auth; 0: On, 1: Off, 2: Auto BugDeriveKey2 Miscomputes SSH-2 encryption keys; 0: On, 1: Off, 2: Auto BugIgnore1 Chokes on SSH-1 ignore messages; 0: On, 1: Off, 2: Auto BugPlainPW1 Refuses all SSH-1 password camouflage; 0: On, 1: Off, 2: Auto BugRSA1 Chokes on SSH-1 RSA authentication; 0: On, 1: Off, 2: Auto

Connection/SSH/RSCP and WinSCP

General protocol setting WinSCPProtocol Prefered protocol: 0: scp 1: sftp 2: ftp 3: ftps 4: ftpes 5: http 6: https
PSCP integration SCPAutoPwd Send file in current directory; 0: No, 1: Yes PSCPRemoteDir Remote directory (exclusive with previous setting) PSCPOptions PSCP options
WinSCP integration SFTPConnect SFTP connect ([user@]hostname[:port]) WinSCPOptions WinSCP additional options WinSCPRawSettings WinSCP additional rawsettings PSCPShell Shell (scp mode only)

Connection/Serial

Select a serial line SerialLine Serial line to connect to, e.g., COM1 SerialSpeed Speed (baud) SerialDataBits Data bits SerialStopHalfbits Stop bits SerialParity Parity; 0: None, 1: Odd, 2: Even, 3: Mark, 4: Space SerialFlowControl Flow control; 0: None, 1: XON/XOFF, 2: RTS/CTS, 3: DSR/DTR

Connection/Telnet

Telnet protocol adjustments RFCEnviron Handling of OLD_ENVIRON ambiguity: 0: BSD (commonplace) 1: RFC 1408 (unusual) PassiveTelnet Telnet negotiation mode: 0: Active 1: Passive TelnetKey Keyboard sends Telnet special commands; 0: No, 1: Yes TelnetRet Return key sends Telnet New Line instead of ^M; 0: No, 1: Yes

Connection/Rlogin

Data to send to the server LocalUserName Local username

Connection/SUPDUP

SUPDUPLocation

Location string

SUPDUPCharset

Exendetd ASCII Character set:
0: None
1: ITS
2: WAITS

SUPDUPMoreProcessing

**MORE** processing; 0: No, 1: Yes

SUPDUPScrolling

Terminal scrolling; 0: No, 1: Yes

Comment

Now you can add comments on your session Comment Comment

Preparing a KiTTY configuration file

Destination

Options specific to SSH packet logging

Various terminal options

Line discipline options

Remote-controlled printing

Change the sequences sent by:

Application keypad settings:

Enable extra keyboard features:

Style of bell

Bell overload behaviour

Size of the window

Control the scrollback in the window

Adjust the use of the cursor

Font settings

Adjust the use of the mouse pointer

Adjust the window border

Remember Window Position

Transparency setting

Adjust the behaviour of the window title

When WindowHasSysMenu is non-zero

Character set translation

Adjust how to handle line drawing characters

Control use of mouse

Assign copy/paste actions to clipboards

Control pasting of text from clipboard to terminal

Classes of character that group together

Formatting of copied characters

General options for colour usage

Colour table

General options for hyperlinks

Browser application

Regular expression

Sending of null packets to keep session active

Low-level TCP connection options

Internet protocol version

Reconnect options

Logical name of remote host

Port knocking sequence

Login details

Terminal details

Environment variables

Data to send to the server

Protocol options

Sharing an SSH connection between PuTTY tools

Key exchange algorithm options

Options controlling key re-exchange

Host key algorithm preference

Manually configure host keys for this connection

Encryption options

Authentication methods

Authentication parameters

Terminal modes

X11 forwarding

Port forwarding

Detection of known bugs in SSH servers

Detection of known bugs in SSH servers

General protocol setting

PSCP integration

WinSCP integration

Select a serial line

Telnet protocol adjustments

Data to send to the server

Now you can add comments on your session

When `WindowHasSysMenu` is non-zero