cd5fe773 |
1 | .TH putty 1 |
2 | .UC |
3 | .SH NAME |
4 | putty \- GUI SSH, Telnet and Rlogin client for X |
5 | .SH SYNOPSIS |
6 | \fBputty\fP [ \fIoptions\fP ] [ \fIhost\fP ] |
7 | .SH DESCRIPTION |
8 | \fIputty\fP is a graphical SSH, Telnet and Rlogin client for X. It |
9 | is a direct port of the Windows SSH client of the same name. |
10 | .SH OPTIONS |
11 | The command-line options supported by \fIputty\fP are: |
12 | .IP "\fB\-\-display\fP \fIdisplay\-name\fP" |
13 | Specify the X display on which to open \fIputty\fP. (Note this |
14 | option has a double minus sign, even though none of the others do. |
15 | This is because this option is supplied automatically by GTK. |
16 | Sorry.) |
17 | .IP "\fB\-fn\fP \fIfont-name\fP" |
18 | Specify the font to use for normal text displayed in the terminal. |
19 | .IP "\fB\-fb\fP \fIfont-name\fP" |
20 | Specify the font to use for bold text displayed in the terminal. If |
21 | the \fIBoldAsColour\fP resource is set to 1 (the default), bold text |
22 | will be displayed in different colours instead of a different font, |
23 | so this option will be ignored. If \fIBoldAsColour\fP is set to 0 |
24 | and you do not specify a bold font, \fIputty\fP will overprint the |
25 | normal font to make it look bolder. |
26 | .IP "\fB\-fw\fP \fIfont-name\fP" |
27 | Specify the font to use for double-width characters (typically |
28 | Chinese, Japanese and Korean text) displayed in the terminal. |
29 | .IP "\fB\-fwb\fP \fIfont-name\fP" |
30 | Specify the font to use for bold double-width characters (typically |
31 | Chinese, Japanese and Korean text) Like \fI-fb\fP, this will be |
32 | ignored unless the \fIBoldAsColour\fP resource is set to 0. |
33 | .IP "\fB\-geometry\fP \fIgeometry\fP" |
34 | Specify the size of the terminal, in rows and columns of text. See |
35 | \fIX(7)\fP for more information on the syntax of geometry |
36 | specifications. |
37 | .IP "\fB\-sl\fP \fIlines\fP" |
38 | Specify the number of lines of scrollback to save off the top of the |
39 | terminal. |
40 | .IP "\fB\-fg\fP \fIcolour\fP" |
41 | Specify the foreground colour to use for normal text. |
42 | .IP "\fB\-bg\fP \fIcolour\fP" |
43 | Specify the background colour to use for normal text. |
44 | .IP "\fB\-bfg\fP \fIcolour\fP" |
45 | Specify the foreground colour to use for bold text, if the |
46 | \fIBoldAsColour\fP resource is set to 1 (the default). |
47 | .IP "\fB\-bbg\fP \fIcolour\fP" |
48 | Specify the foreground colour to use for bold reverse-video text, if |
49 | the \fIBoldAsColour\fP resource is set to 1 (the default). (This |
50 | colour is best thought of as the bold version of the background |
51 | colour; so it only appears when text is displayed \fIin\fP the |
52 | background colour.) |
53 | .IP "\fB\-cfg\fP \fIcolour\fP" |
54 | Specify the foreground colour to use for text covered by the cursor. |
55 | .IP "\fB\-cbg\fP \fIcolour\fP" |
56 | Specify the background colour to use for text covered by the cursor. |
57 | In other words, this is the main colour of the cursor. |
58 | .IP "\fB\-title\fP \fItitle\fP" |
59 | Specify the initial title of the terminal window. (This can be |
60 | changed under control of the server.) |
61 | .IP "\fB\-sb\-\fP or \fB+sb\fP" |
62 | Tells \fIputty\fP not to display a scroll bar. |
63 | .IP "\fB\-sb\fP" |
64 | Tells \fIputty\fP to display a scroll bar: this is the opposite of |
65 | \fI\-sb\-\fP. This is the default option: you will probably only need |
66 | to specify it explicitly if you have changed the default using the |
67 | \fIScrollBar\fP resource. |
68 | .IP "\fB\-log\fP \fIfilename\fP" |
69 | This option makes \fIputty\fP log all the terminal output to a file |
70 | as well as displaying it in the terminal. |
71 | .IP "\fB\-cs\fP \fIcharset\fP" |
72 | This option specifies the character set in which \fIputty\fP should |
73 | assume the session is operating. This character set will be used to |
74 | interpret all the data received from the session, and all input you |
75 | type or paste into \fIputty\fP will be converted into this character |
76 | set before being sent to the session. |
77 | |
78 | Any character set name which is valid in a MIME header (and |
79 | supported by \fIputty\fP) should be valid here (examples are |
80 | "ISO-8859-1", "windows-1252" or "UTF-8"). Also, any character |
81 | encoding which is valid in an X logical font description should be |
82 | valid ("ibm-cp437", for example). |
83 | |
84 | \fIputty\fP's default behaviour is to use the same character |
85 | encoding as its primary font. If you supply a Unicode (iso10646-1) |
86 | font, it will default to the UTF-8 character set. |
87 | |
88 | Character set names are case-insensitive. |
89 | .IP "\fB\-nethack\fP" |
90 | Tells \fIputty\fP to enable NetHack keypad mode, in which the |
91 | numeric keypad generates the NetHack "hjklyubn" direction keys. This |
92 | enables you to play NetHack with the numeric keypad without having |
93 | to use the NetHack "number_pad" option (which requires you to press |
94 | "n" before any repeat count). So you can move with the numeric |
95 | keypad, and enter repeat counts with the normal number keys. |
96 | .IP "\fB\-help\fP, \fB\-\-help\fP" |
97 | Display a message summarizing the available options. |
98 | .IP "\fB\-load\fP \fIsession\fP" |
99 | Load a saved session by name. This allows you to run a saved session |
100 | straight from the command line without having to go through the |
101 | configuration box first. |
102 | .IP "\fB\-ssh\fP, \fB\-telnet\fP, \fB\-rlogin\fP, \fB\-raw\fP" |
103 | Select the protocol \fIputty\fP will use to make the connection. |
104 | .IP "\fB\-l\fP \fIusername\fP" |
105 | Specify the username to use when logging in to the server. |
106 | .IP "\fB\-L\fP [\fIsrcaddr\fP:]\fIsrcport\fP:\fIdesthost\fP:\fIdestport\fP" |
107 | Set up a local port forwarding: listen on \fIsrcport\fP (or |
108 | \fIsrcaddr\fP:\fIsrcport\fP if specified), and forward any |
109 | connections over the SSH connection to the destination address |
110 | \fIdesthost\fP:\fIdestport\fP. Only works in SSH. |
111 | .IP "\fB\-R\fP [\fIsrcaddr\fP:]\fIsrcport\fP:\fIdesthost\fP:\fIdestport\fP" |
112 | Set up a remote port forwarding: ask the SSH server to listen on |
113 | \fIsrcport\fP (or \fIsrcaddr\fP:\fIsrcport\fP if specified), |
114 | and to forward any connections back over the SSH connection where |
115 | the client will pass them on to the destination address |
116 | \fIdesthost\fP:\fIdestport\fP. Only works in SSH. |
117 | .IP "\fB\-D\fP [\fIsrcaddr\fP:]\fIsrcport\fP" |
118 | Set up dynamic port forwarding. The client listens on \fIsrcport\fP |
119 | (or \fIsrcaddr\fP:\fIsrcport\fP if specified), and implements a |
120 | SOCKS server. So you can point SOCKS-aware applications at this port |
121 | and they will automatically use the SSH connection to tunnel all |
122 | their connections. Only works in SSH. |
123 | .IP "\fB\-P\fP \fIport\fP" |
124 | Specify the port to connect to the server on. |
125 | .IP "\fB\-A\fP, \fB\-a\fP" |
126 | Enable (\fB\-A\fP) or disable (\fB\-a\fP) SSH agent forwarding. |
127 | Currently this only works with OpenSSH and SSH1. |
128 | .IP "\fB\-X\fP, \fB\-x\fP" |
129 | Enable (\fB\-X\fP) or disable (\fB\-x\fP) X11 forwarding. |
130 | .IP "\fB\-T\fP, \fB\-t\fP" |
131 | Enable (\fB\-t\fP) or disable (\fB\-T\fP) the allocation of a |
132 | pseudo-terminal at the server end. |
133 | .IP "\fB\-C\fP, \fB\-t\fP" |
134 | Enable zlib-style compression on the connection. |
135 | .IP "\fB\-1\fP, \fB\-2\fP" |
136 | Select SSH protocol v1 or v2. |
137 | .IP "\fB\-i\fP \fIkeyfile\fP" |
138 | Specify a private key file to use for authentication. For SSH2 keys, |
139 | this key file must be in PuTTY's format, not OpenSSH's or anyone |
140 | else's. |
141 | .SH SAVED SESSIONS |
142 | Saved sessions are stored in a \fI.putty/sessions\fP subdirectory in |
143 | your home directory. |
144 | .SH MORE INFORMATION |
145 | For more information on PuTTY, it's probably best to go and look at |
146 | the manual on the web page: |
147 | |
148 | \fBhttp://www.chiark.greenend.org.uk/~sgtatham/putty/\fP |
149 | .SH BUGS |
150 | This man page isn't terribly complete. |
151 | |
152 | It's not very helpful to require a PuTTY-format SSH2 key file when |
153 | there isn't yet a Unix port of PuTTYgen. |