Index: doc/v1.html ================================================================== --- doc/v1.html +++ doc/v1.html @@ -1,8 +1,28 @@

-Private Procedure "setupCommonVariables"
+Public API Procedure "getFileViaHttp" (from "common.tcl")
+
+ +    Required argument "uri"
+ +    Required argument "redirectLimit"
+ +    Required argument "channel"
+ +    Required argument "quiet"
+ +    Optional argument list "args"
+ +

+This procedure was stolen from the "getEagle.tcl" script. It is
+designed to process a single HTTP request, including any HTTP
+3XX redirects (up to the specified limit), and return the raw
+HTTP response data. It may raise any number of script errors.
+


+ +Private Procedure "setupCommonVariables" (from "common.tcl")

    Required argument "force"

@@ -11,11 +31,11 @@ parameters used by this package. If the force argument is
non-zero, any existing values will be overwritten and set back
to their default values.


-Private Procedure "pageOut"
+Private Procedure "pageOut" (from "common.tcl")

    Required argument "channel"
    Required argument "string"
@@ -26,11 +46,11 @@ is the channel where the message should be written. The string
argument is the content of the message to emit. If the channel
argument is an empty string, nothing is written.


-Private Procedure "pageLog"
+Private Procedure "pageLog" (from "common.tcl")

    Required argument "string"

@@ -38,11 +58,11 @@ designed to emit a message to the HTTP client log. The string
argument is the content of the message to emit. If the string
argument is an empty string, nothing is written.


-Private Procedure "pageProgress"
+Private Procedure "pageProgress" (from "common.tcl")

    Required argument "channel"
    Required argument "type"
@@ -58,89 +78,11 @@ argument is the number of milliseconds to wait until the next
periodic progress indicator should be emitted. This procedure
reschedules its own execution.


-Public API Procedure "getFileViaHttp"
-
- -    Required argument "uri"
- -    Required argument "redirectLimit"
- -    Required argument "channel"
- -    Required argument "quiet"
- -    Optional argument list "args"
- -

-This procedure was stolen from the "getEagle.tcl" script. It is
-designed to process a single HTTP request, including any HTTP
-3XX redirects (up to the specified limit), and return the raw
-HTTP response data. It may raise any number of script errors.
-


- -Private Procedure "pkgLog"
-
- -    Required argument "string"
- -

-This procedure emits a message to the package downloader client
-log. The string argument is the content of the message to emit.
-


- -Private Procedure "setupDownloadServerVars"
-
- -    Required argument "force"
- -

-This procedure sets up the default values for all URN configuration
-parameters used by the package downloader client. If the force
-argument is non-zero, any existing values will be overwritten and
-set back to their default values.
-


- -Private Procedure "setupDownloadVersionVars"
-
- -    Required argument "force"
- -

-This procedure sets up the default values for all version
-configuration parameters used by the package downloader client.
-If the force argument is non-zero, any existing values will be
-overwritten and set back to their default values.
-


- -Private Procedure "setupDownloadUriVars"
-
- -    Required argument "force"
- -

-This procedure sets up the default values for all URI configuration
-parameters used by the package downloader client. If the force
-argument is non-zero, any existing values will be overwritten and
-set back to their default values.
-


- -Private Procedure "setupDownloadVars"
-
- -    Required argument "script"
- -

-This procedure sets up the default values for all configuration
-parameters used by the package downloader client. The script
-argument is the fully qualified path and file name for the script
-being evaluated.
-


- -Public API Procedure "useServerId"
+Public API Procedure "useServerId" (from "pkgd.eagle")

    Optional argument "serverId" with default value ""

@@ -149,11 +91,11 @@ backend file servers may be used. The serverId argument must
consist only of alphanumeric characters and it must begin with
a letter.


-Public API Procedure "useVersionId"
+Public API Procedure "useVersionId" (from "pkgd.eagle")

    Optional argument "versionId" with default value ""

@@ -160,262 +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.


-Private Procedure "uriEscape"
-
- -    Required argument "name"
- -    Required argument "value"
- -

-This procedure escapes a single name/value pair for use in a URI
-query string. The name argument is the name of the parameter.
-The value argument is the value of the parameter.
-


- -Private Procedure "getPersistentRootDirectory"
- -

-This procedure returns the root directory where any packages that
-are downloaded should be saved to permanent storage for subsequent
-use. There are no arguments.
-


- -Private Procedure "verifyPersistentRootDirectory"
- -

-This procedure checks the configured persistent root directory for
-downloaded packages. If any checks fail, a script error is raised.
-There are no arguments. The return value is undefined.
-


- -Private Procedure "getPackageIndexFileName"
-
- -    Required argument "language"
- -

-This procedure returns the name of the package index file for the
-language specified by the language argument. An empty string will
-be returned if the language is unsupported or unrecognized.
-


- -Private Procedure "maybeCreateMasterTclPackageIndex"
- -

-This procedure, which is only used for native Tcl, generates a
-"master" package index file (i.e. "pkgIndex.tcl") suitable for
-use with native Tcl 8.4 (or higher). It will recursively scan
-for all other native Tcl package index files that are within the
-configured persistent root directory and [source] them, thereby
-causing all packages located within them to become available.
-Since Eagle (by default) already performs recursive searches for
-its package index files, this procedure is not needed for Eagle.
-The return value is undefined.
-


- -Internal API Procedure "downloadAndSaveOpenPgpKeyFile"
-
- -    Required argument "fileName"
- -

-This procedure attempts to download the Package Signing Keys from
-the remote server and save it to a local file. This procedure may
-raise script errors. The fileName argument is the name of the file
-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.
-


- -Private Procedure "isOpenPgpSignatureFileName"
-
- -    Required argument "fileName"
- -    Required argument "nameOnly"
- -

-This procedure returns non-zero if the specified file seems to be
-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 "getAutoPath"
-
- -    Required argument "language"
- -

-This procedure returns the auto-path for the language specified by
-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 "addToAutoPath"
-
- -    Required argument "language"
- -    Required argument "directory"
- -

-This procedure adds a directory to the auto-path of the specified
-language (i.e. native Tcl or Eagle). The directory will not be
-added if it is already present. The language argument must be the
-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 "maybeAddToAutoPath"
-
- -    Required argument "language"
- -    Required argument "directory"
- -

-This procedure adds a directory to the auto-path of the specified
-language (i.e. native Tcl or Eagle). The directory will not be
-added if it is already present. The language argument must be the
-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. The directory will not be added if it falls under
-a directory already in the auto-path.
-


- -Private Procedure "isMonoInstalled"
- -

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

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


- -Internal API Procedure "verifyPackageName"
-
- -    Required argument "packageName"
- -

-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 "verifyPackagePatchLevel"
-
- -    Required argument "patchLevel"
- -

