summaryrefslogtreecommitdiffstats
path: root/doc/packagens.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/packagens.n')
-rw-r--r--doc/packagens.n33
1 files changed, 14 insertions, 19 deletions
diff --git a/doc/packagens.n b/doc/packagens.n
index d73b168..c02b705 100644
--- a/doc/packagens.n
+++ b/doc/packagens.n
@@ -2,28 +2,25 @@
'\" Copyright (c) 1998-2000 by Scriptics Corporation.
'\" All rights reserved.
'\"
-'\" RCS: @(#) $Id: packagens.n,v 1.1 2000/02/03 17:27:03 ericm Exp $
+'\" RCS: @(#) $Id: packagens.n,v 1.2 2000/02/10 10:09:18 hobbs Exp $
'\"
.so man.macros
-.TH package::create n 8.3 Tcl "Tcl Built-In Commands"
+.TH pkg::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
+pkg::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? ...
+\fB::pkg::create \fI\-name packageName\fR \fI\-version packageVersion\fR ?\fI\-load filespec\fR? ... ?\fI\-source filespec\fR? ...
+.BE
.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.
+\fB::pkg::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\fR mechanism.
.SH OPTIONS
The parameters supported are:
@@ -39,19 +36,17 @@ 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
+list of procedures is empty or omitted, \fB::pkg::create\fR will
set up the library for direct loading (see \fBpkg_mkIndex\fR). Any
-number of \fB-load\fR parameters may be specified.
+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
+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
+\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.
-
-
+At least one \fB\-load\fR or \fB\-source\fR paramter must be given.
.SH KEYWORDS
auto-load, index, package, version