| 1 |
.\" Copyright 1988, 1994, 1998 The Open Group |
| 2 |
.\" |
| 3 |
.\" Permission to use, copy, modify, distribute, and sell this software and its |
| 4 |
.\" documentation for any purpose is hereby granted without fee, provided that |
| 5 |
.\" the above copyright notice appear in all copies and that both that |
| 6 |
.\" copyright notice and this permission notice appear in supporting |
| 7 |
.\" documentation. |
| 8 |
.\" |
| 9 |
.\" The above copyright notice and this permission notice shall be included |
| 10 |
.\" in all copies or substantial portions of the Software. |
| 11 |
.\" |
| 12 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| 13 |
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 14 |
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 15 |
.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 16 |
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| 17 |
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 18 |
.\" OTHER DEALINGS IN THE SOFTWARE. |
| 19 |
.\" |
| 20 |
.\" Except as contained in this notice, the name of The Open Group shall |
| 21 |
.\" not be used in advertising or otherwise to promote the sale, use or |
| 22 |
.\" other dealings in this Software without prior written authorization |
| 23 |
.\" from The Open Group. |
| 24 |
.\" |
| 25 |
.\" |
| 26 |
.TH XCLIPBOARD 1 "xclipboard 1.1.4" "X Version 11" |
| 27 |
.SH NAME |
| 28 |
xclipboard \- X clipboard client |
| 29 |
.SH SYNOPSIS |
| 30 |
\fBxclipboard\fP [ \fI\-toolkitoption\fP ... ] [ \fB\-w\fP ] |
| 31 |
[ \fB\-nw\fP ] |
| 32 |
.SH DESCRIPTION |
| 33 |
The \fIxclipboard\fP program is used to collect and display text selections |
| 34 |
that are sent to the CLIPBOARD by other clients. It is typically used to |
| 35 |
save CLIPBOARD selections for later use. It stores each CLIPBOARD selection |
| 36 |
as a separate string, each of which can be selected. Each time CLIPBOARD |
| 37 |
is asserted by another application, \fIxclipboard\fP transfers the contents |
| 38 |
of that selection to a new buffer and displays it in the text window. |
| 39 |
Buffers are never automatically deleted, so you'll want to use the delete |
| 40 |
button to get rid of useless items. |
| 41 |
.PP |
| 42 |
Since \fIxclipboard\fP uses a Text Widget to display the contents of the |
| 43 |
clipboard, text sent to the CLIPBOARD may be re-selected for use in other |
| 44 |
applications. \fIxclipboard\fP also responds to requests for the CLIPBOARD |
| 45 |
selection from other clients by sending the entire contents of the currently |
| 46 |
displayed buffer. |
| 47 |
.PP |
| 48 |
An \fIxclipboard\fP window has the following buttons across the top: |
| 49 |
.TP 8 |
| 50 |
.I quit |
| 51 |
When this button is pressed, \fIxclipboard\fP exits. |
| 52 |
.TP 8 |
| 53 |
.I delete |
| 54 |
When this button is pressed, the current buffer is deleted and the |
| 55 |
next one displayed. |
| 56 |
.TP 8 |
| 57 |
.I new |
| 58 |
Creates a new buffer with no contents. Useful in constructing a new |
| 59 |
CLIPBOARD selection by hand. |
| 60 |
.TP 8 |
| 61 |
.I save |
| 62 |
Displays a File Save dialog box. |
| 63 |
Pressing the Accept button saves the currently |
| 64 |
displayed buffer to the file specified in the text field. |
| 65 |
.TP 8 |
| 66 |
.I next |
| 67 |
Displays the next buffer in the list. |
| 68 |
.TP 8 |
| 69 |
.I previous |
| 70 |
Displays the previous buffer. |
| 71 |
.SH OPTIONS |
| 72 |
The \fIxclipboard\fP program accepts all of the standard X Toolkit command |
| 73 |
line options as well as the following: |
| 74 |
.TP 8 |
| 75 |
.B \-w |
| 76 |
This option indicates that lines of text that are too long to be displayed on |
| 77 |
one line in the clipboard should wrap around to the following lines. |
| 78 |
.TP 8 |
| 79 |
.B \-nw |
| 80 |
This option indicates that long lines of text should not wrap around. This |
| 81 |
is the default behavior. |
| 82 |
.SH WIDGETS |
| 83 |
In order to specify resources, it is useful to know the hierarchy of |
| 84 |
the widgets which compose \fIxclipboard\fR. In the notation below, |
| 85 |
indentation indicates hierarchical structure. The widget class name |
| 86 |
is given first, followed by the widget instance name. |
| 87 |
.sp |
| 88 |
.nf |
| 89 |
.ft CW |
| 90 |
XClipboard xclipboard |
| 91 |
Form form |
| 92 |
Command Quit |
| 93 |
Command delete |
| 94 |
Command new |
| 95 |
Command Save |
| 96 |
Command next |
| 97 |
Command prev |
| 98 |
Label index |
| 99 |
Text text |
| 100 |
TransientShell fileDialogShell |
| 101 |
Dialog fileDialog |
| 102 |
Label label |
| 103 |
Command accept |
| 104 |
Command cancel |
| 105 |
Text value |
| 106 |
TransientShell failDialogShell |
| 107 |
Dialog failDialog |
| 108 |
Label label |
| 109 |
Command continue |
| 110 |
.ft |
| 111 |
.fi |
| 112 |
.sp |
| 113 |
.SH SENDING/RETRIEVING CLIPBOARD CONTENTS |
| 114 |
Text is copied to the clipboard whenever a client asserts ownership of the |
| 115 |
\fBCLIPBOARD\fP selection. Text is copied from the clipboard whenever a |
| 116 |
client requests the contents of the \fBCLIPBOARD\fP selection. Examples of |
| 117 |
event bindings that a user may wish to include in a resource configuration |
| 118 |
file to use the clipboard are: |
| 119 |
.sp |
| 120 |
.nf |
| 121 |
.ft CW |
| 122 |
*VT100.Translations: #override \\ |
| 123 |
<Btn3Up>: select-end(CLIPBOARD) \\n\\ |
| 124 |
<Btn2Up>: insert-selection(PRIMARY,CLIPBOARD) \\n\\ |
| 125 |
<Btn2Down>: ignore () |
| 126 |
|
| 127 |
.ft |
| 128 |
.fi |
| 129 |
.sp |
| 130 |
.SH "SEE ALSO" |
| 131 |
X(7), xcutsel(1), xterm(1), individual client documentation for how to make a |
| 132 |
selection and send it to the CLIPBOARD. |
| 133 |
.SH ENVIRONMENT |
| 134 |
.PP |
| 135 |
.TP 8 |
| 136 |
.B DISPLAY |
| 137 |
to get the default host and display number. |
| 138 |
.TP 8 |
| 139 |
.B XENVIRONMENT |
| 140 |
to get the name of a resource file that overrides the global resources |
| 141 |
stored in the RESOURCE_MANAGER property. |
| 142 |
.SH FILES |
| 143 |
.TP |
| 144 |
.I /etc/X11/app-defaults/XClipboard |
| 145 |
specifies required resources |
| 146 |
.SH AUTHOR |
| 147 |
Ralph R. Swick, DEC/MIT Project Athena |
| 148 |
.br |
| 149 |
Chris D. Peterson, MIT X Consortium |
| 150 |
.br |
| 151 |
Keith Packard, MIT X Consortium |