Overview
Comment: | Regenerate the documentation. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA1: |
d87ad6540144fe2a88ff38fd2d65457a |
User & Date: | mistachkin on 2019-10-18 05:24:28 |
Other Links: | manifest | tags |
Context
2019-11-06
| ||
16:00 | Pickup 'common.tcl' fixes from upstream, mostly related to TLS handling. Unify variable override handling. Bump version. check-in: 0771035cd3 user: mistachkin tags: trunk | |
2019-10-18
| ||
05:24 | Regenerate the documentation. check-in: d87ad65401 user: mistachkin tags: trunk | |
2019-10-16
| ||
04:29 | Add .NET Core support for the 'msil' platform. check-in: 9fa57a256a user: mistachkin tags: trunk | |
Changes
Modified doc/v1.html from [10103d412d] to [cef92c0427].
︙ | ︙ | |||
76 77 78 79 80 81 82 | the progress indicator should be emitted. The type argument is<br> the single-character progress indicator. The milliseconds<br> argument is the number of milliseconds to wait until the next<br> periodic progress indicator should be emitted. This procedure<br> reschedules its own execution.<br> </blockquote><br><hr><br> | | | | | | | | 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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 | the progress indicator should be emitted. The type argument is<br> the single-character progress indicator. The milliseconds<br> argument is the number of milliseconds to wait until the next<br> periodic progress indicator should be emitted. This procedure<br> reschedules its own execution.<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=385">::PackageDownloader::useServerId</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 "serverId" with default value ""</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure modifies the URN variables used by the package<br> downloader client so that one or more alternative (private?)<br> backend file servers may be used. The serverId argument must<br> consist only of alphanumeric characters and it must begin with<br> 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/pkgd.eagle&ln=425">::PackageDownloader::useVersionId</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 "versionId" with default value ""</span></big><br> <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=1342">::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=1392">::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=1445">::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=1539">::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=1846">::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> |
︙ | ︙ | |||
205 206 207 208 209 210 211 | 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> | | | | | | 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 | 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> <big><big><span style="font-family: monospace;">Internal API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=971">::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=984">::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=1005">::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 | major and minor portions of "1.0" 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> | | | | | | 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 | major and minor portions of "1.0" 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 "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1037">::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=1118">::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=1137">::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=1369">::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> |
︙ | ︙ | |||
370 371 372 373 374 375 376 | <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used by the package downloader client. The script<br> argument is the fully qualified path and file name for the script<br> being evaluated.<br> </blockquote><br><hr><br> | | | | | | | | | | | | > > > > > > > > > > | | | | | | 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 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 | <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used by the package downloader client. The script<br> argument is the fully qualified path and file name for the script<br> being evaluated.<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=450">::PackageDownloader::uriEscape</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 "name"</span></big><br> <big><span style="font-family: monospace;"> Required argument "value"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure escapes a single name/value pair for use in a URI<br> query string. The name argument is the name of the parameter.<br> The value argument is the value of the parameter.<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=466">::PackageDownloader::getPersistentRootDirectory</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 root directory where any packages that<br> are downloaded should be saved to permanent storage for subsequent<br> use. There are 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=490">::PackageDownloader::verifyPersistentRootDirectory</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 configured persistent root directory for<br> downloaded packages. If any checks fail, a script error is raised.<br> There are no arguments. 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=518">::PackageDownloader::getPackageIndexFileName</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 name of the package index file for the<br> language specified by the language argument. An empty string will<br> be returned if the language is unsupported or unrecognized.<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=539">::PackageDownloader::maybeCreateMasterTclPackageIndex</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, which is only used for native Tcl, generates a<br> "master" package index file (i.e. "pkgIndex.tcl") suitable for<br> use with native Tcl 8.4 (or higher). It will recursively scan<br> for all other native Tcl package index files that are within the<br> configured persistent root directory and [source] them, thereby<br> causing all packages located within them to become available.<br> Since Eagle (by default) already performs recursive searches for<br> its package index files, this procedure is not needed for Eagle.<br> 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=659">::PackageDownloader::isOpenPgpSignatureFileName</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 "nameOnly"</span></big><br> <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::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=758">::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=807">::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=880">::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=914">::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=948">::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=1270">::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> <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.<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=1329">::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=1499">::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=1594">::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=1628">::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> |
︙ | ︙ | |||
581 582 583 584 585 586 587 | 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> | | | | 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 | 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=1732">::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=1780">::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> |
︙ | ︙ | |||
737 738 739 740 741 742 743 | 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> | | | | 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 | 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=2199">::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 the package repository client settings<br> script file, if it exists. Any script errors raised are not<br> masked. The script argument must be the fully qualified path<br> and file name for the primary package repository client script<br> 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=2528">::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> |
︙ | ︙ | |||
1308 1309 1310 1311 1312 1313 1314 | 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> | | | | | 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 | 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=2275">::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=2296">::PackageRepository::setupRepositoryOpenPgpVars</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 sets up the default values for all configuration<br> parameters used to interact with the OpenPGP implementation.<br> There are 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/pkgr.eagle&ln=2415">::PackageRepository::setupPackageUnknownVars</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 sets up the default values for all configuration<br> parameters used by the package repository client. There are no<br> arguments.<br> </blockquote><br><hr><br> |
︙ | ︙ |
Modified doc/v1.html.asc from [89033638d6] to [a8e5ef3fb4].
1 2 3 4 | -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Eagle Package Repository | | | | | | | | | | | | | | | 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 iQIcBAABCAAGBQJdqUxkAAoJEFAslq9JXcLZU5AP/RyM1FpTYa/A1vNpBOEs9O/p 3JYElIQCPBndxJqJ140YCgRwWJX/FD3ufoSXVXLyaM52IwuiwXFuPr1abkTgGBSe 18GcfE/bZ979JRipDT5J1GHV9NNuJOoEeqx+mFFQntP31EljY8WfiMb9qWDvWhyf VneU3TsIzYMNEUJSe8hYfK2fDckU46KoN+GLi6tXpVfRIkMfBaNuuBzOV0tbQAXY LsxlrqLJSFFLmUQKTBIcrkIfH26dHhvRo6/D/STo0fTTorz1Iuq/18RHX7DbgIyc t5rkeQvhnzPlGQog/4WdOsAvqyB0Q1EhGzfCXFKj8dRlEkHHR/usDrujpdADHcwv HLkLc99FPnINuOaMpMtdA7e34c0UJ/1MQKICJ+hm2PPWLSH+22YwH7BxkszljmXG RONfda2I5BJK2jsuO9XGiYePgUQxm9pTi+5+RpMvuhONNwKzWJTljsjnj6nZ1seI ArYfJKO02LLQtVTO3BWPehVGHFwrgFdBanKS/5V3S5gX2vC7ARjNcEKk7NNO/7mH +8WyM35jzs1+5vvl8JbPrENcHdwbpnx2r5m3nbwelQkLVNfutFW1pyOy5ClrHd0w KDsIcPg1+LsnZlV9qy+tv8IL+Sw2Z406CUEEAJRwqDzZTJdfgEFGeqZAIjwr1wFL 2t8EF5hLQ/xC4NyuOZGR =MkDq -----END PGP SIGNATURE----- |