Check-in [eee7ac9ae9]
Not logged in
Overview
Comment:Update generated documentation.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: eee7ac9ae9a97fa6decc58e67429867d644edb2a
User & Date: mistachkin on 2020-10-28 04:00:59
Other Links: manifest | tags
Context
2020-11-11
05:38
Pickup Harpy tooling changes from upstream into externals. check-in: 708aefc02a user: mistachkin tags: trunk
2020-10-28
04:00
Update generated documentation. check-in: eee7ac9ae9 user: mistachkin tags: trunk
03:56
Update list of supported native Tcl versions. check-in: 3dfd1392a1 user: mistachkin tags: trunk
Changes

Modified doc/v1.html from [b9dbe9d297] to [5df56b91d8].

1
2
3
4
5
6
7
8
9
10
<div class="fossil-doc" data-title="Package Client Toolset API v1"><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=227">::Eagle::Tools::Common::getFileViaHttp</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;uri&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;redirectLimit&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;channel&quot;</span></big><br>


|







1
2
3
4
5
6
7
8
9
10
<div class="fossil-doc" data-title="Package Client Toolset API v1"><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=237">::Eagle::Tools::Common::getFileViaHttp</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;uri&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;redirectLimit&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;channel&quot;</span></big><br>
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
This procedure was stolen from the &quot;common.tcl&quot; script.  This<br>
procedure sets up the default values for all HTTP configuration<br>
parameters used by this package.  If the force argument is<br>
non-zero, any existing values will be overwritten and set back<br>
to their default values.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=163">::Eagle::Tools::Common::pageOut</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;channel&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;string&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure was stolen from the &quot;common.tcl&quot; script.  It is<br>
designed to emit a message to the console.  The channel argument<br>
is the channel where the message should be written.  The string<br>
argument is the content of the message to emit.  If the channel<br>
argument is an empty string, nothing is written.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=177">::Eagle::Tools::Common::pageLog</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;string&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure was stolen from the &quot;common.tcl&quot; script.  It is<br>
designed to emit a message to the HTTP client log.  The string<br>
argument is the content of the message to emit.  If the string<br>
argument is an empty string, nothing is written.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=196">::Eagle::Tools::Common::pageProgress</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;channel&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;type&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;milliseconds&quot;</span></big><br>







|














|











|







29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
This procedure was stolen from the &quot;common.tcl&quot; script.  This<br>
procedure sets up the default values for all HTTP configuration<br>
parameters used by this package.  If the force argument is<br>
non-zero, any existing values will be overwritten and set back<br>
to their default values.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=173">::Eagle::Tools::Common::pageOut</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;channel&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;string&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure was stolen from the &quot;common.tcl&quot; script.  It is<br>
designed to emit a message to the console.  The channel argument<br>
is the channel where the message should be written.  The string<br>
argument is the content of the message to emit.  If the channel<br>
argument is an empty string, nothing is written.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=187">::Eagle::Tools::Common::pageLog</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;string&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure was stolen from the &quot;common.tcl&quot; script.  It is<br>
designed to emit a message to the HTTP client log.  The string<br>
argument is the content of the message to emit.  If the string<br>
argument is an empty string, nothing is written.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=206">::Eagle::Tools::Common::pageProgress</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;channel&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;type&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;milliseconds&quot;</span></big><br>
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

<blockquote style="font-family: monospace;"><br>
This procedure modifies the version variables used by the package<br>
downloader client so that a specific version will be used.  The<br>
versionId argument must consist only of hexadecimal characters.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1354">::PackageDownloader::resetCookieAndLoginSimple</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure resets the currently configured login cookie, if<br>
any, and then attempts to login using the configured package<br>
repository server API key -OR- using the public access account.<br>
Upon success, it will set the login cookie to the one from the<br>
raw response data.  Upon failure, a script error will be raised.<br>
There are no arguments.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1404">::PackageDownloader::resetCookieAndLogin</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;userName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;password&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure resets the currently configured login cookie, if<br>
any, and then attempts to login using the specified user name and<br>
password.  Upon success, it will set the login cookie to the one<br>
from the raw response data.  Upon failure, a script error will be<br>
raised.  The userName argument must be the name of a package file<br>
server user with at least Fossil Check-Out (o) permissions on the<br>
package file server.  The password argument must be the plaintext<br>
password that is associated with the specified user name.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1457">::PackageDownloader::logoutAndResetCookie</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure attempts to logout using the currently configured<br>
login cookie, if any, and then resets the login cookie.  There<br>
are no arguments.  This procedure may raise a script error.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1690">::PackageDownloader::checkForHigherVersion</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;platform&quot;</span></big><br>







