util/src/TclTk/tcl8.6.12/doc/packagens.n

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