]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - doc/man-ptel.but
Fix missing options in man pages.
[PuTTY.git] / doc / man-ptel.but
1 \cfg{man-identity}{puttytel}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}
2
3 \H{puttytel-manpage} Man page for PuTTYtel
4
5 \S{puttytel-manpage-name} NAME
6
7 \cw{puttytel} \- GUI Telnet and Rlogin client for X
8
9 \S{puttytel-manpage-synopsis} SYNOPSIS
10
11 \c puttytel [ options ] [ host ]
12 \e bbbbbbbb   iiiiiii     iiii
13
14 \S{puttytel-manpage-description} DESCRIPTION
15
16 \cw{puttytel} is a graphical Telnet and Rlogin client for X. It
17 is a direct port of the Windows Telnet and Rlogin client of the same
18 name, and a cut-down cryptography-free version of PuTTY.
19
20 \S{puttytel-manpage-options} OPTIONS
21
22 The command-line options supported by \cw{puttytel} are:
23
24 \dt \cw{\-\-display} \e{display\-name}
25
26 \dd Specify the X display on which to open \cw{puttytel}. (Note this
27 option has a double minus sign, even though none of the others do.
28 This is because this option is supplied automatically by GTK.
29 Sorry.)
30
31 \dt \cw{\-fn} \e{font-name}
32
33 \dd Specify the font to use for normal text displayed in the terminal.
34 For example, \cw{\-fn\_fixed}, \cw{\-fn\_"Monospace\_12"}.
35
36 \dt \cw{\-fb} \e{font-name}
37
38 \dd Specify the font to use for bold text displayed in the terminal. If
39 the \cw{BoldAsColour} resource is set to 1 (the default), bold text
40 will be displayed in different colours instead of a different font,
41 so this option will be ignored. If \cw{BoldAsColour} is set to 0 or 2
42 and you do not specify a bold font, \cw{puttytel} will overprint the
43 normal font to make it look bolder.
44
45 \dt \cw{\-fw} \e{font-name}
46
47 \dd Specify the font to use for double-width characters (typically
48 Chinese, Japanese and Korean text) displayed in the terminal.
49
50 \dt \cw{\-fwb} \e{font-name}
51
52 \dd Specify the font to use for bold double-width characters
53 (typically Chinese, Japanese and Korean text). Like \cw{-fb}, this
54 will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2.
55
56 \dt \cw{\-geometry} \e{geometry}
57
58 \dd Specify the size of the terminal, in rows and columns of text. See
59 \e{X(7)} for more information on the syntax of geometry
60 specifications.
61
62 \dt \cw{\-sl} \e{lines}
63
64 \dd Specify the number of lines of scrollback to save off the top of the
65 terminal.
66
67 \dt \cw{\-fg} \e{colour}
68
69 \dd Specify the foreground colour to use for normal text.
70
71 \dt \cw{\-bg} \e{colour}
72
73 \dd Specify the background colour to use for normal text.
74
75 \dt \cw{\-bfg} \e{colour}
76
77 \dd Specify the foreground colour to use for bold text, if the
78 \cw{BoldAsColour} resource is set to 1 (the default) or 2.
79
80 \dt \cw{\-bbg} \e{colour}
81
82 \dd Specify the foreground colour to use for bold reverse-video text, if
83 the \cw{BoldAsColour} resource is set to 1 (the default) or 2. (This
84 colour is best thought of as the bold version of the background
85 colour; so it only appears when text is displayed \e{in} the
86 background colour.)
87
88 \dt \cw{\-cfg} \e{colour}
89
90 \dd Specify the foreground colour to use for text covered by the cursor.
91
92 \dt \cw{\-cbg} \e{colour}
93
94 \dd Specify the background colour to use for text covered by the cursor.
95 In other words, this is the main colour of the cursor.
96
97 \dt \cw{\-title} \e{title}
98
99 \dd Specify the initial title of the terminal window. (This can be
100 changed under control of the server.)
101
102 \dt \cw{\-sb\-} or \cw{+sb}
103
104 \dd Tells \cw{puttytel} not to display a scroll bar.
105
106 \dt \cw{\-sb}
107
108 \dd Tells \cw{puttytel} to display a scroll bar: this is the opposite of
109 \cw{\-sb\-}. This is the default option: you will probably only need
110 to specify it explicitly if you have changed the default using the
111 \cw{ScrollBar} resource.
112
113 \dt \cw{\-log} \e{logfile}, \cw{\-sessionlog} \e{logfile}
114
115 \dd This option makes \cw{puttytel} log all the terminal output to a file
116 as well as displaying it in the terminal.
117
118 \dt \cw{\-cs} \e{charset}
119
120 \dd This option specifies the character set in which \cw{puttytel}
121 should assume the session is operating. This character set will be
122 used to interpret all the data received from the session, and all
123 input you type or paste into \cw{puttytel} will be converted into
124 this character set before being sent to the session.
125
126 \lcont{ Any character set name which is valid in a MIME header (and
127 supported by \cw{puttytel}) should be valid here (examples are
128 \q{\cw{ISO-8859-1}}, \q{\cw{windows-1252}} or \q{\cw{UTF-8}}). Also,
129 any character encoding which is valid in an X logical font
130 description should be valid (\q{\cw{ibm-cp437}}, for example).
131
132 \cw{puttytel}'s default behaviour is to use the same character
133 encoding as its primary font. If you supply a Unicode
134 (\cw{iso10646-1}) font, it will default to the UTF-8 character set.
135
136 Character set names are case-insensitive.
137 }
138
139 \dt \cw{\-nethack}
140
141 \dd Tells \cw{puttytel} to enable NetHack keypad mode, in which the
142 numeric keypad generates the NetHack \c{hjklyubn} direction keys.
143 This enables you to play NetHack with the numeric keypad without
144 having to use the NetHack \c{number_pad} option (which requires you
145 to press \q{\cw{n}} before any repeat count). So you can move with
146 the numeric keypad, and enter repeat counts with the normal number
147 keys.
148
149 \dt \cw{\-help}, \cw{\-\-help}
150
151 \dd Display a message summarizing the available options.
152
153 \dt \cw{\-pgpfp}
154
155 \dd Display the fingerprints of the PuTTY PGP Master Keys, to aid
156 in verifying new files released by the PuTTY team.
157
158 \dt \cw{\-load} \e{session}
159
160 \dd Load a saved session by name. This allows you to run a saved session
161 straight from the command line without having to go through the
162 configuration box first.
163
164 \dt \cw{\-telnet}, \cw{\-rlogin}, \cw{\-raw}
165
166 \dd Select the protocol \cw{puttytel} will use to make the connection.
167
168 \dt \cw{\-l} \e{username}
169
170 \dd Specify the username to use when logging in to the server.
171
172 \dt \cw{\-P} \e{port}
173
174 \dd Specify the port to connect to the server on.
175
176 \dt \cw{-4}, \cw{-6}
177
178 \dd Force use of IPv4 or IPv6 for network connections.
179
180 \S{puttytel-manpage-saved-sessions} SAVED SESSIONS
181
182 Saved sessions are stored in a \cw{.putty/sessions} subdirectory in
183 your home directory.
184
185 \S{puttytel-manpage-more-information} MORE INFORMATION
186
187 For more information on PuTTY and PuTTYtel, it's probably best to go
188 and look at the manual on the web page:
189
190 \W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}
191
192 \S{puttytel-manpage-bugs} BUGS
193
194 This man page isn't terribly complete.