| 1 | '\" |
|---|
| 2 | '\" Copyright (c) 1998-2000 by Scriptics Corporation. |
|---|
| 3 | '\" All rights reserved. |
|---|
| 4 | '\" |
|---|
| 5 | '\" RCS: @(#) $Id: packagens.n,v 1.9 2007/12/13 15:22:33 dgp Exp $ |
|---|
| 6 | '\" |
|---|
| 7 | .so man.macros |
|---|
| 8 | .TH pkg::create n 8.3 Tcl "Tcl Built-In Commands" |
|---|
| 9 | .BS |
|---|
| 10 | '\" Note: do not modify the .SH NAME line immediately below! |
|---|
| 11 | .SH NAME |
|---|
| 12 | pkg::create \- Construct an appropriate 'package ifneeded' command for a given package specification |
|---|
| 13 | .SH SYNOPSIS |
|---|
| 14 | \fB::pkg::create \fI\-name packageName\fR \fI\-version packageVersion\fR ?\fI\-load filespec\fR? ... ?\fI\-source filespec\fR? ... |
|---|
| 15 | .BE |
|---|
| 16 | |
|---|
| 17 | .SH DESCRIPTION |
|---|
| 18 | .PP |
|---|
| 19 | \fB::pkg::create\fR is a utility procedure that is part of the standard Tcl |
|---|
| 20 | library. It is used to create an appropriate \fBpackage ifneeded\fR |
|---|
| 21 | command for a given package specification. It can be used to construct a |
|---|
| 22 | \fBpkgIndex.tcl\fR file for use with the \fBpackage\fR mechanism. |
|---|
| 23 | |
|---|
| 24 | .SH OPTIONS |
|---|
| 25 | The parameters supported are: |
|---|
| 26 | .TP |
|---|
| 27 | \fB\-name\fR\0\fIpackageName\fR |
|---|
| 28 | This parameter specifies the name of the package. It is required. |
|---|
| 29 | .TP |
|---|
| 30 | \fB\-version\fR\0\fIpackageVersion\fR |
|---|
| 31 | This parameter specifies the version of the package. It is required. |
|---|
| 32 | .TP |
|---|
| 33 | \fB\-load\fR\0\fIfilespec\fR |
|---|
| 34 | This parameter specifies a binary library that must be loaded with the |
|---|
| 35 | \fBload\fR command. \fIfilespec\fR is a list with two elements. The |
|---|
| 36 | first element is the name of the file to load. The second, optional |
|---|
| 37 | element is a list of commands supplied by loading that file. If the |
|---|
| 38 | list of procedures is empty or omitted, \fB::pkg::create\fR will |
|---|
| 39 | set up the library for direct loading (see \fBpkg_mkIndex\fR). Any |
|---|
| 40 | number of \fB\-load\fR parameters may be specified. |
|---|
| 41 | .TP |
|---|
| 42 | \fB\-source\fR\0\fIfilespec\fR |
|---|
| 43 | This parameter is similar to the \fB\-load\fR parameter, except that it |
|---|
| 44 | specifies a Tcl library that must be loaded with the |
|---|
| 45 | \fBsource\fR command. Any number of \fB\-source\fR parameters may be |
|---|
| 46 | specified. |
|---|
| 47 | .PP |
|---|
| 48 | At least one \fB\-load\fR or \fB\-source\fR parameter must be given. |
|---|
| 49 | .SH "SEE ALSO" |
|---|
| 50 | package(n) |
|---|
| 51 | .SH KEYWORDS |
|---|
| 52 | auto-load, index, package, version |
|---|
