Sort out the silly filenames.
[u/mdw/putty] / doc / using.but
CommitLineData
a5a6cb30 1\versionid $Id: using.but,v 1.2 2001/11/25 19:22:47 simon Exp $
fc5a8711 2
3\C{using} Using PuTTY
4
5This chapter provides a general introduction to some more advanced
6features of PuTTY. For extreme detail and reference purposes,
7\k{config} is likely to contain more information.
8
9\H{using-session} During your session
10
11A lot of PuTTY's complexity and features are in the configuration
12panel. Once you have worked your way through that and started
13a session, things should be reasonably simple after that.
14Nevertheless, there are a few more useful features available.
15
16\S{using-selection} Copying and pasting text
17
18Often in a PuTTY session you will find text on your terminal screen
19which you want to type in again. Like most other terminal emulators,
20PuTTY allows you to copy and paste the text rather than having to
21type it again. Also, copy and paste uses the Windows clipboard, so
22that you can paste (for example) URLs into a web browser, or paste
23from a word processor or spreadsheet into your terminal session.
24
25PuTTY's copy and paste works entirely with the mouse. In order to
26copy text to the clipboard, you just click the left mouse button in
27the terminal window, and drag to select text. When you let go of the
28button, the text is \e{automatically} copied to the clipboard. You
29do not need to press Ctrl-C or Ctrl-Ins; in fact, if you do press
30Ctrl-C, PuTTY will send a Ctrl-C character down your session to the
31server where it will probably cause a process to be interrupted.
32
33Pasting is done using the right button (or the middle mouse button,
34if you have a three-button mouse and have set it up; see
35\k{config-mouse}). When you click the right mouse button, PuTTY will
36read whatever is in the Windows Clipboard and paste it into your
37session, \e{exactly} as if it had been typed at the keyboard.
38(Therefore, be careful of pasting formatted text into an editor that
39does automatic indenting; you may find that the spaces pasted from
40the clipboard plus the spaces added by the editor add up to too many
41spaces and ruin the formatting. There is nothing PuTTY can do about
42this.)
43
44If you double-click the left mouse button, PuTTY will select a whole
45word. If you double-click, hold down the second click, and drag the
a5a6cb30 46mouse, PuTTY will select a sequence of whole words. (You can adjust
47precisely what PuTTY considers to be part of a word; see
48\k{config-charclasses}.) If you \e{triple}-click, or triple-click
49and drag, then PuTTY will select a whole line or sequence of lines.
fc5a8711 50
51If you want to select a rectangular region instead of selecting to
52the end of each line, you can do this by holding down Alt when you
53make your selection. (You can also configure rectangular selection
54to be the default, and then holding down Alt gives the normal
a5a6cb30 55behaviour instead. See \k{config-rectselect} for details.)
fc5a8711 56
57If you have a middle mouse button, then you can use it to adjust an
58existing selection if you selected something slightly wrong. (If you
59have configured the middle mouse button to paste, then the right
60mouse button does this instead.) Click the button on the screen, and
61you can pick up the nearest end of the selection and drag it to
62somewhere else.
63
64\S{using-scrollback} Scrolling the screen back
65
66PuTTY keeps track of text that has scrolled up off the top of the
67terminal. So if something appears on the screen that you want to
68read, but it scrolls too fast and it's gone by the time you try to
69look for it, you can use the scrollbar on the right side of the
70window to look back up the session history and find it again.
71
72As well as using the scrollbar, you can also page the scrollback up
73and down by pressing Shift-PgUp and Shift-PgDn. These are still
74available if you configure the scrollbar to be invisible.
75
76By default the last 200 lines scrolled off the top are
77preserved for you to look at. You can increase (or decrease) this
78value using the configuration box; see \k{config-scrollback}.
79
80\S{using-sysmenu} The System menu
81
82If you click the left mouse button on the icon in the top left
83corner of PuTTY's window, or click the right mouse button on the
84title bar, you will see the standard Windows system menu containing
85items like Minimise, Move, Size and Close.
86
87PuTTY's system menu contains extra program features in addition to
88the Windows standard options. These extra menu commands are
89described below.
90
91\S2{using-eventlog} The PuTTY Event Log
92
93If you choose \q{Event Log} from the system menu, a small window
94will pop up in which PuTTY logs significant events during the
95connection. Most of the events in the log will probably take place
96during session startup, but a few can occur at any point in the
97session, and one or two occur right at the end.
98
99You can use the mouse to select one or more lines of the Event Log,
100and hit the Copy button to copy them to the clipboard. If you are
101reporting a bug, it's often useful to paste the contents of the
102Event Log into your bug report.
103
104\S2{using-newsession} Starting new sessions
105
106PuTTY's system menu provides some shortcut ways to start new
107sessions:
108
109\b Selecting \q{New Session} will start a completely new instance of
110PuTTY, and bring up the configuration box as normal.
111
112\b Selecting \q{Duplicate Session} will start a session with
113precisely the same options as your current one - connecting to the
114same host using the same protocol, with all the same terminal
115settings and everything.
116
117\b The \q{Saved Sessions} submenu gives you quick access to any
118sets of stored session details you have previously saved. See
119\k{config-saving} for details of how to create saved sessions.
120
121\S2{using-changesettings} Changing your session settings
122
123If you select \q{Change Settings} from the system menu, PuTTY will
124display a cut-down version of its initial configuration box. This
125allows you to adjust most properties of your current session. You
126can change the terminal size, the font, the actions of various
127keypresses, the colours, and so on.
128
129Some of the options that are available in the main configuration box
130are not shown in the cut-down Change Settings box. These are usually
131options which don't make sense to change in the middle of a session
132(for example, you can't switch from SSH to Telnet in mid-session).
133
134\S2{using-copyall} Copy All to Clipboard
135
136This system menu option provides a convenient way to copy the whole
137contents of the terminal screen and scrollback to the clipboard in
138one go.
139
140\S2{reset-terminal} Clearing and resetting the terminal
141
142The \q{Clear Scrollback} option on the system menu tells PuTTY to
143discard all the lines of text that have been kept after they
144scrolled off the top of the screen. This might be useful, for
145example, if you displayed sensitive information and wanted to make
146sure nobody could look over your shoulder and see it. (Note that
147this only prevents a casual user from using the scrollbar to view
148the information; the text is not guaranteed not to still be in
149PuTTY's memory.)
150
151The \q{Reset Terminal} option causes a full reset of the terminal
152emulation. A VT-series terminal is a complex piece of software and
153can easily get into a state where all the text printed becomes
154unreadable. (This can happen, for example, if you accidentally
155output a binary file to your terminal.) If this happens, selecting
156Reset Terminal should sort it out.
157
158\S2{using-fullscreen} Full screen mode
159
160If you find the title bar on a maximised window to be ugly or
161distracting, you can select Full Screen mode to maximise PuTTY
162\q{even more}. When you select this, PuTTY will expand to fill the
163whole screen and its borders, title bar and scrollbar will
164disappear. (You can configure the scrollbar not to disappear in
a5a6cb30 165full-screen mode if you want to keep it; see \k{config-scrollback}.)
fc5a8711 166
167When you are in full-screen mode, you can still access the system
168menu if you click the left mouse button in the \e{extreme} top left
169corner of the screen.
170
171\H{using-logging} Creating a log file of your session
172
173For some purposes you may find you want to log everything that
174appears on your screen. You can do this using the \q{Logging} panel
175in the configuration box.
176
177To begin a session log, select \q{Change Settings} from the system
178menu and go to the Logging panel. Enter a log file name, and select
179a logging mode. (You can log all session output including the
180terminal control sequences, or you can just log the printable text.
181It depends what you want the log for.) Click \q{Apply} and your log
182will be started. Later on, you can go back to the Logging panel and
183select \q{Logging turned off completely} to stop logging; then PuTTY
184will close the log file and you can safely read it.
185
186See \k{config-logging} for more details and options.
187
188\H{using-translation} Altering your character set configuration
189
190If you find that special characters (accented characters, for
191example) are not being displayed correctly in your PuTTY session, it
192may be that PuTTY is interpreting the characters sent by the server
193according to the wrong \e{character set}. There are a lot of
194different character sets available, so it's entirely possible for
195this to happen.
196
197If you click \q{Change Settings} and look at the \q{Translation}
198panel, you should see a large number of character sets which you can
199select. Now all you need is to find out which of them you want!
200
201\H{using-forwarding} Port forwarding and X forwarding in SSH
202
203\# using X forwarding
204
205\# using port forwarding
206
207\H{using-rawprot} Making raw TCP connections
208
209\# Raw protocol