-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 "verifyLanguageAndVersion"
-
- -    Required argument "language"
- -    Required argument "version"
- -    Required argument "varName"
- -

-This procedure verifies the combination of language and version
-specified by the caller. The language argument must be one of the
-literal strings "eagle", "tcl", or "client". The version argument
-must be one of the literal strings "8.4", "8.5", or "8.6" when the
-language is "tcl" -OR- the literal string "1.0" when the language
-is "eagle". When the language is "client", the version match the
-major and minor portions of "1.0" and any remaining portions must
-be numeric. The varName argument is the name of a 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 "getPlatform"
- -

-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 "verifyVersionId"
-
- -    Required argument "versionId"
- -

-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 "verifyPlatform"
-
- -    Required argument "platform"
- -    Required argument "varName"
- -

-This procedure verifies the platform specified by the caller. The
-platform argument must be an empty string -OR- one of the literal
-strings "msil" or "neutral", or one of the values returned by the
-[getPlatform] procedure. An empty string means that the associated
-entity does not require a specific platform. The varName argument
-is the name of a variable in the context of the immediate caller
-that will receive a modified platform name, if applicable. Upon
-failure, a script error will be raised. The return value is
-undefined.
-


- -Private Procedure "getPackageFile"
-
- -    Required argument "uri"
- -

-This procedure issues a request to an HTTP(S) server. It returns
-the raw response data verbatim. It may raise a script error. It
-will always use the currently configured HTTP(S) login cookie, if
-any; therefore, it should really only be used for requests to the
-package file server. The uri argument is the fully qualified URI
-to request.
-


- -Private Procedure "getDownloadVarNamePrefix"
- -

-This procedure returns the prefix for fully qualified variable
-names that MAY be present in the global namespace. There are
-no arguments.
-


- -Public API Procedure "resetCookieAndLoginSimple"
+Public API Procedure "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.
@@ -422,21 +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.


-Internal API Procedure "maybeResetCookieAndLoginSimple"
- -

-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
-cookie to the one from the raw response data. Upon failure, a
-script error will be raised. There are no arguments.
-


- -Public API Procedure "resetCookieAndLogin"
+Public API Procedure "resetCookieAndLogin" (from "pkgd.eagle")

    Required argument "userName"
    Required argument "password"
@@ -450,31 +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 "logoutAndResetCookie"
+Public API Procedure "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.


-Private Procedure "getUniqueTempDirectory"
-
- -    Optional argument "prefix" with default value ""
- -

-This procedure returns a unique temporary directory where one or
-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.
-


- -Public API Procedure "checkForHigherVersion"
+Public API Procedure "checkForHigherVersion" (from "pkgd.eagle")

    Required argument "language"
    Required argument "version"
@@ -500,113 +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.


-Private Procedure "guessPackageNameFromFileNames"
-
- -    Required argument "language"
- -    Required argument "fileNames"
- -

-This procedure attempts to guess a package name based on a list of
-its files. It relies upon the fact that all packages must include
-a package index file. The language argument must be one of the
-literal strings "eagle", "tcl", or "client". The fileNames argument
-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 "downloadAllPlatforms"
-
- -    Required argument "language"
- -    Required argument "version"
- -    Required argument "packageName"
- -    Required argument "fileNames"
- -    Required argument "usePgp"
- -

-This procedure downloads a manitest from the package file server,
-writing its contents to the specified local file name. It can also
-verify the OpenPGP signature. The language argument must be one of
-the literal strings "eagle", "tcl", or "client". The version
-argument must be one of the literal strings "8.4", "8.5", or "8.6"
-when the language is "tcl" -OR- the literal string "1.0" when the
-language is either "eagle" or "client". The packageName argument
-is a directory name relative to the language and version-specific
-directory on the package file server and may be an empty string.
-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 "downloadOneUriToFile"
-
- -    Required argument "localFileName"
- -    Required argument "uri"
- -    Required argument "usePgp"
- -    Required argument "forcePgp"
- -

-This procedure downloads a single URI from the package file server
-and writes the result to a local file. The localFileName argument
-is the file name where the downloaded file should be written. The
-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 "downloadOneFile"
-
- -    Required argument "language"
- -    Required argument "version"
- -    Required argument "platform"
- -    Required argument "fileName"
- -    Required argument "localFileName"
- -    Required argument "usePgp"
- -

-This procedure downloads a single file from the package file server,
-writing its contents to the specified local file name. It can also
-verify the OpenPGP signatures. When an OpenPGP signature file is
-downloaded, this procedure assumes the corresponding data file was
-already downloaded (i.e. since OpenPGP needs both to perform the
-signature checks). The language argument must be one of the
-literal strings "eagle", "tcl", or "client". The version argument
-must be one of the literal strings "8.4", "8.5", or "8.6" when the
-language is "tcl" -OR- the literal string "1.0" when the language
-is either "eagle" or "client". The platform argument must be an
-empty string -OR- one of the literal strings "msil" or "neutral", or
-one of the values returned by the [getPlatform] procedure. An empty
-string means that the associated package does not require a specific
-platform. The fileName argument is a file name relative to the
-language and version-specific directory on the package file server.
-The localFileName argument is the file name where the downloaded
-file should be written. The usePgp argument should be non-zero when
-the OpenPGP signature file needs to be verified for the downloaded
-file.
-


- -Public API Procedure "downloadFiles"
+Public API Procedure "downloadFiles" (from "pkgd.eagle")

    Required argument "language"
    Required argument "version"
@@ -640,95 +207,444 @@ persistent directories containing the downloaded files. The
-allowUpdate option should be non-zero to allow existing package
files to be overwritten.


-Private Procedure "setupRepositoryServerVars"
+Internal API Procedure "downloadAndSaveOpenPgpKeyFile" (from "pkgd.eagle")
+
+ +    Required argument "fileName"
+ +

+This procedure attempts to download the Package Signing Keys from
+the remote server and save it to a local file. This procedure may
+raise script errors. The fileName argument is the name of the file
+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 "verifyPackageName" (from "pkgd.eagle")
+
+ +    Required argument "packageName"
+ +

+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 "verifyPackagePatchLevel" (from "pkgd.eagle")
+
+ +    Required argument "patchLevel"
+ +

+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 "verifyLanguageAndVersion" (from "pkgd.eagle")
+
+ +    Required argument "language"
+ +    Required argument "version"
+ +    Required argument "varName"
+ +

+This procedure verifies the combination of language and version
+specified by the caller. The language argument must be one of the
+literal strings "eagle", "tcl", or "client". The version argument
+must be one of the literal strings "8.4", "8.5", or "8.6" when the
+language is "tcl" -OR- the literal string "1.0" when the language
+is "eagle". When the language is "client", the version match the
+major and minor portions of "1.0" and any remaining portions must
+be numeric. The varName argument is the name of a 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 "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 "verifyVersionId" (from "pkgd.eagle")
+
+ +    Required argument "versionId"
+ +

