diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Package.n | 57 | ||||
| -rw-r--r-- | doc/library.n | 7 | ||||
| -rw-r--r-- | doc/pkgMkIndex.n | 6 |
3 files changed, 65 insertions, 5 deletions
diff --git a/doc/Package.n b/doc/Package.n new file mode 100644 index 0000000..4859c2f --- /dev/null +++ b/doc/Package.n @@ -0,0 +1,57 @@ +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: Package.n,v 1.1 2000/02/01 01:14:00 ericm Exp $ +'\" +.so man.macros +.TH package::create n 8.3 Tcl "Tcl Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +package::create \- Construct an appropriate \fBpackage ifneeded\fR +command for a given package specification +.SH SYNOPSIS +.nf +.VS 8.3.0 +\fB::package::create \fI-name packageName\fR \fI-version +packageVersion\fR ?\fI-load filespec\fR? ... ?\fI-source filespec\fR? ... + +.SH DESCRIPTION +.PP +\fB::package::create\fR is a utility procedure that is part of the standard +Tcl library. It is used to create an appropriate \fBpackage +ifneeded\fR command for a given package specification. It can be used +to construct a \fBpkgIndex.tcl\fR file for use with the \fBpackage\fI +mechanism. + +.SH OPTIONS +The parameters supported are: +.TP +\fB\-name\fR\0\fIpackageName\fR +This parameter specifies the name of the package. It is required. +.TP +\fB\-version\fR\0\fIpackageVersion\fR +This parameter specifies the version of the package. It is required. +.TP +\fB\-load\fR\0\fIfilespec\fR +This parameter specifies a binary library that must be loaded with the +\fBload\fR command. \fIfilespec\fR is a list with two elements. The +first element is the name of the file to load. The second, optional +element is a list of commands supplied by loading that file. If the +list of procedures is empty or omitted, \fB::package::create\fR will +set up the library for direct loading (see \fBpkg_mkIndex\fR). Any +number of \fB-load\fR parameters may be specified. +.TP +\fB\-source\fR\0\fIfilespec\fR +This parameter is similar to the \fB-load\fR parameter, except that it +specifies a Tcl library that must be loaded with the +\fBsource\fR command. Any number of \fB-source\fR parameters may be +specified. +.PP +At least one \fB-load\fR or \fB-source\fR paramter must be given. + + + +.SH KEYWORDS +auto-load, index, package, version diff --git a/doc/library.n b/doc/library.n index e958e63..1b1ee6d 100644 --- a/doc/library.n +++ b/doc/library.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: library.n,v 1.8 1999/06/29 00:25:23 welch Exp $ +'\" RCS: @(#) $Id: library.n,v 1.9 2000/02/01 01:14:01 ericm Exp $ .so man.macros .TH library n "8.0" Tcl "Tcl Built-In Commands" .BS @@ -139,7 +139,10 @@ as its first characters then it is assumed to be a procedure definition and the next word of the line is taken as the procedure's name. Procedure definitions that don't appear in this way (e.g. they -have spaces before the \fBproc\fR) will not be indexed. +have spaces before the \fBproc\fR) will not be indexed. If your +script contains "dangerous" code, such as global initialization +code or procedure names with special characters like \fB$\fR, +\fB*\fR, \fB[\fR or \fB]\fR, you are safer using auto_mkindex_old. .RE .TP \fBauto_reset\fR diff --git a/doc/pkgMkIndex.n b/doc/pkgMkIndex.n index cb77b8b..f816436 100644 --- a/doc/pkgMkIndex.n +++ b/doc/pkgMkIndex.n @@ -4,17 +4,17 @@ '\" 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.7 2000/01/27 19:20:05 ericm Exp $ +'\" RCS: @(#) $Id: pkgMkIndex.n,v 1.8 2000/02/01 01:14:01 ericm Exp $ '\" .so man.macros -.TH pkg_mkIndex n 8.0 Tcl "Tcl Built-In Commands" +.TH pkg_mkIndex n 8.3 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME pkg_mkIndex \- Build an index for automatic loading of packages .SH SYNOPSIS .nf -.VS 8.0.3 +.VS 8.3.0 \fBpkg_mkIndex ?\fI-lazy\fR? ?\fI-load pkgPat\fR? ?\fI-verbose\fR? \fIdir\fR ?\fIpattern pattern ...\fR? .VE .fi |