installPackage -- load and install a package and its documentation

Synopsis

• Usage:

  installPackage PACKAGENAME

• Inputs:

  • PACKAGENAME, a String or Package
• Consequences:

  • The package is installed in a local directory, so that in the future, one may simply use loadPackage. Documentation for the package is also produced, running any Macaulay2 examples that are requested in the package documentation.
• Optional inputs:

  • UserMode => a Boolean value, default value false, whether the installation will ignore packages installed in the user's application directory and will ignore the user's initialization file when running examples
  • DebuggingMode => a Boolean value, default value false, whether to enter the debugger if an error occurs during installation
  • RerunExamples => a Boolean value, default value false, whether to rerun all the examples during installation
  • IgnoreExampleErrors => a Boolean value, default value false, whether to ignore errors that occur during the running of examples during installation
  • CheckDocumentation => a Boolean value, default value true, whether to check the package's documentation for consistency and completeness
  • MakeDocumentation => a Boolean value, default value true, whether to make the documentation for the package during installation
  • MakeInfo => a Boolean value, default value true, whether to make the info pages. This is a form of the documentation that can be viewed using the Unix command info or using emacs.
  • Encapsulate => a Boolean value, default value true, whether to encapsulate all the installed files in a subdirectory whose name has the form PACKAGENAME-VERSION, where VERSION is the version number specified by the package as value of the Version option provided to newPackage. Encapsulation makes it easy to delete all the files associated with a package, and symbolic links can make it look like the files have been installed in the right place.
  • PackagePrefix => the path to the directory where the files of the package should be installed. The default value is the subdirectory named encap of the user's application directory.
  • InstallPrefix => the path to the directory where the links should be created, in case encapsulation is enabled. The value of this option can be a string or a function of 0 arguments returning a string. The default value is the subdirectory named local of the user's application directory.
  • MakeLinks => a Boolean value, default value true, whether to make links to the files after installing them, in case encapsulation is enabled
  • AbsoluteLinks => default value false, whether the links made should contain absolute paths, rather than relative paths
  • RemakeAllDocumentation => default value true, whether to regenerate all of the help pages for this package. The default action is to rebuild only the html pages of the documentation entries that have been changed since the last time the package was installed. However, some changes to an entry, such as to its headline, will change the html of other pages that cross-reference it.

Description

See also

• packages