Check-in [e35450c726]
Not logged in
Overview
Comment:Update generated documentation.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: e35450c726eea5a59e55bfebaab2e3f72f6c8ed2
User & Date: mistachkin on 2024-03-25 04:59:43
Other Links: manifest | tags
Context
2024-03-25
05:13
In the package upload tool, add support for creating Harpy script certificates for encrypted script files. check-in: 17012cff1e user: mistachkin tags: trunk
04:59
Update generated documentation. check-in: e35450c726 user: mistachkin tags: trunk
04:58
Robustify the nested Eagle shell handling for creating a new Harpy certificate. check-in: e110ec48d0 user: mistachkin tags: trunk
Changes

Modified doc/v1.html from [cd81bbba96] to [54aed06092].

1
2
3
4
5
6
7
8
9
10
<div class="fossil-doc" data-title="Package Client Toolset API v1"><br>

<big><big><span style="font-family: monospace;">Generated [2024-03-25 @ 03:39:49 UTC] from checkout [617a84df96503031e72bafc9255e9840485accd7 2024-03-22 04:56:26 UTC]</span></big></big><br><br><hr><br>


<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=272">::Eagle::Tools::Common::getFileViaHttp</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;uri&quot;</span></big><br>



|







1
2
3
4
5
6
7
8
9
10
<div class="fossil-doc" data-title="Package Client Toolset API v1"><br>

<big><big><span style="font-family: monospace;">Generated [2024-03-25 @ 04:59:00 UTC] from checkout [e110ec48d0eb7e2aebe1c4e8ffddd91317fbd1c0 2024-03-25 04:58:19 UTC]</span></big></big><br><br><hr><br>


<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl&amp;ln=272">::Eagle::Tools::Common::getFileViaHttp</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/common.tcl">common.tcl</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;uri&quot;</span></big><br>

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
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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=677">::PackageRepository::createOpenPgpSignature</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=775">::PackageRepository::getUniqueSuffix</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;paranoia&quot; with default value &quot;1&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=905">::PackageRepository::useServerId</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;serverId&quot; with default value &quot;&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2246">::PackageRepository::maybeReadSettingsFiles</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;script&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure evaluates package repository client settings script<br>
files, if they exists.  Any script errors raised are not masked.<br>
The script argument must be the fully qualified path and file name<br>
for a package client toolset script file.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2593">::PackageRepository::getPackageFromRepository</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;caller&quot;</span></big><br>







|












|














|












|











|







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
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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=727">::PackageRepository::createOpenPgpSignature</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=825">::PackageRepository::getUniqueSuffix</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;paranoia&quot; with default value &quot;1&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=955">::PackageRepository::useServerId</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;serverId&quot; with default value &quot;&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2296">::PackageRepository::maybeReadSettingsFiles</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;script&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure evaluates package repository client settings script<br>
files, if they exists.  Any script errors raised are not masked.<br>
The script argument must be the fully qualified path and file name<br>
for a package client toolset script file.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Public API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2643">::PackageRepository::getPackageFromRepository</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;caller&quot;</span></big><br>
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
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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=626">::PackageRepository::createHarpyCertificate</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=716">::PackageRepository::importOpenPgpKeyFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</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>
&quot;pkgr_setup.eagle&quot; 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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=800">::PackageRepository::getApiKeys</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;prefix&quot; with default value &quot;&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;prefixOnly&quot; with default value &quot;false&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=878">::PackageRepository::verifyMetadataLanguage</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</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>
&quot;Eagle&quot; or &quot;Tcl&quot;.  This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=890">::PackageRepository::verifyServerId</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;serverId&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=959">::PackageRepository::getSubmitBaseUri</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1133">::PackageRepository::getResponseCodeFromRawData</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;data&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1147">::PackageRepository::getResponseResultFromRawData</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;data&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1161">::PackageRepository::isResponseCodeOk</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;code&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1383">::PackageRepository::makeTclReady</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is designed for Eagle.  It attempts to load the<br>
&quot;best&quot; 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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1412">::PackageRepository::eagleMustBeReady</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1436">::PackageRepository::makeEagleReady</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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>








|














|

















|
















|










|










|







|










|










|










|







|







|







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
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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=652">::PackageRepository::createHarpyCertificate</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=766">::PackageRepository::importOpenPgpKeyFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;fileName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</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>
&quot;pkgr_setup.eagle&quot; 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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=850">::PackageRepository::getApiKeys</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;prefix&quot; with default value &quot;&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;prefixOnly&quot; with default value &quot;false&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=928">::PackageRepository::verifyMetadataLanguage</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;language&quot;</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>
&quot;Eagle&quot; or &quot;Tcl&quot;.  This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=940">::PackageRepository::verifyServerId</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;serverId&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1009">::PackageRepository::getSubmitBaseUri</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1183">::PackageRepository::getResponseCodeFromRawData</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;data&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1197">::PackageRepository::getResponseResultFromRawData</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;data&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1211">::PackageRepository::isResponseCodeOk</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;code&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1433">::PackageRepository::makeTclReady</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is designed for Eagle.  It attempts to load the<br>
&quot;best&quot; 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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1462">::PackageRepository::eagleMustBeReady</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1486">::PackageRepository::makeEagleReady</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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>

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
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

