Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / man / mann / clipboard.n
CommitLineData
920dae64
AT
1'\"
2'\" Copyright (c) 1994 The Regents of the University of California.
3'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
4'\"
5'\" See the file "license.terms" for information on usage and redistribution
6'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7'\"
8'\" RCS: @(#) $Id: clipboard.n,v 1.5.2.1 2004/10/28 10:19:29 dkf Exp $
9'\"
10'\" The definitions below are for supplemental macros used in Tcl/Tk
11'\" manual entries.
12'\"
13'\" .AP type name in/out ?indent?
14'\" Start paragraph describing an argument to a library procedure.
15'\" type is type of argument (int, etc.), in/out is either "in", "out",
16'\" or "in/out" to describe whether procedure reads or modifies arg,
17'\" and indent is equivalent to second arg of .IP (shouldn't ever be
18'\" needed; use .AS below instead)
19'\"
20'\" .AS ?type? ?name?
21'\" Give maximum sizes of arguments for setting tab stops. Type and
22'\" name are examples of largest possible arguments that will be passed
23'\" to .AP later. If args are omitted, default tab stops are used.
24'\"
25'\" .BS
26'\" Start box enclosure. From here until next .BE, everything will be
27'\" enclosed in one large box.
28'\"
29'\" .BE
30'\" End of box enclosure.
31'\"
32'\" .CS
33'\" Begin code excerpt.
34'\"
35'\" .CE
36'\" End code excerpt.
37'\"
38'\" .VS ?version? ?br?
39'\" Begin vertical sidebar, for use in marking newly-changed parts
40'\" of man pages. The first argument is ignored and used for recording
41'\" the version when the .VS was added, so that the sidebars can be
42'\" found and removed when they reach a certain age. If another argument
43'\" is present, then a line break is forced before starting the sidebar.
44'\"
45'\" .VE
46'\" End of vertical sidebar.
47'\"
48'\" .DS
49'\" Begin an indented unfilled display.
50'\"
51'\" .DE
52'\" End of indented unfilled display.
53'\"
54'\" .SO
55'\" Start of list of standard options for a Tk widget. The
56'\" options follow on successive lines, in four columns separated
57'\" by tabs.
58'\"
59'\" .SE
60'\" End of list of standard options for a Tk widget.
61'\"
62'\" .OP cmdName dbName dbClass
63'\" Start of description of a specific option. cmdName gives the
64'\" option's name as specified in the class command, dbName gives
65'\" the option's name in the option database, and dbClass gives
66'\" the option's class in the option database.
67'\"
68'\" .UL arg1 arg2
69'\" Print arg1 underlined, then print arg2 normally.
70'\"
71'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
72'\"
73'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
74.if t .wh -1.3i ^B
75.nr ^l \n(.l
76.ad b
77'\" # Start an argument description
78.de AP
79.ie !"\\$4"" .TP \\$4
80.el \{\
81. ie !"\\$2"" .TP \\n()Cu
82. el .TP 15
83.\}
84.ta \\n()Au \\n()Bu
85.ie !"\\$3"" \{\
86\&\\$1 \\fI\\$2\\fP (\\$3)
87.\".b
88.\}
89.el \{\
90.br
91.ie !"\\$2"" \{\
92\&\\$1 \\fI\\$2\\fP
93.\}
94.el \{\
95\&\\fI\\$1\\fP
96.\}
97.\}
98..
99'\" # define tabbing values for .AP
100.de AS
101.nr )A 10n
102.if !"\\$1"" .nr )A \\w'\\$1'u+3n
103.nr )B \\n()Au+15n
104.\"
105.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106.nr )C \\n()Bu+\\w'(in/out)'u+2n
107..
108.AS Tcl_Interp Tcl_CreateInterp in/out
109'\" # BS - start boxed text
110'\" # ^y = starting y location
111'\" # ^b = 1
112.de BS
113.br
114.mk ^y
115.nr ^b 1u
116.if n .nf
117.if n .ti 0
118.if n \l'\\n(.lu\(ul'
119.if n .fi
120..
121'\" # BE - end boxed text (draw box now)
122.de BE
123.nf
124.ti 0
125.mk ^t
126.ie n \l'\\n(^lu\(ul'
127.el \{\
128.\" Draw four-sided box normally, but don't draw top of
129.\" box if the box started on an earlier page.
130.ie !\\n(^b-1 \{\
131\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
132.\}
133.el \}\
134\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
135.\}
136.\}
137.fi
138.br
139.nr ^b 0
140..
141'\" # VS - start vertical sidebar
142'\" # ^Y = starting y location
143'\" # ^v = 1 (for troff; for nroff this doesn't matter)
144.de VS
145.if !"\\$2"" .br
146.mk ^Y
147.ie n 'mc \s12\(br\s0
148.el .nr ^v 1u
149..
150'\" # VE - end of vertical sidebar
151.de VE
152.ie n 'mc
153.el \{\
154.ev 2
155.nf
156.ti 0
157.mk ^t
158\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
159.sp -1
160.fi
161.ev
162.\}
163.nr ^v 0
164..
165'\" # Special macro to handle page bottom: finish off current
166'\" # box/sidebar if in box/sidebar mode, then invoked standard
167'\" # page bottom macro.
168.de ^B
169.ev 2
170'ti 0
171'nf
172.mk ^t
173.if \\n(^b \{\
174.\" Draw three-sided box if this is the box's first page,
175.\" draw two sides but no top otherwise.
176.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
178.\}
179.if \\n(^v \{\
180.nr ^x \\n(^tu+1v-\\n(^Yu
181\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
182.\}
183.bp
184'fi
185.ev
186.if \\n(^b \{\
187.mk ^y
188.nr ^b 2
189.\}
190.if \\n(^v \{\
191.mk ^Y
192.\}
193..
194'\" # DS - begin display
195.de DS
196.RS
197.nf
198.sp
199..
200'\" # DE - end display
201.de DE
202.fi
203.RE
204.sp
205..
206'\" # SO - start of list of standard options
207.de SO
208.SH "STANDARD OPTIONS"
209.LP
210.nf
211.ta 5.5c 11c
212.ft B
213..
214'\" # SE - end of list of standard options
215.de SE
216.fi
217.ft R
218.LP
219See the \\fBoptions\\fR manual entry for details on the standard options.
220..
221'\" # OP - start of full description for a single option
222.de OP
223.LP
224.nf
225.ta 4c
226Command-Line Name: \\fB\\$1\\fR
227Database Name: \\fB\\$2\\fR
228Database Class: \\fB\\$3\\fR
229.fi
230.IP
231..
232'\" # CS - begin code excerpt
233.de CS
234.RS
235.nf
236.ta .25i .5i .75i 1i
237..
238'\" # CE - end code excerpt
239.de CE
240.fi
241.RE
242..
243.de UL
244\\$1\l'|0\(ul'\\$2
245..
246.TH clipboard n 8.4 Tk "Tk Built-In Commands"
247.BS
248'\" Note: do not modify the .SH NAME line immediately below!
249.SH NAME
250clipboard \- Manipulate Tk clipboard
251.SH SYNOPSIS
252\fBclipboard \fIoption\fR ?\fIarg arg ...\fR?
253.BE
254
255.SH DESCRIPTION
256.PP
257This command provides a Tcl interface to the Tk clipboard,
258which stores data for later retrieval using the selection mechanism
259(via the \fB-selection CLIPBOARD\fR option).
260In order to copy data into the clipboard, \fBclipboard clear\fR must
261be called, followed by a sequence of one or more calls to \fBclipboard
262append\fR. To ensure that the clipboard is updated atomically, all
263appends should be completed before returning to the event loop.
264.PP
265The first argument to \fBclipboard\fR determines the format of the
266rest of the arguments and the behavior of the command. The following
267forms are currently supported:
268.PP
269.TP
270\fBclipboard clear\fR ?\fB\-displayof\fR \fIwindow\fR?
271Claims ownership of the clipboard on \fIwindow\fR's display and removes
272any previous contents. \fIWindow\fR defaults to ``.''. Returns an
273empty string.
274.TP
275\fBclipboard append\fR ?\fB\-displayof\fR \fIwindow\fR? ?\fB\-format\fR \fIformat\fR? ?\fB\-type\fR \fItype\fR? ?\fB\-\|\-\fR? \fIdata\fR
276Appends \fIdata\fR to the clipboard on \fIwindow\fR's
277display in the form given by \fItype\fR with the representation given
278by \fIformat\fR and claims ownership of the clipboard on \fIwindow\fR's
279display.
280.RS
281.PP
282\fIType\fR specifies the form in which the selection is to be returned
283(the desired ``target'' for conversion, in ICCCM terminology), and
284should be an atom name such as STRING or FILE_NAME; see the
285Inter-Client Communication Conventions Manual for complete details.
286\fIType\fR defaults to STRING.
287.PP
288The \fIformat\fR argument specifies the representation that should be
289used to transmit the selection to the requester (the second column of
290Table 2 of the ICCCM), and defaults to STRING. If \fIformat\fR is
291STRING, the selection is transmitted as 8-bit ASCII characters. If
292\fIformat\fR is ATOM, then the \fIdata\fR is
293divided into fields separated by white space; each field is converted
294to its atom value, and the 32-bit atom value is transmitted instead of
295the atom name. For any other \fIformat\fR, \fIdata\fR is divided
296into fields separated by white space and each
297field is converted to a 32-bit integer; an array of integers is
298transmitted to the selection requester. Note that strings passed to
299\fBclipboard append\fR are concatenated before conversion, so the
300caller must take care to ensure appropriate spacing across string
301boundaries. All items appended to the clipboard with the same
302\fItype\fR must have the same \fIformat\fR.
303.PP
304The \fIformat\fR argument is needed only for compatibility with
305clipboard requesters that don't use Tk. If the Tk toolkit is being
306used to retrieve the CLIPBOARD selection then the value is converted back to
307a string at the requesting end, so \fIformat\fR is
308irrelevant.
309.PP
310A \fB\-\|\-\fR argument may be specified to mark the end of options: the
311next argument will always be used as \fIdata\fR.
312This feature may be convenient if, for example, \fIdata\fR starts
313with a \fB\-\fR.
314.RE
315.TP
316\fBclipboard get\fR ?\fB\-displayof\fR \fIwindow\fR? ?\fB\-type\fR \fItype\fR?
317.VS 8.4
318Retrieve data from the clipboard on \fIwindow\fR's display.
319\fIwindow\fR defaults to ".". \fIType\fR specifies the form in which
320the data is to be returned and should be an atom name such as STRING
321or FILE_NAME. \fIType\fR defaults to STRING. This command is
322equivalent to \fBselection get -selection CLIPBOARD\fR.
323.VE 8.4
324.SH EXAMPLES
325Get the current contents of the clipboard.
326.CS
327if {[catch {\fBclipboard get\fR} contents]} {
328 # There were no clipboard contents at all
329}
330.CE
331.PP
332Set the clipboard to contain a fixed string.
333.CS
334\fBclipboard clear\fR
335\fBclipboard append\fR "some fixed string"
336.CE
337
338.SH "SEE ALSO"
339selection(n)
340
341.SH KEYWORDS
342clear, format, clipboard, append, selection, type