+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 "verifyPlatform" (from "pkgd.eagle")
+
+ +    Required argument "platform"
+ +    Required argument "varName"
+ +

+This procedure verifies the platform specified by the caller. The
+platform argument must be an empty string -OR- one of the literal
+strings "msil" or "neutral", or one of the values returned by the
+[getPlatform] procedure. An empty string means that the associated
+entity does not require a specific platform. The varName argument
+is the name of a variable in the context of the immediate caller
+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 "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
+cookie to the one from the raw response data. Upon failure, a
+script error will be raised. There are no arguments.
+


+ +Private Procedure "pkgLog" (from "pkgd.eagle")
+
+ +    Required argument "string"
+ +

+This procedure emits a message to the package downloader client
+log. The string argument is the content of the message to emit.
+


+ +Private Procedure "setupDownloadServerVars" (from "pkgd.eagle")

    Required argument "force"

This procedure sets up the default values for all URN configuration
-parameters used by the package repository client. If the force
+parameters used by the package downloader client. If the force
argument is non-zero, any existing values will be overwritten and
set back to their default values.


-Private Procedure "setupRepositoryUriVars"
+Private Procedure "setupDownloadVersionVars" (from "pkgd.eagle")
+
+ +    Required argument "force"
+ +

+This procedure sets up the default values for all version
+configuration parameters used by the package downloader client.
+If the force argument is non-zero, any existing values will be
+overwritten and set back to their default values.
+


+ +Private Procedure "setupDownloadUriVars" (from "pkgd.eagle")

    Required argument "force"

This procedure sets up the default values for all URI configuration
-parameters used by the package repository client. If the force
+parameters used by the package downloader client. If the force
argument is non-zero, any existing values will be overwritten and
set back to their default values.


-Internal API Procedure "formatExecArgument"
-
- -    Required argument "value"
- -

-This procedure returns a string argument value, which may contain
-spaces, for use with the [exec] command. The value argument is
-the string value to format as an [exec] argument.
-


- -Private Procedure "formatPackageName"
-
- -    Required argument "package"
- -    Required argument "version"
- -

-This procedure returns a formatted, possibly version-specific,
-package name, for use in logging. The package argument is the
-name of the package. The version argument is the version of the
-package.
-


- -Private Procedure "formatResult"
-
- -    Required argument "code"
- -    Required argument "result"
- -

-This procedure returns a formatted script result. If the string
-result is empty, only the return code is used. The code argument
-must be an integer Tcl return code (e.g. from [catch]) and the
-result argument is the script result or error message.
-


- -Private Procedure "pkgLog"
-
- -    Required argument "string"
- -

-This procedure emits a message to the package repository client
-log. The string argument is the content of the message to emit.
-


- -Private Procedure "stringIsList"
-
- -    Required argument "value"
- -

-This procedure attempts to determine if a string is a valid list
-and returns non-zero when that is true. The value argument is
-the string to check.
-


- -Public API Procedure "isHarpyCertificate"
+Private Procedure "setupDownloadVars" (from "pkgd.eagle")
+
+ +    Required argument "script"
+ +

+This procedure sets up the default values for all configuration
+parameters used by the package downloader client. The script
+argument is the fully qualified path and file name for the script
+being evaluated.
+


+ +Private Procedure "uriEscape" (from "pkgd.eagle")
+
+ +    Required argument "name"
+ +    Required argument "value"
+ +

+This procedure escapes a single name/value pair for use in a URI
+query string. The name argument is the name of the parameter.
+The value argument is the value of the parameter.
+


+ +Private Procedure "getPersistentRootDirectory" (from "pkgd.eagle")
+ +

+This procedure returns the root directory where any packages that
+are downloaded should be saved to permanent storage for subsequent
+use. There are no arguments.
+


+ +Private Procedure "verifyPersistentRootDirectory" (from "pkgd.eagle")
+ +

+This procedure checks the configured persistent root directory for
+downloaded packages. If any checks fail, a script error is raised.
+There are no arguments. The return value is undefined.
+


+ +Private Procedure "getPackageIndexFileName" (from "pkgd.eagle")
+
+ +    Required argument "language"
+ +

+This procedure returns the name of the package index file for the
+language specified by the language argument. An empty string will
+be returned if the language is unsupported or unrecognized.
+


+ +Private Procedure "maybeCreateMasterTclPackageIndex" (from "pkgd.eagle")
+ +

+This procedure, which is only used for native Tcl, generates a
+"master" package index file (i.e. "pkgIndex.tcl") suitable for
+use with native Tcl 8.4 (or higher). It will recursively scan
+for all other native Tcl package index files that are within the
+configured persistent root directory and [source] them, thereby
+causing all packages located within them to become available.
+Since Eagle (by default) already performs recursive searches for
+its package index files, this procedure is not needed for Eagle.
+The return value is undefined.
+


+ +Private Procedure "isOpenPgpSignatureFileName" (from "pkgd.eagle")
+
+ +    Required argument "fileName"
+ +    Required argument "nameOnly"
+ +

+This procedure returns non-zero if the specified file seems to be
+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 "getAutoPath" (from "pkgd.eagle")
+
+ +    Required argument "language"
+ +

+This procedure returns the auto-path for the language specified by
+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 "addToAutoPath" (from "pkgd.eagle")
+
+ +    Required argument "language"
+ +    Required argument "directory"
+ +

+This procedure adds a directory to the auto-path of the specified
+language (i.e. native Tcl or Eagle). The directory will not be
+added if it is already present. The language argument must be the
+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 "maybeAddToAutoPath" (from "pkgd.eagle")
+
+ +    Required argument "language"
+ +    Required argument "directory"
+ +

+This procedure adds a directory to the auto-path of the specified
+language (i.e. native Tcl or Eagle). The directory will not be
+added if it is already present. The language argument must be the
+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. The directory will not be added if it falls under
+a directory already in the auto-path.
+


+ +Private Procedure "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 "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 "getPackageFile" (from "pkgd.eagle")
+
+ +    Required argument "uri"
+ +

+This procedure issues a request to an HTTP(S) server. It returns
+the raw response data verbatim. It may raise a script error. It
+will always use the currently configured HTTP(S) login cookie, if
+any; therefore, it should really only be used for requests to the
+package file server. The uri argument is the fully qualified URI
+to request.
+


+ +Private Procedure "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 "getUniqueTempDirectory" (from "pkgd.eagle")
+
+ +    Optional argument "prefix" with default value ""
+ +

+This procedure returns a unique temporary directory where one or
+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 "guessPackageNameFromFileNames" (from "pkgd.eagle")
+
+ +    Required argument "language"
+ +    Required argument "fileNames"
+ +