<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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=761">::PackageRepository::getLookupVarNamePrefix</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=932">::PackageRepository::getLookupBaseUri</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=991">::PackageRepository::getLookupUri</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;apiKeys&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1047">::PackageRepository::getIfNeededVersion</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1062">::PackageRepository::packageRequirementToVersion</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;requirement&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1094">::PackageRepository::getLookupData</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;apiKeys&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1175">::PackageRepository::isValidPackageName</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;name&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;emptyOk&quot; with default value &quot;false&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1196">::PackageRepository::isValidPackageRequirement</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;requirement&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;rangeOk&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;emptyOk&quot; with default value &quot;false&quot;</span></big><br>







|
>
>
>
>
>
>
>
>
>
>
>
>
>







|







|




















|















|












|




















|













|







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
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

<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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=623">::PackageRepository::dequoteList</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;list&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure returns a list of the same size as the list argument<br>
value.  Each element will have one pair of surrounding double quote<br>
characters removed -IF- they are the first and last non-whitespace<br>
character of that element.  A script error should not be raised by<br>
this procedure.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=811">::PackageRepository::getLookupVarNamePrefix</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=982">::PackageRepository::getLookupBaseUri</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1041">::PackageRepository::getLookupUri</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;apiKeys&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1097">::PackageRepository::getIfNeededVersion</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1112">::PackageRepository::packageRequirementToVersion</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;requirement&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1144">::PackageRepository::getLookupData</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;apiKeys&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1225">::PackageRepository::isValidPackageName</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;name&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;emptyOk&quot; with default value &quot;false&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1246">::PackageRepository::isValidPackageRequirement</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;requirement&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;rangeOk&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;emptyOk&quot; with default value &quot;false&quot;</span></big><br>
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
package version, with up to four components, without any &#39;a&#39; or &#39;b&#39;.<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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1254">::PackageRepository::extractAndVerifyLookupMetadata</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;result&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;caller&quot;</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 &quot;handler&quot;.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1359">::PackageRepository::tclMustBeReady</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1463">::PackageRepository::eagleHasSecurity</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1495">::PackageRepository::processLookupMetadata</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</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>







|

















|







|







|







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
package version, with up to four components, without any &#39;a&#39; or &#39;b&#39;.<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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1304">::PackageRepository::extractAndVerifyLookupMetadata</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;result&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;caller&quot;</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 &quot;handler&quot;.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1409">::PackageRepository::tclMustBeReady</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1513">::PackageRepository::eagleHasSecurity</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1545">::PackageRepository::processLookupMetadata</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</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>
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
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1866">::PackageRepository::isPackagePresent</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1898">::PackageRepository::isPackageAvailable</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1951">::PackageRepository::canDownloadPackage</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1997">::PackageRepository::setupPackageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2037">::PackageRepository::isPackageUnknownHandlerHooked</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2049">::PackageRepository::hookPackageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2067">::PackageRepository::unhookPackageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2083">::PackageRepository::runSavedPackageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2105">::PackageRepository::packageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;version&quot; with default value &quot;&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2213">::PackageRepository::getSettingsPrefixes</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;scriptName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;envVarName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;all&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure returns the list of possible prefixes that should be<br>
considered for settings files.  The scriptName parameter is the name<br>
of the script being evaluated, if any.  The envVarName parameter is<br>
the name of an environment variable associated with the script being<br>
evaluated, if any.  The all parameter should be non-zero to include<br>
all available prefixes, even if they are inapplicable to the current<br>
configuration.  This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2336">::PackageRepository::maybeReadApiKeysFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;::pkgr_api_keys&quot; 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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2358">::PackageRepository::setupRepositoryOpenPgpVars</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;force&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2480">::PackageRepository::setupPackageUnknownVars</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;force&quot;</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>







|














|














|











|









|







|









|









|












|
















|


















|










|











