1
2
3
4
5
6
7
8
|
1
2
3
4
5
6
7
8
|
-
+
|
<div class="fossil-doc" data-title="Package Client Toolset API v1"><br>
<big><big><span style="font-family: monospace;">Generated [2024-06-03 @ 04:22:59 UTC] from checkout [17012cff1e01097762dddc6b7222a639a76e82d8 2024-03-25 05:13:08 UTC]</span></big></big><br><br><hr><br>
<big><big><span style="font-family: monospace;">Generated [2024-06-14 @ 21:57:18 UTC] from checkout [96fc9afa4e9742bef71ef5d6070f1d6736948fc9 2024-06-03 04:37:38 UTC]</span></big></big><br><br><hr><br>
<big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl&ln=272">::Eagle::Tools::Common::getFileViaHttp</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
|
| ︙ | | |
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
-
+
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1386">::PackageDownloader::resetCookieAndLoginSimple</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1411">::PackageDownloader::resetCookieAndLoginSimple</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1436">::PackageDownloader::resetCookieAndLogin</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1461">::PackageDownloader::resetCookieAndLogin</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "userName"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "password"</span></big><br>
|
| ︙ | | |
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
-
+
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1489">::PackageDownloader::logoutAndResetCookie</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1514">::PackageDownloader::logoutAndResetCookie</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1722">::PackageDownloader::checkForHigherVersion</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1747">::PackageDownloader::checkForHigherVersion</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "language"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "version"</span></big><br>
|
| ︙ | | |
195
196
197
198
199
200
201
202
203
204
205
|
195
196
197
198
199
200
201
202
203
204
205
|
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=2030">::PackageDownloader::downloadFiles</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=2055">::PackageDownloader::downloadFiles</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "language"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "version"</span></big><br>
|
| ︙ | | |
233
234
235
236
237
238
239
240
241
242
243
|
233
234
235
236
237
238
239
240
241
242
243
|
-
+
|
persistent directories containing the downloaded files. The<br>
-allowUpdate option should be non-zero to allow existing package<br>
files to be overwritten.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=2256">::PackageDownloader::maybeAddTemporaryPackagesToAutoPath</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=2281">::PackageDownloader::maybeAddTemporaryPackagesToAutoPath</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "language"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "options"</span></big><br>
|
| ︙ | | |
359
360
361
362
363
364
365
366
367
368
369
|
359
360
361
362
363
364
365
366
367
368
369
|
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1413">::PackageDownloader::maybeResetCookieAndLoginSimple</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Internal API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1438">::PackageDownloader::maybeResetCookieAndLoginSimple</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</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>
|
| ︙ | | |
585
586
587
588
589
590
591
592
593
594
595
|
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
|
+
+
+
+
+
+
+
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1295">::PackageDownloader::haveValidLoginCookie</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<blockquote style="font-family: monospace;"><br>
This procedure checks the current login cookie to make sure that<br>
it exists -AND- conforms to the correct format.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1300">::PackageDownloader::getPackageFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1325">::PackageDownloader::getPackageFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "uri"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "allowHtml" with default value "false"</span></big><br>
|
| ︙ | | |
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
|
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
|
-
+
-
+
-
+
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1373">::PackageDownloader::getDownloadVarNamePrefix</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1398">::PackageDownloader::getDownloadVarNamePrefix</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1543">::PackageDownloader::getUniqueTempDirectory</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1568">::PackageDownloader::getUniqueTempDirectory</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Optional argument "prefix" with default value ""</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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1573">::PackageDownloader::createInterp</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1598">::PackageDownloader::createInterp</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "varName"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This procedure creates a new interpreter, which may be "safe", 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1650">::PackageDownloader::getIfNeededVersions</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1675">::PackageDownloader::getIfNeededVersions</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "interp"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "fileName"</span></big><br>
|
| ︙ | | |
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
|
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
|
-
+
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1673">::PackageDownloader::extractVersionsFromFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1698">::PackageDownloader::extractVersionsFromFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "fileName"</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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1785">::PackageDownloader::guessPackageNameFromFileNames</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1810">::PackageDownloader::guessPackageNameFromFileNames</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "language"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br>
|
| ︙ | | |
681
682
683
684
685
686
687
688
689
690
691
|
688
689
690
691
692
693
694
695
696
697
698
|
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1819">::PackageDownloader::downloadAllPlatforms</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1844">::PackageDownloader::downloadAllPlatforms</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "language"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "version"</span></big><br>
|
| ︙ | | |
709
710
711
712
713
714
715
716
717
718
719
|
716
717
718
719
720
721
722
723
724
725
726
|
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1923">::PackageDownloader::downloadOneUriToFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1948">::PackageDownloader::downloadOneUriToFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "localFileName"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "uri"</span></big><br>
|
| ︙ | | |
729
730
731
732
733
734
735
736
737
738
739
|
736
737
738
739
740
741
742
743
744
745
746
|
-
+
|
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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1964">::PackageDownloader::downloadOneFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1989">::PackageDownloader::downloadOneFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "language"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "version"</span></big><br>
|
| ︙ | | |