Overview
Comment: | Update generated documentation. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | vNext |
Files: | files | file ages | folders |
SHA1: |
029c9867a50472aecb9bb79fee4204b0 |
User & Date: | test on 2022-02-20 16:44:34 |
Other Links: | branch diff | manifest | tags |
Context
2022-02-20
| ||
16:47 | Minor default value fix. check-in: 1936fa886c user: test tags: vNext | |
16:44 | Update generated documentation. check-in: 029c9867a5 user: test tags: vNext | |
16:34 | Fix some comments. check-in: 19cfb58c4c user: test tags: vNext | |
Changes
Modified doc/v1.html from [5df56b91d8] to [fb41fa3dd0].
︙ | ︙ | |||
100 101 102 103 104 105 106 | <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> | | | | | | 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1383">::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=1433">::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> <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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1486">::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=1719">::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> <big><span style="font-family: monospace;"> Required argument "platform"</span></big><br> |
︙ | ︙ | |||
167 168 169 170 171 172 173 | 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> | | | 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=2027">::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> <big><span style="font-family: monospace;"> Required argument "platform"</span></big><br> |
︙ | ︙ | |||
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | when an OpenPGP signature file needs to be downloaded and verified<br> for each downloaded file. The -useAutoPath option should be<br> non-zero to modify the auto-path to include the temporary or<br> 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;">Internal API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=600">::PackageDownloader::downloadAndSaveOpenPgpKeyFile</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 download the Package Signing Keys from<br> the remote server and save it to a local file. This procedure may<br> raise script errors. The fileName argument is the name of the file<br> where the downloaded data should be written. This procedure is only<br> intended to be used from the "pkgr_setup.eagle" tool script and may<br> go away in later versions of this package.<br> </blockquote><br><hr><br> | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | | | 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 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 | when an OpenPGP signature file needs to be downloaded and verified<br> for each downloaded file. The -useAutoPath option should be<br> non-zero to modify the auto-path to include the temporary or<br> 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=2253">::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> <big><span style="font-family: monospace;"> Optional argument "pattern" with default value "*"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure adds temporary package directories to the auto-path<br> of the specified language (i.e. native Tcl or Eagle). Directories<br> will not be added if already present. The language argument must<br> be the literal string "eagle" or the literal string "tcl". The<br> pattern argument is the optional pattern to match against each of<br> the candidate temporary package directories. If the pattern is an<br> empty string then all candidate temporary package directories will<br> be added to the auto-path; otherwise, the pattern will be matched<br> against the final portion of the temporary package directory name<br> and only those temporary package directories that actually match<br> the pattern will be added to the auto-path. The options argument<br> must be a dictionary of name/value pairs. This procedure does not<br> currently support any options. This procedure may raise script<br> errors. This procedure assumes the local temporary directory is<br> writable only by applications that are implicitly trusted by the<br> current user. If this assumption does not hold on your platform,<br> DO NOT USE THIS PROCEDURE AS IT MAY BE UNSAFE.<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=600">::PackageDownloader::downloadAndSaveOpenPgpKeyFile</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 download the Package Signing Keys from<br> the remote server and save it to a local file. This procedure may<br> raise script errors. The fileName argument is the name of the file<br> where the downloaded data should be written. This procedure is only<br> intended to be used from the "pkgr_setup.eagle" tool script and may<br> go away in later versions of this package.<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=999">::PackageDownloader::verifyPackageName</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 "packageName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure verifies that the specified value is indeed a valid<br> package name. The packageName 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1012">::PackageDownloader::verifyPackagePatchLevel</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 "patchLevel"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure verifies that the specified value is indeed a valid<br> patch level. The patchLevel argument is the value to verify. This<br> procedure may raise script errors.<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=1033">::PackageDownloader::verifyLanguageAndVersion</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> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> |
︙ | ︙ | |||
264 265 266 267 268 269 270 | match the major and minor portions of "1.0" 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> | | | | | | 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | match the major and minor portions of "1.0" 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1066">::PackageDownloader::getPlatform</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 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1147">::PackageDownloader::verifyVersionId</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 "versionId"</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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1166">::PackageDownloader::verifyPlatform</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 "platform"</span></big><br> <big><span style="font-family: monospace;"> Required argument "varName"</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 "msil" or "neutral", 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1410">::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> cookie to the one from the raw response data. Upon failure, a<br> script error will be raised. There are no arguments.<br> |
︙ | ︙ | |||
440 441 442 443 444 445 446 | <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified file seems to be<br> an OpenPGP signature file. The fileName argument is the name of<br> the file to check, which may or may not exist. The nameOnly<br> argument should be non-zero to ignore the contents of the file.<br> </blockquote><br><hr><br> | | > > > > > > > > > > > > > > | | | | | | | | | | | | | | 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 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 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 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 | <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified file seems to be<br> an OpenPGP signature file. The fileName argument is the name of<br> the file to check, which may or may not exist. The nameOnly<br> argument should be non-zero to ignore the contents of the 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=710">::PackageDownloader::maybeVerifyOpenPgpSignature</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> <big><span style="font-family: monospace;"> Required argument "forcePgp"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify the specified OpenPGP signature<br> file. If the forcePgp parameter is non-zero verification will be<br> attempted even when the specified file does not appear to be an<br> OpenPGP signature file. 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=738">::PackageDownloader::getAutoPath</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> <blockquote style="font-family: monospace;"><br> This procedure returns the auto-path for the language specified by<br> the language argument. An empty list is returned if the auto-path<br> does not exist in the target language. This procedure may raise<br> 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=786">::PackageDownloader::addToAutoPath</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 "directory"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure adds a directory to the auto-path of the specified<br> language (i.e. native Tcl or Eagle). The directory will not be<br> added if it is already present. The language argument must be the<br> literal string "eagle" or the literal string "tcl". The directory<br> argument is the fully qualified path for the directory to add to<br> the auto-path.<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=835">::PackageDownloader::maybeAddToAutoPath</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 "directory"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure adds a directory to the auto-path of the specified<br> language (i.e. native Tcl or Eagle). The directory will not be<br> added if it is already present. The language argument must be the<br> literal string "eagle" or the literal string "tcl". The directory<br> argument is the fully qualified path for the directory to add to<br> the auto-path. The directory will not be added if it falls under<br> a directory already in the auto-path.<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=908">::PackageDownloader::isMonoInstalled</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 verify that an instance of Mono and its<br> associated runtimes are installed locally. There are no arguments.<br> The return value is non-zero if Mono appears to be installed and<br> available for use; otherwise, the 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=942">::PackageDownloader::isDotNetCoreInstalled</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 verify that an instance of .NET Core<br> and its associated runtimes are installed locally. There are no<br> arguments. The return value is non-zero if Mono appears to be<br> installed and available for use; otherwise, the return value is<br> 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=976">::PackageDownloader::canUseMsilPlatform</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 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 "<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> <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> <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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1370">::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=1540">::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=1570">::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=1647">::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> <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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1670">::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=1782">::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> <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 "eagle", "tcl", or "client". 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1816">::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> <big><span style="font-family: monospace;"> Required argument "packageName"</span></big><br> |
︙ | ︙ | |||
638 639 640 641 642 643 644 | 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> | | | | 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 | 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1920">::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> <big><span style="font-family: monospace;"> Required argument "usePgp"</span></big><br> <big><span style="font-family: monospace;"> Required argument "forcePgp"</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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1961">::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> <big><span style="font-family: monospace;"> Required argument "platform"</span></big><br> |
︙ | ︙ | |||
794 795 796 797 798 799 800 | This procedure modifies the URN variables used by the package<br> repository client so that one or more alternative (private?)<br> backend repository servers may be used. The serverId argument<br> must consist only of alphanumeric characters and it must begin<br> with a letter.<br> </blockquote><br><hr><br> | | | | | < | | | 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 | This procedure modifies the URN variables used by the package<br> repository client so that one or more alternative (private?)<br> backend repository servers may be used. The serverId argument<br> must consist only of alphanumeric characters and it must begin<br> with a letter.<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/pkgr.eagle&ln=2246">::PackageRepository::maybeReadSettingsFiles</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "script"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure evaluates package repository client settings script<br> files, if they exists. Any script errors raised are not masked.<br> The script argument must be the fully qualified path and file name<br> for a package client toolset script 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/pkgr.eagle&ln=2593">::PackageRepository::getPackageFromRepository</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "package"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "caller"</span></big><br> |
︙ | ︙ | |||
1365 1366 1367 1368 1369 1370 1371 | package being sought, it cannot be an empty string. The version<br> argument must be a specific version -OR- a package specification<br> that conforms to TIP #268. This version argument must be optional<br> here, because Eagle does not add a version argument when one is<br> not explicitly supplied to the [package require] sub-command.<br> </blockquote><br><hr><br> | | > > > > > > > > > > > > > > > > > > > | | | 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 | package being sought, it cannot be an empty string. The version<br> argument must be a specific version -OR- a package specification<br> that conforms to TIP #268. This version argument must be optional<br> here, because Eagle does not add a version argument when one is<br> not explicitly supplied to the [package require] sub-command.<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/pkgr.eagle&ln=2213">::PackageRepository::getSettingsPrefixes</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "scriptName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "envVarName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "all"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns the list of possible prefixes that should be<br> considered for settings files. The scriptName parameter is the name<br> of the script being evaluated, if any. The envVarName parameter is<br> the name of an environment variable associated with the script being<br> evaluated, if any. The all parameter should be non-zero to include<br> all available prefixes, even if they are inapplicable to the current<br> configuration. 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/pkgr.eagle&ln=2336">::PackageRepository::maybeReadApiKeysFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure evaluates a package repository client API keys<br> script file, if it has been configured -AND- actually exists.<br> Any script errors raised are not masked. The evaluated script<br> file should (normally) modify the "::pkgr_api_keys" variable<br> in order to add API keys for use with the package repository<br> client.<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/pkgr.eagle&ln=2358">::PackageRepository::setupRepositoryOpenPgpVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used to interact with the OpenPGP implementation.<br> If the force argument is non-zero, any existing values will be<br> overwritten and set back to their default values.<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/pkgr.eagle&ln=2480">::PackageRepository::setupPackageUnknownVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used by the package repository client. If the force<br> |
︙ | ︙ |