Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
caviness:valet [2019/06/27 16:53] frey |
caviness:valet [2019/06/27 17:11] (current) frey [Getting help] |
||
|---|---|---|---|
| Line 70: | Line 70: | ||
| </code> | </code> | ||
| - | ===== Adding a package ===== | + | ===== Adding packages ===== |
| The ''vpkg_require'' command is used to add a package's changes to your environment. One or more versioned package identifiers can be passed to the command: | The ''vpkg_require'' command is used to add a package's changes to your environment. One or more versioned package identifiers can be passed to the command: | ||
| Line 79: | Line 79: | ||
| Adding package `ffmpeg/4.0` to your environment | Adding package `ffmpeg/4.0` to your environment | ||
| Adding package `python/3.6.5` to your environment | Adding package `python/3.6.5` to your environment | ||
| - | [«username»@login00 ~]$ | ||
| </code> | </code> | ||
| Line 85: | Line 84: | ||
| <WRAP center round tip 60%> | <WRAP center round tip 60%> | ||
| - | Whenever possible, try to merge your package requests into as few ''vpkg_require'' commands as possible. | + | Whenever possible, try to merge your package requests into as few ''vpkg_require'' commands as possible. This limits the number of environment snapshots that must be created and stored on disk. |
| </WRAP> | </WRAP> | ||
| + | |||
| + | To see what packages have been added to your environment, use the ''vpkg_history'' command: | ||
| + | |||
| + | <code> | ||
| + | [«username»@login00 ~]$ vpkg_history | ||
| + | [standard] | ||
| + | intel/2019u2 | ||
| + | ffmpeg/4.0 | ||
| + | python/3.6.5 | ||
| + | </code> | ||
| + | |||
| + | ===== Removing packages ===== | ||
| + | |||
| + | The changes produced by each invocation of ''vpkg_require'' can be rolled back using the ''vpkg_rollback'' command: | ||
| + | |||
| + | <code> | ||
| + | [«username»@login00 ~]$ which ifort | ||
| + | /opt/shared/intel/2019u2/compilers_and_libraries_2019.2.187/linux/bin/intel64/ifort | ||
| + | [«username»@login00 ~]$ vpkg_rollback | ||
| + | [«username»@login00 ~]$ which ifort | ||
| + | /usr/bin/which: no ifort in (/home/1001/bin:/opt/shared/valet/2.1/bin/bash:/opt/shared/valet/2.1/bin:/opt/shared/slurm/add-ons/bin:/opt/shared/slurm/bin:/usr/lib64/qt-3.3/bin:/opt/shared/gqueue/bin:/usr/local/bin:/usr/bin:/usr/local/sbin:/usr/sbin) | ||
| + | </code> | ||
| + | |||
| + | By default, ''vpkg_rollback'' undoes the last ''vpkg_require''. To rollback the last //N// ''vpkg_require'' commands issued in your current shell, use ''vpkg_rollback //N//''. | ||
| + | |||
| + | To undo all ''vpkg_require'' commands issued in your current shell, use ''vpkg_rollback all''. | ||
| + | |||
| + | ===== Getting help ===== | ||
| + | |||
| + | VALET includes several Linux manual (man) pages for online help: | ||
| + | |||
| + | ^Name^Section^Description^ | ||
| + | |valet|7|General discussion of what VALET is, how it's used, etc. Good starting point.| | ||
| + | |vpkg_yaml|5|Outlines the YAML VALET package definition file format (see also the vpkg_json page); this is currently the preferred format| | ||
| + | |vpkg_json|5|Outlines the JSON VALET package definition file format (the YAML format is similar)| | ||
| + | |vpkg_xml|5|Outlines the XML VALET package definition file format; this was the original format and is now more or less deprecated in favor of YAML/JSON| | ||
| + | |vpkg_py|5|Outlines the Python package definition file format; there are two variants, literal and executable (dynamic), with availability of the latter determined by the sysadmin| | ||
| + | |vpkg_attr|1|Describes the ''vpkg_attr'' command| | ||
| + | |vpkg_devrequire|1|Describes the ''vpkg_devrequire'' command| | ||
| + | |vpkg_history|1|Describes the ''vpkg_history'' command| | ||
| + | |vpkg_info|1|Describes the ''vpkg_info'' command| | ||
| + | |vpkg_list|1|Describes the ''vpkg_list'' command| | ||
| + | |vpkg_require|1|Describes the ''vpkg_require'' command| | ||
| + | |vpkg_rollback|1|Describes the ''vpkg_rollback'' command| | ||
| + | |vpkg_versions|1|Describes the ''vpkg_versions'' command| | ||
| + | |||