|










|

















|







|







100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

<blockquote style="font-family: monospace;"><br>
This procedure modifies the version variables used by the package<br>
downloader client so that a specific version will be used.  The<br>
versionId argument must consist only of hexadecimal characters.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1355">::PackageDownloader::resetCookieAndLoginSimple</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure resets the currently configured login cookie, if<br>
any, and then attempts to login using the configured package<br>
repository server API key -OR- using the public access account.<br>
Upon success, it will set the login cookie to the one from the<br>
raw response data.  Upon failure, a script error will be raised.<br>
There are no arguments.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1405">::PackageDownloader::resetCookieAndLogin</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;userName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;password&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure resets the currently configured login cookie, if<br>
any, and then attempts to login using the specified user name and<br>
password.  Upon success, it will set the login cookie to the one<br>
from the raw response data.  Upon failure, a script error will be<br>
raised.  The userName argument must be the name of a package file<br>
server user with at least Fossil Check-Out (o) permissions on the<br>
package file server.  The password argument must be the plaintext<br>
password that is associated with the specified user name.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1458">::PackageDownloader::logoutAndResetCookie</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure attempts to logout using the currently configured<br>
login cookie, if any, and then resets the login cookie.  There<br>
are no arguments.  This procedure may raise a script error.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1691">::PackageDownloader::checkForHigherVersion</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;platform&quot;</span></big><br>
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
not require a specific platform.  The packageName argument is a<br>
directory name relative to the language and version-specific<br>
directory on the package file server and may be an empty string.<br>
The usePgp argument should be non-zero when an OpenPGP signature<br>
file needs to be downloaded and verified for the downloaded file.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=2005">::PackageDownloader::downloadFiles</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;platform&quot;</span></big><br>







|







167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
not require a specific platform.  The packageName argument is a<br>
directory name relative to the language and version-specific<br>
directory on the package file server and may be an empty string.<br>
The usePgp argument should be non-zero when an OpenPGP signature<br>
file needs to be downloaded and verified for the downloaded file.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=2006">::PackageDownloader::downloadFiles</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;platform&quot;</span></big><br>
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure verifies the combination of language and version<br>
specified by the caller.  The language argument must be one of the<br>
literal strings &quot;eagle&quot;, &quot;tcl&quot;, or &quot;client&quot;.  The version argument<br>
must be one of the literal strings &quot;8.4&quot;, &quot;8.5&quot;, or &quot;8.6&quot; when the<br>
language is &quot;tcl&quot; -OR- the literal string &quot;1.0&quot; when the language<br>
is &quot;eagle&quot;.  When the language is &quot;client&quot;, the version match the<br>
major and minor portions of &quot;1.0&quot; and any remaining portions must<br>
be numeric.  The varName argument is the name of a scalar variable<br>
in the context of the immediate caller that will receive a boolean<br>
value indicating if the specified language is actually a reference<br>
to the package downloader client itself.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1037">::PackageDownloader::getPlatform</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure returns the name of the current platform.  There are<br>
no arguments.  An empty string will be returned if the name of the<br>
current platform cannot be determined for any reason.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1118">::PackageDownloader::verifyVersionId</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;versionId&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure verifies that the specified value is indeed a valid<br>
version identifier.  The versionId argument is the value to verify.<br>
This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1137">::PackageDownloader::verifyPlatform</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;platform&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure verifies the platform specified by the caller.  The<br>
platform argument must be an empty string -OR- one of the literal<br>
strings &quot;msil&quot; or &quot;neutral&quot;, or one of the values returned by the<br>
[getPlatform] procedure.  An empty string means that the associated<br>
entity does not require a specific platform.  The varName argument<br>
is the name of a variable in the context of the immediate caller<br>
that will receive a modified platform name, if applicable.  Upon<br>
failure, a script error will be raised.  The return value is<br>
undefined.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1381">::PackageDownloader::maybeResetCookieAndLoginSimple</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure attempts to login using the configured package<br>
repository server API key -OR- using the public access account,<br>
if not already logged in.  Upon success, it will set the login<br>
cookie to the one from the raw response data.  Upon failure, a<br>
script error will be raised.  There are no arguments.<br>







