[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / man / man3 / Tcl_GetVersion.3

'\"
'\" Copyright (c) 1999 Scriptics Corporation
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\" 
'\" RCS: @(#) $Id: GetVersion.3,v 1.3 2001/12/14 06:04:42 dgp Exp $
'\" 
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.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
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH Tcl_GetVersion 3 7.5 Tcl "Tcl Library Procedures"
.BS
.SH NAME
Tcl_GetVersion \- get the version of the library at runtime
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
.sp
\fBTcl_GetVersion\fR(\fImajor, minor, patchLevel, type\fR)
.SH ARGUMENTS
.AP int *major out
Major version number of the Tcl library.
.AP int *minor out
Minor version number of the Tcl library.
.AP int *patchLevel out
The patch level of the Tcl library (or alpha or beta number).
.AP Tcl_ReleaseType *type out
The type of release, also indicates the type of patch level. Can be
one of \fBTCL_ALPHA_RELEASE\fR, \fBTCL_BETA_RELEASE\fR, or 
\fBTCL_FINAL_RELEASE\fR.
.BE

.SH DESCRIPTION
.PP
\fBTcl_GetVersion\fR should be used to query the version number
of the Tcl library at runtime.  This is useful when using a 
dynamically loaded Tcl library or when writing a stubs-aware
extension.  For instance, if you write an extension that is
linked against the Tcl stubs library, it could be loaded into
a program linked to an older version of Tcl than you expected.
Use \fBTcl_GetVersion\fR to verify that fact, and possibly to
change the behavior of your extension.
.PP
\fBTcl_GetVersion\fR accepts NULL for any of the arguments. For instance if 
you do not care about the \fIpatchLevel\fR of the library, pass
a NULL for the \fIpatchLevel\fR argument.

.SH KEYWORDS
version, patchlevel, major, minor, alpha, beta, release
Commit	Line	Data
920dae64 AT	1	'\"
	2	'\" Copyright (c) 1999 Scriptics Corporation
	3	'\"
	4	'\" See the file "license.terms" for information on usage and redistribution
	5	'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
	6	'\"
	7	'\" RCS: @(#) $Id: GetVersion.3,v 1.3 2001/12/14 06:04:42 dgp Exp $
	8	'\"
	9	'\" The definitions below are for supplemental macros used in Tcl/Tk
	10	'\" manual entries.
	11	'\"
	12	'\" .AP type name in/out ?indent?
	13	'\" Start paragraph describing an argument to a library procedure.
	14	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	15	'\" or "in/out" to describe whether procedure reads or modifies arg,
	16	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	17	'\" needed; use .AS below instead)
	18	'\"
	19	'\" .AS ?type? ?name?
	20	'\" Give maximum sizes of arguments for setting tab stops. Type and
	21	'\" name are examples of largest possible arguments that will be passed
	22	'\" to .AP later. If args are omitted, default tab stops are used.
	23	'\"
	24	'\" .BS
	25	'\" Start box enclosure. From here until next .BE, everything will be
	26	'\" enclosed in one large box.
	27	'\"
	28	'\" .BE
	29	'\" End of box enclosure.
	30	'\"
	31	'\" .CS
	32	'\" Begin code excerpt.
	33	'\"
	34	'\" .CE
	35	'\" End code excerpt.
	36	'\"
	37	'\" .VS ?version? ?br?
	38	'\" Begin vertical sidebar, for use in marking newly-changed parts
	39	'\" of man pages. The first argument is ignored and used for recording
	40	'\" the version when the .VS was added, so that the sidebars can be
	41	'\" found and removed when they reach a certain age. If another argument
	42	'\" is present, then a line break is forced before starting the sidebar.
	43	'\"
	44	'\" .VE
	45	'\" End of vertical sidebar.
	46	'\"
	47	'\" .DS
	48	'\" Begin an indented unfilled display.
	49	'\"
	50	'\" .DE
	51	'\" End of indented unfilled display.
	52	'\"
	53	'\" .SO
	54	'\" Start of list of standard options for a Tk widget. The
	55	'\" options follow on successive lines, in four columns separated
	56	'\" by tabs.
	57	'\"
	58	'\" .SE
	59	'\" End of list of standard options for a Tk widget.
	60	'\"
	61	'\" .OP cmdName dbName dbClass
	62	'\" Start of description of a specific option. cmdName gives the
	63	'\" option's name as specified in the class command, dbName gives
	64	'\" the option's name in the option database, and dbClass gives
65	'\" the option's class in the option database.
66	'\"
67	'\" .UL arg1 arg2
68	'\" Print arg1 underlined, then print arg2 normally.
69	'\"
70	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
71	'\"
72	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
73	.if t .wh -1.3i ^B
74	.nr ^l \n(.l
75	.ad b
76	'\" # Start an argument description
77	.de AP
78	.ie !"\\$4"" .TP \\$4
79	.el \{\
80	. ie !"\\$2"" .TP \\n()Cu
81	. el .TP 15
82	.\}
83	.ta \\n()Au \\n()Bu
84	.ie !"\\$3"" \{\
85	\&\\$1 \\fI\\$2\\fP (\\$3)
86	.\".b
87	.\}
88	.el \{\
89	.br
90	.ie !"\\$2"" \{\
91	\&\\$1 \\fI\\$2\\fP
92	.\}
93	.el \{\
94	\&\\fI\\$1\\fP
95	.\}
96	.\}
97	..
98	'\" # define tabbing values for .AP
99	.de AS
100	.nr )A 10n
101	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
102	.nr )B \\n()Au+15n
103	.\"
104	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105	.nr )C \\n()Bu+\\w'(in/out)'u+2n
106	..
107	.AS Tcl_Interp Tcl_CreateInterp in/out
108	'\" # BS - start boxed text
109	'\" # ^y = starting y location
110	'\" # ^b = 1
111	.de BS
112	.br
113	.mk ^y
114	.nr ^b 1u
115	.if n .nf
116	.if n .ti 0
117	.if n \l'\\n(.lu\(ul'
118	.if n .fi
119	..
120	'\" # BE - end boxed text (draw box now)
121	.de BE
122	.nf
123	.ti 0
124	.mk ^t
125	.ie n \l'\\n(^lu\(ul'
126	.el \{\
127	.\" Draw four-sided box normally, but don't draw top of
128	.\" box if the box started on an earlier page.
129	.ie !\\n(^b-1 \{\
130	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
131	.\}
132	.el \}\
133	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
134	.\}
135	.\}
136	.fi
137	.br
138	.nr ^b 0
139	..
140	'\" # VS - start vertical sidebar
141	'\" # ^Y = starting y location
142	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
143	.de VS
144	.if !"\\$2"" .br
145	.mk ^Y
146	.ie n 'mc \s12\(br\s0
147	.el .nr ^v 1u
148	..
149	'\" # VE - end of vertical sidebar
150	.de VE
151	.ie n 'mc
152	.el \{\
153	.ev 2
154	.nf
155	.ti 0
156	.mk ^t
157	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
158	.sp -1
159	.fi
160	.ev
161	.\}
162	.nr ^v 0
163	..
164	'\" # Special macro to handle page bottom: finish off current
165	'\" # box/sidebar if in box/sidebar mode, then invoked standard
166	'\" # page bottom macro.
167	.de ^B
168	.ev 2
169	'ti 0
170	'nf
171	.mk ^t
172	.if \\n(^b \{\
173	.\" Draw three-sided box if this is the box's first page,
174	.\" draw two sides but no top otherwise.
175	.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
176	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
177	.\}
178	.if \\n(^v \{\
179	.nr ^x \\n(^tu+1v-\\n(^Yu
180	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
181	.\}
182	.bp
183	'fi
184	.ev
185	.if \\n(^b \{\
186	.mk ^y
187	.nr ^b 2
188	.\}
189	.if \\n(^v \{\
190	.mk ^Y
191	.\}
192	..
193	'\" # DS - begin display
194	.de DS
195	.RS
196	.nf
197	.sp
198	..
199	'\" # DE - end display
200	.de DE
201	.fi
202	.RE
203	.sp
204	..
205	'\" # SO - start of list of standard options
206	.de SO
207	.SH "STANDARD OPTIONS"
208	.LP
209	.nf
210	.ta 5.5c 11c
211	.ft B
212	..
213	'\" # SE - end of list of standard options
214	.de SE
215	.fi
216	.ft R
217	.LP
218	See the \\fBoptions\\fR manual entry for details on the standard options.
219	..
220	'\" # OP - start of full description for a single option
221	.de OP
222	.LP
223	.nf
224	.ta 4c
225	Command-Line Name: \\fB\\$1\\fR
226	Database Name: \\fB\\$2\\fR
227	Database Class: \\fB\\$3\\fR
228	.fi
229	.IP
230	..
231	'\" # CS - begin code excerpt
232	.de CS
233	.RS
234	.nf
235	.ta .25i .5i .75i 1i
236	..
237	'\" # CE - end code excerpt
238	.de CE
239	.fi
240	.RE
241	..
242	.de UL
243	\\$1\l'\|0\(ul'\\$2
244	..
245	.TH Tcl_GetVersion 3 7.5 Tcl "Tcl Library Procedures"
246	.BS
247	.SH NAME
248	Tcl_GetVersion \- get the version of the library at runtime
249	.SH SYNOPSIS
250	.nf
251	\fB#include <tcl.h>\fR
252	.sp
253	\fBTcl_GetVersion\fR(\fImajor, minor, patchLevel, type\fR)
254	.SH ARGUMENTS
255	.AP int *major out
256	Major version number of the Tcl library.
257	.AP int *minor out
258	Minor version number of the Tcl library.
259	.AP int *patchLevel out
260	The patch level of the Tcl library (or alpha or beta number).
261	.AP Tcl_ReleaseType *type out
262	The type of release, also indicates the type of patch level. Can be
263	one of \fBTCL_ALPHA_RELEASE\fR, \fBTCL_BETA_RELEASE\fR, or
264	\fBTCL_FINAL_RELEASE\fR.
265	.BE
266
267	.SH DESCRIPTION
268	.PP
269	\fBTcl_GetVersion\fR should be used to query the version number
270	of the Tcl library at runtime. This is useful when using a
271	dynamically loaded Tcl library or when writing a stubs-aware
272	extension. For instance, if you write an extension that is
273	linked against the Tcl stubs library, it could be loaded into
274	a program linked to an older version of Tcl than you expected.
275	Use \fBTcl_GetVersion\fR to verify that fact, and possibly to
276	change the behavior of your extension.
277	.PP
278	\fBTcl_GetVersion\fR accepts NULL for any of the arguments. For instance if
279	you do not care about the \fIpatchLevel\fR of the library, pass
280	a NULL for the \fIpatchLevel\fR argument.
281
282	.SH KEYWORDS
283	version, patchlevel, major, minor, alpha, beta, release
284