diff options
Diffstat (limited to 'doc/tm.n')
| -rw-r--r-- | doc/tm.n | 63 |
1 files changed, 23 insertions, 40 deletions
@@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tm.n,v 1.8 2007/10/25 14:07:32 dkf Exp $ +'\" RCS: @(#) $Id: tm.n,v 1.9 2007/10/26 20:11:53 dgp Exp $ '\" .so man.macros .TH tm n 8.5 Tcl "Tcl Built-In Commands" @@ -56,11 +56,8 @@ that they are searched for modules. .TP \fB::tcl::tm::roots\fR \fIpath\fR... Similar to \fBpath add\fR, and layered on top of it. This command -takes a list of paths, extends each with -.QW "\fBtcl\fIX\fB/site-tcl\fR" , -and -.QW "\fBtcl\fIX\fB/\fIX\fB.\fIy\fR" , -for major version \fIX\fR of the +takes a list of paths, extends each with "\fBtcl\fIX\fB/site-tcl\fR", +and "\fBtcl\fIX\fB/\fIX\fB.\fIy\fR", for major version \fIX\fR of the Tcl interpreter and minor version \fIy\fR less than or equal to the minor version of the interpreter, and adds the resulting set of paths to the list of paths to search. @@ -115,37 +112,22 @@ For any two directories, neither is an ancestor directory of the other. .PP This is required to avoid ambiguities in package naming. If for -example the two directories -.QW \fIfoo/\fR -and -.QW \fIfoo/cool\fR -were on -the path a package named -.QW \fBcool::ice\fR -could be found via the names -.QW \fBcool::ice\fR -or -.QW \fBice\fR , -the latter potentially obscuring a package named -.QW \fBice\fR , -unqualified. +example the two directories "\fIfoo/\fR" and "\fIfoo/cool\fR" were on +the path a package named \fBcool::ice\fR could be found via the +names \fBcool::ice\fR or \fBice\fR, the latter potentially +obscuring a package named \fBice\fR, unqualified. .PP Before the search is started, the name of the requested package is translated into a partial path, using the following algorithm: .IP -All occurrences of -.QW \fB::\fR -in the package name are replaced by the appropriate directory -separator character for the platform we are on. On Unix, for example, -this is -.QW \fB/\fR . +All occurrences of "\fB::\fR" in the package name are replaced by +the appropriate directory separator character for the platform we are +on. On Unix, for example, this is "\fB/\fR". .PP Example: .IP -The requested package is -.QW \fBencoding::base64\fR . -The generated partial path is -.QW \fIencoding/base64\fR +The requested package is \fBencoding::base64\fR. The generated +partial path is "\fIencoding/base64\fR" .PP After this translation the package is looked for in all module paths, by combining them one-by-one, first to last with the partial path to @@ -175,13 +157,12 @@ Both package name \fBPNAME\fR and package version \fBPVERSION\fR are extracted from the filename \fBMF\fR according to the definition below: .CS -\fBMF\fR = /module_path/\fBPNAME\(fm\fR-\fBPVERSION\fR.tm +\fBMF\fR = /module_path/\fBPNAME'\fR-\fBPVERSION\fR.tm .CE .PP -Where \fBPNAME\(fm\fR is the partial path of the module as defined in -section \fBFINDING MODULES\fR, and translated into \fBPNAME\fR by -changing all directory separators to -.QW \fB::\fR , +Where \fBPNAME'\fR is the partial path of the module as defined in +section \fBFINDING MODULES\fR, and translated into \fB\fRPNAME by +changing all directory separators to "\fB::\fR", and \fBmodule_path\fR is the path (from the list of paths to search) that we found the module file under. .PP @@ -272,11 +253,13 @@ environment variables: \fB$::env(TCL8.0_TM_PATH)\fR .CE .RE + .SH "SEE ALSO" -package(n), Tcl Improvement Proposal #189 -.QW "\fITcl Modules\fR" -(online at http://tip.tcl.tk/189.html), Tcl Improvement Proposal #190 -.QW "\fIImplementation Choices for Tcl Modules\fR" -(online at http://tip.tcl.tk/190.html) +package(n), Tcl Improvement Proposal #189 "\fITcl Modules\fR" (online +at http://tip.tcl.tk/189.html), Tcl Improvement Proposal #190 +"\fIImplementation Choices for Tcl Modules\fR" (online at +http://tip.tcl.tk/190.html) + + .SH "KEYWORDS" modules, package |