|
|
|
|
|
|
|
|


|







|










|


















|







254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure verifies the combination of language and version<br>
specified by the caller.  The language argument must be one of the<br>
literal strings &quot;eagle&quot;, &quot;tcl&quot;, or &quot;client&quot;.  The version argument<br>
must be one of the literal strings &quot;8.4&quot;, &quot;8.5&quot;, &quot;8.6&quot;, or &quot;8.7&quot;<br>
when the language is &quot;tcl&quot; -OR- the literal string &quot;1.0&quot; when the<br>
language is &quot;eagle&quot;.  When the language is &quot;client&quot;, the version<br>
match the major and minor portions of &quot;1.0&quot; and any remaining<br>
portions must be numeric.  The varName argument is the name of a<br>
scalar variable in the context of the immediate caller that will<br>
receive a boolean value indicating if the specified language is<br>
actually a reference to the package downloader client itself.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1038">::PackageDownloader::getPlatform</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure returns the name of the current platform.  There are<br>
no arguments.  An empty string will be returned if the name of the<br>
current platform cannot be determined for any reason.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1119">::PackageDownloader::verifyVersionId</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;versionId&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure verifies that the specified value is indeed a valid<br>
version identifier.  The versionId argument is the value to verify.<br>
This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1138">::PackageDownloader::verifyPlatform</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;platform&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure verifies the platform specified by the caller.  The<br>
platform argument must be an empty string -OR- one of the literal<br>
strings &quot;msil&quot; or &quot;neutral&quot;, or one of the values returned by the<br>
[getPlatform] procedure.  An empty string means that the associated<br>
entity does not require a specific platform.  The varName argument<br>
is the name of a variable in the context of the immediate caller<br>
that will receive a modified platform name, if applicable.  Upon<br>
failure, a script error will be raised.  The return value is<br>
undefined.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1382">::PackageDownloader::maybeResetCookieAndLoginSimple</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure attempts to login using the configured package<br>
repository server API key -OR- using the public access account,<br>
if not already logged in.  Upon success, it will set the login<br>
cookie to the one from the raw response data.  Upon failure, a<br>
script error will be raised.  There are no arguments.<br>
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
This procedure attempts to verify that some runtime is available to<br>
run CLR applications locally (e.g. the .NET Framework or Mono JIT).<br>
There are no arguments.  The return value is non-zero if it appears<br>
that CLR applications should be runnable locally; otherwise, the<br>
return value is zero.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1271">::PackageDownloader::getPackageFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;uri&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;allowHtml&quot; with default value &quot;false&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure issues a request to an HTTP(S) server.  It returns<br>
the raw response data verbatim.  It may raise a script error.  It<br>
will always use the currently configured HTTP(S) login cookie, if<br>
any; therefore, it should really only be used for requests to the<br>
package file server.  The uri argument is the fully qualified URI<br>
to request.  The allowHtml argument should be non-zero if raw HTML<br>
should be allowed in the response data.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1341">::PackageDownloader::getDownloadVarNamePrefix</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure returns the prefix for fully qualified variable<br>
names that MAY be present in the global namespace.  There are<br>
no arguments.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1511">::PackageDownloader::getUniqueTempDirectory</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;prefix&quot; with default value &quot;&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure returns a unique temporary directory where one or<br>
more files may be saved.  The prefix argument is a prefix for the<br>
directory name and it may be an empty string.  There is no attempt<br>
to actually create the resulting directory.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1541">::PackageDownloader::createInterp</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure creates a new interpreter, which may be &quot;safe&quot;, and<br>
places a reference to it in a variable in the context of the caller<br>
identified by the varName argument.  The created interpreter has a<br>
fully functioning [package] command ensemble; all other commands do<br>
nothing and return nothing.  This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1618">::PackageDownloader::getIfNeededVersions</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;interp&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure evaluates a script file and attempts to determine the<br>
list of new [package ifneeded] scripts added by it.  When successful<br>
it returns a list-of-lists.  Each element of the outer list contains<br>
a package name and the list of its versions in descending order; in<br>
the event of failure, empty lists may be returned for the outer list<br>
or for a list of versions.  The interp argument is the interp to use<br>
when evaluating the file specified by the fileName argument.  This<br>
procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1641">::PackageDownloader::extractVersionsFromFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure attempts to extract a package version information<br>
from the specified file.  The fileName argument is the local file<br>
name to read.  This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1753">::PackageDownloader::guessPackageNameFromFileNames</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileNames&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure attempts to guess a package name based on a list of<br>
its files.  It relies upon the fact that all packages must include<br>
a package index file.  The language argument must be one of the<br>
literal strings &quot;eagle&quot;, &quot;tcl&quot;, or &quot;client&quot;.  The fileNames argument<br>
must be the list of file names to be downloaded.  The package name,<br>
if one can be detected, is returned; otherwise, an empty string will<br>
be returned.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1787">::PackageDownloader::downloadAllPlatforms</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;packageName&quot;</span></big><br>