|







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
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1916">::PackageRepository::isPackagePresent</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=1948">::PackageRepository::isPackageAvailable</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2001">::PackageRepository::canDownloadPackage</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2047">::PackageRepository::setupPackageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2087">::PackageRepository::isPackageUnknownHandlerHooked</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2099">::PackageRepository::hookPackageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2117">::PackageRepository::unhookPackageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2133">::PackageRepository::runSavedPackageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;version&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2155">::PackageRepository::packageUnknownHandler</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;package&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument &quot;version&quot; with default value &quot;&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2263">::PackageRepository::getSettingsPrefixes</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;scriptName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;envVarName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;all&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure returns the list of possible prefixes that should be<br>
considered for settings files.  The scriptName parameter is the name<br>
of the script being evaluated, if any.  The envVarName parameter is<br>
the name of an environment variable associated with the script being<br>
evaluated, if any.  The all parameter should be non-zero to include<br>
all available prefixes, even if they are inapplicable to the current<br>
configuration.  This procedure may raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2386">::PackageRepository::maybeReadApiKeysFile</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</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 &quot;::pkgr_api_keys&quot; 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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2408">::PackageRepository::setupRepositoryOpenPgpVars</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;force&quot;</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 &quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle&amp;ln=2530">::PackageRepository::setupPackageUnknownVars</a>&quot;&nbsp;(from&nbsp;&quot;<a href="$ROOT/artifact?ci=trunk&amp;filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>&quot;)</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;force&quot;</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 [08424fbbba] to [c94f6a6c75].

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

iQIcBAABCAAGBQJmAPIjAAoJEFAslq9JXcLZhggQAKSadePmOnh12vbmcU3oukv9
qfOmjO8qX+DCm4ByXxBVDhXJs0YIcheATPes15VY9kkGvgW8HNR8YkuoiokoDrYG
y+Vh9Rbm3pd6BW2EbdTDK83Da8CwCFIrC1uW/Sr/RXwc3LQ9H6t247laN4btslZC
ewrV/NkYla/jDHOTd8mqy8XwBnBTHtCZN5CkkixDDgjfKRSo4Zy/TtJw1xzD6fDo
KVCsklmY0c6E1Sqs4znnKR68W4ckmf2ZuRV3ywn9dLnzis/CJsDhsyHD3deKufeG
ZDlLvZ4mKCGT0ecgIGmSIkNDVKwEKtIdlfqdgTnYWh5SZv02IYkud5oe40N2dTEF
a0aur4sU2VEujyoPWIrPP1zIkAdtRAE6AK5TYokXQpb7VDfB1TYMsaJgmP4FSSLZ
SCajr5sikGgfnFBal+xhZGMubvtlpt8DfFQNqIVO0HTOxtOLGa6ESqpqQGSa36xM
k1YIwePYnGrMaenicZbwCPeA95nNyi47BYfCYCIjC5tyvcVPBVHjasQZAPHyjt9g
q5scv32af2+lCBdl90pzYT355oRnz3QeaQgwFE1FTze+Lgbp7rE+Fgdzf9sila1x
fAG7EIhA4fAFmgSYbMffkRBbkJTAH8i5Nz5PfVPpeR7JGSDsTPSD8BS+tm8fNh6p
OarlfJillorkT+vnn9Mp
=vUL8
-----END PGP SIGNATURE-----




|
|
|
|
|
|
|
|
|
|
|
|
|

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

iQIcBAABCAAGBQJmAQS3AAoJEFAslq9JXcLZMfUQAL6qCJgbBRTuy3t62P4fWTxL
vVW7LGx8rw6TgocXFOh0Eq6v16E9I+37Ib7AdsPmmIm+vZZ+jxBsYQamsLxRvMNb
jqLezFBmai4g3cQ6JbefdgWlbEG11mK3KcjOKC0L+sYk5C3m6lGJugeaE+/zB2ox
dLXC/cT4ZW0i7MWkYvHsC0tJ9iLo5bJvzrSQ6/BL67eT+sD1ohVY9lNcL/0v06KQ
8yEEPGPE0NZZfOHuCnHzDMTjSzzAPItnPgq3SpHMGaQb3SmCDvXhw3TBRR8dqHCh
1nksYz4UrEKul/HM3AVJin8ULY8GUJRStLamtKV6myeSPh3pE24hmnijOV9zYfbl
FKfRWLaQY9Cv6PbrEBejSw6MHVC9Js7zwRdaxV/U+jSQtUygcoyx7sqKQQn2EMLU
aAFTgf4Q7NHagAPKphqKZrsdcbVvzEIfcM0yjDeGViMZicGHSTfh2RkV03mCEnBv
J8v4VqyDU34vUaSyIdFS5yxvhxxbkD3b4WpfiPL4WRGW/lguKIOamkxyyXLTjYs0
Nvoq/V++mXs0cnr0gDWPVh3ujlAlWCDDoYS3XQ8KCLWh+e+vrGkSVHEkW9nW/j9g
mUJYJ0lBYEbvuiAAN3LTPmN3ZkkScnTeTBpKUJFbjt5keBJWrQ0TvxOk0AbgxBb1
l7Ubhp7gnDzpP/G0vrwS
=eNvr
-----END PGP SIGNATURE-----