This file describes changes in recent versions of Modules. It primarily documents those changes that are of interest to users and admins.
Modules 4.1.0 (2018-01-15)¶
- Extend stderr output redirection on sh-kind shells to all terminal-attached shell session, not only interactive shell session.
- Extend shell code produced by the
autoinitcommand to perform the same environment initialization as done in
initshell scripts (default value set for module-specific environment variables, parse or source of configuration files).
- Make init shell scripts rely on
autoinitcommand to define the
modulecommand and setup its default environment.
- Fix error rendering code for Tcl shell by producing a call to the
- Introduce pager support to handle informational messages, using
-eFKRXoptions by default. Environment variable
PAGERmay be used to supersede default pager command and options.
--no-pagerswitches enable or disable pager from the command line.
- Install: add
--with-pager-optsconfigure options to define default pager command and its relative command-line options.
- Introduce quarantine mechanism to protect module execution against side
effect coming from the current environment definition. Variables whose name
has been put in
MODULES_RUN_QUARANTINEwill be emptied or set to the value hold by
MODULES_RUNENV_<VAR>in the modulecmd.tcl run-time environment. Quarantine variable original value is then restored within modulecmd.tcl execution context once it has started.
- Install: add
--with-quarantine-varsconfigure option to define at build time the
MODULES_RUNENV_<VAR>environment variables set in initialization scripts.
MODULES_SILENT_SHELL_DEBUGenvironment variable to disable on sh shell and derivatives any
verbosedebugging property for the duration of either the module command or the module shell initialization script. (fix issue#121)
- Change error code produced by modulecmd.tcl for the Tcl, Perl, Python, Ruby, CMake and R scripting languages to return a ‘false’ boolean value in case of error rather raising a fatal exception.
- Adapt module function definition for Tcl, Perl, Python, Ruby, CMake and R
scripting languages to always return a value, result of the modulecmd.tcl
run. When modulecmd.tcl run does not produce a specific status, a ‘true’
boolean value is returned. On CMake, resulting value is returned though a
- Spool content sent to the stdout channel with
putscommand during a modulefile interpretation, to effectively transmit this content to stdout after rendering the environment changes made by this modulefile. (fix issue#113)
is-loadedmodule sub-commands, based on existing modulefile-specific Tcl commands. (fix issue#116)
is-availmodulefile Tcl commands and module sub-commands to test availability of collection, modulepath or modulefile.
- Raise error when a call to
pathsmodule sub-commands is attempted during a modulefile interpretation. Both commands now return text rather print text on scripting languages. An empty string is returned in no match case instead of a false boolean value.
module-info loadedmodulefile command and its module sub-command counterpart
info-loaded. This new command returns name of the modules currently loaded corresponding to the name passed as argument. (fix issue#3)
is-loadedcommand to correctly handle multiple module names passed as argument (fix issue#138)
- Support no argument on
is-usedcommands to return if anything is respectively loaded, saved or used.
module sourcecommand set in modulefile in
unloadmode when the modulefile itself is interpreted in this mode.
- Consider a modulefile passed with name starting by
../a full path name modulefile, like those starting by
/. These kind of names are converted to absolute path names, for instance to register them in loaded modulefile list during a
- Correlate modulefile passed as full path name (starting by either
/) to already loaded modulefile registered with regular module name (file name without its modulepath prefix) to prevent for instance from loading twice same modulefile. Correlate in the same way regular module name to already loaded full path name modulefile.
MODULES_COLLECTION_PIN_VERSIONenvironment variable to record modulefile version number when saving collections even if version corresponds to the default one. (fix issue#89)
- Fix location of
etc/rcglobal RC file to
$MODULESHOME/etc/rcnot to depend on
MODULESHOMEenvironment variable value.
- Strengthen argument check for
remove-pathmodulefile Tcl commands and module sub-commands. Raise error if argument list is not correct.
- Fix support for the
--delim=Cargument form on
- Fix path reference counter handling in case path element is an empty string. Distinguish an empty path element from a variable set empty to clear it.
- Pass multiple path elements separated by delimiter character as one string
- Accept multiple path element arguments on
- Introduce the
--duplicatesargument option to
prepend-pathcommands to add a path element already registered in variable.
- Introduce the
--indexargument option to
remove-pathcommand to delete a path entry by passing its position index in variable.
- Provide the ability to setup a site-specific configuration sourced at the
modulecmd.tclmain procedure. This configuration is a Tcl script named
siteconfig.tclwhich enables to supersede any Tcl definition made in
modulecmd.tcl. Location of this file is controlled at configure time with the
- Add the ability to handle paths containing reference to environment variable
MODULEPATH. When these kind of paths are used by
modulecommand, the variable references are converted to their corresponding value or to an empty string if they are not defined.
- Enclose value set to environment variable on Tcl within curly braces rather double quotes to protect special characters in it from interpretation.
- Correctly parse
.modulespathinitialization file to handle lines without any
#character or to handle files with no content to extract.
- Re-introduce the
--enable-versioningconfigure option, which appends Modules version to installation prefix and deploy a
versionsmodulepath shared between all versioning enabled Modules installation. A modulefile corresponding to Modules version is added to the shared modulepath and enables to switch from one Modules version to another.
- Fix removal of CMake generated temporary script file by stripping newline character from script file name.
MODULES_CMDenvironment variable to expose path to the currently active module command script. This variable is set at initialization time.
modulecmdwrapper script, installed in binary directory, which executes the active module command.
- Fix modulefile Tcl interpreter reset when handling list variables. (fix issue#145)
- Introduce ‘module-virtual’ modulefile Tcl command to associate a virtual module name to a modulefile. This module can be located with its virtual name and the associated modulefile is the script interpreted when loading, unloading, etc.
- Resolution of relative paths occurring during a modulefile interpretation to target a modulefile or a modulepath now takes the directory of the currently interpreted modulefile as the current working directory to solve the relative paths.
Modules 4.0.0 (2017-10-16)¶
Starting with this release, modules-tcl has become Modules. The following changes describe the differences with last modules-tcl release (1.923). To learn about the changes between this release and last Modules 3.2 release, please see the MIGRATING document.
- Relax constraint on command-line argument position so options and switches can be passed either before or after command name.
unsupported optionwarning rather stop on error when compatibility-version specific command-line switches are passed (
- Keep empty
module loadline in shell configuration files after running the
- Always return the value of
- Optimize code output, for Perl to only return
1;once for a no-operation situation and for Python to not
import oswhen there is only an error to render.
- Use value of system command
- Add support for CMake shell
/character used as suffix in modulefile name passed on command line.
- Rename Perl initialization script in
perl.pmand Python in
- Add support for Ruby shell (with contribution from Tammo Tjarks)
- Add support for R shell (with contribution from Roy Storey)
- When a default is set for a given module name, target modulefile can be referred on as modulename/default in addition to just modulename.
- Locate symbolic versions on
availcommand even these symbols are set over a module alias or another symbolic version. In this situation the symbol spread along the resolution path until reaching a modulefile.
- Define a more standard shebang on modulecmd.tcl script.
- Determine modulefile corresponding to given module name using the loaded
context only on
- Enable to unload mod/dir/subdir/vers when unload of mod or mod/dir asked. Was previously working only if deep module to unload was also the default version for these root names.
- Make -l/-t switches mutually exclusive. Last switch mentioned on the command-line is honored.
- Output parsable modulepath header when -l/-t switches are enabled.
- When searching for a module in a given modulepath directory, if a module alias or a symbolic version matches searched module but the target of this alias or symbol is not found in current modulepath directory, search for this target restarting search from the first modulepath in list to ensure modulepath priority.
- Solve aliases or symbolic versions looking for all modulepaths on
pathscommands. Was previously solved if their target was found in same modulepath directory.
- Add support for hidden dot modulefiles. A hidden modulefile does not appear in case of wild search, it is only returned when search is about its exact name.
- No table header print in –long mode on an
availcommand if no result are returned.
- Add blank line between displayed list of elements, for instance between
modulepath content on
- Improve readability of error messages encountered during modulefile
execution by putting Tcl error message first after the
- Do not exit immediately when an internal error occurs in currently interpreted modulefile. Consider this interpretation as failed and continue to proceed the other modulefile arguments.
- When multiple modulefiles are passed on
testcommands only output one separator line between 2 interpreted modulefiles.
- Fix environment settings stack handling issue when restoring stack after a failed attempt to load a modulefile in a modulefile.
- Failed attempt to load or unload a modulefile within a modulefile now leads to this upper modulefile load or unload failure. Previously upper modulefile were loaded respectively unloaded even if its dependent sub-modulefile failed to load or unload.
- During a
switchcommand, if the unloading part fails the loading part will not be tried. Unloading part fails if module to unload does not exist or its unload interpretation raise error.
- Init: use
module sourcerather shell command
sourceto load modulerc system configuration in sh-kind, csh-kind and fish shell init scripts.
- Install: transform configuration options to bind to an existing compatibility Modules version into option (–enable-compat-version) to build and install this compatibility version along with main version.
- Init: adapt initialization scripts to handle both main and compatibility version. By default a shell script enables main version and if the environment variable MODULES_USE_COMPAT_VERSION is set to 1, the compatibility version is enabled instead of main version.
- Install: import from compatibility version and install
mkrootutility scripts (scripts developed by R.K. Owen).
- Install: update RPM spec file to handle compatibility version as a
- Add completion script for Fish shell (contribution from BEFH).
- Doc: extend content of diff_v3_v4 to details all noticeable changes between v3.2 and v4.0.
- Doc: introduce MIGRATING guide to learn the major changes when moving from v3.2 to v4.0.
listcommand when full pathname modulefile is loaded (fix bug#132)
- Install: handle version number though git tags in scripts, documentation and RPM spec file.
- Doc: migrate documents from POD format to reStructuredText to benefit from Sphinx documentation framework and Read The Docs publishing capabilities.
Above changes describe the differences with modules-tcl release 1.923. To learn about the changes between Modules 4.0 and last Modules 3.2 release, please see the MIGRATING document.
aliasescommand when a global or user RC file is set.
- Find and solve global or user RC aliases and symbolic versions on
- Do not look at currently loaded modules to resolve the target of a module alias.
- Rework default and latest versions search on
availcommand. Correct display when at a given level a sub-directory element is last element in directory among modulefiles. Previously sub-directory was printed but last file among modulefiles was also printed (2 latest versions at the same level). A directory tagged “default” does not appear anymore in default listing result as its content (the default version found in that directory) will be displayed.
- When an alias is set and overrides name of an existing directory, take this alias into account for default and latest choice and ignore directory content.
- Bad default set will lead to no result displayed for the corresponding
module in case of default
- Correct inclusion of aliases in output result when these aliases are not part of the exact same module path than module path of the search.
- Rewrite existing shell initialization file with initadd, initprepend, initswitch, initrm and initclear commands rather than writing a new file then copying this new file to replace the existing initialization file. In addition only re-writes shell initialization file if its content need to be altered.
- Raise an error on initadd, initprepend, initswitch, initrm and initclear
commands when no
module loadline are found in shell initialization file.
- Normalize error messages for the various collection-related commands when collection cannot be accessed.
- Cleanup existing reference counters of a path list variable when this
variable is altered by a
- Init: do not pollute tab-completion with moduleraw command. (Bert Wesarg)
- Make use of the same Tcl interp for each modulefile interpretation and
use another one for each modulerc (but the same for each modulerc). By
doing so we proceed like on C-version where same interpreter is used
across modulefile or modulerc interpretation. Huge performance
improvement is achieved with this change on commands making intensive
use of interp like
avail. Interpreter state is reset from one interpretation to another: the initial variable and procedure state is restored before each new interpretation to avoid spread of definitions from one interpretation to another. Also in case of nested interpretation each interpretation level has its own interpreter so a module loaded by another does not influence the interpretation of the module loading it.
- Improve performance of aliases and symbolic versions resolution by computing these resolution at definition time. As a consequence resolution loop are not registered anymore and produce an error message when spotted not at display time.
- Reduce number of
accesssystem call by trying access to modulefile when reading the content of a modulefile directory rather testing access before trying it.
- No error raise on empty argument list for load. To cope with initadd
behavior that requires at least an empty
module loadline in startup files. (fix SF bug#88)
- Fix initadd to handle load line without trailing space. Was previously
expecting load directive to be written “module load ” to get a match.
module loadline will also be matched.
- Like C-version catch raised error when break or continue are called from outside of a loop to handle them as when they are called from modulefile main body. (fix SF bug#87)
- Return error on
module usecommand when an empty path string is provided rather ignoring it.
lreverseprocedure for correct operations under Tcl version 8.4.
- Install: add –with-tclsh configure option to give the ability to choose the Tcl interpreter shell to setup in initialization scripts.
- Handle error raised from the ModulesDisplay, ModulesHelp and ModulesTest
procedures in the same way than for the evaluation of the modulefile
content. An error occurring during the evaluation of the modulefile
content will lead to no evaluation of the
testcommand specific functions.
- Doc: describe
- Correct use of xrdb tool when not installed in default path.
init*module commands to behave more like C-version and document remaining differences in diff_with_c-version.
- Init: make
shinit script closer to POSIX specification to support sh flavors different than Bash or Zsh like Dash.
- Fix column-mode display for very short width terminal.
- Install: introduce an
installnon-regression testsuite which is triggered by the
make testinstallcommand and checks modules-tcl installation is operational.
- Init: fix modulerc load test on
- Init: fix interactive shell test on
- Install: add –enable-example-modulefiles configure option that install by default some modulefiles provided as example in the system modulefiles directory.
- Install: when uninstalling, do not remove modulefiles directory if it is not empty.
- Add completion script for Zsh shell.
module testcommand to trigger when called execution of a ModulesTest procedure in target modulefile following same kind of mechanism than
getenvsub-command to correctly return environment variable value.
- Clarify in man-pages display of module alias and symbolic version-name on
availcommand and management of file access issue when locating modulefiles.
- Distinguish access issue (permission denied) from find issue (cannot
locate) when trying to access directly a directory or a modulefile as
whatiscommands. In addition on this kind of access, not readable .modulerc files are ignored rather producing a missing magic cookie error.
- When mode is set to unload,
module loadcommands in modulefile are interpreted as
module unloadcommands. To guaranty correct behavior regarding requirements, the module list passed to the load command is reversed to unload the modulefiles in the reverse order than they have been loaded.
displaycommand to only report module commands set in modulefile and not those set in the various .modulerc on the path toward this modulefile.
- Fix bash and tcsh completion scripts to eliminate symbolic version names
availcommand when a symbolic version-name is passed as argument to return the modulefile target of this symbolic version-name.
- When looking for an implicit default in a directory, now a module alias is taken into account so it can be returned as the last element in it (highest numerically sorted version).
listcommand to correctly display the
defaulttag along loaded modules when set via a .version file.
- Fix long output of
listcommand to display the symbolic version-names associated to each loaded module if any.
availcommand to return alias module when an alias name is passed as argument.
- On a
--defaultlisting, a modulefile does not appear anymore if a directory is set default at the same level. On a
--latestlisting, a directory does not appear anymore if set default but not the latest.
- Read modulerc and validate its header in a single open/read/close sequence
instead of two in order to reduce to number of IO operations during an
- Drastically reduce grid size computation time which removes overhead when displaying module avail results in column-mode.
- Translate module name to currently interpreted module name when name correspond to the last part this interpreted module only in case of symbolic version-name or alias resolution.
- Avoid resetting regular path (/usr/bin) or manpath (/usr/share/man) when switching from Tcl to C version in switchml utility.
- Raise error on x-resource if DISPLAY environment variable is not set.
- Fix lisp init script which was broken for environment change actions.
- Improve README with examples, requirements, links, etc. Also update INSTALL documentation with details on the new configure/make/make install process.
- Add display of a release date next to the version number when calling for
- Update diff_with_c-version document to describe the features of the Tcl-version that are not supported on the C-version. Also state that the diff takes C version 3.2.10 against Tcl version 1.729 as a basis.
switchmltool, a shell function (or alias for csh or tcsh shells) that swap currently enabled Modules version (C or Tcl) by the other version (C or Tcl). Configure option
--with-cver-initdirmust be defined to enable
switchmlin initialization script.
- Define a PATH and MANPATH in shell initialization scripts that point to the defined modules-tcl installation directories.
- Give ability to generate distribution tarball from the git repository with
- Introduce an installation process for this software following the configure/make/make install fashion. Configure step enables to choose installation paths and init scripts features to activate. Make step mainly translates init scripts with the configuration set. Make install creates target directories and copy files into them.
- Fix MODULESHOME setup in autoinit command to define it as an absolute path
and set it to the upper directory when modulecmd.tcl is located in a
- Correct alias and version resolution on avail command which was erroneous
in case of a modulefile holding symbols (like
default) and targeted by aliases. Avail output was showing the aliases holding the symbols instead of the modulefile.
- Add documentation in module(1) man page on the modulefile collection
concept and the relative
- Add document to list the differences of the functionalities that can be found on the C-version of the Modules package compared to the Tcl-version.
- Improve modulecmd.tcl shebang to only search
tclshonce if found in PATH.
module-info modecheck against
module-info commandModules-specific Tcl command to distinguish complex
unloadcommands that cannot be determined with
module-info modealone. For instance a modulefile can now be aware that a
purgecommand is currently being run.
- Enable usage of
module-infoModules-specific Tcl command from a modulerc file.
module-info specifiedModules-specific Tcl command.
- No exit raise on modulefile or modulerc error during
searchcommands to avoid harming results from these global commands if error exists in a few modulefiles.
- Exit with error code when a critical error is encountered when interpreting a modulefile or a modulerc.
- Inhibit non-critical error report raised from modulefiles during
searchcommands to avoid error flood when parsing all modulefiles or modulercs.
- Handle multiple lines of
module-whatisModules-specific Tcl commands defined for the same modulefile.
- Handle multiple arguments passed to the
module-whatisModules-specific Tcl commands. They are joined to get a single line of text.
- Return error on
whatiscommand if searched modulefile is not found.
- Set path variable counter to 1 for paths without a known reference count (was previously set to 999999999).
envmlutility which acts as an application launcher where module commands are instantiated to setup environment before launching the given application.
- Always register paths provided to be part of MODULEPATH environment variable as absolute paths to get independent from the current working directory.
- Inhibit next modulefiles interpretation with
exitModules-specific Tcl command only if current mode is
- Add argument to
module-info shelltypeto test current shell or shelltype value.
- Fix use of
defaultversion-name to not consider it as a module symbol if a modulefile is named
- Fix path variable counters when
:character is used in elements of a path-like variable.
- Update module(1) and modulefile(4) man pages to clear content specific to the C version of Modules and add content specific to or adapt content that behave differently on this Tcl version.
- Fix TCLSH variable issue in Python init script.
switchcommand handle a single argument. The modulefile to switch to is the one passed on the command-line and the modulefile to unload is assumed to be the currently loaded module with the same root name as this modulefile specified on the command-line.
switchcommand idempotent by always ending up with
newloaded, whatever the starting situation is.
exitModules-specific Tcl command.
refreshcommand as alias on
- Add dummy
module-verbosityModules-specific Tcl commands to enable support for modulefiles using them.
systemModules-specific Tcl command to behave like described on the man page.
module listwhen module loaded with full path
g_forceproperty by default to avoid loading a modulefile already loaded. It also avoids path element reference counting to get increased when the same module is asked twice for load.
- Clarify module-info
modeoption and set
- Clarify module-info
- Handle empty or separator path on
- Delete environment variable targeted by an
unloadmode if no value has been provided along. On display mode, print environment variable value if any has been passed to
- When setting Tcl variable, enclose value within double quotes.
- Fix perl quoting style for variable set, escape single quotes rather double quotes.
unusecommand instead of
usecommand on a
continueModules-specific Tcl command.
chdirModules-specific Tcl command.
breakModules-specific Tcl command.
- No display of modulepath header if no module found in it.
- Remove call to
module availcommand, as aliases are now directly included in the
- Include module aliases in the displayed result of an
availcommand. Also display aliases defined in a global or user modulerc file.
- Exit with error code if error occurred on display or help commands.
- Fix module-info symbols resolution.
- Better handling of .modulerc and .version files when searching for a modulefile.
- Fix module-info version resolution.
- Fix module-info alias resolution.
- Register alias and version by the short module name and improve their resolution to avoid loop.
- Source $MODULERCFILE/modulerc when $MODULERCFILE is dir.
- Make it so you can do
module avail un, wildcard
- Raise error if command does not receive the excepted number of arguments.
- Improve column-mode display to get a denser output on
- Standardize the output of Warning, Error, InternalBug and ErrorAndExit messages.
- Add short option -d for –delim on prepend-path.
- Introduce collection target concept to distinguish between machines, environments or domains that are incompatible with each other.
saveshowcommand, to display content of saved collections.
restorecommands to handle collection specified as absolute or relative file path.
savermcommand, to delete saved collections.
- Enable to
restorecollection with multiple modulefiles specified on the same line.
restorecommand when there is no module to load in collection.
restorecommand when collection fully rewind module paths.
restorecommand to preserve module path order set in collection.
- Raise error if try to save an empty environment in a collection.
- Add support for Fish shell.
- Import recent tests added to C-version on 10-use and 50-cmds testsuites.
- Add short option -d for –delim on append-path and remove-path.
- Fix load and implement unload x-resource.
- Fix Python code that was broken or not Python3-compliant. Fixed code is used to define the module command, to render error and to process x-resource.
- Always dictionary-sort (also called numerical-sort) list of modulefiles or list of collections.
- Fix bash completion script to be compliant with bash posix mode.
- First release to be described in this NEWS file but it does not mean this is the first version of modules-tcl as this Modules flavor is born in 2002.
- At this stage, modules-tcl handles a majority of the module commands and modulefile Tcl commands available on C version.