Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / mann / tk.n
CommitLineData
920dae64
AT
1'\"
2'\" Copyright (c) 1992 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: tk.n,v 1.7 2002/09/02 22:00:37 hobbs 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 tk n 8.4 Tk "Tk Built-In Commands"
247.BS
248'\" Note: do not modify the .SH NAME line immediately below!
249.SH NAME
250tk \- Manipulate Tk internal state
251.SH SYNOPSIS
252\fBtk\fR \fIoption \fR?\fIarg arg ...\fR?
253.BE
254
255.SH DESCRIPTION
256.PP
257The \fBtk\fR command provides access to miscellaneous
258elements of Tk's internal state.
259Most of the information manipulated by this command pertains to the
260application as a whole, or to a screen or display, rather than to a
261particular window.
262The command can take any of a number of different forms
263depending on the \fIoption\fR argument. The legal forms are:
264.TP
265\fBtk appname \fR?\fInewName\fR?
266If \fInewName\fR isn't specified, this command returns the name
267of the application (the name that may be used in \fBsend\fR
268commands to communicate with the application).
269If \fInewName\fR is specified, then the name of the application
270is changed to \fInewName\fR.
271If the given name is already in use, then a suffix of the form
272``\fB #2\fR'' or ``\fB #3\fR'' is appended in order to make the name unique.
273The command's result is the name actually chosen.
274\fInewName\fR should not start with a capital letter.
275This will interfere with option processing, since names starting with
276capitals are assumed to be classes; as a result, Tk may not
277be able to find some options for the application.
278If sends have been disabled by deleting the \fBsend\fR command,
279this command will reenable them and recreate the \fBsend\fR
280command.
281.VS 8.4
282.TP
283\fBtk caret window \fR?\fB\-x \fIx\fR? ?\fB\-y \fIy\fR? ?\fB\-height \fIheight\fR?
284.
285Sets and queries the caret location for the display of the specified
286Tk window \fIwindow\fR. The caret is the per-display cursor location
287used for indicating global focus (e.g. to comply with Microsoft
288Accessibility guidelines), as well as for location of the over-the-spot
289XIM (X Input Methods) or Windows IME windows. If no options are specified,
290the last values used for setting the caret are return in option-value pair
291format. \fI\-x\fR and \fI\-y\fR represent window-relative coordinates, and
292\fI\-height\fR is the height of the current cursor location, or the height
293of the specified \fIwindow\fR if none is given.
294.VE
295.TP
296\fBtk scaling \fR?\fB\-displayof \fIwindow\fR? ?\fInumber\fR?
297.
298Sets and queries the current scaling factor used by Tk to convert between
299physical units (for example, points, inches, or millimeters) and pixels. The
300\fInumber\fR argument is a floating point number that specifies the number of
301pixels per point on \fIwindow\fR's display. If the \fIwindow\fR argument is
302omitted, it defaults to the main window. If the \fInumber\fR argument is
303omitted, the current value of the scaling factor is returned.
304.RS
305.PP
306A ``point'' is a unit of measurement equal to 1/72 inch. A scaling factor
307of 1.0 corresponds to 1 pixel per point, which is equivalent to a standard
30872 dpi monitor. A scaling factor of 1.25 would mean 1.25 pixels per point,
309which is the setting for a 90 dpi monitor; setting the scaling factor to
3101.25 on a 72 dpi monitor would cause everything in the application to be
311displayed 1.25 times as large as normal. The initial value for the scaling
312factor is set when the application starts, based on properties of the
313installed monitor, but it can be changed at any time. Measurements made
314after the scaling factor is changed will use the new scaling factor, but it
315is undefined whether existing widgets will resize themselves dynamically to
316accomodate the new scaling factor.
317.RE
318.VS 8.3
319.TP
320\fBtk useinputmethods \fR?\fB\-displayof \fIwindow\fR? ?\fIboolean\fR?
321.
322Sets and queries the state of whether Tk should use XIM (X Input Methods)
323for filtering events. The resulting state is returned. XIM is used in
324some locales (ie: Japanese, Korean), to handle special input devices. This
325feature is only significant on X. If XIM support is not available, this
326will always return 0. If the \fIwindow\fR argument is omitted, it defaults
327to the main window. If the \fIboolean\fR argument is omitted, the current
328state is returned. This is turned on by default for the main display.
329.VE
330.VS 8.4
331.TP
332\fBtk windowingsystem\fR
333.
334Returns the current Tk windowing system, one of
335\fBx11\fR (X11-based), \fBwin32\fR (MS Windows),
336\fBclassic\fR (Mac OS Classic), or \fBaqua\fR (Mac OS X Aqua).
337.VE
338.SH KEYWORDS
339application name, send