summaryrefslogtreecommitdiffstats
path: root/doc/tm.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2009-12-16 14:04:05 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2009-12-16 14:04:05 (GMT)
commitb37c64be40edeb5c2f75e084417fb802058ae239 (patch)
tree06526f32ba540f4985cb92daf59f3c37ff39389b /doc/tm.n
parent2645c7c322e609d8c5ca99ae8718d29b2f8a3b4c (diff)
downloadtcl-b37c64be40edeb5c2f75e084417fb802058ae239.zip
tcl-b37c64be40edeb5c2f75e084417fb802058ae239.tar.gz
tcl-b37c64be40edeb5c2f75e084417fb802058ae239.tar.bz2
[Bug 1911342]: Rewrite formatting to avoid bogus link from tm.n to list.n in
the HTML documentation.
Diffstat (limited to 'doc/tm.n')
-rw-r--r--doc/tm.n21
1 files changed, 11 insertions, 10 deletions
diff --git a/doc/tm.n b/doc/tm.n
index f214e3c..df6d907 100644
--- a/doc/tm.n
+++ b/doc/tm.n
@@ -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.14.2.2 2008/06/25 18:16:03 dgp Exp $
+'\" RCS: @(#) $Id: tm.n,v 1.14.2.3 2009/12/16 14:04:05 dkf Exp $
'\"
.so man.macros
.TH tm n 8.5 Tcl "Tcl Built-In Commands"
@@ -14,17 +14,18 @@
tm \- Facilities for locating and loading of Tcl Modules
.SH SYNOPSIS
.nf
-\fB::tcl::tm::path\fR \fBadd\fR \fIpath\fR...
-\fB::tcl::tm::path\fR \fBremove\fR \fIpath\fR...
-\fB::tcl::tm::path\fR \fBlist\fR
-\fB::tcl::tm::roots\fR \fIpath\fR...
+\fB::tcl::tm::path add \fR?\fIpath\fR...?
+\fB::tcl::tm::path remove \fR?\fIpath\fR...?
+\fB::tcl::tm::path list\fR
+\fB::tcl::tm::roots \fR?\fIpath\fR...?
.fi
.BE
.SH DESCRIPTION
This document describes the facilities for locating and loading Tcl
-Modules. The following commands are supported:
+Modules (see \fBMODULE DEFINITION\fR for the definition of a Tcl Module).
+The following commands are supported:
.TP
-\fB::tcl::tm::path\fR \fBadd\fR \fIpath\fR...
+\fB::tcl::tm::path add \fR?\fIpath\fR...?
.
The paths are added at the head to the list of module paths, in order
of appearance. This means that the last argument ends up as the new
@@ -46,17 +47,17 @@ reverse order of addition. In other words, the paths added last are
looked at first.
.RE
.TP
-\fB::tcl::tm::path\fR \fBremove\fR \fIpath\fR...
+\fB::tcl::tm::path remove \fR?\fIpath\fR...?
.
Removes the paths from the list of module paths. The command silently
ignores all paths which are not on the list.
.TP
-\fB::tcl::tm::path\fR \fBlist\fR
+\fB::tcl::tm::path list\fR
.
Returns a list containing all registered module paths, in the order
that they are searched for modules.
.TP
-\fB::tcl::tm::roots\fR \fIpath\fR...
+\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