X Version 11 (Release 6.1)

xclipboard(X1)

xclipboard -- X clipboard client

Synopsis

xclipboard [ -toolkitoption ... ] [ -w ] [ -nw ]

Description

The xclipboard program is used to collect and display text selections that are sent to the clipboard by other clients. It is typically used to save clipboard selections for later use. It stores each clipboard selection as a separate string, each of which can be selected. Each time clipboard is asserted by another application, xclipboard transfers the contents of that selection to a new buffer and displays it in the text window. Buffers are never automatically deleted, so you'll want to use the delete button to get rid of useless items.

Since xclipboard uses a Text Widget to display the contents of the clipboard, text sent to the clipboard may be re-selected for use in other applications. xclipboard also responds to requests for the clipboard selection from other clients by sending the entire contents of the currently displayed buffer.

An xclipboard window has the following buttons across the top:

quit: When this button is pressed, xclipboard exits.
delete: When this button is pressed, the current buffer is deleted and the next one displayed.
new: Creates a new buffer with no contents. Useful in constructing a new clipboard selection by hand.
save: Displays a File Save dialog box. Pressing the Accept button saves the currently displayed buffer to the file specified in the text field.
next: Displays the next buffer in the list.
previous: Displays the previous buffer.

Options

The xclipboard program accepts all of the standard X Toolkit command line options as well as the following:

-w: This option indicates that lines of text that are too long to be displayed on one line in the clipboard should wrap around to the following lines.
-nw: This option indicates that long lines of text should not wrap around. This is the default behavior.

Widgets

In order to specify resources, it is useful to know the hierarchy of the widgets which compose xclipboard. In the notation below, indentation indicates hierarchical structure. The widget class name is given first, followed by the widget instance name.

XClipboard  xclipboard
   Form  form
      Command  Quit
      Command  delete
      Command  new
      Command  Save
      Command  next
      Command  prev
      Label  index
      Text  text
   TransientShell  fileDialogShell
      Dialog  fileDialog
         Label  label
         Command  accept
         Command  cancel
         Text value
   TransientShell  failDialogShell
      Dialog  failDialog
         Label  label
         Command  continue

Sending/retrieving clipboard contents

Text is copied to the clipboard whenever a client asserts ownership of the ``clipboard'' selection. Text is copied from the clipboard whenever a client requests the contents of the ``clipboard'' selection. Examples of event bindings that a user may wish to include in a resource configuration file to use the clipboard are:

*VT100.Translations: #override \
   <Btn3Up>:     select-end(CLIPBOARD) \n\
   <Btn2Up>:     insert-selection(PRIMARY,CLIPBOARD) \n\
   <Btn2Down>:   ignore ()

Environment

DISPLAY: to get the default host and display number.
XENVIRONMENT: to get the name of a resource file that overrides the global resources stored in the ``RESOURCE_MANAGER'' property.

Files

/usr/lib/X11/app-defaults/XClipboard - specifies required resources.

References

X(X1M), xcutsel(X1), xterm(X1),

individual client documentation for how to make a selection and send it to the clipboard.