summaryrefslogtreecommitdiffstats
path: root/doc/Package.n
diff options
context:
space:
mode:
authorericm <ericm>2000-02-01 01:14:00 (GMT)
committerericm <ericm>2000-02-01 01:14:00 (GMT)
commitacb2f260bec04797bce0d16b709b530c511fe87f (patch)
tree112da6d0b67c743bbc7eec435cfb6c42345bd653 /doc/Package.n
parentbfc121a8bd79c18c8d1b7760be65a4db3ad18bfd (diff)
downloadtcl-acb2f260bec04797bce0d16b709b530c511fe87f.zip
tcl-acb2f260bec04797bce0d16b709b530c511fe87f.tar.gz
tcl-acb2f260bec04797bce0d16b709b530c511fe87f.tar.bz2
* tests/package.test:
* library/tclIndex: * library/package.tcl: Added ::package namespace and ::package::create function. * library/init.tcl: Fixed problem with auto_load and determining if commands were loaded. * library/auto.tcl: "Fixed" issues with $ in files to be auto indexed. * doc/Package.n: New man page for package::create function. * doc/pkgMkIndex.n: Added additional information. * doc/library.n: Added additional qualification regarding auto_mkindex.
Diffstat (limited to 'doc/Package.n')
-rw-r--r--doc/Package.n57
1 files changed, 57 insertions, 0 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