@@ -17,6 +17,7 @@ argc, argv, argv0, auto_path, env, errorCode, errorInfo, tcl_interactive, tcl_li
17
17
The following global variables are created and managed automatically
18
18
by the Tcl library. Except where noted below, these variables should
19
19
normally be treated as read-only by application-specific code and by users.
20
+ .\" VARIABLE: auto_path
20
21
.TP
21
22
\fB auto_path \fR
22
23
.
@@ -27,6 +28,7 @@ This variable is initialized during startup to contain, in order:
27
28
the directories listed in the \fB TCLLIBPATH \fR environment variable,
28
29
the directory named by the \fB tcl_library \fR global variable,
29
30
the parent directory of \fB tcl_library \fR ,
31
+ \fB [file dirname [file dirname [info nameofexecutable]]]/lib \fR ,
30
32
the directories listed in the \fB tcl_pkgPath \fR variable.
31
33
Additional locations to look for files and package indices should
32
34
normally be added to this variable using \fB lappend \fR .
@@ -36,6 +38,7 @@ Additional variables relating to package management exist. More
36
38
details are listed in the \fB VARIABLES \fR section of the \fB library \fR
37
39
manual page.
38
40
.RE
41
+ .\" VARIABLE: env
39
42
.TP
40
43
\fB env \fR
41
44
.
@@ -117,6 +120,7 @@ If existing, it has the same effect as running \fBinterp debug\fR
117
120
\fB {} -frame 1 \fR
118
121
as the very first command of each new Tcl interpreter.
119
122
.RE
123
+ .\" VARIABLE: errorCode
120
124
.TP
121
125
\fB errorCode \fR
122
126
.
@@ -213,6 +217,7 @@ If none of these methods for setting the error code has been used,
213
217
the Tcl interpreter will reset the variable to \fB NONE \fR after
214
218
the next error.
215
219
.RE
220
+ .\" VARIABLE: errorInfo
216
221
.TP
217
222
\fB errorInfo \fR
218
223
.
@@ -223,6 +228,7 @@ identifying the Tcl commands and procedures that were being executed
223
228
when the most recent error occurred.
224
229
Its contents take the form of a stack trace showing the various
225
230
nested Tcl commands that had been invoked at the time of the error.
231
+ .\" VARIABLE: tcl_library
226
232
.TP
227
233
\fB tcl_library \fR
228
234
.
@@ -245,6 +251,7 @@ If \fBTCL_LIBRARY\fR is not set or doesn't refer to an appropriate
245
251
directory, then Tcl checks several other directories based on a
246
252
compiled-in default location, the location of the binary containing
247
253
the application, and the current working directory.
254
+ .\" VARIABLE: tcl_patchLevel
248
255
.TP
249
256
\fB tcl_patchLevel \fR
250
257
.
@@ -254,6 +261,7 @@ hold a string giving the current patch level for Tcl, such as
254
261
\fB 8.5b3 \fR for the third beta release of Tcl 8.5.
255
262
The value of this variable is returned by the \fB info patchlevel \fR
256
263
command.
264
+ .\" VARIABLE: tcl_pkgPath
257
265
.TP
258
266
\fB tcl_pkgPath \fR
259
267
.
@@ -273,6 +281,7 @@ value is added to \fBauto_path\fR at startup; changes to \fBtcl_pkgPath\fR
273
281
are not reflected in \fB auto_path \fR . If you want Tcl to search additional
274
282
directories for packages you should add the names of those directories to
275
283
\fB auto_path \fR , not \fB tcl_pkgPath \fR .
284
+ .\" VARIABLE: tcl_platform
276
285
.TP
277
286
\fB tcl_platform \fR
278
287
.
@@ -285,76 +294,54 @@ retrieve any relevant information. In addition, extensions
285
294
and applications may add additional values to the array. The
286
295
predefined elements are:
287
296
.RS
288
- .TP
289
- \fB byteOrder \fR
290
- .
297
+ .IP \fB byteOrder \fR
291
298
The native byte order of this machine: either \fB littleEndian \fR or
292
299
\fB bigEndian \fR .
293
- .TP
294
- \fB debug \fR
295
- .
300
+ .IP \fB debug \fR
296
301
If this variable exists, then the interpreter was compiled with and linked
297
302
to a debug-enabled C run-time. This variable will only exist on Windows,
298
303
so extension writers can specify which package to load depending on the
299
304
C run-time library that is in use. This is not an indication that this core
300
305
contains symbols.
301
- .TP
302
- \fB engine \fR
303
- .
306
+ .IP \fB engine \fR
304
307
The name of the Tcl language implementation. When the interpreter is first
305
308
created, this is always set to the string \fB Tcl \fR .
306
- .TP
307
- \fB machine \fR
308
- .
309
+ .IP \fB machine \fR
309
310
The instruction set executed by this machine, such as
310
311
\fB intel \fR , \fB PPC \fR , \fB 68k \fR , or \fB sun4m \fR . On UNIX machines, this
311
312
is the value returned by \fB uname -m \fR .
312
- .TP
313
- \fB os \fR
314
- .
313
+ .IP \fB os \fR
315
314
The name of the operating system running on this machine,
316
315
such as \fB Windows NT \fR or \fB SunOS \fR .
317
316
On UNIX machines, this is the value returned by \fB uname -s \fR .
318
- .TP
319
- \fB osVersion \fR
320
- .
317
+ .IP \fB osVersion \fR
321
318
The version number for the operating system running on this machine.
322
319
On UNIX machines, this is the value returned by \fB uname -r \fR .
323
- .TP
324
- \fB pathSeparator \fR
320
+ .IP \fB pathSeparator \fR
325
321
.VS 8.6
326
322
'\" Defined by TIP #315
327
323
The character that should be used to \fB split \fR PATH-like environment
328
324
variables into their corresponding list of directory names.
329
325
.VE 8.6
330
- .TP
331
- \fB platform \fR
332
- .
326
+ .IP \fB platform \fR
333
327
Either \fB windows \fR , or \fB unix \fR . This identifies the
334
328
general operating environment of the machine.
335
- .TP
336
- \fB pointerSize \fR
337
- .
329
+ .IP \fB pointerSize \fR
338
330
This gives the size of the native-machine pointer in bytes (strictly, it
339
331
is same as the result of evaluating \fI sizeof(void*) \fR in C.)
340
- .TP
341
- \fB threaded \fR
342
- .
332
+ .IP \fB threaded \fR
343
333
If this variable exists, then the interpreter
344
334
was compiled with threads enabled.
345
- .TP
346
- \fB user \fR
347
- .
335
+ .IP \fB user \fR
348
336
This identifies the
349
337
current user based on the login information available on the platform.
350
338
This value comes from the getuid() and getpwuid() system calls on Unix,
351
339
and the value from the GetUserName() system call on Windows.
352
- .TP
353
- \fB wordSize \fR
354
- .
340
+ .IP \fB wordSize \fR
355
341
This gives the size of the native-machine word in bytes (strictly, it
356
342
is same as the result of evaluating \fI sizeof(long) \fR in C.)
357
343
.RE
344
+ .\" VARIABLE: tcl_precision
358
345
.TP
359
346
\fB tcl_precision \fR
360
347
.
@@ -419,6 +406,7 @@ initialization, then the Tcl startup code will check for the existence
419
406
of this file and \fB source \fR it if it exists. For example, for \fB wish \fR
420
407
the variable is set to \fB ~/.wishrc \fR for Unix and \fB ~/wishrc.tcl \fR
421
408
for Windows.
409
+ .\" VARIABLE: tcl_traceCompile
422
410
.TP
423
411
\fB tcl_traceCompile \fR
424
412
.
@@ -437,6 +425,7 @@ tracking down suspected problems with the Tcl compiler.
437
425
This variable and functionality only exist if
438
426
\fB TCL_COMPILE_DEBUG \fR was defined during Tcl's compilation.
439
427
.RE
428
+ .\" VARIABLE: tcl_traceExec
440
429
.TP
441
430
\fB tcl_traceExec \fR
442
431
.
@@ -463,6 +452,7 @@ and interpreter.
463
452
This variable and functionality only exist if
464
453
\fB TCL_COMPILE_DEBUG \fR was defined during Tcl's compilation.
465
454
.RE
455
+ .\" VARIABLE: tcl_wordchars
466
456
.TP
467
457
\fB tcl_wordchars \fR
468
458
.
@@ -474,6 +464,7 @@ selecting a word by double-clicking in text in Tk. It is platform
474
464
dependent. On Windows, it defaults to \fB \e S \fR , meaning anything
475
465
but a Unicode space character. Otherwise it defaults to \fB \e w \fR ,
476
466
which is any Unicode word character (number, letter, or underscore).
467
+ .\" VARIABLE: tcl_nonwordchars
477
468
.TP
478
469
\fB tcl_nonwordchars \fR
479
470
.
@@ -500,20 +491,24 @@ command.
500
491
The following variables are only guaranteed to exist in \fB tclsh \fR
501
492
and \fB wish \fR executables; the Tcl library does not define them
502
493
itself but many Tcl environments do.
494
+ .\" VARIABLE: argc
503
495
.TP 6
504
496
\fB argc \fR
505
497
.
506
498
The number of arguments to \fB tclsh \fR or \fB wish \fR .
499
+ .\" VARIABLE: argv
507
500
.TP 6
508
501
\fB argv \fR
509
502
.
510
503
Tcl list of arguments to \fB tclsh \fR or \fB wish \fR .
504
+ .\" VARIABLE: argv0
511
505
.TP 6
512
506
\fB argv0 \fR
513
507
.
514
508
The script that \fB tclsh \fR or \fB wish \fR started executing (if it was
515
509
specified) or otherwise the name by which \fB tclsh \fR or \fB wish \fR
516
510
was invoked.
511
+ .\" VARIABLE: tcl_interactive
517
512
.TP 6
518
513
\fB tcl_interactive \fR
519
514
.
0 commit comments