|
















|







|











|












|

















|










|
















|







514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
This procedure attempts to verify that some runtime is available to<br>
run CLR applications locally (e.g. the .NET Framework or Mono JIT).<br>
There are no arguments.  The return value is non-zero if it appears<br>
that CLR applications should be runnable locally; otherwise, the<br>
return value is zero.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1272">::PackageDownloader::getPackageFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;uri&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;allowHtml&quot; with default value &quot;false&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure issues a request to an HTTP(S) server.  It returns<br>
the raw response data verbatim.  It may raise a script error.  It<br>
will always use the currently configured HTTP(S) login cookie, if<br>
any; therefore, it should really only be used for requests to the<br>
package file server.  The uri argument is the fully qualified URI<br>
to request.  The allowHtml argument should be non-zero if raw HTML<br>
should be allowed in the response data.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1342">::PackageDownloader::getDownloadVarNamePrefix</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure returns the prefix for fully qualified variable<br>
names that MAY be present in the global namespace.  There are<br>
no arguments.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1512">::PackageDownloader::getUniqueTempDirectory</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;prefix&quot; with default value &quot;&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure returns a unique temporary directory where one or<br>
more files may be saved.  The prefix argument is a prefix for the<br>
directory name and it may be an empty string.  There is no attempt<br>
to actually create the resulting directory.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1542">::PackageDownloader::createInterp</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure creates a new interpreter, which may be &quot;safe&quot;, and<br>
places a reference to it in a variable in the context of the caller<br>
identified by the varName argument.  The created interpreter has a<br>
fully functioning [package] command ensemble; all other commands do<br>
nothing and return nothing.  This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1619">::PackageDownloader::getIfNeededVersions</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;interp&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure evaluates a script file and attempts to determine the<br>
list of new [package ifneeded] scripts added by it.  When successful<br>
it returns a list-of-lists.  Each element of the outer list contains<br>
a package name and the list of its versions in descending order; in<br>
the event of failure, empty lists may be returned for the outer list<br>
or for a list of versions.  The interp argument is the interp to use<br>
when evaluating the file specified by the fileName argument.  This<br>
procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1642">::PackageDownloader::extractVersionsFromFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure attempts to extract a package version information<br>
from the specified file.  The fileName argument is the local file<br>
name to read.  This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1754">::PackageDownloader::guessPackageNameFromFileNames</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileNames&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure attempts to guess a package name based on a list of<br>
its files.  It relies upon the fact that all packages must include<br>
a package index file.  The language argument must be one of the<br>
literal strings &quot;eagle&quot;, &quot;tcl&quot;, or &quot;client&quot;.  The fileNames argument<br>
must be the list of file names to be downloaded.  The package name,<br>
if one can be detected, is returned; otherwise, an empty string will<br>
be returned.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1788">::PackageDownloader::downloadAllPlatforms</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;packageName&quot;</span></big><br>
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
is a directory name relative to the language and version-specific<br>
directory on the package file server and may be an empty string.<br>
The fileNames argument is the list of file names to be downloaded.<br>
The usePgp argument should be non-zero when an OpenPGP signature<br>
needs to be verified for the downloaded file.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1891">::PackageDownloader::downloadOneUriToFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;localFileName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;uri&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;usePgp&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;forcePgp&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure downloads a single URI from the package file server<br>
and writes the result to a local file.  The localFileName argument<br>
is the file name where the downloaded file should be written.  The<br>
The uri argument is the URI to download.  The usePgp argument should<br>
be non-zero when the OpenPGP signature file needs to be verified for<br>
the downloaded file.  The return value is undefined.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1939">::PackageDownloader::downloadOneFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;platform&quot;</span></big><br>







