| Both sides previous revision Previous revision Next revision | Previous revision |
| software:software [2024-03-26 15:53] – [VALET commands] anita | software:software [2024-03-27 09:13] (current) – mkyle |
|---|
| ===== VALET commands ===== | ===== VALET commands ===== |
| |
| The following table provides a brief summary of the most often-used VALET commands. Additional information is available in the [[:software:valet:valet|VALET software documentation]]. These commands are available in login shells and batch scripts (since they are run as login shells). | The UD-developed //VALET// system facilitates your use of compilers, libraries, programming tools and application software. It provides a uniform mechanism for setting up a package's required UNIX environment. VALET is a recursive acronym for **//V//**//ALET //**//A//**//utomates //**//L//**//inux //**//E//**//nvironment //**//T//**//asks//. It provides functionality similar to the **Modules** package used at other HPC sites. |
| |
| The table below shows the basic informational commands for VALET. In subsequent sections, VALET commands are illustrated in the contexts of application development (e.g., compiling, using libraries) and running IT-installed applications. | VALET commands set the basic environment for software. This may include the ''PATH'', ''MANPATH'', ''INFOPATH'', ''LDPATH'', ''LIBPATH'' and ''LD_LIBRARY_PATH'' environment variables, compiler flags, software directory locations, and license paths. This reduces the need for you to set them or update them yourself when changes are made to system and application software. For example, you might find several versions for a single package name, such as Mathematica/8 and Mathematica/8.0.4. You can even apply VALET commands to packages that you install or alter its actions by customizing VALET's configuration files. |
| | |
| | The following table provides a brief summary of the most often-used VALET commands. Additional information is available by typing **man valet** for instructions or see the [[:software:valet:valet|VALET software documentation]] for complete details. These commands are available in login shells and batch scripts (since they are run as login shells). |
| |
| ^ Command ^ Function ^ | ^ Command ^ Function ^ |
| | ''vpkg_help'' | VALET help. | | | ''vpkg_help'' | VALET help. | |
| | ''vpkg_list'' | List the packages that have VALET configuration files. | | | ''vpkg_list'' | List the packages that have VALET configuration files. | |
| | ''vpkg_versions ''<<//pkgid//>> | List versions available for a single package. | | | ''vpkg_versions ''<<//package-id//>> | List versions available for a single package. | |
| | ''vpkg_info ''<<//pkgid//>> | Show information for a single package (or package version). | | | ''vpkg_info ''<<//package-id//>> | Show information for a single package (or package version). | |
| | ''vpkg_require ''<<//versioned-package-id//>> | Configure environment for one or more VALET packages. | | | ''vpkg_require ''<<//versioned-package-id//>> | Configure environment for one or more VALET packages. | |
| | ''vpkg_devrequire ''<<//pkgid//>> | Configure environment for one or more VALET packages including software development variables such as ''CPPFLAGS'' and ''LDFLAGS''. | | | ''vpkg_devrequire ''<<//versioned-package-id//>> | Configure environment for one or more VALET packages including software development variables such as ''CPPFLAGS'' and ''LDFLAGS''. | |
| | ''vpkg_rollback ''<<//# or all//>> | Each time VALET changes the environment, it makes a snapshot of your environment to which it can return.\\ ''vpkg_rollback'' attempts to restore the UNIX environment to its previous state. You can specify a number (''#'') to revert one or more prior changes to the environment or ''all'' to remove all changes. | | | ''vpkg_rollback ''<<//# or all//>> | Each time VALET changes the environment, it makes a snapshot of your environment to which it can return.\\ ''vpkg_rollback'' attempts to restore the UNIX environment to its previous state. You can specify a number (''#'') to revert one or more prior changes to the environment or ''all'' to remove all changes. | |
| | ''vpkg_history'' | List the versioned packages that have been added to the environment. | | | ''vpkg_history'' | List the versioned packages that have been added to the environment. | |
| | ''man valet'' | Complete documentation of VALET commands. | | | ''man valet'' | Complete documentation of VALET commands. | |
| |
| A ''<//<versioned-package-id//>>'' is the combination of a package identifier (found using the ''vpkg_list'' command) with a version/variant identifier (via the ''vpkg_versions'' command). The two pieces are joined using a forward slash (/). For example, the commercial software "Matlab" has a <<package-id>> of ''matlab'' and the 2012 release has a <<version-id>> of ''r2012a'', producing the <<versioned-package-id>> ''matlab/r2012a''. | A <<//versioned-package-id//>> is the combination of a package identifier (found using the ''vpkg_list'' command) with a version/variant identifier (via the ''vpkg_versions'' command). The two pieces are joined using a forward slash (/). For example, the commercial software "Matlab" has a <<//package-id//>> of ''matlab'' and the 2012 release has a <<//version-id//>> of ''r2012a'', producing the <<//versioned-package-id//>> ''matlab/r2012a''. |
| |
| <note>In the context of a <<versioned-package-id>>, a blank <<version-id>> implies the default version of the package. If the 2012 release of Matlab were the default, then using ''matlab'' (or ''matlab/default'') as the <<versioned-package-id>> would imply ''matlab/r2012a''.</note> | <note>In the context of a <<//versioned-package-id//>>, a blank <<//version-id//>> implies the default version of the package (marked with an asterisk ''*''). If the 2012 release of Matlab were the default, then using ''matlab'' (or ''matlab/default'') as the <<//versioned-package-id//>> would imply ''matlab/r2012a''.</note> |
| |
| VALET environment changes apply to the shell in which the ''vpkg_require'' command is issued; the changes do not "stick" after exiting that shell (by logging-out, for example). Thus, one way to discard changes affected by a ''vpkg_require'' command is to just exit the shell. The ''vpkg_rollback'' command is a more graceful alternative and iteratively discards the changes produced by prior ''vpkg_require'' commands issued in the shell. To undo all changes, ''vpkg_require all'' can be used. | VALET environment changes apply to the shell in which the ''vpkg_require'' command is issued; the changes do not "stick" after exiting that shell (by logging-out, for example). Thus, one way to discard changes affected by a ''vpkg_require'' command is to just exit the shell. The ''vpkg_rollback'' command is a more graceful alternative and iteratively discards the changes produced by prior ''vpkg_require'' commands issued in the shell. To undo all changes, ''vpkg_rollback all'' can be used. |
| |
| A script contains commands to be executed in a shell. | A script contains commands to be executed in a shell. |