Overview
| Comment: | Update generated documentation. |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA1: |
63c15d9539e7e8f7dd917c2f2554b3de |
| User & Date: | mistachkin on 2020-03-27 21:03:11 |
| Other Links: | manifest | tags |
Context
|
2020-06-08
| ||
| 18:05 | Pickup the HTTP package enhancements from upstream. check-in: fb2060af38 user: mistachkin tags: trunk | |
|
2020-03-27
| ||
| 21:03 | Update generated documentation. check-in: 63c15d9539 user: mistachkin tags: trunk | |
| 20:58 | Various fixes related to package version checking and OpenPGP integration. check-in: 1ba61d8533 user: mistachkin tags: trunk | |
Changes
Modified doc/v1.html from [c6c2976562] to [9eb4e6638e].
| ︙ | ︙ | |||
100 101 102 103 104 105 106 | <blockquote style="font-family: monospace;"><br> This procedure modifies the version variables used by the package<br> downloader client so that a specific version will be used. The<br> versionId argument must consist only of hexadecimal characters.<br> </blockquote><br><hr><br> | | | | | | 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | <blockquote style="font-family: monospace;"><br> This procedure modifies the version variables used by the package<br> downloader client so that a specific version will be used. The<br> versionId argument must consist only of hexadecimal characters.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1354">::PackageDownloader::resetCookieAndLoginSimple</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure resets the currently configured login cookie, if<br> any, and then attempts to login using the configured package<br> repository server API key -OR- using the public access account.<br> Upon success, it will set the login cookie to the one from the<br> raw response data. Upon failure, a script error will be raised.<br> There are no arguments.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1404">::PackageDownloader::resetCookieAndLogin</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "userName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "password"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure resets the currently configured login cookie, if<br> any, and then attempts to login using the specified user name and<br> password. Upon success, it will set the login cookie to the one<br> from the raw response data. Upon failure, a script error will be<br> raised. The userName argument must be the name of a package file<br> server user with at least Fossil Check-Out (o) permissions on the<br> package file server. The password argument must be the plaintext<br> password that is associated with the specified user name.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1457">::PackageDownloader::logoutAndResetCookie</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to logout using the currently configured<br> login cookie, if any, and then resets the login cookie. There<br> are no arguments. This procedure may raise a script error.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1690">::PackageDownloader::checkForHigherVersion</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "language"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "platform"</span></big><br> |
| ︙ | ︙ | |||
167 168 169 170 171 172 173 | not require a specific platform. The packageName argument is a<br> directory name relative to the language and version-specific<br> directory on the package file server and may be an empty string.<br> The usePgp argument should be non-zero when an OpenPGP signature<br> file needs to be downloaded and verified for the downloaded file.<br> </blockquote><br><hr><br> | | | 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | not require a specific platform. The packageName argument is a<br> directory name relative to the language and version-specific<br> directory on the package file server and may be an empty string.<br> The usePgp argument should be non-zero when an OpenPGP signature<br> file needs to be downloaded and verified for the downloaded file.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=2005">::PackageDownloader::downloadFiles</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "language"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "platform"</span></big><br> |
| ︙ | ︙ | |||
302 303 304 305 306 307 308 | 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> | | | 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 | 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=1381">::PackageDownloader::maybeResetCookieAndLoginSimple</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to login using the configured package<br> repository server API key -OR- using the public access account,<br> if not already logged in. Upon success, it will set the login<br> cookie to the one from the raw response data. Upon failure, a<br> script error will be raised. There are no arguments.<br> |
| ︙ | ︙ | |||
514 515 516 517 518 519 520 | 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> | | > > | > | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 | This procedure attempts to verify that some runtime is available to<br> run CLR applications locally (e.g. the .NET Framework or Mono JIT).<br> There are no arguments. The return value is non-zero if it appears<br> that CLR applications should be runnable locally; otherwise, the<br> return value is zero.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1271">::PackageDownloader::getPackageFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "uri"</span></big><br> <big><span style="font-family: monospace;"> Optional argument "allowHtml" with default value "false"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure issues a request to an HTTP(S) server. It returns<br> the raw response data verbatim. It may raise a script error. It<br> will always use the currently configured HTTP(S) login cookie, if<br> any; therefore, it should really only be used for requests to the<br> package file server. The uri argument is the fully qualified URI<br> to request. The allowHtml argument should be non-zero if raw HTML<br> should be allowed in the response data.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1341">::PackageDownloader::getDownloadVarNamePrefix</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns the prefix for fully qualified variable<br> names that MAY be present in the global namespace. There are<br> no arguments.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1511">::PackageDownloader::getUniqueTempDirectory</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Optional argument "prefix" with default value ""</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns a unique temporary directory where one or<br> more files may be saved. The prefix argument is a prefix for the<br> directory name and it may be an empty string. There is no attempt<br> to actually create the resulting directory.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1541">::PackageDownloader::createInterp</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure creates a new interpreter, which may be "safe", and<br> places a reference to it in a variable in the context of the caller<br> identified by the varName argument. The created interpreter has a<br> fully functioning [package] command ensemble; all other commands do<br> nothing and return nothing. This procedure may raise script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1618">::PackageDownloader::getIfNeededVersions</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "interp"</span></big><br> <big><span style="font-family: monospace;"> Required argument "fileName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure evaluates a script file and attempts to determine the<br> list of new [package ifneeded] scripts added by it. When successful<br> it returns a list-of-lists. Each element of the outer list contains<br> a package name and the list of its versions in descending order; in<br> the event of failure, empty lists may be returned for the outer list<br> or for a list of versions. The interp argument is the interp to use<br> when evaluating the file specified by the fileName argument. This<br> procedure may raise script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1641">::PackageDownloader::extractVersionsFromFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "fileName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to extract a package version information<br> from the specified file. The fileName argument is the local file<br> name to read. This procedure may raise script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1753">::PackageDownloader::guessPackageNameFromFileNames</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "language"</span></big><br> <big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to guess a package name based on a list of<br> its files. It relies upon the fact that all packages must include<br> a package index file. The language argument must be one of the<br> literal strings "eagle", "tcl", or "client". The fileNames argument<br> must be the list of file names to be downloaded. The package name,<br> if one can be detected, is returned; otherwise, an empty string will<br> be returned.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1787">::PackageDownloader::downloadAllPlatforms</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "language"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "packageName"</span></big><br> |
| ︙ | ︙ | |||
593 594 595 596 597 598 599 | 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> | | | | 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 | is a directory name relative to the language and version-specific<br> directory on the package file server and may be an empty string.<br> The fileNames argument is the list of file names to be downloaded.<br> The usePgp argument should be non-zero when an OpenPGP signature<br> needs to be verified for the downloaded file.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1891">::PackageDownloader::downloadOneUriToFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "localFileName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "uri"</span></big><br> <big><span style="font-family: monospace;"> Required argument "usePgp"</span></big><br> <big><span style="font-family: monospace;"> Required argument "forcePgp"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure downloads a single URI from the package file server<br> and writes the result to a local file. The localFileName argument<br> is the file name where the downloaded file should be written. The<br> The uri argument is the URI to download. The usePgp argument should<br> be non-zero when the OpenPGP signature file needs to be verified for<br> the downloaded file. The return value is undefined.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=1939">::PackageDownloader::downloadOneFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "language"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "platform"</span></big><br> |
| ︙ | ︙ | |||
685 686 687 688 689 690 691 | <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> | | | | | | | | | 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 | <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=480">::PackageRepository::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=568">::PackageRepository::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=677">::PackageRepository::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=775">::PackageRepository::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=905">::PackageRepository::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=2212">::PackageRepository::maybeReadSettingsFiles</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "script"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure evaluates the package repository client settings<br> script file, if it exists. Any script errors raised are not<br> masked. The script argument must be the fully qualified path<br> and file name for the primary package repository client script<br> file.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle&ln=2545">::PackageRepository::getPackageFromRepository</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "package"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "caller"</span></big><br> |
| ︙ | ︙ | |||
804 805 806 807 808 809 810 | 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> | | | | | | | | | | | | | | 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 | 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=626">::PackageRepository::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=716">::PackageRepository::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=800">::PackageRepository::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=878">::PackageRepository::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=890">::PackageRepository::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=959">::PackageRepository::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=1133">::PackageRepository::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=1147">::PackageRepository::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=1161">::PackageRepository::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=1383">::PackageRepository::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=1412">::PackageRepository::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=1436">::PackageRepository::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> |
| ︙ | ︙ | |||
1022 1023 1024 1025 1026 1027 1028 | <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> | | | | | | | | | | | 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 1120 1121 1122 1123 1124 1125 1126 1127 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 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 | <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=600">::PackageRepository::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=761">::PackageRepository::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=932">::PackageRepository::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=991">::PackageRepository::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=1047">::PackageRepository::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=1062">::PackageRepository::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=1094">::PackageRepository::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=1175">::PackageRepository::isValidPackageName</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 "name"</span></big><br> <big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified string value is a<br> valid package name. The emptyOk argument can be non-zero if the<br> caller wishes to permit an empty string. This procedure is shared<br> with the server.<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=1196">::PackageRepository::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> |
| ︙ | ︙ | |||
1154 1155 1156 1157 1158 1159 1160 | 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> | | | | | | 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 | 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=1254">::PackageRepository::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=1359">::PackageRepository::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=1463">::PackageRepository::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=1495">::PackageRepository::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> |
| ︙ | ︙ | |||
1210 1211 1212 1213 1214 1215 1216 | 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> | | | | | | | | | | | | | | 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 | 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=1866">::PackageRepository::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=1898">::PackageRepository::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=1951">::PackageRepository::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=1997">::PackageRepository::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=2037">::PackageRepository::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=2049">::PackageRepository::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=2067">::PackageRepository::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=2083">::PackageRepository::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=2105">::PackageRepository::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=2288">::PackageRepository::maybeReadApiKeysFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure evaluates a package repository client API keys<br> script file, if it has been configured -AND- actually exists.<br> Any script errors raised are not masked. The evaluated script<br> file should (normally) modify the "::pkgr_api_keys" variable<br> in order to add API keys for use with the package repository<br> client.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle&ln=2310">::PackageRepository::setupRepositoryOpenPgpVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used to interact with the OpenPGP implementation.<br> If the force argument is non-zero, any existing values will be<br> overwritten and set back to their default values.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle&ln=2432">::PackageRepository::setupPackageUnknownVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used by the package repository client. If the force<br> |
| ︙ | ︙ |
Modified doc/v1.html.asc from [e3f0a78c63] to [23f813e837].
1 2 3 4 | -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Eagle Package Repository | | | | | | | | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Eagle Package Repository iQIcBAABCAAGBQJefmnwAAoJEFAslq9JXcLZB3gP/0zEqRwXUTgNEijRCVDY7rpo /lasyz4Oksyd1aqUI6jFppt2NTc6Z3SFx3FCNESEBItLHHspeUMux5pme5PeKKCE m9hLvCAvt33LsQ03MHHnBD3A6ZI+aaVZTYRjUyCxUuxDy4Ma7t7P8pihpnvng3RE Q4T8ioHJLczJ3ni5SfDfkZjY1sdjTklc7w8azKl1eaDXdfYMbTrELi6KVon5jnh6 I50UpY3Eb0zoLW5UlXs4MU9eToJ0Ffj5yBqctw/SR8G0prVq1ZasnIW2fHHtnA/Z G+dtKudcxaoRUirJkrBUOVwe0aVbPaEFdjbeUZW+ko4LUv4QWG4P0Inai+P+wScA NrM/dFo7stF8zHh1zS2l1EuUcOjUX/JLOvZV/BV/Fg8oBUdDsH2JpirA8flcbOV/ aSoPIvf47JhXytpIBuMKmHzjqPfiQ8RddbO2VK6FBaFRLGfSN25iqr69kO8XtiuE GEdcE9yE9pYoV9XPOfuA1Ci9hufNtBWzHXRuY3+ux4ondrpNVONSui4TTDFP67BC /Fdun2BotIj7lq4lipOyfpFXia2TYcLe44kAuR5RE+PfFj6GzoKWMM83jQscFPFT v1/nbTj8N9L9/eFiiIC4iiewhkDIcZ4/Wi2CaEmVzjgBV8s00cVayzYoLcKv+fPT BsSejAX1W2pmq9ixxPPn =T8DD -----END PGP SIGNATURE----- |