Goto Chapter: Top 1 2 Ind
 [Top of Book]  [Contents]   [Previous Chapter]   [Next Chapter] 

2 Commands
 2.1 Installing and updating packages
 2.2 Removing packages

2 Commands

2.1 Installing and updating packages

2.1-1 InstallPackage
‣ InstallPackage( string[, interactive] )( function )

Returns: true or false

Attempts to download and install a package. The argument string should be a string containing one of the following:

The package will then be downloaded and installed, along with any additional packages that are required in order for it to be loaded. If this installation is successful, or if this package is already installed, true is returned; otherwise, false is returned.

By default, packages will be installed in user's home directory at ~/.gap/pkg. Note that this location is not the default user pkg location on Mac OSX, but it will be created on any system if not already present. Note also that starting GAP with the -r flag will cause all packages in this directory to be ignored.

Certain decisions, such as installing newer versions of packages, will be confirmed by the user via an interactive shell - to avoid this interactivity and use sane defaults instead, the optional second argument interactive can be set to false.

To see more information about this process while it is ongoing, see InfoPackageManager.

gap> InstallPackage("digraphs");
true

2.1-2 UpdatePackage
‣ UpdatePackage( name[, interactive] )( function )

Returns: true or false

Attempts to update an installed package to the latest version. The first argument name should be a string specifying the name of a package installed in the user GAP root (for example, one installed using InstallPackage (2.1-1)). The second argument interactive is optional, and should be a boolean specifying whether to confirm interactively before any directories are deleted (default value true).

If the package was installed via archive, the new version will be installed in a new directory, and the old version will be deleted. If installed via git or mercurial, it will be updated using git pull or hg pull -u, so long as there are no outstanding changes. If no newer version is available, no changes will be made.

Returns true if a newer version was installed successfully, or if no newer version is available. Returns false otherwise.

gap> UpdatePackage("io");
#I  io version 4.6.0 will be installed, replacing 4.5.4
#I  Saved archive to /tmp/tm7r5Ug7/io-4.6.0.tar.gz
Remove old version of io at /home/user/.gap/pkg/io-4.5.4 ? [y/N] y
true

2.1-3 InfoPackageManager
‣ InfoPackageManager( info class )

Info class for the PackageManager package. Set this to the following levels for different levels of information:

Set this using, for example SetInfoLevel(InfoPackageManager, 1). Default value is 3.

2.1-4 InstallPackageFromName
‣ InstallPackageFromName( name[, interactive] )( function )

Returns: true or false

Attempts to download and install a package given only its name. Returns false if something went wrong, and true otherwise.

Certain decisions, such as installing newer versions of packages, will be confirmed by the user via an interactive shell - to avoid this interactivity and use sane defaults instead, the optional second argument interactive can be set to false.

2.1-5 InstallPackageFromInfo
‣ InstallPackageFromInfo( info )( function )

Returns: true or false

Attempts to download and install a package from a valid PackageInfo.g file. The argument info should be either a valid package info record, or a URL that points to a valid PackageInfo.g file. Returns true if the installation was successful, and false otherwise.

2.1-6 InstallPackageFromArchive
‣ InstallPackageFromArchive( url )( function )

Returns: true or false

Attempts to download and install a package from an archive located at the given URL. Returns true if the installation was successful, and false otherwise.

2.1-7 InstallPackageFromGit
‣ InstallPackageFromGit( url[, interactive][, branch] )( function )

Returns: true or false

Attempts to download and install a package from a git repository located at the given URL. Returns false if something went wrong, and true otherwise.

If the optional string argument branch is specified, this function will install the branch with this name. Otherwise, the repository's default branch will be used.

Certain decisions, such as installing newer versions of packages, will be confirmed by the user via an interactive shell - to avoid this interactivity and use sane defaults instead, the optional second argument interactive can be set to false.

2.1-8 InstallPackageFromHg
‣ InstallPackageFromHg( url[, interactive][, branch] )( function )

Returns: true or false

Attempts to download and install a package from a Mercurial repository located at the given URL. Returns false if something went wrong, and true otherwise.

If the optional string argument branch is specified, this function will install the branch with this name. Otherwise, the repository's default branch will be used.

Certain decisions, such as installing newer versions of packages, will be confirmed by the user via an interactive shell - to avoid this interactivity and use sane defaults instead, the optional second argument interactive can be set to false.

2.1-9 InstallRequiredPackages
‣ InstallRequiredPackages( )( function )

Returns: true or false

Attempts to download and install the latest versions of all packages required for GAP to run. Currently these packages are GAPDoc, primgrp, SmallGrp, and transgrp. Returns false if something went wrong, and true otherwise.

Clearly, since these packages are required for GAP to run, they must be loaded before this function can be executed. However, this function installs the packages in the ~/.gap/pkg directory, so that they can be managed by PackageManager in the future, and are available for other GAP installations on the machine.

2.2 Removing packages

2.2-1 RemovePackage
‣ RemovePackage( name[, interactive] )( function )

Returns: true or false

Attempts to remove an installed package using its name. The first argument name should be a string specifying the name of a package installed in the user GAP root. The second argument interactive is optional, and should be a boolean specifying whether to confirm certain decisions interactively (default value true).

Returns true if the removal was successful, and false otherwise.

gap> RemovePackage("digraphs");
Really delete directory /home/user/.gap/pkg/digraphs-0.13.0 ? [y/N] y
true
 [Top of Book]  [Contents]   [Previous Chapter]   [Next Chapter] 
Goto Chapter: Top 1 2 Ind

generated by GAPDoc2HTML