summaryrefslogtreecommitdiffstats
path: root/doc/pkgMkIndex.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2024-01-25 17:45:17 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2024-01-25 17:45:17 (GMT)
commitd78ebb8e014475bdb1c47d4b695856f79925e755 (patch)
treed6ac371db01bf12d8b1e08214f3eef292617549f /doc/pkgMkIndex.n
parent104d50836d96335baa9b788de5e85dc2359dc323 (diff)
downloadtcl-d78ebb8e014475bdb1c47d4b695856f79925e755.zip
tcl-d78ebb8e014475bdb1c47d4b695856f79925e755.tar.gz
tcl-d78ebb8e014475bdb1c47d4b695856f79925e755.tar.bz2
Another round of small fixes, especially spelling errors...
Diffstat (limited to 'doc/pkgMkIndex.n')
-rw-r--r--doc/pkgMkIndex.n10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/pkgMkIndex.n b/doc/pkgMkIndex.n
index f98cbcd..3d10360 100644
--- a/doc/pkgMkIndex.n
+++ b/doc/pkgMkIndex.n
@@ -96,29 +96,39 @@ Different versions of a package may be loaded in different
interpreters.
.SH OPTIONS
The optional switches are:
+.\" OPTION: -direct
.TP 15
\fB\-direct\fR
+.
The generated index will implement direct loading of the package
upon \fBpackage require\fR. This is the default.
+.\" OPTION: -lazy
.TP 15
\fB\-lazy\fR
+.
The generated index will manage to delay loading the package until the
use of one of the commands provided by the package, instead of loading
it immediately upon \fBpackage require\fR. This is not compatible with
the use of \fIauto_reset\fR, and therefore its use is discouraged.
+.\" OPTION: -load
.TP 15
\fB\-load \fIpkgPat\fR
+.
The index process will preload any packages that exist in the
current interpreter and match \fIpkgPat\fR into the child interpreter used to
generate the index. The pattern match uses string match rules, but without
making case distinctions.
See \fBCOMPLEX CASES\fR below.
+.\" OPTION: -verbose
.TP 15
\fB\-verbose\fR
+.
Generate output during the indexing process. Output is via
the \fBtclLog\fR procedure, which by default prints to stderr.
+.\" OPTION: --
.TP 15
\fB\-\-\fR
+.
End of the flags, in case \fIdir\fR begins with a dash.
.SH "PACKAGES AND THE AUTO-LOADER"
.PP