|



















|







638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
is a directory name relative to the language and version-specific<br>
directory on the package file server and may be an empty string.<br>
The fileNames argument is the list of file names to be downloaded.<br>
The usePgp argument should be non-zero when an OpenPGP signature<br>
needs to be verified for the downloaded file.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1892">::PackageDownloader::downloadOneUriToFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;localFileName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;uri&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;usePgp&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;forcePgp&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure downloads a single URI from the package file server<br>
and writes the result to a local file.  The localFileName argument<br>
is the file name where the downloaded file should be written.  The<br>
The uri argument is the URI to download.  The usePgp argument should<br>
be non-zero when the OpenPGP signature file needs to be verified for<br>
the downloaded file.  The return value is undefined.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle&amp;ln=1940">::PackageDownloader::downloadOneFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;platform&quot;</span></big><br>
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
This procedure creates and returns a script block designed for use<br>
with the package repository server in order to download and provide<br>
a package consisting of a set of files.  The serverId argument is<br>
the identifier for the specific server to use, if any.  The<br>
versionId argument is the identifier for the specific version to use,<br>
if any.  The language argument must be the literal string &quot;eagle&quot; or<br>
the literal string &quot;tcl&quot;.  The version argument must be one of the<br>
literal strings &quot;8.4&quot;, &quot;8.5&quot;, or &quot;8.6&quot; when the language is &quot;tcl&quot;<br>
-OR- the literal string &quot;1.0&quot; when the language is &quot;eagle&quot;.  The<br>
platform argument must be an empty string -OR- one of the literal<br>
strings &quot;neutral&quot;, &quot;win32-arm&quot;, &quot;win32-x86&quot;, &quot;win64-arm64&quot;,<br>
&quot;win64-ia64&quot;, or &quot;win64-x64&quot;.  The fileNames argument is the list of<br>
(fully?) qualified file names to be downloaded when the associated<br>
package is being provided.  The options argument is reserved for<br>
future use, it should be an empty list.<br>
</blockquote><br><hr><br>








|
|
|







1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
This procedure creates and returns a script block designed for use<br>
with the package repository server in order to download and provide<br>
a package consisting of a set of files.  The serverId argument is<br>
the identifier for the specific server to use, if any.  The<br>
versionId argument is the identifier for the specific version to use,<br>
if any.  The language argument must be the literal string &quot;eagle&quot; or<br>
the literal string &quot;tcl&quot;.  The version argument must be one of the<br>
literal strings &quot;8.4&quot;, &quot;8.5&quot;, &quot;8.6&quot;, or &quot;8.7&quot; when the language is<br>
&quot;tcl&quot; -OR- the literal string &quot;1.0&quot; when the language is &quot;eagle&quot;.<br>
The platform argument must be an empty string -OR- one of the literal<br>
strings &quot;neutral&quot;, &quot;win32-arm&quot;, &quot;win32-x86&quot;, &quot;win64-arm64&quot;,<br>
&quot;win64-ia64&quot;, or &quot;win64-x64&quot;.  The fileNames argument is the list of<br>
(fully?) qualified file names to be downloaded when the associated<br>
package is being provided.  The options argument is reserved for<br>
future use, it should be an empty list.<br>
</blockquote><br><hr><br>

