Index: doc/v1.html
==================================================================
--- doc/v1.html
+++ doc/v1.html
@@ -102,11 +102,11 @@
This procedure modifies the version variables used by the package
downloader client so that a specific version will be used. The
versionId argument must consist only of hexadecimal characters.
-Public API Procedure "::PackageDownloader::resetCookieAndLoginSimple" (from "pkgd.eagle")
+Public API Procedure "::PackageDownloader::resetCookieAndLoginSimple" (from "pkgd.eagle")
This procedure resets the currently configured login cookie, if
any, and then attempts to login using the configured package
repository server API key -OR- using the public access account.
@@ -113,11 +113,11 @@
Upon success, it will set the login cookie to the one from the
raw response data. Upon failure, a script error will be raised.
There are no arguments.
-Public API Procedure "::PackageDownloader::resetCookieAndLogin" (from "pkgd.eagle")
+Public API Procedure "::PackageDownloader::resetCookieAndLogin" (from "pkgd.eagle")
Required argument "userName"
Required argument "password"
@@ -131,19 +131,19 @@
server user with at least Fossil Check-Out (o) permissions on the
package file server. The password argument must be the plaintext
password that is associated with the specified user name.
-Public API Procedure "::PackageDownloader::logoutAndResetCookie" (from "pkgd.eagle")
+Public API Procedure "::PackageDownloader::logoutAndResetCookie" (from "pkgd.eagle")
This procedure attempts to logout using the currently configured
login cookie, if any, and then resets the login cookie. There
are no arguments. This procedure may raise a script error.
-Public API Procedure "::PackageDownloader::checkForHigherVersion" (from "pkgd.eagle")
+Public API Procedure "::PackageDownloader::checkForHigherVersion" (from "pkgd.eagle")
Required argument "language"
Required argument "version"
@@ -169,11 +169,11 @@
directory on the package file server and may be an empty string.
The usePgp argument should be non-zero when an OpenPGP signature
file needs to be downloaded and verified for the downloaded file.
-Public API Procedure "::PackageDownloader::downloadFiles" (from "pkgd.eagle")
+Public API Procedure "::PackageDownloader::downloadFiles" (from "pkgd.eagle")
Required argument "language"
Required argument "version"
@@ -206,10 +206,39 @@
non-zero to modify the auto-path to include the temporary or
persistent directories containing the downloaded files. The
-allowUpdate option should be non-zero to allow existing package
files to be overwritten.
+
+Public API Procedure "::PackageDownloader::maybeAddTemporaryPackagesToAutoPath" (from "pkgd.eagle")
+
+
+ Required argument "language"
+
+ Required argument "options"
+
+ Optional argument "pattern" with default value "*"
+
+
+This procedure adds temporary package directories to the auto-path
+of the specified language (i.e. native Tcl or Eagle). Directories
+will not be added if already present. The language argument must
+be the literal string "eagle" or the literal string "tcl". The
+pattern argument is the optional pattern to match against each of
+the candidate temporary package directories. If the pattern is an
+empty string then all candidate temporary package directories will
+be added to the auto-path; otherwise, the pattern will be matched
+against the final portion of the temporary package directory name
+and only those temporary package directories that actually match
+the pattern will be added to the auto-path. The options argument
+must be a dictionary of name/value pairs. This procedure does not
+currently support any options. This procedure may raise script
+errors. This procedure assumes the local temporary directory is
+writable only by applications that are implicitly trusted by the
+current user. If this assumption does not hold on your platform,
+DO NOT USE THIS PROCEDURE AS IT MAY BE UNSAFE.
+
Internal API Procedure "::PackageDownloader::downloadAndSaveOpenPgpKeyFile" (from "pkgd.eagle")
Required argument "fileName"
@@ -221,11 +250,11 @@
where the downloaded data should be written. This procedure is only
intended to be used from the "pkgr_setup.eagle" tool script and may
go away in later versions of this package.
-Internal API Procedure "::PackageDownloader::verifyPackageName" (from "pkgd.eagle")
+Internal API Procedure "::PackageDownloader::verifyPackageName" (from "pkgd.eagle")
Required argument "packageName"
@@ -232,11 +261,11 @@
This procedure verifies that the specified value is indeed a valid
package name. The packageName argument is the value to verify.
This procedure may raise script errors.
-Internal API Procedure "::PackageDownloader::verifyPackagePatchLevel" (from "pkgd.eagle")
+Internal API Procedure "::PackageDownloader::verifyPackagePatchLevel" (from "pkgd.eagle")
Required argument "patchLevel"
@@ -243,11 +272,11 @@
This procedure verifies that the specified value is indeed a valid
patch level. The patchLevel argument is the value to verify. This
procedure may raise script errors.
-Internal API Procedure "::PackageDownloader::verifyLanguageAndVersion" (from "pkgd.eagle")
+Internal API Procedure "::PackageDownloader::verifyLanguageAndVersion" (from "pkgd.eagle")
Required argument "language"
Required argument "version"
@@ -266,19 +295,19 @@
scalar variable in the context of the immediate caller that will
receive a boolean value indicating if the specified language is
actually a reference to the package downloader client itself.
-Internal API Procedure "::PackageDownloader::getPlatform" (from "pkgd.eagle")
+Internal API Procedure "::PackageDownloader::getPlatform" (from "pkgd.eagle")
This procedure returns the name of the current platform. There are
no arguments. An empty string will be returned if the name of the
current platform cannot be determined for any reason.
-Internal API Procedure "::PackageDownloader::verifyVersionId" (from "pkgd.eagle")
+Internal API Procedure "::PackageDownloader::verifyVersionId" (from "pkgd.eagle")
Required argument "versionId"
@@ -285,11 +314,11 @@
This procedure verifies that the specified value is indeed a valid
version identifier. The versionId argument is the value to verify.
This procedure may raise script errors.
-Internal API Procedure "::PackageDownloader::verifyPlatform" (from "pkgd.eagle")
+Internal API Procedure "::PackageDownloader::verifyPlatform" (from "pkgd.eagle")
Required argument "platform"
Required argument "varName"
@@ -304,11 +333,11 @@
that will receive a modified platform name, if applicable. Upon
failure, a script error will be raised. The return value is
undefined.
-Internal API Procedure "::PackageDownloader::maybeResetCookieAndLoginSimple" (from "pkgd.eagle")
+Internal API Procedure "::PackageDownloader::maybeResetCookieAndLoginSimple" (from "pkgd.eagle")
This procedure attempts to login using the configured package
repository server API key -OR- using the public access account,
if not already logged in. Upon success, it will set the login
@@ -442,11 +471,25 @@
an OpenPGP signature file. The fileName argument is the name of
the file to check, which may or may not exist. The nameOnly
argument should be non-zero to ignore the contents of the file.
-Private Procedure "::PackageDownloader::getAutoPath" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::maybeVerifyOpenPgpSignature" (from "pkgd.eagle")
+
+
+ Required argument "fileName"
+
+ Required argument "forcePgp"
+
+
+This procedure attempts to verify the specified OpenPGP signature
+file. If the forcePgp parameter is non-zero verification will be
+attempted even when the specified file does not appear to be an
+OpenPGP signature file. This procedure may raise script errors.
+
+
+Private Procedure "::PackageDownloader::getAutoPath" (from "pkgd.eagle")
Required argument "language"
@@ -454,11 +497,11 @@
the language argument. An empty list is returned if the auto-path
does not exist in the target language. This procedure may raise
script errors.
-Private Procedure "::PackageDownloader::addToAutoPath" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::addToAutoPath" (from "pkgd.eagle")
Required argument "language"
Required argument "directory"
@@ -470,11 +513,11 @@
literal string "eagle" or the literal string "tcl". The directory
argument is the fully qualified path for the directory to add to
the auto-path.
-Private Procedure "::PackageDownloader::maybeAddToAutoPath" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::maybeAddToAutoPath" (from "pkgd.eagle")
Required argument "language"
Required argument "directory"
@@ -487,40 +530,40 @@
argument is the fully qualified path for the directory to add to
the auto-path. The directory will not be added if it falls under
a directory already in the auto-path.
-Private Procedure "::PackageDownloader::isMonoInstalled" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::isMonoInstalled" (from "pkgd.eagle")
This procedure attempts to verify that an instance of Mono and its
associated runtimes are installed locally. There are no arguments.
The return value is non-zero if Mono appears to be installed and
available for use; otherwise, the return value is zero.
-Private Procedure "::PackageDownloader::isDotNetCoreInstalled" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::isDotNetCoreInstalled" (from "pkgd.eagle")
This procedure attempts to verify that an instance of .NET Core
and its associated runtimes are installed locally. There are no
arguments. The return value is non-zero if Mono appears to be
installed and available for use; otherwise, the return value is
zero.
-Private Procedure "::PackageDownloader::canUseMsilPlatform" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::canUseMsilPlatform" (from "pkgd.eagle")
This procedure attempts to verify that some runtime is available to
run CLR applications locally (e.g. the .NET Framework or Mono JIT).
There are no arguments. The return value is non-zero if it appears
that CLR applications should be runnable locally; otherwise, the
return value is zero.
-Private Procedure "::PackageDownloader::getPackageFile" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::getPackageFile" (from "pkgd.eagle")
Required argument "uri"
Optional argument "allowHtml" with default value "false"
@@ -533,19 +576,19 @@
package file server. The uri argument is the fully qualified URI
to request. The allowHtml argument should be non-zero if raw HTML
should be allowed in the response data.
-Private Procedure "::PackageDownloader::getDownloadVarNamePrefix" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::getDownloadVarNamePrefix" (from "pkgd.eagle")
This procedure returns the prefix for fully qualified variable
names that MAY be present in the global namespace. There are
no arguments.
-Private Procedure "::PackageDownloader::getUniqueTempDirectory" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::getUniqueTempDirectory" (from "pkgd.eagle")
Optional argument "prefix" with default value ""
@@ -553,11 +596,11 @@
more files may be saved. The prefix argument is a prefix for the
directory name and it may be an empty string. There is no attempt
to actually create the resulting directory.
-Private Procedure "::PackageDownloader::createInterp" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::createInterp" (from "pkgd.eagle")
Required argument "varName"
@@ -566,11 +609,11 @@
identified by the varName argument. The created interpreter has a
fully functioning [package] command ensemble; all other commands do
nothing and return nothing. This procedure may raise script errors.
-Private Procedure "::PackageDownloader::getIfNeededVersions" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::getIfNeededVersions" (from "pkgd.eagle")
Required argument "interp"
Required argument "fileName"
@@ -584,11 +627,11 @@
or for a list of versions. The interp argument is the interp to use
when evaluating the file specified by the fileName argument. This
procedure may raise script errors.
-Private Procedure "::PackageDownloader::extractVersionsFromFile" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::extractVersionsFromFile" (from "pkgd.eagle")
Required argument "fileName"
@@ -595,11 +638,11 @@
This procedure attempts to extract a package version information
from the specified file. The fileName argument is the local file
name to read. This procedure may raise script errors.
-Private Procedure "::PackageDownloader::guessPackageNameFromFileNames" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::guessPackageNameFromFileNames" (from "pkgd.eagle")
Required argument "language"
Required argument "fileNames"
@@ -612,11 +655,11 @@
must be the list of file names to be downloaded. The package name,
if one can be detected, is returned; otherwise, an empty string will
be returned.
-Private Procedure "::PackageDownloader::downloadAllPlatforms" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::downloadAllPlatforms" (from "pkgd.eagle")
Required argument "language"
Required argument "version"
@@ -640,11 +683,11 @@
The fileNames argument is the list of file names to be downloaded.
The usePgp argument should be non-zero when an OpenPGP signature
needs to be verified for the downloaded file.
-Private Procedure "::PackageDownloader::downloadOneUriToFile" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::downloadOneUriToFile" (from "pkgd.eagle")
Required argument "localFileName"
Required argument "uri"
@@ -660,11 +703,11 @@
The uri argument is the URI to download. The usePgp argument should
be non-zero when the OpenPGP signature file needs to be verified for
the downloaded file. The return value is undefined.
-Private Procedure "::PackageDownloader::downloadOneFile" (from "pkgd.eagle")
+Private Procedure "::PackageDownloader::downloadOneFile" (from "pkgd.eagle")
Required argument "language"
Required argument "version"
@@ -796,24 +839,23 @@
backend repository servers may be used. The serverId argument
must consist only of alphanumeric characters and it must begin
with a letter.
-Public API Procedure "::PackageRepository::maybeReadSettingsFiles" (from "pkgr.eagle")
+Public API Procedure "::PackageRepository::maybeReadSettingsFiles" (from "pkgr.eagle")
Required argument "script"
-This procedure evaluates the package repository client settings
-script file, if it exists. Any script errors raised are not
-masked. The script argument must be the fully qualified path
-and file name for the primary package repository client script
-file.
+This procedure evaluates package repository client settings script
+files, if they exists. Any script errors raised are not masked.
+The script argument must be the fully qualified path and file name
+for a package client toolset script file.
-Public API Procedure "::PackageRepository::getPackageFromRepository" (from "pkgr.eagle")
+Public API Procedure "::PackageRepository::getPackageFromRepository" (from "pkgr.eagle")
Required argument "package"
Required argument "version"
@@ -1367,11 +1409,30 @@
that conforms to TIP #268. This version argument must be optional
here, because Eagle does not add a version argument when one is
not explicitly supplied to the [package require] sub-command.
-Private Procedure "::PackageRepository::maybeReadApiKeysFile" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::getSettingsPrefixes" (from "pkgr.eagle")
+
+
+ Required argument "scriptName"
+
+ Required argument "envVarName"
+
+ Required argument "all"
+
+
+This procedure returns the list of possible prefixes that should be
+considered for settings files. The scriptName parameter is the name
+of the script being evaluated, if any. The envVarName parameter is
+the name of an environment variable associated with the script being
+evaluated, if any. The all parameter should be non-zero to include
+all available prefixes, even if they are inapplicable to the current
+configuration. This procedure may raise script errors.
+
+
+Private Procedure "::PackageRepository::maybeReadApiKeysFile" (from "pkgr.eagle")
This procedure evaluates a package repository client API keys
script file, if it has been configured -AND- actually exists.
Any script errors raised are not masked. The evaluated script
@@ -1378,11 +1439,11 @@
file should (normally) modify the "::pkgr_api_keys" variable
in order to add API keys for use with the package repository
client.
-Private Procedure "::PackageRepository::setupRepositoryOpenPgpVars" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::setupRepositoryOpenPgpVars" (from "pkgr.eagle")
Required argument "force"
@@ -1390,11 +1451,11 @@
parameters used to interact with the OpenPGP implementation.
If the force argument is non-zero, any existing values will be
overwritten and set back to their default values.
-Private Procedure "::PackageRepository::setupPackageUnknownVars" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::setupPackageUnknownVars" (from "pkgr.eagle")
Required argument "force"