Overview
| Comment: | Add links to the documentation. |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA1: |
b858153d7e5b44e30d36c3b3ab25b7da |
| User & Date: | mistachkin on 2019-08-19 21:19:09 |
| Other Links: | manifest | tags |
Context
|
2019-08-20
| ||
| 01:18 | Add namespaces to the documentation. check-in: d8c0232ece user: mistachkin tags: trunk | |
|
2019-08-19
| ||
| 21:19 | Add links to the documentation. check-in: b858153d7e user: mistachkin tags: trunk | |
| 20:27 | Order the documentation: public, internal, private. check-in: bcf1a6a4e4 user: mistachkin tags: trunk | |
Changes
Modified doc/v1.html from [23dfee5ad7] to [5213da85db].
1 2 | <div class="fossil-doc" data-title="Package Client Toolset API v1"><br> | | | | | | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 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 | <div class="fossil-doc" data-title="Package Client Toolset API v1"><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=217">getFileViaHttp</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "uri"</span></big><br> <big><span style="font-family: monospace;"> Required argument "redirectLimit"</span></big><br> <big><span style="font-family: monospace;"> Required argument "channel"</span></big><br> <big><span style="font-family: monospace;"> Required argument "quiet"</span></big><br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure was stolen from the "getEagle.tcl" script. It is<br> designed to process a single HTTP request, including any HTTP<br> 3XX redirects (up to the specified limit), and return the raw<br> HTTP response data. It may raise any number of 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/common.tcl&ln=97">setupCommonVariables</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</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 was stolen from the "getEagle.tcl" script. This<br> procedure sets up the default values for all HTTP configuration<br> parameters used by this package. If the force argument is<br> non-zero, any existing values will be overwritten and set back<br> to their default values.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl&ln=153">pageOut</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "channel"</span></big><br> <big><span style="font-family: monospace;"> Required argument "string"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure was stolen from the "getEagle.tcl" script. It is<br> designed to emit a message to the console. The channel argument<br> is the channel where the message should be written. The string<br> argument is the content of the message to emit. If the channel<br> argument is an empty string, nothing is written.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl&ln=167">pageLog</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "string"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure was stolen from the "getEagle.tcl" script. It is<br> designed to emit a message to the HTTP client log. The string<br> argument is the content of the message to emit. If the string<br> argument is an empty string, nothing is written.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl&ln=186">pageProgress</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "channel"</span></big><br> <big><span style="font-family: monospace;"> Required argument "type"</span></big><br> <big><span style="font-family: monospace;"> Required argument "milliseconds"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure was stolen from the "getEagle.tcl" script. It is<br> designed to emit a progress indicator while an HTTP request is<br> being processed. The channel argument is the Tcl channel where<br> 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=349">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=389">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=1272">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=1322">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=1375">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=1469">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=1776">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=564">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=901">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=914">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=935">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 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 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 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 | 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=967">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=1048">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=1067">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=1299">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> </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=27">pkgLog</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 "string"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure emits a message to the package downloader client<br> log. The string argument is the content of the message to emit.<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=39">setupDownloadServerVars</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 "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all URN configuration<br> parameters used by the package downloader client. If the force<br> argument is non-zero, any existing values will be overwritten and<br> 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/pkgd.eagle&ln=108">setupDownloadVersionVars</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 "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all version<br> configuration parameters used by the package downloader client.<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/pkgd.eagle&ln=126">setupDownloadUriVars</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 "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all URI configuration<br> parameters used by the package downloader client. If the force<br> argument is non-zero, any existing values will be overwritten and<br> 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/pkgd.eagle&ln=210">setupDownloadVars</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 "script"</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 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=414">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=430">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=454">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=482">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=503">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=623">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=674">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=722">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=771">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=844">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=878">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=1200">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=1259">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=1429">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=1524">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=1558">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> | | | | 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 | 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=1662">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=1710">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> |
| ︙ | ︙ | |||
638 639 640 641 642 643 644 | language and version-specific directory on the package file server.<br> The localFileName argument is the file name where the downloaded<br> file should be written. The usePgp argument should be non-zero when<br> the OpenPGP signature file needs to be verified for the downloaded<br> file.<br> </blockquote><br><hr><br> | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 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 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 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 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 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 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 | language and version-specific directory on the package file server.<br> The localFileName argument is the file name where the downloaded<br> file should be written. The usePgp argument should be non-zero when<br> the OpenPGP signature file needs to be verified for the downloaded<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=315">isHarpyCertificate</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 "value"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified string value<br> looks like a Harpy (script) certificate. The value argument is<br> the string to check. The value 14 used within this procedure is<br> the length of the literal string "</Certificate>".<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=339">isOpenPgpSignature</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 "value"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified string value<br> looks like an OpenPGP signature. The value argument is the string<br> to check. The value 27 used within this procedure is the length<br> of the literal string "-----END PGP SIGNATURE-----".<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=360">getFileTempDirectory</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;"> Optional argument "envVarName" with default value ""</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns the fully qualified name of the directory<br> where temporary files should be written. The envVarName argument<br> is an optional extra environment variable to check (first).<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=471">openPgpMustBeInstalled</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 attempts to verify that a configured implementation<br> of OpenPGP is installed locally. There are no arguments. Script<br> errors are raised if any problems are found. The return value is<br> undefined.<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=555">verifyOpenPgpSignature</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 "fileName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify the OpenPGP signature contained<br> in the specified (named) file. Non-zero is only returned if the<br> OpenPGP signature is verified successfully. A script error should<br> not be raised by this procedure. The fileName argument must be<br> the fully qualified path and file name of the OpenPGP signature<br> file to verify.<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=664">createOpenPgpSignature</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 "fileName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to create an OpenPGP signature for the<br> specified (named) file. Non-zero is only returned if the OpenPGP<br> signature is created successfully. A script error should not be<br> raised by this procedure. The fileName argument must be the fully<br> qualified path and file name of the file to be signed.<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=762">getUniqueSuffix</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;"> Optional argument "paranoia" with default value "1"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns a name suffix (directory, variable, etc)<br> that is unique to the running process at the current point in<br> time. It is used (internally) to avoid name collisions with any<br> preexisting variables or commands that may be present in the<br> global namespace. The paranoia argument represents the relative<br> level of paranoia required by the caller; the higher this level,<br> the more uniqueness is required.<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=892">useServerId</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;"> 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> 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=2162">maybeReadSettingsFile</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=2472">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> <blockquote style="font-family: monospace;"><br> This procedure is the primary entry point to the package repository<br> client. It attempts to lookup the specified package using the<br> currently configured package repository server. The package<br> argument is the name of the package being sought, it cannot be an<br> empty string. The version argument must be a specific version -OR-<br> a package specification that conforms to TIP #268. The caller<br> argument must be an empty string -OR- the literal string "handler".<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/pkgr.eagle&ln=235">formatExecArgument</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 "value"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns a string argument value, which may contain<br> spaces, for use with the [exec] command. The value argument is<br> the string value to format as an [exec] argument.<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/pkgr.eagle&ln=420">probeForOpenPgpInstallation</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 attempts to check for an OpenPGP installation being<br> installed at the default location. There are no arguments. If the<br> OpenPGP installation is detected and is not yet present in the PATH,<br> an attempt will be made to add it. Non-zero will be returned if the<br> OpenPGP installation directory was successfully detected and added<br> to the PATH -OR- detecting and adding it was not necessary because<br> it already appeared to be available for use.<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/pkgr.eagle&ln=613">createHarpyCertificate</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 "fileName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to create a Harpy (script) certificate for<br> the specified (named) file. Non-zero is only returned if the Harpy<br> (script) certificate is created successfully. A script error should<br> not be raised by this procedure. The fileName argument must be the<br> fully qualified path and file name of the file to be signed. This<br> procedure assumes that the Harpy package for Eagle is installed and<br> ready for use (i.e. it can find a valid license certificate).<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/pkgr.eagle&ln=703">importOpenPgpKeyFile</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 "fileName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to import the OpenPGP keys contained in<br> the specified (named) file. Non-zero is only returned if the<br> OpenPGP keys are imported successfully. A script error should<br> not be raised by this procedure. The fileName argument must be<br> the fully qualified path and file name of the OpenPGP key file<br> to import. This procedure is only intended to be used from the<br> "pkgr_setup.eagle" tool script and may go away in later versions<br> 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/pkgr.eagle&ln=787">getApiKeys</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;"> Optional argument "prefix" with default value ""</span></big><br> <big><span style="font-family: monospace;"> Optional argument "prefixOnly" with default value "false"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns the list of API keys to use when looking<br> up packages via the package repository server. An empty list<br> is returned if no API keys are currently configured. The prefix<br> argument is an extra variable name prefix to check prior to any<br> that are already configured. The prefixOnly argument should be<br> non-zero to exclude any API keys other than those based on the<br> prefix specified by the caller.<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/pkgr.eagle&ln=865">verifyMetadataLanguage</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 "language"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure verifies the language specified by the caller. The<br> language argument must be an empty string -OR- the literal string<br> "Eagle" or "Tcl". 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/pkgr.eagle&ln=877">verifyServerId</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 "serverId"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure verifies that the specified value is indeed a valid<br> server identifier. The serverId 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/pkgr.eagle&ln=946">getSubmitBaseUri</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 returns the base URI for the package repository<br> server endpoint that is used to submit packages. There are no<br> arguments.<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/pkgr.eagle&ln=1120">getResponseCodeFromRawData</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 "data"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to extract the lookup code from the raw<br> HTTP response data. The data argument is the raw HTTP response<br> data. An empty string is returned if no lookup code is available.<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/pkgr.eagle&ln=1134">getResponseResultFromRawData</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 "data"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to extract the lookup result from the raw<br> HTTP response data. The data argument is the raw HTTP response<br> data. An empty string is returned if no lookup result is available.<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/pkgr.eagle&ln=1148">isResponseCodeOk</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 "code"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified lookup response<br> code indicates success. The code argument is the extracted HTTP<br> lookup response code.<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/pkgr.eagle&ln=1340">makeTclReady</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 is designed for Eagle. It attempts to load the<br> "best" native Tcl library. It may raise any number of script<br> errors. There are no arguments.<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/pkgr.eagle&ln=1369">eagleMustBeReady</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, which may only be used from a native Tcl script,<br> checks if Garuda and Eagle are loaded and ready. If not, a script<br> error is raised. There are no arguments.<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/pkgr.eagle&ln=1393">makeEagleReady</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 is designed for native Tcl. It attempts to load<br> the Garuda package and gain access to Eagle. It may raise any<br> number of script errors. 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=170">setupRepositoryServerVars</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 URN configuration<br> parameters used by the package repository client. If the force<br> argument is non-zero, any existing values will be overwritten and<br> 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=198">setupRepositoryUriVars</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 URI configuration<br> parameters used by the package repository client. If the force<br> argument is non-zero, any existing values will be overwritten and<br> 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=249">formatPackageName</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> <blockquote style="font-family: monospace;"><br> This procedure returns a formatted, possibly version-specific,<br> package name, for use in logging. The package argument is the<br> name of the package. The version argument is the version of the<br> package.<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=259">formatResult</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 "code"</span></big><br> <big><span style="font-family: monospace;"> Required argument "result"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns a formatted script result. If the string<br> result is empty, only the return code is used. The code argument<br> must be an integer Tcl return code (e.g. from [catch]) and the<br> result argument is the script result or error message.<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=281">pkgLog</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 "string"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure emits a message to the package repository client<br> log. The string argument is the content of the message to emit.<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=292">stringIsList</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 "value"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to determine if a string is a valid list<br> and returns non-zero when that is true. The value argument is<br> the string to check.<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=390">getFileTempName</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 returns a unique temporary file name. A script<br> error is raised if this task cannot be accomplished. 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/pkgr.eagle&ln=587">getOpenPgpPassphraseFile</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 returns the name of the file containing the OpenPGP<br> passphrase. This procedure is only used when creating an OpenPGP<br> signature. 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=748">getLookupVarNamePrefix</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 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/pkgr.eagle&ln=919">getLookupBaseUri</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 returns the base URI for the package repository<br> server endpoint that is used to lookup packages. There are no<br> 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=978">getLookupUri</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 "apiKeys"</span></big><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> <blockquote style="font-family: monospace;"><br> This procedure returns the full URI to use when looking up a<br> specific package via the package repository server. The apiKeys<br> argument is the list of API keys to use -OR- an empty list if a<br> public package is being looked up. The package argument is the<br> name of the package being looked up, it cannot be an empty<br> string. The version argument is the specific version being<br> looked up -OR- an empty string for any available version. There<br> are no HTTP requests issued by this procedure; it simply returns<br> the URI to use.<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=1034">getIfNeededVersion</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> <blockquote style="font-family: monospace;"><br> This procedure returns the version of the package that should be<br> used to lookup the associated [package ifneeded] script -OR- an<br> empty string if no such version exists. The package argument is<br> the name of the package, it cannot be an empty string. The<br> version argument is the specific version being looked up -OR- an<br> empty string for any available version.<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=1049">packageRequirementToVersion</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 "requirement"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure accepts a package requirement (spec) and returns<br> a simple package version, if possible. An empty string will be<br> returned, if appropriate (i.e. any version should be allowed).<br> The requirement argument must be a package specification that<br> conforms to TIP #268.<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=1081">getLookupData</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 "apiKeys"</span></big><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> <blockquote style="font-family: monospace;"><br> This procedure issues an HTTP request that should return metadata<br> that can be used to load and/or provide the specified package.<br> The apiKeys argument is the list of API keys to use -OR- an empty<br> list if a public package is being looked up. The package argument<br> is the name of the package, it cannot be an empty string. The<br> version argument is the specific version being looked up -OR- an<br> empty string for any available version. This procedure may raise<br> script errors. All line-endings are normalized to Unix-style;<br> therefore, all script signatures must assume this.<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=1169">isValidPackageRequirement</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 "requirement"</span></big><br> <big><span style="font-family: monospace;"> Required argument "rangeOk"</span></big><br> <big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br> |
| ︙ | ︙ | |||
1128 1129 1130 1131 1132 1133 1134 | package version, with up to four components, without any 'a' or 'b'.<br> The emptyOk argument should be non-zero if an empty string should be<br> considered to be valid by the caller. The rangeOk argument should<br> be non-zero if the version range syntax is allowed; this argument is<br> ignored for Eagle because it requires TIP #268 support.<br> </blockquote><br><hr><br> | | | | | | 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 | package version, with up to four components, without any 'a' or 'b'.<br> The emptyOk argument should be non-zero if an empty string should be<br> considered to be valid by the caller. The rangeOk argument should<br> be non-zero if the version range syntax is allowed; this argument is<br> ignored for Eagle because it requires TIP #268 support.<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=1227">extractAndVerifyLookupMetadata</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 "result"</span></big><br> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "caller"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to extract the package lookup metadata from<br> the lookup result. The result argument is the lookup result. The<br> varName argument is the name of an array variable, in the call frame<br> of the immediate caller, that should receive the extracted package<br> lookup metadata. The caller argument must be an empty string -OR-<br> the literal string "handler".<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=1316">tclMustBeReady</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, which may only be used from an Eagle script, checks<br> if a native Tcl library is loaded and ready. If not, a script error<br> is raised. 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=1420">eagleHasSecurity</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 returns non-zero if the current script is being<br> evaluated in Eagle with signed-only script security enabled.<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=1452">processLookupMetadata</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 "varName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure uses the package lookup metadata. If the package<br> script is properly signed, an attempt will be made to evaluate it<br> |
| ︙ | ︙ | |||
1184 1185 1186 1187 1188 1189 1190 | script itself to either add the package or provide the package to<br> the language(s) supported by that package. The varName argument<br> is the name of an array variable in the call frame of the<br> immediate caller, that contains the package lookup metadata. This<br> procedure may raise script errors.<br> </blockquote><br><hr><br> | | | | | | | | | | | | | | | | | | | | | | | | | | | 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 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 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 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 1464 1465 1466 1467 1468 1469 1470 1471 1472 | script itself to either add the package or provide the package to<br> the language(s) supported by that package. The varName argument<br> is the name of an array variable in the call frame of the<br> immediate caller, that contains the package lookup metadata. 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/pkgr.eagle&ln=1816">isPackagePresent</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> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified package appears to<br> be present. The package argument is the name of the package being<br> sought, it cannot be an empty string. The version argument must be<br> a specific version -OR- a package specification that conforms to TIP<br> #268.<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=1848">isPackageAvailable</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> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified package appears to<br> be available. The package argument is the name of the package being<br> sought, it cannot be an empty string. The version argument must be<br> a specific version -OR- a package specification that conforms to TIP<br> #268.<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=1901">canDownloadPackage</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> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified package can be<br> downloaded, i.e. because it is not required for the downloading<br> process itself to be functional, etc. The package argument is<br> the name of the package to check.<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=1947">setupPackageUnknownHandler</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 performs initial setup of the package repository<br> client, using the current configuration parameters. There are<br> no arguments. It may load the Garuda package when evaluated in<br> native Tcl. It may load a native Tcl library when evaluated in<br> Eagle. It may install the [package unknown] hook.<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=1987">isPackageUnknownHandlerHooked</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 returns non-zero if the [package unknown] handler<br> has already been hooked by the package repository client. There<br> 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=1999">hookPackageUnknownHandler</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 attempts to hook the [package unknown] handler. It<br> will raise a script error if this has already been done. The old<br> [package unknown] handler is saved and will be used by the new one<br> as part of the overall package loading process. There are no<br> 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=2017">unhookPackageUnknownHandler</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 attempts to unhook the [package unknown] handler.<br> It will raise a script error if the [package unknown] handler is<br> not hooked. The old [package unknown] handler is restored and<br> the saved [package unknown] handler is cleared. There are no<br> 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=2033">runSavedPackageUnknownHandler</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> <blockquote style="font-family: monospace;"><br> The procedure runs the saved [package unknown] handler. Any script<br> errors are raised to the caller. The package and version arguments<br> are passed in from the current [package unknown] handler verbatim.<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=2055">packageUnknownHandler</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;"> Optional argument "version" with default value ""</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is the [package unknown] handler entry point called<br> by native Tcl and Eagle. The package argument is the name of the<br> 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=2219">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=2240">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=2359">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> <big><big><span style="font-family: monospace;">Internal API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1209">setupArgumentData</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "argv"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure initializes the array containing data derived from<br> the command line arguments, if any. The argv argument should be<br> the list of command line arguments.<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/pkgu.eagle&ln=1284">haveArgumentData</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure is used to determine if all the package submission<br> data is available. There are no arguments. Non-zero is returned<br> if all the package submission data is available. This procedure<br> should not 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/pkgu.eagle&ln=1434">submitEventHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles the submit button in<br> both Tk and Eagle. It starts the package submission process. The<br> args argument is not really used, it is a placeholder to make this<br> procedure more portable between Tcl and Eagle. This procedure may<br> 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/pkgu.eagle&ln=1577">setupWinFormsUserInterface</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure creates the user interface for this tool using Eagle<br> and WinForms. The existing argument data, if any, will be used to<br> populate it. There are no arguments.<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/pkgu.eagle&ln=1779">setupTkUserInterface</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure creates the user interface for this tool using Tcl<br> and Tk. The existing argument data, if any, will be used to<br> populate it. 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/pkgu.eagle&ln=28">setupUploadVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.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 uploader client. There are no<br> 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/pkgu.eagle&ln=230">setupCheckoutVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.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 uploader client that require the<br> location of the checkout directory. 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/pkgu.eagle&ln=250">formatStringMapValue</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "value"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns a string value, formatted for use within a<br> script block being processed by the [string map] command. The<br> value argument is the string value to format. No return value is<br> reserved to indicate an error. This procedure may not raise any<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/pkgu.eagle&ln=270">countCommonPathParts</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "path1"</span></big><br> <big><span style="font-family: monospace;"> Required argument "path2"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure counts the common path components for two paths. The<br> count is returned, zero if there are no common path components. The<br> path1 and path2 arguments are the paths to compare. This procedure<br> may not 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/pkgu.eagle&ln=298">getCommonContainingDirectory</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure processes a list of (fully?) qualified file names and<br> tries to determine their common containing directory, if any. The<br> fileNames argument is the list of (fully?) qualified file names to<br> process. This procedure may not raise script errors. If there is<br> no common containing directory, an empty string is 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/pkgu.eagle&ln=344">getRelativeFileNames</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br> <big><span style="font-family: monospace;"> Required argument "maximumLevels"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to process a list of (fully?) qualified file<br> names and return the corresponding list of relative file names. The<br> fileNames argument is the list of (fully?) qualified file names to<br> process. The maximumLevels argument is the maximum path depth that<br> is allowed for all file names. This procedure may raise script<br> 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/pkgu.eagle&ln=390">getScriptChunkForFileNames</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br> <big><span style="font-family: monospace;"> Required argument "maximumLevels"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to create a script chunk that appends the<br> specified list of file names to a list variable. The fileNames<br> argument is the list of (fully?) qualified file names to append to<br> the list variable. The maximumLevels argument is the maximum path<br> depth that is allowed for all file names. 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/pkgu.eagle&ln=424">createRepositoryScript</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "serverId"</span></big><br> <big><span style="font-family: monospace;"> Required argument "versionId"</span></big><br> <big><span style="font-family: monospace;"> Required argument "language"</span></big><br> |
| ︙ | ︙ | |||
1493 1494 1495 1496 1497 1498 1499 | strings "neutral", "win32-arm", "win32-x86", "win64-arm64",<br> "win64-ia64", or "win64-x64". The fileNames argument is the list of<br> (fully?) qualified file names to be downloaded when the associated<br> package is being provided. The options argument is reserved for<br> future use, it should be an empty list.<br> </blockquote><br><hr><br> | | | | | 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 | strings "neutral", "win32-arm", "win32-x86", "win64-arm64",<br> "win64-ia64", or "win64-x64". The fileNames argument is the list of<br> (fully?) qualified file names to be downloaded when the associated<br> package is being provided. The options argument is reserved for<br> future use, it should be an empty list.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=486">createMultipartFormData</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "boundary"</span></big><br> <big><span style="font-family: monospace;"> Required argument "request"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure creates textual data that conforms to the content<br> type "multipart/form-data", per RFC 2388. The boundary argument<br> is a boundary value, as specified in section 4.1 of the RFC. The<br> request argument is the dictionary of name/value pairs to include<br> in the form body. This procedure may not 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/pkgu.eagle&ln=512">getSubmitUri</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns the full URI to use when submitting a new<br> package to the package repository server. There are no arguments.<br> 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/pkgu.eagle&ln=552">submitPackageMetadata</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "apiKey"</span></big><br> <big><span style="font-family: monospace;"> Required argument "package"</span></big><br> <big><span style="font-family: monospace;"> Required argument "patchLevel"</span></big><br> |
| ︙ | ︙ | |||
1545 1546 1547 1548 1549 1550 1551 | string, "Tcl", or "Eagle". If it is an empty string, the current<br> language will be assumed. The script argument is the script to be<br> evaluated when the package needs to be provided. The certificate<br> argument is the certificate associated with the script, which may be<br> an OpenPGP signature or a Harpy script certificate.<br> </blockquote><br><hr><br> | | | | | | | | | | | | | | | | | | 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 | string, "Tcl", or "Eagle". If it is an empty string, the current<br> language will be assumed. The script argument is the script to be<br> evaluated when the package needs to be provided. The certificate<br> argument is the certificate associated with the script, which may be<br> an OpenPGP signature or a Harpy script certificate.<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/pkgu.eagle&ln=651">getCheckoutId</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to query the identifier of the Fossil<br> checkout. There are no arguments. An empty string is returned if<br> the information cannot be determined.<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/pkgu.eagle&ln=694">getCheckoutDirectory</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to query the root directory of the Fossil<br> checkout. There are no arguments. An empty string is returned if<br> the information cannot be determined.<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/pkgu.eagle&ln=736">joinPath</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure builds a native path using the specified parts and<br> returns it. All arguments are considered to be parts of the 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/pkgu.eagle&ln=746">verifyCheckoutDirectory</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that the root directory of the<br> Fossil checkout is present, valid, and is actually a directory.<br> There are no arguments. Script errors will be raised if any of<br> the checks fail.<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/pkgu.eagle&ln=809">fossilMustBeInstalled</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that an implementation of Fossil<br> is installed locally. There are no arguments. Script errors are<br> raised if any problems are found. 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/pkgu.eagle&ln=855">verifyThereAreNoChanges</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that the checkout directory does<br> not contain any (stray) changes. There are no arguments. Non-zero<br> is returned if the verification is successful.<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/pkgu.eagle&ln=899">verifyThisIsTheCorrectProject</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that the checkout directory does<br> belong to the correct project. There are no arguments. Non-zero<br> is returned if the verification is successful.<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/pkgu.eagle&ln=943">verifyThisIsTheCorrectBranch</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that the checkout directory does<br> belong to the correct branch. There are no arguments. Non-zero<br> is returned if the verification is successful.<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/pkgu.eagle&ln=986">changeToTheCorrectBranch</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to change the branch for the checkout<br> directory. There are no arguments. 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/pkgu.eagle&ln=1023">stageOnePackageFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "targetDirectory"</span></big><br> <big><span style="font-family: monospace;"> Required argument "fileName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to stage the specified package file using<br> Fossil. The targetDirectory argument is the fully qualified path<br> to the package platform directory. The fileName argument is the<br> relative name of the file to be staged. 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/pkgu.eagle&ln=1058">stagePackageFiles</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.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> <big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to stage the specified package files using<br> Fossil. The fileNames argument is a list of (fully?) qualified<br> local file names to stage.<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/pkgu.eagle&ln=1141">commitPackageFiles</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.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 "patchLevel"</span></big><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> <blockquote style="font-family: monospace;"><br> This procedure attempts to commit the staged package files to the<br> remote package file repository using Fossil. The varName argument<br> is the name of a scalar variable in the context of the immediate<br> caller that will receive the resulting Fossil check-in identifier.<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/pkgu.eagle&ln=1367">textBoxEventHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "sender"</span></big><br> <big><span style="font-family: monospace;"> Required argument "e"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles the Changed event<br> for a text box. It is not used when the user interface was built<br> with Tk. The varName argument is the name of the scalar variable<br> that must be updated with the contents of the text box. The sender<br> and e arguments are provided by the framework and represent the<br> control involved in the event and any extra data that may be<br> necessary to process the event.<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/pkgu.eagle&ln=1381">listBoxEventHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles double-clicking the<br> list box in both Tk and Eagle. The varName argument is the name of<br> the scalar variable that must be updated with the list of items from<br> the list box -OR- the list of items from an interactive file picker<br> dialog. The args argument, which is only used for Eagle, is a list<br> containing two elements. The first element is the control involved<br> in the event. The second element is any extra data that may be<br> necessary to process the event.<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/pkgu.eagle&ln=1412">handleFormClosedEvent</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles the Closed event for<br> a WinForms form -OR- the WM_DELETE_WINDOW event on a Tk window. The<br> args argument is not really used, it is a placeholder to make this<br> procedure more portable between Tcl and Eagle. This procedure may<br> 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/pkgu.eagle&ln=1535">clearEventHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles the clear button in<br> Tk and Eagle. It is used to clear the package submission data. The<br> args argument is not really used, it is a placeholder to make this<br> procedure more portable between Tcl and Eagle. This procedure may<br> raise script errors.<br> </blockquote><br><hr><br> </div> |