-
Notifications
You must be signed in to change notification settings - Fork 75
/
xclip.1
147 lines (133 loc) · 6.73 KB
/
xclip.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.\"
.\"
.\" xclip.man - xclip manpage
.\" Copyright (C) 2001 Kim Saunders
.\" Copyright (C) 2007-2008 Peter Åstrand
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
.\"
.TH XCLIP 1
.SH NAME
xclip \- command line interface to X selections (clipboard)
.SH SYNOPSIS
.B xclip
[OPTION] [FILE]...
.SH DESCRIPTION
Reads from standard in, or from one or more files, and makes the data available as an X selection for pasting into X applications. Prints current X selection to standard out.
.TP
\fB\-i\fR, \fB\-in\fR
read text into X selection from standard input or files (default)
.TP
\fB\-o\fR, \fB\-out\fR
print the selection to standard out (generally for piping to a file or program)
.TP
\fB\-f\fR, \fB\-filter\fR
when xclip is invoked in the in mode with output level set to silent (the defaults), the filter option will cause xclip to print the text piped to standard in back to standard out unmodified
.TP
\fB\-r\fR, \fB\-rmlastnl\fR
when the last character of the selection is a newline character, remove it. Newline characters that are not the last character in the selection are not affected. If the selection does not end with a newline character, this option has no effect. This option is useful for copying one-line output of programs like \fBpwd\fR to the clipboard to paste it again into the command prompt without executing the line immediately due to the newline character \fBpwd\fR appends.
.TP
\fB\-l\fR \fIn\fR, \fB\-loops\fR \fIn\fR
number of X selection requests (pastes into X applications) to wait for before exiting, with a value of 0 (default) causing xclip to wait for an unlimited number of requests until another application (possibly another invocation of xclip) takes ownership of the selection.
.TP
\fB\-t\fR \fIt\fR, \fB\-target\fR \fIt\fR
specify a particular data format using the given target atom. With \fB\-o\fR the
special target atom name "TARGETS" can be used to get a list of valid target
atoms for this selection. The default target is "STRING". For more information
about target atoms refer to ICCCM section 2.6.2
.TP
\fB\-d\fR, \fB\-display\fR
X display to use (e.g. "localhost:0"), xclip defaults to the value in $\fBDISPLAY\fR if this option is omitted
.TP
\fB\-h\fR, \fB\-help\fR
show quick summary of options
.TP
\fB\-selection\fR
specify which X selection to use, options are "primary" to use XA_PRIMARY (default), "secondary" for XA_SECONDARY or "clipboard" for XA_CLIPBOARD
.TP
\fB\-version\fR
show version information
.TP
\fB\-silent\fR
fork into the background to wait for requests, no informational output, errors only (default)
.TP
\fB\-quiet\fR
show informational messages on the terminal and run in the foreground
.TP
\fB\-verbose\fR
provide a running commentary of what xclip is doing
.TP
\fB\-noutf8\fR
operate in legacy (i.e. non UTF-8) mode for backwards compatibility
(Use this option only when really necessary, as the old behavior was broken)
.TP
\fB\-sensitive\fR
clear sensitive data from selection buffer after being pasted once.
This is currently implemented as -wait 50. See \fBNOTES\fR
.TP
\fB\-wait\fR \fIn\fR
after the first paste, wait for \fIn\fR milliseconds. If a subsequent paste
request arrives before the timer expires, reset the timer. Once the timer
expires, the selection buffer is cleared so the data cannot be pasted again.
.PP
xclip reads text from standard in or files and makes it available to other X applications for pasting as an X selection (traditionally with the middle mouse button). It reads from all files specified, or from standard in if no files are specified. xclip can also print the contents of a selection to standard out with the
.B
\-o
option.
xclip was designed to allow tighter integration of X applications and command line programs. The default action is to silently wait in the background for X selection requests (pastes) until another X application places data in the clipboard, at which point xclip exits silently. You can use the \fB\-verbose\fR option to see if and when xclip actually receives selection requests from other X applications.
Options can be abbreviated as long as they remain unambiguous. For example, it is possible to use \fB\-d\fR or \fB\-disp\fR instead of \fB\-display\fR. However, \fB\-v\fR couldn't be used because it is ambiguous (it could be short for \fB\-verbose\fR or \fB\-version\fR), so it would be interpreted as a filename.
Note that only the first character of the selection specified with the \fB\-selection\fR option is important. This means that "p", "sec" and "clip" would have the same effect as using "primary", "secondary" or "clipboard" respectively.
.SH EXAMPLES
.PP
I hate man pages without examples!
.B
uptime | xclip
.PP
Put your uptime in the X selection. Then middle click in an X application to paste.
.B xclip -o > helloworld.c
.PP
Put the contents of the selection into a file.
.B xclip -t text/html index.html
.PP
Middle click in an X application supporting HTML to paste the contents of the given file as HTML.
.B xclip -loops 10 -verbose /etc/motd
.PP
Exit after /etc/motd (message of the day) has been pasted 10 times. Show how many selection requests (pastes) have been processed.
.SH NOTES
Using the \fB\-sensitive\fR option will clear the selection buffer of the
sensitive information 50 milliseconds after it has been pasted, effectively only
allowing the selection to be pasted once. In some instances this may be too low
and will prevent pasting. If this is the case, or if the user needs to be able
to paste more than once for some other reason, they may use \fB\-wait\fR \fIn\fR
instead. \fB\-wait\fR is the same as \fB\-sensitive\fR, except it allows one to
adjust the time to wait before clearing the selection to be \fIn\fR
milliseconds.
.PP
Ideally, \fB\-sensitive\fR would allow exactly one paste and not need a timeout,
but due to subtleties in the way the X clipboard protocol works, doing so is not
as simple as it may seem.
.SH ENVIRONMENT
.TP
.SM
\fBDISPLAY\fR
X display to use if none is specified with the
.B
\-display
option.
.SH REPORTING BUGS
Please report any bugs, problems, queries, experiences, etc. directly to the author.
.SH AUTHORS
Kim Saunders <kims@debian.org>
Peter Åstrand <astrand@lysator.liu.se>
.br