2 '\" Copyright (c
) 1998-2000 by Scriptics Corporation
.
3 '\" All rights reserved.
5 '\" RCS: @(#) $Id: packagens.n,v 1.1 2003/12/20 03:31:54 bbbush Exp $
7 '\" The definitions below are for supplemental macros used in Tcl/Tk
10 '\" .AP
type name
in/out ?indent?
11 '\" Start paragraph describing an argument to a library procedure.
12 '\" type is
type of
argument (int, etc
.), in/out is either
"in", "out",
13 '\" or "in/out" to describe whether procedure reads or modifies arg,
14 '\" and indent is equivalent to second arg of
.IP (shouldn
't ever be
15 '\" needed
; use
.AS below instead
)
18 '\" Give maximum sizes of arguments for setting tab stops. Type and
19 '\" name are examples of largest possible arguments that will be passed
20 '\" to .AP later. If args are omitted, default tab stops are used.
23 '\" Start box enclosure
. From here until next
.BE
, everything will be
24 '\" enclosed in one large box.
27 '\" End of box enclosure
.
30 '\" Begin code excerpt.
35 '\" .VS ?version? ?br?
36 '\" Begin vertical sidebar, for use in marking newly-changed parts
37 '\" of man pages
. The first argument is ignored
and used
for recording
38 '\" the version when the .VS was added, so that the sidebars can be
39 '\" found
and removed
when they reach a certain age
. If another argument
40 '\" is present, then a line break is forced before starting the sidebar.
43 '\" End of vertical sidebar
.
46 '\" Begin an indented unfilled display.
49 '\" End of indented unfilled display
.
52 '\" Start of list of standard options for a Tk widget. The
53 '\" options follow on successive lines
, in four columns separated
57 '\" End of
list of standard options
for a Tk widget
.
59 '\" .OP cmdName dbName dbClass
60 '\" Start of description of a specific option. cmdName gives the
61 '\" option
's name as specified in the class command, dbName gives
62 '\" the option
's name in the option database, and dbClass gives
63 '\" the option
's class in the option database.
66 '\" Print arg1 underlined
, then print arg2 normally
.
68 '\" RCS
: @
(#) $Id: packagens.n,v 1.1 2003/12/20 03:31:54 bbbush Exp $
70 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
74 '\" # Start an argument description
78 . ie !"\\$2"" .TP \\n()Cu
83 \&\\$1 \\fI\\$2\\fP (\\$3)
96 '\" # define tabbing values for .AP
99 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
102 .if !"\\$2
"" .nr
)B
\\w
'\\$2'u
+\\n()Au
+3n
103 .nr
)C
\\n()Bu
+\\w
'(in/out)'u
+2n
105 .AS Tcl_Interp Tcl_CreateInterp
in/out
106 '\" # BS - start boxed text
107 '\" # ^y = starting y location
115 .if n \l'\\n(.lu\
(ul
'
118 '\" # BE - end boxed text (draw box now)
123 .ie n \l
'\\n(^lu\(ul'
125 .\" Draw four
-sided box normally
, but don
't draw top of
126 .\" box if the box started on an earlier page.
128 \h'-1.5n
'\L'|\\n(^yu
-1v
'\l'\\n(^lu
+3n\
(ul
'\L'\\n(^tu
+1v
-\\n(^yu
'\l'|0u-1.5n\
(ul
'
131 \h'-1.5n
'\L'|\\n(^yu
-1v
'\h'\\n(^lu
+3n
'\L'\\n(^tu
+1v
-\\n(^yu
'\l'|0u-1.5n\
(ul
'
138 '\" # VS - start vertical sidebar
139 '\" # ^Y = starting y location
140 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
144 .ie n 'mc \s12\(br\s0
147 '\" # VE - end of vertical sidebar
155 \h
'|\\n(^lu+3n'\L
'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h
'-|\\n(^lu+3n'
162 '\" # Special macro to handle page bottom: finish off current
163 '\" # box/sidebar if in box/sidebar mode, then invoked standard
164 '\" # page bottom macro.
171 .\" Draw three-sided box if this is the box's first page
,
172 .\" draw two sides but no top otherwise
.
173 .ie
!\\n(^b
-1 \h
'-1.5n'\L
'|\\n(^yu-1v'\l
'\\n(^lu+3n\(ul'\L
'\\n(^tu+1v-\\n(^yu'\h
'|0u'\c
174 .el \h
'-1.5n'\L
'|\\n(^yu-1v'\h
'\\n(^lu+3n'\L
'\\n(^tu+1v-\\n(^yu'\h
'|0u'\c
177 .nr ^x
\\n(^tu
+1v
-\\n(^Yu
178 \kx\h
'-\\nxu'\h
'|\\n(^lu+3n'\ky\L
'-\\n(^xu'\v'\\n(^xu'\h
'|0u'\c
191 '\" # DS - begin display
197 '\" # DE - end display
203 '\" # SO - start of list of standard options
205 .SH
"STANDARD OPTIONS"
211 '\" # SE - end of list of standard options
216 See the \\fBoptions\\fR manual entry for details on the standard options.
218 '\" # OP - start of full description for a single option
223 Command
-Line Name
: \\fB
\\$1
\\fR
224 Database Name
: \\fB
\\$2
\\fR
225 Database Class
: \\fB
\\$3
\\fR
229 '\" # CS - begin code excerpt
235 '\" # CE - end code excerpt
243 .TH pkg
::create n
8.3 Tcl
"Tcl Built-In Commands"
245 '\" Note: do not modify the .SH NAME line immediately below!
247 pkg::create \- Construct an appropriate \fBpackage ifneeded\fR
248 command for a given package specification
250 \fB::pkg::create \fI\-name packageName\fR \fI\-version packageVersion\fR ?\fI\-load filespec\fR? ... ?\fI\-source filespec\fR? ...
255 \fB::pkg::create\fR is a utility procedure that is part of the standard Tcl
256 library. It is used to create an appropriate \fBpackage ifneeded\fR
257 command for a given package specification. It can be used to construct a
258 \fBpkgIndex.tcl\fR file for use with the \fBpackage\fR mechanism.
261 The parameters supported are:
263 \fB\-name\fR\0\fIpackageName\fR
264 This parameter specifies the name of the package. It is required.
266 \fB\-version\fR\0\fIpackageVersion\fR
267 This parameter specifies the version of the package. It is required.
269 \fB\-load\fR\0\fIfilespec\fR
270 This parameter specifies a binary library that must be loaded with the
271 \fBload\fR command. \fIfilespec\fR is a list with two elements. The
272 first element is the name of the file to load. The second, optional
273 element is a list of commands supplied by loading that file. If the
274 list of procedures is empty or omitted, \fB::pkg::create\fR will
275 set up the library for direct loading (see \fBpkg_mkIndex\fR). Any
276 number of \fB\-load\fR parameters may be specified.
278 \fB\-source\fR\0\fIfilespec\fR
279 This parameter is similar to the \fB\-load\fR parameter, except that it
280 specifies a Tcl library that must be loaded with the
281 \fBsource\fR command. Any number of \fB\-source\fR parameters may be
284 At least one \fB\-load\fR or \fB\-source\fR paramter must be given.
290 auto-load, index, package, version