diff options
author | welch <welch@noemail.net> | 1998-12-02 01:42:17 (GMT) |
---|---|---|
committer | welch <welch@noemail.net> | 1998-12-02 01:42:17 (GMT) |
commit | 9e5e12319919df75287cff6caa156bbea0c28fe2 (patch) | |
tree | 1025014306bb97b26495b5deb646f9ddfbbb6a56 /doc/pkgMkIndex.n | |
parent | 2e4ccda8d5c3b6dcc8bf02d722fa4568330d519f (diff) | |
download | tcl-9e5e12319919df75287cff6caa156bbea0c28fe2.zip tcl-9e5e12319919df75287cff6caa156bbea0c28fe2.tar.gz tcl-9e5e12319919df75287cff6caa156bbea0c28fe2.tar.bz2 |
Cleaned up man page so it works with html generator
FossilOrigin-Name: 3b85863bc1516859a778080d02f4f41252156808
Diffstat (limited to 'doc/pkgMkIndex.n')
-rw-r--r-- | doc/pkgMkIndex.n | 49 |
1 files changed, 25 insertions, 24 deletions
diff --git a/doc/pkgMkIndex.n b/doc/pkgMkIndex.n index 3c51284..bf211e1 100644 --- a/doc/pkgMkIndex.n +++ b/doc/pkgMkIndex.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: pkgMkIndex.n,v 1.5 1998/11/12 05:52:46 welch Exp $ +'\" RCS: @(#) $Id: pkgMkIndex.n,v 1.6 1998/12/02 01:42:18 welch Exp $ '\" .so man.macros .TH pkg_mkIndex n 8.0 Tcl "Tcl Built-In Commands" @@ -43,28 +43,8 @@ The \fIdir\fR argument gives the name of a directory and each script or binary files in \fIdir\fR. .VS 8.0.3 The default pattern is \fB*.tcl\fR and \fB*.[info sharedlibextension]\fR. -The optional switches are: -.TP 15 -\fB\-direct\fR -The generated index -will manage to load the package immediately upon \fBpackage require\fR -instead of delaying loading until actual use of one of the commands. -.TP 15 -\fB\-load \fIpkgPat\fR -The index process will pre-load any packages that exist in the -current interpreter and match \fIpkgPat\fP into the slave interpreter used to -generate the index. The pattern match uses string match rules. -See COMPLEX CASES below. -.TP 15 -\fB\-verbose\fR -Generate output during the indexing process. Output is via -the \fBtclLog\fP procedure, which by default prints to stderr. -.TP 15 -\fB\-\-\fR -End of the flags, in case \fIdir\fP begins with a dash. .VE -.LP -.RS +.sp 1 \fBPkg_mkIndex\fR will create a file \fBpkgIndex.tcl\fR in \fIdir\fR with package information about all the files given by the \fIpattern\fR arguments. @@ -78,7 +58,7 @@ or if you have dependencies among files, you may have to use the \fB-load\fP option or adjust the order in which \fBpkg_mkIndex\fR processes the files. See COMPLEX CASES below. -.RE + .IP [3] Install the package as a subdirectory of one of the directories given by the \fBtcl_pkgPath\fR variable. If \fB$tcl_pkgPath\fR contains more @@ -92,7 +72,7 @@ the package's script and/or binary files as well as the \fBpkgIndex.tcl\fR file. As long as the package is installed as a subdirectory of a directory in \fB$tcl_pkgPath\fR it will automatically be found during \fBpackage require\fR commands. -.IP +.sp 1 If you install the package anywhere else, then you must ensure that the directory containing the package is in the \fBauto_path\fR global variable or an immediate subdirectory of one of the directories in \fBauto_path\fR. @@ -119,6 +99,27 @@ interpreter, based on the first call to \fBpackage require\fR. Different versions of a package may be loaded in different interpreters. +.SH OPTIONS +The optional switches are: +.TP 15 +\fB\-direct\fR +The generated index +will manage to load the package immediately upon \fBpackage require\fR +instead of delaying loading until actual use of one of the commands. +.TP 15 +\fB\-load \fIpkgPat\fR +The index process will pre-load any packages that exist in the +current interpreter and match \fIpkgPat\fP into the slave interpreter used to +generate the index. The pattern match uses string match rules. +See COMPLEX CASES below. +.TP 15 +\fB\-verbose\fR +Generate output during the indexing process. Output is via +the \fBtclLog\fP procedure, which by default prints to stderr. +.TP 15 +\fB\-\-\fR +End of the flags, in case \fIdir\fP begins with a dash. + .SH "PACKAGES AND THE AUTO-LOADER" .PP The package management facilities overlap somewhat with the auto-loader, |