+This procedure attempts to guess a package name based on a list of
+its files. It relies upon the fact that all packages must include
+a package index file. The language argument must be one of the
+literal strings "eagle", "tcl", or "client". The fileNames argument
+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 "downloadAllPlatforms" (from "pkgd.eagle")
+
+ +    Required argument "language"
+ +    Required argument "version"
+ +    Required argument "packageName"
+ +    Required argument "fileNames"
+ +    Required argument "usePgp"
+ +

+This procedure downloads a manitest from the package file server,
+writing its contents to the specified local file name. It can also
+verify the OpenPGP signature. The language argument must be one of
+the literal strings "eagle", "tcl", or "client". The version
+argument must be one of the literal strings "8.4", "8.5", or "8.6"
+when the language is "tcl" -OR- the literal string "1.0" when the
+language is either "eagle" or "client". The packageName argument
+is a directory name relative to the language and version-specific
+directory on the package file server and may be an empty string.
+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 "downloadOneUriToFile" (from "pkgd.eagle")
+
+ +    Required argument "localFileName"
+ +    Required argument "uri"
+ +    Required argument "usePgp"
+ +    Required argument "forcePgp"
+ +

+This procedure downloads a single URI from the package file server
+and writes the result to a local file. The localFileName argument
+is the file name where the downloaded file should be written. The
+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 "downloadOneFile" (from "pkgd.eagle")
+
+ +    Required argument "language"
+ +    Required argument "version"
+ +    Required argument "platform"
+ +    Required argument "fileName"
+ +    Required argument "localFileName"
+ +    Required argument "usePgp"
+ +

+This procedure downloads a single file from the package file server,
+writing its contents to the specified local file name. It can also
+verify the OpenPGP signatures. When an OpenPGP signature file is
+downloaded, this procedure assumes the corresponding data file was
+already downloaded (i.e. since OpenPGP needs both to perform the
+signature checks). The language argument must be one of the
+literal strings "eagle", "tcl", or "client". The version argument
+must be one of the literal strings "8.4", "8.5", or "8.6" when the
+language is "tcl" -OR- the literal string "1.0" when the language
+is either "eagle" or "client". The platform argument must be an
+empty string -OR- one of the literal strings "msil" or "neutral", or
+one of the values returned by the [getPlatform] procedure. An empty
+string means that the associated package does not require a specific
+platform. The fileName argument is a file name relative to the
+language and version-specific directory on the package file server.
+The localFileName argument is the file name where the downloaded
+file should be written. The usePgp argument should be non-zero when
+the OpenPGP signature file needs to be verified for the downloaded
+file.
+


+ +Public API Procedure "isHarpyCertificate" (from "pkgr.eagle")

    Required argument "value"

@@ -736,11 +652,11 @@ looks like a Harpy (script) certificate. The value argument is
the string to check. The value 14 used within this procedure is
the length of the literal string "</Certificate>".


-Public API Procedure "isOpenPgpSignature"
+Public API Procedure "isOpenPgpSignature" (from "pkgr.eagle")

    Required argument "value"

@@ -748,11 +664,11 @@ looks like an OpenPGP signature. The value argument is the string
to check. The value 27 used within this procedure is the length
of the literal string "-----END PGP SIGNATURE-----".


-Public API Procedure "getFileTempDirectory"
+Public API Procedure "getFileTempDirectory" (from "pkgr.eagle")

    Optional argument "envVarName" with default value ""

@@ -759,40 +675,20 @@ This procedure returns the fully qualified name of the directory
where temporary files should be written. The envVarName argument
is an optional extra environment variable to check (first).


-Private Procedure "getFileTempName"
- -

-This procedure returns a unique temporary file name. A script
-error is raised if this task cannot be accomplished. There are
-no arguments.
-


- -Internal API Procedure "probeForOpenPgpInstallation"
- -

-This procedure attempts to check for an OpenPGP installation being
-installed at the default location. There are no arguments. If the
-OpenPGP installation is detected and is not yet present in the PATH,
-an attempt will be made to add it. Non-zero will be returned if the
-OpenPGP installation directory was successfully detected and added
-to the PATH -OR- detecting and adding it was not necessary because
-it already appeared to be available for use.
-


- -Public API Procedure "openPgpMustBeInstalled"
+Public API Procedure "openPgpMustBeInstalled" (from "pkgr.eagle")

This procedure attempts to verify that a configured implementation
of OpenPGP is installed locally. There are no arguments. Script
errors are raised if any problems are found. The return value is
undefined.


-Public API Procedure "verifyOpenPgpSignature"
+Public API Procedure "verifyOpenPgpSignature" (from "pkgr.eagle")

    Required argument "fileName"

@@ -802,19 +698,107 @@ not be raised by this procedure. The fileName argument must be
the fully qualified path and file name of the OpenPGP signature
file to verify.


-Private Procedure "getOpenPgpPassphraseFile"
+Public API Procedure "createOpenPgpSignature" (from "pkgr.eagle")
+
+ +    Required argument "fileName"

-This procedure returns the name of the file containing the OpenPGP
-passphrase. This procedure is only used when creating an OpenPGP
-signature. There are no arguments.
+This procedure attempts to create an OpenPGP signature for the
+specified (named) file. Non-zero is only returned if the OpenPGP
+signature is created successfully. A script error should not be
+raised by this procedure. The fileName argument must be the fully
+qualified path and file name of the file to be signed.


-Internal API Procedure "createHarpyCertificate"
+Public API Procedure "getUniqueSuffix" (from "pkgr.eagle")
+
+ +    Optional argument "paranoia" with default value "1"
+ +

+This procedure returns a name suffix (directory, variable, etc)
+that is unique to the running process at the current point in
+time. It is used (internally) to avoid name collisions with any
+preexisting variables or commands that may be present in the
+global namespace. The paranoia argument represents the relative
+level of paranoia required by the caller; the higher this level,
+the more uniqueness is required.
+


+ +Public API Procedure "useServerId" (from "pkgr.eagle")
+
+ +    Optional argument "serverId" with default value ""
+ +