Modified doc/v1.html.asc from [394919c8af] to [62a31b7242].

1

2
3
4
5
6
7
8
9
10
11
12
13
14
15

16
17
-----BEGIN PGP SIGNATURE-----

Comment: Eagle Package Repository

iQIzBAABCAAdFiEEw8dROIPu3TrtH+QlUCyWr0ldwtkFAl7tQJkACgkQUCyWr0ld
wtlrTg//f/Flu7RZIXBSInkBTGHTDaDFB3ft8y2Mf0tIHYHqaVRK9kmufKdvd1+V
Bb4FsMTs7tW2bmL0msPK3+NEqs1pIJJdS9xE4zbqVLrNhJ88Wvz/PhLzV+qVtO+r
x7sIkjy4ayvCZxLVET5kLWxKuBcFcw/A9vATg0ZtX9qM6EnDGkkSsMo4lJRaBDN+
QWbzagOh+E1GMrVAqr7Cnbc6dZ1jjp5ISLG4UQOTio0QBlIUmQlfvzOivsCo9twR
FHxjbDaAmu0eXpFwDktrJtOx1u9ZXyrd9WE3rhTLN6rasyoAdt5iSSgXBXP4XEHe
FLpKJPGqYCIvpEyP3TZKs5+/0tteODaxE6FggMoiT5vkGA0NDwJFopdMzl8ji3D/
29FvEqosTfU5WTO03xvwSLclj4K/wiOi5dozSlBP89lPtj2IOOgoBtsopby0dyB1
2cVC9SWPj9ox9tqWFinKTQn6D4pmUtTNftUEk07kiz52tYlNQHt16fNjxU31uVP5
PYPWktc/mBS7liKvYmuvIx2iVNphnvqQlQtYLTa7FWKkegTENleny483Cwb5Im6q
iODSxLHNBcPqcRt4mWw2D1XqLBZGN5RUL8MLRXBaq1Otc8Qssn9U5SYpwscR/lJR
NgkmGBLBdXgIes7E7ywuWgztChJ8Qg6bVmLrNeNDN4tyWzWM27s=

=IsAT
-----END PGP SIGNATURE-----

>


|
<
|
|
|
|
|
|
|
|
|
|
>
|

1
2
3
4
5

6
7
8
9
10
11
12
13
14
15
16
17
18
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
Comment: Eagle Package Repository

iQIcBAABCAAGBQJfmOzsAAoJEFAslq9JXcLZujoP/3cq6nPkU+eZ3xL78ps7fAoW

o2JvPup1CQSsYRbu+VubyQee0vt2JJeS8NCzzSI+15L0bPMXypApZ/iHfiyibTv8
ldCOZy+DiKE6ndFHLabv+vAcqTXsoEzRoP89Z16XW2nVo1xt8H72jLLPyPPyC6Yr
aB9xv4pUQJDw9z8tLxz0qKqOmN+X5D3CFgC52jGrdsj32+6b3vIW2KFzo7IibTLG
RpLwMe7FyZKb9rOa94bBp6SLDR2vmqqtBLrRFDmpR6vYkiPUIiJhGM9GX1r9sH1S
EkgM3cOHywnPOZCIKwFqAFrZ99nskhs7gSXAso6gz+6t0uAKpdHndkVM6cFVs7GK
fiU59/USUsJQaOq9aPm//O2wkTgWU2OYmb/tb0t57fK4Nn7W7YwPM2I6YENlZaQv
YmjCQFc4UcvzVUonnZS6nB7VwLcALBbZQrjyTeFGvHfba8IMF9eS9Zs0fh5IGfnj
nrG5rihkYn7Kzpczv0o2iM08sFzUQfHhJ8BC8jR7Hbo4PH92ViCgoAaSBMhQi243
z4/Pzbq26HN21Niz6yd1/Eww+VySaYPmZfhwXQXcciw2be3eX4ovz6FTuyuG75LW
qjJSJW2gFfhXJhc5gwMNxgzgWOqaXQDZc0EoFWGDN2+Px1ypnmLuY1vJLewihrfa
mw0jxeFhgDjyXsieDWLC
=YEcJ
-----END PGP SIGNATURE-----