Package tcl-doc

Tcl documentation

TCL documentation.

Library Functions
Library Function Description
Tcl_Access check file permissions and other attributes
Tcl_Alloc allocate or free heap memory
Tcl_AllowExceptions allow all exceptions in next script evaluation
Tcl_AppendExportList manipulate namespaces
Tcl_AppInit perform application-specific initialization
Tcl_AsyncCreate handle asynchronous events
Tcl_BackgroundException report Tcl exception that occurred in background processing
Tcl_Backslash parse a backslash sequence
Tcl_CallWhenDeleted Arrange for callback when interpreter is deleted
Tcl_CancelEval cancel Tcl scripts
Tcl_ClassGetMetadata manipulate objects and classes
Tcl_ClassSetConstructor manipulate methods and method-call contexts
Tcl_CommandComplete Check for unmatched braces in a Tcl command
Tcl_CommandTraceInfo monitor renames and deletes of a command
Tcl_Concat concatenate a collection of strings
Tcl_ConditionNotify Tcl thread support
Tcl_CreateChannel procedures for creating and manipulating channels
Tcl_CreateChannelHandler call a procedure when a channel becomes readable or writable
Tcl_CreateCloseHandler arrange for callbacks when channels are closed
Tcl_CreateCommand implement new commands in C
Tcl_CreateEnsemble manipulate ensemble commands
Tcl_CreateEventSource the event queue and notifier interfaces
Tcl_CreateFileHandler associate procedure callbacks with files or devices (Unix only)
Tcl_CreateInterp create and delete Tcl command interpreters
Tcl_CreateMathFunc Define, query and enumerate math functions for expressions
Tcl_CreateObjCommand implement new commands in C
Tcl_CreateTimerHandler call a procedure at a given time
Tcl_CreateTrace arrange for command execution to be traced
Tcl_DetachPids manage child processes in background
Tcl_DoOneEvent wait for events and invoke event handlers
Tcl_DoWhenIdle invoke a procedure when there are no pending events
Tcl_DStringInit manipulate dynamic strings
Tcl_DumpActiveMemory Validated memory allocation interface
Tcl_EvalObjEx execute Tcl scripts
Tcl_Exit end the application or thread (and invoke exit handlers)
Tcl_ExprLong evaluate an expression
Tcl_ExprLongObj evaluate an expression
Tcl_FindExecutable identify or return the name of the binary file containing the application
Tcl_FSRegister procedures to interact with any filesystem
Tcl_GetAssocData manage associations of string keys and user specified data with Tcl interpreters
Tcl_GetCwd manipulate the current working directory
Tcl_GetEncoding procedures for creating and using encodings
Tcl_GetHostName get the name of the local host
Tcl_GetIndexFromObj lookup string in table of keywords
Tcl_GetInt convert from string to integer, double, or boolean
Tcl_GetOpenFile Return a FILE* for a channel registered in the given interpreter (Unix only)
Tcl_GetReturnOptions retrieve or record information about errors and other return options
Tcl_GetStdChannel procedures for retrieving and replacing the standard channels
Tcl_GetTime get date and time
Tcl_GetVersion get the version of the library at runtime
Tcl_Init find and source initialization script
Tcl_InitHashTable procedures to manage hash tables
Tcl_InitStubs initialize the Tcl stubs mechanism
Tcl_Interp client-visible fields of interpreter structures
Tcl_IsSafe manage multiple Tcl interpreters, aliases and hidden commands
Tcl_LimitAddHandler manage and check resource limits on interpreters
Tcl_LinkVar link Tcl variable to C variable
Tcl_ListObjAppendList manipulate Tcl values as lists
Tcl_LoadFile platform-independent dynamic library loading
Tcl_Main main program, startup script, and event loop definition for Tcl-based...
TCL_MEM_DEBUG Compile-time flag to enable Tcl memory debugging
Tcl_NewBooleanObj store/retrieve boolean value in a Tcl_Obj
Tcl_NewByteArrayObj manipulate Tcl values as a arrays of bytes
Tcl_NewDictObj manipulate Tcl values as dictionaries
Tcl_NewDoubleObj manipulate Tcl values as floating-point values
Tcl_NewIntObj manipulate Tcl values as integers
Tcl_NewObj manipulate Tcl values
Tcl_NewStringObj manipulate Tcl values as strings
Tcl_NRCreateCommand Non-Recursive (stackless) evaluation of Tcl scripts.
Tcl_OOInitStubs initialize library access to TclOO functionality
Tcl_OpenFileChannel buffered I/O facilities using channels
Tcl_OpenTcpClient procedures to open channels using TCP sockets
Tcl_Panic report fatal error and abort
Tcl_ParseArgsObjv parse arguments according to a tabular description
Tcl_ParseCommand parse Tcl scripts and expressions
Tcl_PkgRequire package version control
Tcl_Preserve avoid freeing storage while it is being used
Tcl_PrintDouble Convert floating value to string
Tcl_PutEnv procedures to manipulate the environment
Tcl_RecordAndEval save command on history list before evaluating
Tcl_RecordAndEvalObj save command on history list before evaluating
Tcl_RegExpMatch Pattern matching with regular expressions
Tcl_RegisterConfig procedures to register embedded configuration information
Tcl_RegisterObjType manipulate Tcl value types
Tcl_SaveInterpState save and restore an interpreter's state
Tcl_SetChannelError functions to create/intercept Tcl errors by channel drivers.
Tcl_SetErrno manipulate errno to store and retrieve error codes
Tcl_SetObjResult manipulate Tcl result
Tcl_SetRecursionLimit set maximum allowable nesting depth in interpreter
Tcl_SetVar2Ex manipulate Tcl variables
Tcl_SignalId Convert signal codes
Tcl_Sleep delay execution for a given number of milliseconds
Tcl_SourceRCFile source the Tcl rc file
Tcl_SplitList manipulate Tcl lists
Tcl_SplitPath manipulate platform-dependent file paths
Tcl_StackChannel manipulate stacked I/O channels
Tcl_StandardChannels How the Tcl library deals with the standard channels
Tcl_StaticPackage make a statically linked package available via the 'load' command
Tcl_StringMatch test whether a string matches a pattern
Tcl_SubstObj perform substitutions on Tcl values
Tcl_TraceVar monitor accesses to a variable
Tcl_TranslateFileName convert file name to native form and replace tilde with home directory
Tcl_UniChar routines for manipulating UTF-8 strings
Tcl_UniCharIsAlnum routines for classification of Tcl_UniChar characters
Tcl_UniCharToUpper routines for manipulating the case of Unicode characters and UTF-8 strings
Tcl_UpVar link one variable to another
Tcl_WrongNumArgs generate standard error message for wrong number of arguments
Tcl_ZlibDeflate compression and decompression functions
Tcl/Tk Keywords
Keyword Description
after Execute a command after a time delay
append Append to variable
apply Apply an anonymous function
argc Variables used by Tcl
array Manipulate array variables
auto_execok standard library of Tcl procedures
bgerror Command invoked to process background errors
binary Insert and extract fields from binary strings
break Abort looping command
case Evaluate one of several scripts, depending on a given value
catch Evaluate script and trap exceptional returns
cd Change working directory
chan Read, write and manipulate channels
clock Obtain and manipulate dates and times
close Close an open channel
concat Join lists together
continue Skip to the next iteration of a loop
coroutine Create and produce values from coroutines
dde Execute a Dynamic Data Exchange command
dict Manipulate dictionaries
encoding Manipulate encodings
eof Check for end of file condition on channel
error Generate an error
eval Evaluate a Tcl script
exec Invoke subprocesses
exit End the application
expr Evaluate an expression
fblocked Test whether the last input operation exhausted all available input
fconfigure Set and get options on a channel
fcopy Copy data from one channel to another
file Manipulate file names and attributes
fileevent Execute a script when a channel becomes readable or writable
filename File name conventions supported by Tcl commands
flush Flush buffered output for a channel
for 'For' loop
foreach Iterate over all elements in one or more lists
format Format a string in the style of sprintf
gets Read a line from a channel
glob Return names of files that match patterns
global Access global variables
history Manipulate the history list
http Client-side implementation of the HTTP/1.1 protocol
if Execute scripts conditionally
incr Increment the value of a variable
info Return information about the state of the Tcl interpreter
interp Create and manipulate Tcl interpreters
join Create a string by joining together list elements
lappend Append list elements onto a variable
lassign Assign list elements to variables
lindex Retrieve an element from a list
linsert Insert elements into a list
list Create a list
llength Count the number of elements in a list
lmap Iterate over all elements in one or more lists and collect results
load Load machine code and initialize new commands
lrange Return one or more adjacent elements from a list
lrepeat Build a list by repeating elements
lreplace Replace elements in a list with new elements
lreverse Reverse the order of a list
lsearch See if a list contains a particular element
lset Change an element in a list
lsort Sort the elements of a list
mathfunc Mathematical functions for Tcl expressions
mathop Mathematical operators as Tcl commands
memory Control Tcl memory debugging capabilities
msgcat Tcl message catalog
my invoke any method of current object
namespace create and manipulate contexts for commands and variables
next invoke superclass method implementations
oo_class class of all classes
oo_copy create copies of objects and classes
oo_define define and configure classes and objects
oo_object root class of the class hierarchy
open Open a file-based or command pipeline channel
package Facilities for package loading and version control
pid Retrieve process identifiers
pkg_create Construct an appropriate 'package ifneeded' command for a given package...
pkg_mkIndex Build an index for automatic loading of packages
platform System identification support code and utilities
platform_shell System identification support code and utilities
proc Create a Tcl procedure
puts Write to a channel
pwd Return the absolute path of the current working directory
read Read from a channel
refchan command handler API of reflected channels
regexp Match a regular expression against a string
registry Manipulate the Windows registry
regsub Perform substitutions based on regular expression pattern matching
rename Rename or delete a command
re_syntax Syntax of Tcl regular expressions
return Return from a procedure, or set return code of a script
safe Creating and manipulating safe interpreters
scan Parse string using conversion specifiers in the style of sscanf
seek Change the access position for an open channel
self method call internal introspection
set Read and write variables
socket Open a TCP network connection
source Evaluate a file or resource as a Tcl script
split Split a string into a proper Tcl list
string Manipulate strings
subst Perform backslash, command, and variable substitutions
switch Evaluate one of several scripts, depending on a given value
tailcall Replace the current procedure with another command
Tcl Tool Command Language
tcl_prefix facilities for prefix matching
tcltest Test harness support code and utilities
tell Return current access position for an open channel
throw Generate a machine-readable error
time Time the execution of a script
tm Facilities for locating and loading of Tcl Modules
trace Monitor variable accesses, command usages and command executions
transchan command handler API of channel transforms
try Trap and process errors and exceptions
unknown Handle attempts to use non-existent commands
unload Unload machine code
unset Delete variables
update Process pending events and idle callbacks
uplevel Execute a script in a different stack frame
upvar Create link to variable in a different stack frame
variable create and initialize a namespace variable
vwait Process events until a variable is written
while Execute script repeatedly as long as a condition is met
zlib compression and decompression operations