+This procedure modifies the URN variables used by the package
+repository client so that one or more alternative (private?)
+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 "maybeReadSettingsFile" (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.
+


+ +Public API Procedure "getPackageFromRepository" (from "pkgr.eagle")
+
+ +    Required argument "package"
+ +    Required argument "version"
+ +    Required argument "caller"
+ +

+This procedure is the primary entry point to the package repository
+client. It attempts to lookup the specified package using the
+currently configured package repository server. The package
+argument is the name of the package being sought, it cannot be an
+empty string. The version argument must be a specific version -OR-
+a package specification that conforms to TIP #268. The caller
+argument must be an empty string -OR- the literal string "handler".
+


+ +Internal API Procedure "formatExecArgument" (from "pkgr.eagle")
+
+ +    Required argument "value"
+ +

+This procedure returns a string argument value, which may contain
+spaces, for use with the [exec] command. The value argument is
+the string value to format as an [exec] argument.
+


+ +Internal API Procedure "probeForOpenPgpInstallation" (from "pkgr.eagle")
+ +

+This procedure attempts to check for an OpenPGP installation being
+installed at the default location. There are no arguments. If the
+OpenPGP installation is detected and is not yet present in the PATH,
+an attempt will be made to add it. Non-zero will be returned if the
+OpenPGP installation directory was successfully detected and added
+to the PATH -OR- detecting and adding it was not necessary because
+it already appeared to be available for use.
+


+ +Internal API Procedure "createHarpyCertificate" (from "pkgr.eagle")

    Required argument "fileName"

@@ -825,24 +809,11 @@ fully qualified path and file name of the file to be signed. This
procedure assumes that the Harpy package for Eagle is installed and
ready for use (i.e. it can find a valid license certificate).


-Public API Procedure "createOpenPgpSignature"
-
- -    Required argument "fileName"
- -

-This procedure attempts to create an OpenPGP signature for the
-specified (named) file. Non-zero is only returned if the OpenPGP
-signature is created successfully. A script error should not be
-raised by this procedure. The fileName argument must be the fully
-qualified path and file name of the file to be signed.
-


- -Internal API Procedure "importOpenPgpKeyFile"
+Internal API Procedure "importOpenPgpKeyFile" (from "pkgr.eagle")

    Required argument "fileName"
    Required argument "varName"
@@ -856,34 +827,11 @@ to import. 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.


-Private Procedure "getLookupVarNamePrefix"
- -

-This procedure returns the prefix for fully qualified variable
-names that MAY be present in the global namespace. There are
-no arguments.
-


- -Public API Procedure "getUniqueSuffix"
-
- -    Optional argument "paranoia" with default value "1"
- -

-This procedure returns a name suffix (directory, variable, etc)
-that is unique to the running process at the current point in
-time. It is used (internally) to avoid name collisions with any
-preexisting variables or commands that may be present in the
-global namespace. The paranoia argument represents the relative
-level of paranoia required by the caller; the higher this level,
-the more uniqueness is required.
-


- -Internal API Procedure "getApiKeys"
+Internal API Procedure "getApiKeys" (from "pkgr.eagle")

    Optional argument "prefix" with default value ""
    Optional argument "prefixOnly" with default value "false"
@@ -896,11 +844,11 @@ that are already configured. The prefixOnly argument should be
non-zero to exclude any API keys other than those based on the
prefix specified by the caller.


-Internal API Procedure "verifyMetadataLanguage"
+Internal API Procedure "verifyMetadataLanguage" (from "pkgr.eagle")

    Required argument "language"

@@ -907,11 +855,11 @@ This procedure verifies the language specified by the caller. The
language argument must be an empty string -OR- the literal string
"Eagle" or "Tcl". This procedure may raise script errors.


-Internal API Procedure "verifyServerId"
+Internal API Procedure "verifyServerId" (from "pkgr.eagle")

    Required argument "serverId"

@@ -918,40 +866,181 @@ This procedure verifies that the specified value is indeed a valid
server identifier. The serverId argument is the value to verify.
This procedure may raise script errors.


-Public API Procedure "useServerId"
-
- -    Optional argument "serverId" with default value ""
- -

-This procedure modifies the URN variables used by the package
-repository client so that one or more alternative (private?)
-backend repository servers may be used. The serverId argument
-must consist only of alphanumeric characters and it must begin
-with a letter.
-


- -Private Procedure "getLookupBaseUri"
- -

-This procedure returns the base URI for the package repository
-server endpoint that is used to lookup packages. There are no
-arguments.
-


- -Internal API Procedure "getSubmitBaseUri"
+Internal API Procedure "getSubmitBaseUri" (from "pkgr.eagle")

This procedure returns the base URI for the package repository
server endpoint that is used to submit packages. There are no
arguments.


-Private Procedure "getLookupUri"
+Internal API Procedure "getResponseCodeFromRawData" (from "pkgr.eagle")
+
+ +    Required argument "data"
+ +

+This procedure attempts to extract the lookup code from the raw
+HTTP response data. The data argument is the raw HTTP response
+data. An empty string is returned if no lookup code is available.
+


+ +Internal API Procedure "getResponseResultFromRawData" (from "pkgr.eagle")
+
+ +    Required argument "data"
+ +

+This procedure attempts to extract the lookup result from the raw
+HTTP response data. The data argument is the raw HTTP response
+data. An empty string is returned if no lookup result is available.
+


+ +Internal API Procedure "isResponseCodeOk" (from "pkgr.eagle")
+
+ +    Required argument "code"
+ +

+This procedure returns non-zero if the specified lookup response
+code indicates success. The code argument is the extracted HTTP
+lookup response code.
+


+ +Internal API Procedure "makeTclReady" (from "pkgr.eagle")
+ +

+This procedure is designed for Eagle. It attempts to load the
+"best" native Tcl library. It may raise any number of script
+errors. There are no arguments.
+


+ +Internal API Procedure "eagleMustBeReady" (from "pkgr.eagle")
+ +

+This procedure, which may only be used from a native Tcl script,
+checks if Garuda and Eagle are loaded and ready. If not, a script
+error is raised. There are no arguments.
+


+ +Internal API Procedure "makeEagleReady" (from "pkgr.eagle")
+ +

+This procedure is designed for native Tcl. It attempts to load
+the Garuda package and gain access to Eagle. It may raise any
+number of script errors. There are no arguments.
+


+ +Private Procedure "setupRepositoryServerVars" (from "pkgr.eagle")
+
+ +    Required argument "force"
+ +

+This procedure sets up the default values for all URN configuration
+parameters used by the package repository client. If the force
+argument is non-zero, any existing values will be overwritten and
+set back to their default values.
+


+ +Private Procedure "setupRepositoryUriVars" (from "pkgr.eagle")
+
+ +    Required argument "force"
+ +

+This procedure sets up the default values for all URI configuration
+parameters used by the package repository client. If the force
+argument is non-zero, any existing values will be overwritten and
+set back to their default values.
+


+ +Private Procedure "formatPackageName" (from "pkgr.eagle")
+
+ +    Required argument "package"
+ +    Required argument "version"
+ +

+This procedure returns a formatted, possibly version-specific,
+package name, for use in logging. The package argument is the
+name of the package. The version argument is the version of the
+package.
+


+ +Private Procedure "formatResult" (from "pkgr.eagle")
+
+ +    Required argument "code"
+ +    Required argument "result"
+ +

+This procedure returns a formatted script result. If the string
+result is empty, only the return code is used. The code argument
+must be an integer Tcl return code (e.g. from [catch]) and the
+result argument is the script result or error message.
+


+ +Private Procedure "pkgLog" (from "pkgr.eagle")
+
+ +    Required argument "string"
+ +

+This procedure emits a message to the package repository client
+log. The string argument is the content of the message to emit.
+


+ +Private Procedure "stringIsList" (from "pkgr.eagle")
+
+ +    Required argument "value"
+ +

+This procedure attempts to determine if a string is a valid list
+and returns non-zero when that is true. The value argument is
+the string to check.
+


+ +Private Procedure "getFileTempName" (from "pkgr.eagle")
+ +

+This procedure returns a unique temporary file name. A script
+error is raised if this task cannot be accomplished. There are
+no arguments.
+


+ +Private Procedure "getOpenPgpPassphraseFile" (from "pkgr.eagle")
+ +

+This procedure returns the name of the file containing the OpenPGP
+passphrase. This procedure is only used when creating an OpenPGP
+signature. There are no arguments.
+


+ +Private Procedure "getLookupVarNamePrefix" (from "pkgr.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 "getLookupBaseUri" (from "pkgr.eagle")
+ +

+This procedure returns the base URI for the package repository
+server endpoint that is used to lookup packages. There are no
+arguments.
+


+ +Private Procedure "getLookupUri" (from "pkgr.eagle")

    Required argument "apiKeys"
    Required argument "package"
@@ -968,11 +1057,11 @@ looked up -OR- an empty string for any available version. There
are no HTTP requests issued by this procedure; it simply returns
the URI to use.


-Private Procedure "getIfNeededVersion"
+Private Procedure "getIfNeededVersion" (from "pkgr.eagle")

    Required argument "package"
    Required argument "version"
@@ -984,11 +1073,11 @@ the name of the package, it cannot be an empty string. The
version argument is the specific version being looked up -OR- an
empty string for any available version.


-Private Procedure "packageRequirementToVersion"
+Private Procedure "packageRequirementToVersion" (from "pkgr.eagle")

    Required argument "requirement"

@@ -997,11 +1086,11 @@ returned, if appropriate (i.e. any version should be allowed).
The requirement argument must be a package specification that
conforms to TIP #268.


-Private Procedure "getLookupData"
+Private Procedure "getLookupData" (from "pkgr.eagle")

    Required argument "apiKeys"
    Required argument "package"
@@ -1018,44 +1107,11 @@ empty string for any available version. This procedure may raise
script errors. All line-endings are normalized to Unix-style;
therefore, all script signatures must assume this.


-Internal API Procedure "getResponseCodeFromRawData"
-
- -    Required argument "data"
- -

-This procedure attempts to extract the lookup code from the raw
-HTTP response data. The data argument is the raw HTTP response
-data. An empty string is returned if no lookup code is available.
-


- -Internal API Procedure "getResponseResultFromRawData"
-
- -    Required argument "data"
- -

-This procedure attempts to extract the lookup result from the raw
-HTTP response data. The data argument is the raw HTTP response
-data. An empty string is returned if no lookup result is available.
-


- -Internal API Procedure "isResponseCodeOk"
-
- -    Required argument "code"
- -

-This procedure returns non-zero if the specified lookup response
-code indicates success. The code argument is the extracted HTTP
-lookup response code.
-


- -Private Procedure "isValidPackageRequirement"
+Private Procedure "isValidPackageRequirement" (from "pkgr.eagle")

    Required argument "requirement"
    Required argument "rangeOk"
@@ -1074,11 +1130,11 @@ considered to be valid by the caller. The rangeOk argument should
be non-zero if the version range syntax is allowed; this argument is
ignored for Eagle because it requires TIP #268 support.


-Private Procedure "extractAndVerifyLookupMetadata"
+Private Procedure "extractAndVerifyLookupMetadata" (from "pkgr.eagle")

    Required argument "result"
    Required argument "varName"
@@ -1092,51 +1148,27 @@ of the immediate caller, that should receive the extracted package
lookup metadata. The caller argument must be an empty string -OR-
the literal string "handler".


-Private Procedure "tclMustBeReady"
+Private Procedure "tclMustBeReady" (from "pkgr.eagle")

This procedure, which may only be used from an Eagle script, checks
if a native Tcl library is loaded and ready. If not, a script error
is raised. There are no arguments.


-Internal API Procedure "makeTclReady"
- -

-This procedure is designed for Eagle. It attempts to load the
-"best" native Tcl library. It may raise any number of script
-errors. There are no arguments.
-


- -Internal API Procedure "eagleMustBeReady"
- -

-This procedure, which may only be used from a native Tcl script,
-checks if Garuda and Eagle are loaded and ready. If not, a script
-error is raised. There are no arguments.
-


- -Internal API Procedure "makeEagleReady"
- -

-This procedure is designed for native Tcl. It attempts to load
-the Garuda package and gain access to Eagle. It may raise any
-number of script errors. There are no arguments.
-


- -Private Procedure "eagleHasSecurity"
+Private Procedure "eagleHasSecurity" (from "pkgr.eagle")

This procedure returns non-zero if the current script is being
evaluated in Eagle with signed-only script security enabled.
There are no arguments.


-Private Procedure "processLookupMetadata"
+Private Procedure "processLookupMetadata" (from "pkgr.eagle")

    Required argument "varName"

@@ -1154,11 +1186,11 @@ is the name of an array variable in the call frame of the
immediate caller, that contains the package lookup metadata. This
procedure may raise script errors.


-Private Procedure "isPackagePresent"
+Private Procedure "isPackagePresent" (from "pkgr.eagle")

    Required argument "package"
    Required argument "version"
@@ -1169,11 +1201,11 @@ sought, it cannot be an empty string. The version argument must be
a specific version -OR- a package specification that conforms to TIP
#268.


-Private Procedure "isPackageAvailable"
+Private Procedure "isPackageAvailable" (from "pkgr.eagle")

    Required argument "package"
    Required argument "version"
@@ -1184,11 +1216,11 @@ sought, it cannot be an empty string. The version argument must be
a specific version -OR- a package specification that conforms to TIP
#268.


-Private Procedure "canDownloadPackage"
+Private Procedure "canDownloadPackage" (from "pkgr.eagle")

    Required argument "package"

@@ -1196,49 +1228,49 @@ downloaded, i.e. because it is not required for the downloading
process itself to be functional, etc. The package argument is
the name of the package to check.


-Private Procedure "setupPackageUnknownHandler"
+Private Procedure "setupPackageUnknownHandler" (from "pkgr.eagle")

This procedure performs initial setup of the package repository
client, using the current configuration parameters. There are
no arguments. It may load the Garuda package when evaluated in
native Tcl. It may load a native Tcl library when evaluated in
Eagle. It may install the [package unknown] hook.


-Private Procedure "isPackageUnknownHandlerHooked"
+Private Procedure "isPackageUnknownHandlerHooked" (from "pkgr.eagle")

This procedure returns non-zero if the [package unknown] handler
has already been hooked by the package repository client. There
are no arguments.


-Private Procedure "hookPackageUnknownHandler"
+Private Procedure "hookPackageUnknownHandler" (from "pkgr.eagle")

This procedure attempts to hook the [package unknown] handler. It
will raise a script error if this has already been done. The old
[package unknown] handler is saved and will be used by the new one
as part of the overall package loading process. There are no
arguments.


-Private Procedure "unhookPackageUnknownHandler"
+Private Procedure "unhookPackageUnknownHandler" (from "pkgr.eagle")

This procedure attempts to unhook the [package unknown] handler.
It will raise a script error if the [package unknown] handler is
not hooked. The old [package unknown] handler is restored and
the saved [package unknown] handler is cleared. There are no
arguments.


-Private Procedure "runSavedPackageUnknownHandler"
+Private Procedure "runSavedPackageUnknownHandler" (from "pkgr.eagle")

    Required argument "package"
    Required argument "version"
@@ -1247,11 +1279,11 @@ The procedure runs the saved [package unknown] handler. Any script
errors are raised to the caller. The package and version arguments
are passed in from the current [package unknown] handler verbatim.


-Private Procedure "packageUnknownHandler"
+Private Procedure "packageUnknownHandler" (from "pkgr.eagle")

    Required argument "package"
    Optional argument "version" with default value ""
@@ -1264,24 +1296,11 @@ 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.


-Public API Procedure "maybeReadSettingsFile"
-
- -    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.
-


- -Private Procedure "maybeReadApiKeysFile"
+Private Procedure "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
@@ -1288,62 +1307,92 @@ file should (normally) modify the "::pkgr_api_keys" variable
in order to add API keys for use with the package repository
client.


-Private Procedure "setupRepositoryOpenPgpVars"
+Private Procedure "setupRepositoryOpenPgpVars" (from "pkgr.eagle")

This procedure sets up the default values for all configuration
parameters used to interact with the OpenPGP implementation.
There are no arguments.


-Private Procedure "setupPackageUnknownVars"
+Private Procedure "setupPackageUnknownVars" (from "pkgr.eagle")

This procedure sets up the default values for all configuration
parameters used by the package repository client. There are no
arguments.


-Public API Procedure "getPackageFromRepository"
+Internal API Procedure "setupArgumentData" (from "pkgu.eagle")
+
+ +    Required argument "argv"
+ +

+This procedure initializes the array containing data derived from
+the command line arguments, if any. The argv argument should be
+the list of command line arguments.
+


+ +Internal API Procedure "haveArgumentData" (from "pkgu.eagle")
+ +

+This procedure is used to determine if all the package submission
+data is available. There are no arguments. Non-zero is returned
+if all the package submission data is available. This procedure
+should not raise script errors.
+


+ +Internal API Procedure "submitEventHandler" (from "pkgu.eagle")

-    Required argument "package"
+    Optional argument list "args"
-    Required argument "version"
+

+This procedure is an event handler. It handles the submit button in
+both Tk and Eagle. It starts the package submission process. The
+args argument is not really used, it is a placeholder to make this
+procedure more portable between Tcl and Eagle. This procedure may
+raise script errors.
+


-    Required argument "caller"
+Internal API Procedure "setupWinFormsUserInterface" (from "pkgu.eagle")
+ +

+This procedure creates the user interface for this tool using Eagle
+and WinForms. The existing argument data, if any, will be used to
+populate it. There are no arguments.
+


+ +Internal API Procedure "setupTkUserInterface" (from "pkgu.eagle")

-This procedure is the primary entry point to the package repository
-client. It attempts to lookup the specified package using the
-currently configured package repository server. The package
-argument is the name of the package being sought, it cannot be an
-empty string. The version argument must be a specific version -OR-
-a package specification that conforms to TIP #268. The caller
-argument must be an empty string -OR- the literal string "handler".
+This procedure creates the user interface for this tool using Tcl
+and Tk. The existing argument data, if any, will be used to
+populate it. There are no arguments.


-Private Procedure "setupUploadVars"
+Private Procedure "setupUploadVars" (from "pkgu.eagle")

This procedure sets up the default values for all configuration
parameters used by the package uploader client. There are no
arguments.


-Private Procedure "setupCheckoutVars"
+Private Procedure "setupCheckoutVars" (from "pkgu.eagle")

This procedure sets up the default values for all configuration
parameters used by the package uploader client that require the
location of the checkout directory. There are no arguments.


-Private Procedure "formatStringMapValue"
+Private Procedure "formatStringMapValue" (from "pkgu.eagle")

    Required argument "value"

@@ -1352,11 +1401,11 @@ value argument is the string value to format. No return value is
reserved to indicate an error. This procedure may not raise any
script errors.


-Private Procedure "countCommonPathParts"
+Private Procedure "countCommonPathParts" (from "pkgu.eagle")

    Required argument "path1"
    Required argument "path2"
@@ -1366,11 +1415,11 @@ count is returned, zero if there are no common path components. The
path1 and path2 arguments are the paths to compare. This procedure
may not raise script errors.


-Private Procedure "getCommonContainingDirectory"
+Private Procedure "getCommonContainingDirectory" (from "pkgu.eagle")

    Required argument "fileNames"

@@ -1379,11 +1428,11 @@ fileNames argument is the list of (fully?) qualified file names to
process. This procedure may not raise script errors. If there is
no common containing directory, an empty string is returned.


-Private Procedure "getRelativeFileNames"
+Private Procedure "getRelativeFileNames" (from "pkgu.eagle")

    Required argument "fileNames"
    Required argument "maximumLevels"
@@ -1395,11 +1444,11 @@ process. The maximumLevels argument is the maximum path depth that
is allowed for all file names. This procedure may raise script
errors.


-Private Procedure "getScriptChunkForFileNames"
+Private Procedure "getScriptChunkForFileNames" (from "pkgu.eagle")

    Required argument "fileNames"
    Required argument "maximumLevels"
@@ -1411,11 +1460,11 @@ the list variable. The maximumLevels argument is the maximum path
depth that is allowed for all file names. This procedure may raise
script errors.


-Private Procedure "createRepositoryScript"
+Private Procedure "createRepositoryScript" (from "pkgu.eagle")

    Required argument "serverId"
    Required argument "versionId"
@@ -1446,11 +1495,11 @@ (fully?) qualified file names to be downloaded when the associated
package is being provided. The options argument is reserved for
future use, it should be an empty list.


-Private Procedure "createMultipartFormData"
+Private Procedure "createMultipartFormData" (from "pkgu.eagle")

    Required argument "boundary"
    Required argument "request"
@@ -1461,19 +1510,19 @@ is a boundary value, as specified in section 4.1 of the RFC. The
request argument is the dictionary of name/value pairs to include
in the form body. This procedure may not raise script errors.


-Private Procedure "getSubmitUri"
+Private Procedure "getSubmitUri" (from "pkgu.eagle")

This procedure returns the full URI to use when submitting a new
package to the package repository server. There are no arguments.
This procedure may raise script errors.


-Private Procedure "submitPackageMetadata"
+Private Procedure "submitPackageMetadata" (from "pkgu.eagle")

    Required argument "apiKey"
    Required argument "package"
@@ -1498,86 +1547,86 @@ evaluated when the package needs to be provided. The certificate
argument is the certificate associated with the script, which may be
an OpenPGP signature or a Harpy script certificate.


-Private Procedure "getCheckoutId"
+Private Procedure "getCheckoutId" (from "pkgu.eagle")

This procedure attempts to query the identifier of the Fossil
checkout. There are no arguments. An empty string is returned if
the information cannot be determined.


-Private Procedure "getCheckoutDirectory"
+Private Procedure "getCheckoutDirectory" (from "pkgu.eagle")

This procedure attempts to query the root directory of the Fossil
checkout. There are no arguments. An empty string is returned if
the information cannot be determined.


-Private Procedure "joinPath"
+Private Procedure "joinPath" (from "pkgu.eagle")

    Optional argument list "args"

This procedure builds a native path using the specified parts and
returns it. All arguments are considered to be parts of the path.


-Private Procedure "verifyCheckoutDirectory"
+Private Procedure "verifyCheckoutDirectory" (from "pkgu.eagle")

This procedure attempts to verify that the root directory of the
Fossil checkout is present, valid, and is actually a directory.
There are no arguments. Script errors will be raised if any of
the checks fail.


-Private Procedure "fossilMustBeInstalled"
+Private Procedure "fossilMustBeInstalled" (from "pkgu.eagle")

This procedure attempts to verify that an implementation of Fossil
is installed locally. There are no arguments. Script errors are
raised if any problems are found. The return value is undefined.


-Private Procedure "verifyThereAreNoChanges"
+Private Procedure "verifyThereAreNoChanges" (from "pkgu.eagle")

This procedure attempts to verify that the checkout directory does
not contain any (stray) changes. There are no arguments. Non-zero
is returned if the verification is successful.


-Private Procedure "verifyThisIsTheCorrectProject"
+Private Procedure "verifyThisIsTheCorrectProject" (from "pkgu.eagle")

This procedure attempts to verify that the checkout directory does
belong to the correct project. There are no arguments. Non-zero
is returned if the verification is successful.


-Private Procedure "verifyThisIsTheCorrectBranch"
+Private Procedure "verifyThisIsTheCorrectBranch" (from "pkgu.eagle")

This procedure attempts to verify that the checkout directory does
belong to the correct branch. There are no arguments. Non-zero
is returned if the verification is successful.


-Private Procedure "changeToTheCorrectBranch"
+Private Procedure "changeToTheCorrectBranch" (from "pkgu.eagle")

This procedure attempts to change the branch for the checkout
directory. There are no arguments. This procedure may raise
script errors.


-Private Procedure "stageOnePackageFile"
+Private Procedure "stageOnePackageFile" (from "pkgu.eagle")

    Required argument "targetDirectory"
    Required argument "fileName"
@@ -1588,11 +1637,11 @@ to the package platform directory. The fileName argument is the
relative name of the file to be staged. This procedure may raise
script errors.


-Private Procedure "stagePackageFiles"
+Private Procedure "stagePackageFiles" (from "pkgu.eagle")

    Required argument "language"
    Required argument "version"
@@ -1605,11 +1654,11 @@ This procedure attempts to stage the specified package files using
Fossil. The fileNames argument is a list of (fully?) qualified
local file names to stage.


-Private Procedure "commitPackageFiles"
+Private Procedure "commitPackageFiles" (from "pkgu.eagle")

    Required argument "package"
    Required argument "patchLevel"
@@ -1625,31 +1674,11 @@ remote package file repository using Fossil. The varName argument
is the name of a scalar variable in the context of the immediate
caller that will receive the resulting Fossil check-in identifier.


-Internal API Procedure "setupArgumentData"
-
- -    Required argument "argv"
- -

-This procedure initializes the array containing data derived from
-the command line arguments, if any. The argv argument should be
-the list of command line arguments.
-


- -Internal API Procedure "haveArgumentData"
- -

-This procedure is used to determine if all the package submission
-data is available. There are no arguments. Non-zero is returned
-if all the package submission data is available. This procedure
-should not raise script errors.
-


- -Private Procedure "textBoxEventHandler"
+Private Procedure "textBoxEventHandler" (from "pkgu.eagle")

    Required argument "varName"
    Required argument "sender"
@@ -1664,11 +1693,11 @@ and e arguments are provided by the framework and represent the
control involved in the event and any extra data that may be
necessary to process the event.


-Private Procedure "listBoxEventHandler"
+Private Procedure "listBoxEventHandler" (from "pkgu.eagle")

    Required argument "varName"
    Optional argument list "args"
@@ -1682,11 +1711,11 @@ containing two elements. The first element is the control involved
in the event. The second element is any extra data that may be
necessary to process the event.


-Private Procedure "handleFormClosedEvent"
+Private Procedure "handleFormClosedEvent" (from "pkgu.eagle")

    Optional argument list "args"

@@ -1695,24 +1724,11 @@ args argument is not really used, it is a placeholder to make this
procedure more portable between Tcl and Eagle. This procedure may
raise script errors.


-Internal API Procedure "submitEventHandler"
-
- -    Optional argument list "args"
- -

-This procedure is an event handler. It handles the submit button in
-both Tk and Eagle. It starts the package submission process. The
-args argument is not really used, it is a placeholder to make this
-procedure more portable between Tcl and Eagle. This procedure may
-raise script errors.
-


- -Private Procedure "clearEventHandler"
+Private Procedure "clearEventHandler" (from "pkgu.eagle")

    Optional argument list "args"

@@ -1720,22 +1736,6 @@ Tk and Eagle. It is used to clear the package submission data. The
args argument is not really used, it is a placeholder to make this
procedure more portable between Tcl and Eagle. This procedure may
raise script errors.


- -Internal API Procedure "setupWinFormsUserInterface"
- -

-This procedure creates the user interface for this tool using Eagle
-and WinForms. The existing argument data, if any, will be used to
-populate it. There are no arguments.
-


- -Internal API Procedure "setupTkUserInterface"
- -

-This procedure creates the user interface for this tool using Tcl
-and Tk. The existing argument data, if any, will be used to
-populate it. There are no arguments.
-