1
0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-04-15 18:18:05 -05:00

Update copy and paste documentation.

Rewrite the "Using PuTTY" section for 'clipboard-generality', and also
explain why we default to mouse-based selection, interaction with other
applications via PRIMARY when running PuTTY on Unix, and bracketed-paste
mode. Also add lots of index terms.
This commit is contained in:
Jacob Nevins 2018-02-04 12:27:17 +00:00
parent 6b454a89f5
commit c971c428f3
3 changed files with 74 additions and 38 deletions

View File

@ -1405,7 +1405,7 @@ disabled.
\cfg{winhelp-topic}{selection.buttons} \cfg{winhelp-topic}{selection.buttons}
PuTTY's copy and paste mechanism is by default modelled on the Unix PuTTY's copy and paste mechanism is by default modelled on the Unix
\c{xterm} application. The X Window System uses a three-button mouse, \i\c{xterm} application. The X Window System uses a three-button mouse,
and the convention is that the \i{left button} \I{selecting text}selects, and the convention is that the \i{left button} \I{selecting text}selects,
the \i{right button} extends an existing selection, and the the \i{right button} extends an existing selection, and the
\i{middle button} pastes. \i{middle button} pastes.
@ -1474,21 +1474,24 @@ you have to hold down Alt to get the \e{normal} behaviour.
Here you can configure which clipboard(s) are written or read by Here you can configure which clipboard(s) are written or read by
PuTTY's various copy and paste actions. PuTTY's various copy and paste actions.
The X Window System provides multiple clipboards (or \q{selections}), The X Window System (which underlies most Unix graphical interfaces)
and many applications support more than one of them by a different provides multiple clipboards (or \q{\i{selections}}), and many
user interface mechanism. applications support more than one of them by a different user
interface mechanism.
The two most commonly used selections are called \cq{PRIMARY} and The two most commonly used selections are called \cq{\i{PRIMARY}} and
\cq{CLIPBOARD}; in applications supporting both, the usual behaviour \cq{\I{CLIPBOARD selection}CLIPBOARD}; in applications supporting both,
is that \cw{PRIMARY} is used by mouse-only actions (selecting text the usual behaviour is that \cw{PRIMARY} is used by mouse-only actions
automatically copies it to \cw{PRIMARY}, and middle-clicking pastes (selecting text automatically copies it to \cw{PRIMARY}, and
from \cw{PRIMARY}), whereas \cw{CLIPBOARD} is used by explicit Copy \i{middle-clicking} pastes from \cw{PRIMARY}), whereas \cw{CLIPBOARD}
and Paste menu items or keypresses such as Ctrl-C and Ctrl-V. is used by explicit Copy and Paste menu items or keypresses such as
\i{Ctrl-C} and \i{Ctrl-V}.
On other platforms, where there is a single system clipboard, PuTTY On other platforms such as Windows, where there is a single system
provides a second clipboard-like facility by permitting you to paste clipboard, PuTTY provides a second clipboard-like facility by permitting
the text you last selected in \e{this window}, whether or not it is you to paste the text you last selected in \e{this window}, whether or
currently also in the system clipboard. not it is currently also in the system clipboard. This is not enabled
by default.
\S2{config-selection-autocopy} \q{Auto-copy selected text} \S2{config-selection-autocopy} \q{Auto-copy selected text}
@ -1512,15 +1515,15 @@ will \e{also} be placed in \cq{CLIPBOARD} at the same time.
PuTTY has three user-interface actions which can be configured to PuTTY has three user-interface actions which can be configured to
paste into the terminal (not counting menu items). You can click paste into the terminal (not counting menu items). You can click
whichever mouse button (if any) is configured to paste (see whichever mouse button (if any) is configured to paste (see
\k{config-mouse}); you can press Shift-Ins; or you can press \k{config-mouse}); you can press \i{Shift-Ins}; or you can press
Ctrl-Shift-V, although that action is not enabled by default. \i{Ctrl-Shift-V}, although that action is not enabled by default.
You can configure which of the available clipboards each of these You can configure which of the available clipboards each of these
actions pastes from (including turning the paste action off actions pastes from (including turning the paste action off
completely). On platforms with a single system clipboard, the completely). On platforms with a single system clipboard, the
available options are to paste from that clipboard or to paste from available options are to paste from that clipboard or to paste from
PuTTY's internal memory of the last selected text within that window. PuTTY's internal memory of the \i{last selected text} within that
On X, the standard options are \cw{CLIPBOARD} or \cw{PRIMARY}. window. On X, the standard options are \cw{CLIPBOARD} or \cw{PRIMARY}.
(\cw{PRIMARY} is conceptually similar in that it \e{also} refers to (\cw{PRIMARY} is conceptually similar in that it \e{also} refers to
the last selected text \dash just across all applications instead of the last selected text \dash just across all applications instead of
@ -1528,11 +1531,11 @@ just this window.)
The two keyboard options each come with a corresponding key to copy The two keyboard options each come with a corresponding key to copy
\e{to} the same clipboard. Whatever you configure Shift-Ins to paste \e{to} the same clipboard. Whatever you configure Shift-Ins to paste
from, Ctrl-Ins will copy to the same location; similarly, Ctrl-Shift-C from, \i{Ctrl-Ins} will copy to the same location; similarly,
will copy to whatever Ctrl-Shift-V pastes from. \i{Ctrl-Shift-C} will copy to whatever Ctrl-Shift-V pastes from.
On X, you can also enter a selection name of your choice. For example, On X, you can also enter a selection name of your choice. For example,
there is a rarely-used standard selection called \cq{SECONDARY}, which there is a rarely-used standard selection called \cq{\i{SECONDARY}}, which
Emacs (for example) can work with if you hold down the Meta key while Emacs (for example) can work with if you hold down the Meta key while
dragging to select or clicking to paste; if you configure a PuTTY dragging to select or clicking to paste; if you configure a PuTTY
keyboard action to access this clipboard, then you can interoperate keyboard action to access this clipboard, then you can interoperate

View File

@ -73,7 +73,7 @@ from SSH and Telnet
\IM{three-button mouse} mouse, three-button \IM{three-button mouse} mouse, three-button
\IM{left mouse button}{left button} left mouse button \IM{left mouse button}{left button} left mouse button
\IM{middle mouse button}{middle button} middle mouse button \IM{middle mouse button}{middle button}{middle-clicking} middle mouse button
\IM{right mouse button}{right button} right mouse button \IM{right mouse button}{right button} right mouse button
\IM{selecting words}{word-by-word selection} selecting whole words \IM{selecting words}{word-by-word selection} selecting whole words
@ -92,6 +92,18 @@ from SSH and Telnet
\IM{right mouse button, with Ctrl} right mouse button, with Ctrl \IM{right mouse button, with Ctrl} right mouse button, with Ctrl
\IM{right mouse button, with Ctrl} Ctrl, with right mouse button \IM{right mouse button, with Ctrl} Ctrl, with right mouse button
\IM{selections} selections, multiple
\IM{selections} clipboards, multiple
\IM{PRIMARY} \c{PRIMARY} selection
\IM{PRIMARY} selection, \c{PRIMARY}
\IM{CLIPBOARD selection} \c{CLIPBOARD} selection
\IM{CLIPBOARD selection} selection, \c{CLIPBOARD}
\IM{SECONDARY} \c{SECONDARY} selection
\IM{SECONDARY} selection, \c{SECONDARY}
\IM{system menu} system menu \IM{system menu} system menu
\IM{system menu} menu, system \IM{system menu} menu, system
\IM{system menu} window menu \IM{system menu} window menu
@ -342,6 +354,11 @@ saved sessions from
\IM{remote-controlled printing} printing, remote-controlled \IM{remote-controlled printing} printing, remote-controlled
\IM{remote-controlled printing} passthrough printing \IM{remote-controlled printing} passthrough printing
\IM{Control-H} Control-H
\IM{Control-H} Ctrl-H
\IM{Control-?} Control-?
\IM{Control-?} Ctrl-?
\IM{Home and End keys} Home key \IM{Home and End keys} Home key
\IM{Home and End keys} End key \IM{Home and End keys} End key

View File

@ -21,27 +21,31 @@ the \I{Windows clipboard}Windows \i{clipboard}, so that you can
paste (for example) URLs into a web browser, or paste from a word paste (for example) URLs into a web browser, or paste from a word
processor or spreadsheet into your terminal session. processor or spreadsheet into your terminal session.
PuTTY's copy and paste works entirely with the \i{mouse}. In order By default, PuTTY's copy and paste works entirely with the \i{mouse}.
to copy text to the clipboard, you just click the \i{left mouse (This will be familiar to people who have used \i\c{xterm} on Unix.)
button} in the \i{terminal window}, and drag to \I{selecting text}select In order to copy text to the clipboard, you just click the \i{left
text. When you let go of the button, the text is \e{automatically} mouse button} in the \i{terminal window}, and drag to
copied to the clipboard. You do not need to press Ctrl-C or \I{selecting text}select text. When you let go of the button, the text
Ctrl-Ins; in fact, if you do press Ctrl-C, PuTTY will send a Ctrl-C is \e{automatically} copied to the clipboard. You do not need to press
character down your session to the server where it will probably \i{Ctrl-C} or \i{Ctrl-Ins}; in fact, if you do press Ctrl-C, PuTTY will
cause a process to be interrupted. send a Ctrl-C character down your session to the server where it will
probably cause a process to be interrupted.
Pasting is done using the right button (or the middle mouse button, Pasting into PuTTY is done using the right button (or the middle mouse
if you have a \i{three-button mouse} and have set it up; see button, if you have a \i{three-button mouse} and have set it up; see
\k{config-mouse}). (Pressing \i{Shift-Ins}, or selecting \q{Paste} \k{config-mouse}). (Pressing \i{Shift-Ins}, or selecting \q{Paste}
from the \I{right mouse button, with Ctrl}Ctrl+right-click from the \I{right mouse button, with Ctrl}Ctrl+right-click
\i{context menu}, have the same effect.) When \i{context menu}, have the same effect.) When
you click the \i{right mouse button}, PuTTY will read whatever is in you click the \i{right mouse button}, PuTTY will read whatever is in
the Windows clipboard and paste it into your session, \e{exactly} as the Windows clipboard and paste it into your session. By default, this
if it had been typed at the keyboard. (Therefore, be careful of behaves \e{exactly} as if the clipboard contents had been typed at the
pasting formatted text into an editor that does automatic indenting; keyboard; therefore, be careful of pasting formatted text into an
you may find that the spaces pasted from the clipboard plus the editor that does automatic \i{indenting}, as you may find that the spaces
spaces added by the editor add up to too many spaces and ruin the pasted from the clipboard plus the spaces added by the editor add up
formatting. There is nothing PuTTY can do about this.) to too many spaces and ruin the formatting. (Some remote applications
can ask PuTTY to identify text that is being pasted, to avoid this
sort of problem; but if your application does not, there is nothing
PuTTY can do to avoid this.)
If you \i{double-click} the left mouse button, PuTTY will If you \i{double-click} the left mouse button, PuTTY will
\I{selecting words}select a whole word. If you double-click, hold \I{selecting words}select a whole word. If you double-click, hold
@ -69,6 +73,15 @@ middle mouse button to paste, then the right mouse button does this
instead.) Click the button on the screen, and you can pick up the instead.) Click the button on the screen, and you can pick up the
nearest end of the selection and drag it to somewhere else. nearest end of the selection and drag it to somewhere else.
If you are running PuTTY itself on Unix (not just using it to connect
to a Unix system from Windows), by default you will likely have to use
similar mouse actions in other applications to paste the text you
copied from PuTTY, and to copy text for pasting into PuTTY; actions
like \i{Ctrl-C} and Ctrl-V will likely not behave as you expect.
\K{config-clipboards} explains why this is, and how you can change the
behaviour. (On Windows there is only a single selection shared with other
applications, so this confusion does not arise.)
It's possible for the server to ask to \I{mouse reporting}handle mouse It's possible for the server to ask to \I{mouse reporting}handle mouse
clicks in the PuTTY window itself. If this happens, the \i{mouse pointer} clicks in the PuTTY window itself. If this happens, the \i{mouse pointer}
will turn into an arrow, and using the mouse to copy and paste will only will turn into an arrow, and using the mouse to copy and paste will only
@ -76,6 +89,9 @@ work if you hold down Shift. See \k{config-features-mouse} and
\k{config-mouseshift} for details of this feature and how to configure \k{config-mouseshift} for details of this feature and how to configure
it. it.
You can customise much of this behaviour, for instance to enable copy
and paste from the keyboard; see \k{config-selection}.
\S{using-scrollback} \I{scrollback}Scrolling the screen back \S{using-scrollback} \I{scrollback}Scrolling the screen back
PuTTY keeps track of text that has scrolled up off the top of the PuTTY keeps track of text that has scrolled up off the top of the