neulab/tldr huggingface dataset:
If a module load line is found in any of these files, the modulefiles are appended to any existing list of modulefiles. The module load line must be located in at least one of the files listed above for any of the init sub-commands to work properly. If the module load line is found in multiple shell initialization files, all of the lines are changed.
initclear Clear all of the modulefiles from the shell's initialization files.
initlist List all of the modulefiles loaded from the shell's initialization file.
initprepend modulefile... Does the same as initadd but prepends the given modules to the beginning of the list.
initrm modulefile... Remove modulefile from the shell's initialization files.
initswitch modulefile1 modulefile2 Switch modulefile1 with modulefile2 in the shell's initialization files.
is-avail modulefile... Returns a true value if any of the listed modulefiles exists in enabled MODULEPATH. Returns a false value otherwise. See is-avail in the modulefile(4) man page for further explanation.
is-loaded [modulefile...] Returns a true value if any of the listed modulefiles has been loaded or if any modulefile is loaded in case no argument is provided. Returns a false value otherwise. See is-loaded in the modulefile(4) man page for further explanation.
is-saved [collection...] Returns a true value if any of the listed collections exists or if any collection exists in case no argument is provided. Returns a false value otherwise. See is-saved in the modulefile(4) man page for further explanation.
is-used [directory...] Returns a true value if any of the listed directories has been enabled in MODULEPATH or if any directory is enabled in case no argument is provided. Returns a false value otherwise. See is-used in the modulefile(4) man page for further explanation.
keyword [-a] [-j] string See search.
list [-a] [-o LIST] [-t|-l|-j] List loaded modules.
Module tags applying to the loaded modules are reported along the module name they are associated to (see Module tags section).
Module variants selected on the loaded modules are reported along the module name they belong to (see Module variants section).
load [--auto|--no-auto] [-f] modulefile... Load modulefile into the shell environment.
Once loaded, the loaded module tag is associated to the loaded module. If module has been automatically loaded by another module, the auto-loaded tag is associated instead (see Module tags section).
path modulefile Print path to modulefile.
paths modulefile Print path of available modulefiles matching argument.
prepend-path [-d C|--delim C|--delim=C] [--duplicates] variable value... Prepend value to environment variable. The variable is a colon, or delimiter, separated list. See prepend-path in the modulefile(4) man page for further explanation.
When prepend-path is called as a module sub-command, the reference counter variable, which denotes the number of times value has been added to environment variable, is not updated unless if the --duplicates option is set.
purge [-f] Unload all loaded modulefiles.
When the --force option is set, also unload modulefiles that are depended by unloadable modules.
refresh Force a refresh of all non-persistent components of currently loaded modules.  This should be used on derived shells where shell aliases or shell functions need to be reinitialized but the environment variables have already been set by the currently loaded modules.
Loaded modules are evaluated in refresh mode following their load order.  In this evaluation mode only the set-alias and set-function modulefile commands will produce environment changes. Other modulefile commands that produce environment changes (like setenv or append-path) are ignored during a refresh evaluation as their changes should already be applied.
reload Unload then load all loaded modulefiles.
No unload then load is performed and an error is returned if the loaded modulefiles have unsatisfied constraint corresponding to the prereq and conflict they declare.
remove-path [-d C|--delim C|--delim=C] [--index] variable value... Remove value from the colon, or delimiter, separated list in environment variable. See remove-path in the modulefile(4) man page for further explanation.
When remove-path is called as a module sub-command, the reference counter variable, which denotes the number of times value has been added to environment variable, is ignored and value is removed whatever the reference counter value set.
restore [collection] Restore the environment state as defined in collection. If collection name is not specified, then it is assumed to be the default collection. If collection is a fully qualified path, it is restored from this location rather than from a file under the user's collection directory. If MODULES_COLLECTION_TARGET is set, a suffix equivalent to the value of this variable is appended to the collection file name to restore.
When restoring a collection, the currently set MODULEPATH directory list and the currently loaded modulefiles are unused and unloaded then used and loaded to exactly match the MODULEPATH and loaded modulefiles lists saved in this collection file. The order of the paths and modulefiles set in collection is preserved when restoring. It means that currently loaded modules are unloaded to get the same LOADEDMODULES root than collection and currently used module paths are unused to get the same MODULEPATH root. Then missing module paths are used and missing modulefiles are loaded.
If a module, without a default version explicitly defined, is recorded in a collection by its bare name: loading this module when restoring the collection will fail if the configuration option implicit_default is disabled.
rm [--auto|--no-auto] [-f] modulefile... See unload.
save [collection] Record the currently set MODULEPATH directory list and the currently loaded modulefiles in a collection file under the user's collection directory $HOME/.module. If collection name is not specified, then it is assumed to be the default collection. If collection is a fully qualified path, it is saved at this location rather than under the user's collection directory.
If MODULES_COLLECTION_TARGET is set, a suffix equivalent to the value of this variable will be appended to the collection file name.
By default, if a loaded modulefile corresponds to the explicitly defined default module version, the bare module name is recorded. If the configuration option implicit_default is enabled, the bare module name is also recorded for the implicit default module version. If MODULES_COLLECTION_PIN_VERSION is set to 1, module version is always recorded even if it is the default version.
No collection is recorded and an error is returned if the loaded modulefiles have unsatisfied constraint corresponding to the prereq and conflict they declare.
savelist [-t|-l|-j] List collections that are currently saved under the user's collection directory. If MODULES_COLLECTION_TARGET is set, only collections matching the target suffix will be displayed.
saverm [collection] Delete the collection file under the user's collection directory. If collection name is not specified, then it is assumed to be the default collection. If MODULES_COLLECTION_TARGET is set, a suffix equivalent to the value of this variable will be appended to the collection file name.
saveshow [collection] Display the content of collection. If collection name is not specified, then it is assumed to be the default collection. If collection is a fully qualified path, this location is displayed rather than a collection file under the user's collection directory. If MODULES_COLLECTION_TARGET is set, a suffix equivalent to the value of this variable will be appended to the collection file name.
search [-a] [-j] string Seeks through the module-whatis information of all modulefiles for the specified string. All module-whatis information matching the string in a case insensitive manner will be displayed. string may contain wildcard characters.
sh-to-mod shell script [arg...] Evaluate with shell the designated script with defined arguments to find out the environment changes it does. Environment prior and after script evaluation are compared to determine these changes. They are translated into modulefile commands to output the modulefile content equivalent to the evaluation of shell script.
Changes on environment variables, shell aliases, shell functions and current working directory are tracked.
Shell could be specified as a command name or a fully qualified pathname.  The following shells are supported: sh, dash, csh, tcsh, bash, ksh, ksh93, zsh and fish.
show modulefile... See display.
source scriptfile... Execute scriptfile into the shell environment. scriptfile must be written with modulefile syntax and specified with a fully qualified path. Once executed scriptfile is not marked loaded in shell environment which differ from load sub-command.
swap [--auto|--no-auto] [-f] [modulefile1] modulefile2 See switch.
switch [--auto|--no-auto] [-f] [modulefile1] modulefile2 Switch loaded modulefile1 with modulefile2. If modulefile1 is not specified, then it is assumed to be the currently loaded module with the same root name as modulefile2.
try-add [--auto|--no-auto] [-f] modulefile... See try-load.
test modulefile... Execute and display results of the Module-specific tests for the modulefile.
try-load [--auto|--no-auto] [-f] modulefile... Like load sub-command, load modulefile into the shell environment, but do not complain if modulefile cannot be found. If modulefile is found but its evaluation fails, error is still reported.
unload [--auto|--no-auto] [-f] modulefile... Remove modulefile from the shell environment.
unuse directory... Remove one or more directories from the MODULEPATH environment variable.
If module unuse is called during a modulefile evaluation, the reference counter environment variable __MODULES_SHARE_MODULEPATH, which denotes the number of times directory has been enabled, is checked and directory is removed only if its relative counter is equal to 1 or not defined.  Otherwise directory is kept and reference counter is decreased by 1.  When module unuse is called from the command-line or within an initialization modulefile script directory is removed whatever the reference counter value set.
If directory corresponds to the concatenation of multiple paths separated by colon character, each path is treated separately. Changed in version 5.0: directory is removed whatever its reference counter value if module unuse is called from the command-line or within an initialization modulefile script
Changed in version 5.0: Accept several modulepaths passed as a single string
use [-a|--append] directory... Prepend one or more directories to the MODULEPATH environment variable.  The --append flag will append the directory to MODULEPATH.
When directory is already defined in MODULEPATH, it is not added again or moved at the end or at the beginning of the environment variable.
If module use is called during a modulefile evaluation, the reference counter environment variable __MODULES_SHARE_MODULEPATH is also set to increase the number of times directory has been added to MODULEPATH. Reference counter is not updated when module use is called from the command-line or within an initialization modulefile script.
A directory that does not exist yet can be specified as argument and then be added to MODULEPATH.
whatis [-a] [-j] [modulefile...] Display the information set up by the module-whatis commands inside the specified modulefiles. These specified modulefiles may be expressed using wildcard characters. If no modulefile is specified, all module-whatis lines will be shown.
Modulefiles modulefiles are written in the Tool Command Language (Tcl) and are interpreted by modulecmd.tcl. modulefiles can use conditional statements. Thus the effect a modulefile will have on the environment may change depending upon the current state of the environment.
Environment variables are unset when unloading a modulefile. Thus, it is possible to load a modulefile and then unload it without having the environment variables return to their prior state.
Advanced module version specifiers When the advanced module version specifiers mechanism is enabled (see MODULES_ADVANCED_VERSION_SPEC), the specification of modulefile passed on Modules sub-commands changes. After the module name a version constraint and variants may be added.
Version specifiers After the module name a version constraint prefixed by the @ character may be added. It could be directly appended to the module name or separated from it with a space character.
Constraints can be expressed to refine the selection of module version to:
• a single version with the @version syntax, for instance foo@1.2.3 syntax will select module foo/1.2.3
• a list of versions with the @version1,version2,... syntax, for instance foo@1.2.3,1.10 will match modules foo/1.2.3 and foo/1.10
• a range of versions with the @version1:, @:version2 and @version1:version2 syntaxes, for instance foo@1.2: will select all versions of module foo greater than or equal to 1.2, foo@:1.3 will select all versions less than or equal to 1.3 and foo@1.2:1.3 matches all versions between 1.2 and 1.3 including 1.2 and 1.3 versions
Advanced specification of single version or list of versions may benefit from the activation of the extended default mechanism (see MODULES_EXTENDED_DEFAULT) to use an abbreviated notation like @1 to refer to more precise version numbers like 1.2.3. Range of versions on its side natively handles abbreviated versions.
In order to be specified in a range of versions or compared to a range of versions, the version major element should corresponds to a number. For instance 10a, 1.2.3, 1.foo are versions valid for range comparison whereas default or foo.2 versions are invalid for range comparison.
Range of versions can be specified in version list, for instance foo@:1.2,1.4:1.6,1.8:. Such specification helps to exclude specific versions, like versions 1.3 and 1.7 in previous example.
If the implicit default mechanism is also enabled (see MODULES_IMPLICIT_DEFAULT), a default and latest symbolic versions are automatically defined for each module name (also at each directory level for deep modulefiles). These automatic version symbols are defined unless a symbolic version, alias, or regular module version already exists for these default or latest version names. Using the mod@latest (or mod/latest) syntax ensures highest available version will be selected.
The symbolic version loaded may be used over loaded module name to designate the loaded version of the module with associated selected variants.  This version symbol should be specified using the @ prefix notation (e.g., foo@loaded). An error is returned if no version of designated module is currently loaded.
Variants After the module name, variants can be specified. Module variants are alternative evaluation of the same modulefile. A variant is specified by associating a value to its name. This specification is then transmitted to the evaluating modulefile which instantiates the variant in the ModuleVariant array variable when reaching the variant modulefile command declaring this variant.
Variant can be specified with the name=value syntax where name is the declared variant name and value, the value this variant is set to when evaluating the modulefile.
Boolean variants can be specified with the +name syntax to set this variant on and with the -name or ~name syntaxes to set this variant off. The -name syntax is not supported on ml(1) command as the minus sign already means to unload designated module. The ~name and +name syntaxes could also be defined appended to another specification word (e.g., the module name, version or another variant specification), whereas -name syntax must be the start of a new specification word.
Boolean variants may also be specified with the name=value syntax. value should be set to 1, true, t, yes, y or on to enable the variant or it should be set to 0, false, f, no, n or off to disable the variant.
Shortcuts may be used to abbreviate variant specification. The variant_shortcut configuration option associates shortcut character to variant name. With a shortcut defined, variant could be specified with the <shortcut>value syntax. For instance if character % is set as a shortcut for variant foo, the %value syntax is equivalent to the foo=value syntax.
Specific characters used in variant specification syntax cannot be used as part of the name of a module. These specific characters are +, ~, = and all characters set as variant shortcut. Exception is made for + character which could be set one or several consecutive times at the end of module name (e.g., name+ or name++).
Module tags Module tags are piece of information that can be associated to individual modulefiles. Tags could be purely informational or may lead to specific behaviors.
Module tags may be inherited from the module state set by a modulefile command or consequence of a module action. The inherited tags are:
• auto-loaded: module has been automatically loaded by another module
• forbidden: module has been set forbidden through the use of the module-forbid command and thus this module cannot be loaded.
• hidden: module has been set hidden through the use of the module-hide command and thus it is not reported by default among the result of an avail sub-command.
• hidden-loaded: module has been set hidden once loaded through the use of the module-hide --hidden-loaded command thus it is not reported bu default among the result of a list sub-command.
• loaded: module is currently loaded
• nearly-forbidden: module will soon be forbidden, which has been set through the use of the module-forbid command. Thus this module will soon not be able to load anymore.
Tags may also be associated to modules by using the module-tag modulefile command. Among tags that could be set this way, some have a special meaning:
• sticky: module once loaded cannot be unloaded unless forced or reloaded (see Sticky modules section)
• super-sticky: module once loaded cannot be unloaded unless reloaded, module cannot be unloaded even if forced (see Sticky modules section)
Module tags are reported along the module they are associated to on avail and list sub-command results. Tags could be reported either:
• along the module name, all tags set within angle brackets, each tag separated from the others with a colon character (e.g., foo/1.2 <tag1:tag2>).
• graphically rendered over the module name for each tag associated to a Select Graphic Rendition (SGR) code in the color palette (see MODULES_COLORS)
When an abbreviated string is associated to a tag name (see MODULES_TAG_ABBREV), this abbreviation is used to report tag along the module name or the tag is graphically rendered over the module name if a SGR code is associated with tag abbreviation in the color palette. With an abbreviation set, the SGR code associated to the tag full name is ignored thus an SGR code should be associated to the abbreviation to get a graphical rendering of tag. If the abbreviation associated to a tag corresponds to the empty string, tag is not reported.
Graphical rendering is made over the tag name or abbreviation instead of over the module name for each tag name or abbreviation set in the MODULES_TAG_COLOR_NAME environment variable.
When several tags have to be rendered graphically over the same module name, each tag is rendered over a sub-part of the module name. In case more tags need to be rendered than the total number of characters in the module name, the remaining tags are graphically rendered over the tag name instead of over the module name.
When the JSON output mode is enabled (with --json), tags are reported by their name under the tags attribute. Tag abbreviation and color rendering do not apply on JSON output.
Module tags cannot be used in search query to designate a modulefile.
Sticky modules Modules are said sticky when they cannot be unloaded (they stick to the loaded environment). Two kind of stickyness can be distinguished:
• sticky module: cannot be unloaded unless if the unload is forced or if the module is reloaded after being unloaded
• super-sticky module: cannot be unloaded unless if the module is reloaded after being unloaded; super-sticky modules cannot be unloaded even if the unload is forced.
Modules are designated sticky by associating them the sticky or the super-sticky module tag with the module-tag modulefile command.
When stickyness is defined over the generic module name (and not over a specific module version, a version list or a version range), sticky or super-sticky module can be swapped by another version of module. For instance if the sticky tag is defined over foo module, loaded module foo/1.2 can be swapped by foo/2.0. Such stickyness definition means one version of module should stay loaded whatever version it is.
Module variants Module variants are alternative evaluation of the same modulefile. A variant is specified by associating a value to its name when designating module.  Variant specification relies on the Advanced module version specifiers mechanism.
Once specified, variant's value is transmitted to the evaluating modulefile which instantiates the variant in the ModuleVariant array variable when reaching the variant modulefile command declaring this variant.  For instance the module load foo/1.2 bar=value1 command leads to the evaluation of foo/1.2 modulefile with bar=value1 variant specification.  When reaching the variant bar value1 value2 value3 command in modulefile during its evaluation, the ModuleVariant(bar) array element is set to the value1 string.
Once variants are instantiated, modulefile's code could check the variant values to adapt the evaluation and define for instance different module requirements or produce different environment variable setup.
Variants are interpreted in contexts where modulefiles are evaluated. Thus the variants specified on module designation are ignored by the avail, whatis, is-avail, path or paths sub-commands.
When modulefile is evaluated a value should be specified for each variant this modulefile declares. When reaching the variant modulefile command declaring a variant, an error is raised if no value is specified for this variant and if no default value is declared. Specified variant value should match a value from the declared accepted value list otherwise an error is raised. Additionally if a variant is specified but does not correspond to a variant declared in modulefile, an error is raised.
Module variants are reported along the module they are associated to on list sub-command results. Variants are reported within curly braces next to module name, each variant definition separated from the others with a colon character (e.g., foo/1.2{variant1=value:+variant2}). Boolean variants are reported with the +name or -name syntaxes. When a shortcut character is defined for a variant (see MODULES_VARIANT_SHORTCUT) it is reported with the <shortcut>value syntax. For instance if % character is defined as a shortcut for variant1: foo/1.2{%value:+variant2}.
When the JSON output mode is enabled (with --json), variants are reported under the variants JSON object as name/value pairs. Values of Boolean variant are set as JSON Boolean. Other values are set as JSON strings. Variant shortcut and color rendering do not apply on JSON output.
Collections Collections describe a sequence of module use then module load commands that are interpreted by modulecmd.tcl to set the user environment as described by this sequence. When a collection is activated, with the restore sub-command, module paths and loaded modules are unused or unloaded if they are not part or if they are not ordered the same way as in the collection.
Collections are generated by the save sub-command that dumps the current user environment state in terms of module paths and loaded modules. By default collections are saved under the $HOME/.module directory.
Collections may be valid for a given target if they are suffixed. In this case these collections can only be restored if their suffix correspond to the current value of the MODULES_COLLECTION_TARGET environment variable (see the dedicated section of this topic below).
The module command exits with 0 if its execution succeed.  Otherwise 1 is returned.
__MODULES_AUTOINIT_INPROGRESS If set to 1, the autoinit sub-command process is skipped.
This environment variable is set to 1 by the autoinit sub-command after checking it is not set. It ensures no nested initialization of Modules occur. At the end of the processing of the autoinit sub-command, __MODULES_AUTOINIT_INPROGRESS is unset.
__MODULES_LMALTNAME A colon separated list of the alternative names set through module-version and module-alias statements corresponding to all loaded modulefiles. Each element in this list starts by the name of the loaded modulefile followed by all alternative names resolving to it. The loaded modulefile and its alternative names are separated by the ampersand character.
Each alternative name stored in __MODULES_LMALTNAME is prefixed by the al| string if it corresponds to a module alias or prefixed by the as| string if it corresponds to an automatic version symbol. These prefixes help to distinguish the different kind of alternative name.
This environment variable is intended for module command internal use to get knowledge of the alternative names matching loaded modulefiles in order to keep environment consistent when conflicts or pre-requirements are set over these alternative designations. It also helps to find a match after modulefiles being loaded when unload, is-loaded or info-loaded actions are run over these names.
Starting version 4.7 of Modules, __MODULES_LMALTNAME is also used on list sub-command to report the symbolic versions associated with the loaded modules.
__MODULES_LMCONFLICT A colon separated list of the conflict statements defined by all loaded modulefiles. Each element in this list starts by the name of the loaded modulefile declaring the conflict followed by the name of all modulefiles it declares a conflict with. These loaded modulefiles and conflicting modulefile names are separated by the ampersand character.
This environment variable is intended for module command internal use to get knowledge of the conflicts declared by the loaded modulefiles in order to keep environment consistent when a conflicting module is asked for load afterward.
__MODULES_LMPREREQ A colon separated list of the prereq statements defined by all loaded modulefiles. Each element in this list starts by the name of the loaded modulefile declaring the pre-requirement followed by the name of all modulefiles it declares a prereq with. These loaded modulefiles and pre-required modulefile names are separated by the ampersand character. When a prereq statement is composed of multiple modulefiles, these modulefile names are separated by the pipe character.
This environment variable is intended for module command internal use to get knowledge of the pre-requirement declared by the loaded modulefiles in order to keep environment consistent when a pre-required module is asked for unload afterward.
__MODULES_LMSOURCESH A colon separated list of the source-sh statements defined by all loaded modulefiles. Each element in this list starts by the name of the loaded modulefile declaring the environment changes made by the evaluation of source-sh scripts. This name is followed by each source-sh statement call and corresponding result achieved in modulefile. The loaded modulefile name and each source-sh statement description are separated by the ampersand character. The source-sh statement call and each resulting modulefile command (corresponding to the environment changes done by sourced script) are separated by the pipe character.
This environment variable is intended for module command internal use to get knowledge of the modulefile commands applied for each source-sh command when loading the modulefile. In order to reverse these modulefile commands when modulefile is unloaded to undo the environment changes.
__MODULES_LMTAG A colon separated list of the tags corresponding to all loaded modulefiles that have been set through module-tag statements or from other modulefile statements like module-forbid (that may apply the nearly-forbidden tag in specific situation) (see Module tags section).  Each element in this list starts by the name of the loaded modulefile followed by all tags applying to it. The loaded modulefile and its tags are separated by the ampersand character.
This environment variable is intended for module command internal use to get knowledge of the tags applying to loaded modulefiles in order to report these tags on list sub-command output or to apply specific behavior when unloading modulefile.
__MODULES_LMVARIANT A colon separated list of the variant instantiated through variant statements by all loaded modulefiles (see Module variants section).  Each element in this list starts by the name of the loaded modulefile followed by all the variant definitions set during the load of this module.  The loaded modulefile and each of its variant definition are separated by the ampersand character. Each variant definition starts with the variant name, followed by the variant value set, then a flag to know if variant is of the Boolean type and last element in this definition is a flag to know if the chosen value is the default one for this variant and if it has been automatically set or not. These four elements composing the variant definition are separated by the pipe character.
This environment variable is intended for module command internal use to get knowledge of the variant value defined by the loaded modulefiles in order to keep environment consistent when requirements are set over a specific variant value or just to report these variant values when listing loaded modules.
__MODULES_QUAR_<VAR> Value of environment variable <VAR> passed to modulecmd.tcl in order to restore <VAR> to this value once started.
__MODULES_QUARANTINE_SET If set to 1, restore the environment variables set on hold by the quarantine mechanism when starting modulecmd.tcl script. This variable is automatically defined by Modules shell initialization scripts or module shell function when they apply the quarantine mechanism.  (see MODULES_QUARANTINE_SUPPORT).
__MODULES_SHARE_<VAR> Reference counter variable for path-like variable <VAR>. A colon separated list containing pairs of elements. A pair is formed by a path element followed its usage counter which represents the number of times this path has been enabled in variable <VAR>. A colon separates the two parts of the pair.
An element of a path-like variable is added to the reference counter variable as soon as it is added more than one time. When an element of a path-like variable is not found in the reference counter variable, it means this element has only be added once to the path-like variable.
When an empty string is added as an element in the path-like variable, it is added to the reference counter variable even if added only once to distinguish between an empty path-like variable and a path-like variable containing an empty string as single element.
_LMFILES_ A colon separated list of the full pathname for all loaded modulefiles.
LOADEDMODULES A colon separated list of all loaded modulefiles.
MODULECONTACT Email address to contact in case any issue occurs during the interpretation of modulefiles.
MODULEPATH The path that the module command searches when looking for modulefiles. Typically, it is set to the main modulefiles directory, /usr/share/modules/modulefiles, by the initialization script. MODULEPATH can be set using module use or by the module initialization script to search group or personal modulefile directories before or after the main modulefile directory.
Path elements registered in the MODULEPATH environment variable may contain reference to environment variables which are converted to their corresponding value by module command each time it looks at the MODULEPATH value. If an environment variable referred in a path element is not defined, its reference is converted to an empty string.
MODULERCFILE The location of a global run-command file containing modulefile specific setup. See Modulecmd startup section for detailed information.
MODULES_ADVANCED_VERSION_SPEC If set to 1, enable advanced module version specifiers (see Advanced module version specifiers section). If set to 0, disable advanced module version specifiers.
Advanced module version specifiers enablement is defined in the following order of preference: MODULES_ADVANCED_VERSION_SPEC environment variable then the default set in modulecmd.tcl script configuration.  Which means MODULES_ADVANCED_VERSION_SPEC overrides default configuration.
MODULES_AUTO_HANDLING If set to 1, enable automated module handling mode. If set to 0 disable automated module handling mode. Other values are ignored.
Automated module handling mode consists in additional actions triggered when loading or unloading a modulefile to satisfy the constraints it declares.  When loading a modulefile, following actions are triggered:
• Requirement Load: load of the modulefiles declared as a prereq of the loading modulefile.
• Dependent Reload: reload of the modulefiles declaring a prereq onto loaded modulefile or declaring a prereq onto a modulefile part of this reloading batch.
When unloading a modulefile, following actions are triggered:
• Dependent Unload: unload of the modulefiles declaring a non-optional prereq onto unloaded modulefile or declaring a non-optional prereq onto a modulefile part of this unloading batch. A prereq modulefile is considered optional if the prereq definition order is made of multiple modulefiles and at least one alternative modulefile is loaded.
• Useless Requirement Unload: unload of the prereq modulefiles that have been automatically loaded for either the unloaded modulefile, an unloaded dependent modulefile or a modulefile part of this useless requirement unloading batch. Modulefiles are added to this unloading batch only if they are not required by any other loaded modulefiles.
• Dependent Reload: reload of the modulefiles declaring a conflict or an optional prereq onto either the unloaded modulefile, an unloaded dependent or an unloaded useless requirement or declaring a prereq onto a modulefile part of this reloading batch.
In case a loaded modulefile has some of its declared constraints unsatisfied (pre-required modulefile not loaded or conflicting modulefile loaded for instance), this loaded modulefile is excluded from the automatic reload actions described above.
For the specific case of the switch sub-command, where a modulefile is unloaded to then load another modulefile. Dependent modulefiles to Unload are merged into the Dependent modulefiles to Reload that are reloaded after the load of the switched-to modulefile.
Automated module handling mode enablement is defined in the following order of preference: --auto/--no-auto command line switches, then MODULES_AUTO_HANDLING environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_AUTO_HANDLING overrides default configuration and --auto/‐ --no-auto command line switches override every other ways to enable or disable this mode.
MODULES_AVAIL_INDEPTH If set to 1, enable in depth search results for avail sub-command. If set to 0 disable avail sub-command in depth mode. Other values are ignored.
When in depth mode is enabled, modulefiles and directories contained in directories matching search query are also included in search results. When disabled these modulefiles and directories contained in matching directories are excluded.
avail sub-command in depth mode enablement is defined in the following order of preference: --indepth/--no-indepth command line switches, then MODULES_AVAIL_INDEPTH environment variable, then the default set in modulecmd.tcl script configuration.  Which means MODULES_AVAIL_INDEPTH overrides default configuration and --indepth/--no-indepth command line switches override every other ways to enable or disable this mode.
MODULES_AVAIL_OUTPUT A colon separated list of the elements to report in addition to module names on avail sub-command regular output mode.
Accepted elements that can be set in value list are:
• alias: module aliases.
• dirwsym: directories associated with symbolic versions.
• key: legend appended at the end of the output to explain it.
• modulepath: modulepath names set as header prior the list of available modules found in them.
• sym: symbolic versions associated with available modules.
• tag: tags associated with available modules.
The order of the elements in the list does not matter. Module names are the only content reported when LIST is set to an empty value.
In case the modulepath element is missing from value list, the available modules from global/user rc and all enabled modulepaths are reported as a single list.
avail sub-command regular output content is defined in the following order of preference: --output/-o command line switches, then MODULES_AVAIL_OUTPUT environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_AVAIL_OUTPUT overrides default configuration and --output/-o command line switches override every other ways to configure regular output content.
MODULES_AVAIL_TERSE_OUTPUT A colon separated list of the elements to report in addition to module names on avail sub-command terse output mode.
See MODULES_AVAIL_OUTPUT to get the accepted elements that can be set in value list.
avail sub-command terse output content is defined in the following order of preference: --output/-o command line switches, then MODULES_AVAIL_TERSE_OUTPUT environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_AVAIL_TERSE_OUTPUT overrides default configuration and --output/-o command line switches override every other ways to configure terse output content.
MODULES_CMD The location of the active module command script.
MODULES_COLLECTION_PIN_VERSION If set to 1, register exact version number of modulefiles when saving a collection. Otherwise modulefile version number is omitted if it corresponds to the explicitly set default version and also to the implicit default when the configuration option implicit_default is enabled.
MODULES_COLLECTION_TARGET The collection target that determines what collections are valid thus reachable on the current system.
Collection directory may sometimes be shared on multiple machines which may use different modules setup. For instance modules users may access with the same HOME directory multiple systems using different OS versions.  When it happens a collection made on machine 1 may be erroneous on machine 2.
When a target is set, only the collections made for that target are available to the restore, savelist, saveshow and saverm sub-commands. Saving a collection registers the target footprint by suffixing the collection filename with .$MODULES_COLLECTION_TARGET. The collection target is not involved when collection is specified as file path on the saveshow, restore and save sub-commands.
For example, the MODULES_COLLECTION_TARGET variable may be set with results from commands like lsb_release, hostname, dnsdomainname, etc.
MODULES_COLOR Defines if output should be colored or not. Accepted values are never, auto and always.
When color mode is set to auto, output is colored only if the standard error output channel is attached to a terminal.
Colored output enablement is defined in the following order of preference: --color command line switch, then MODULES_COLOR environment variable, then NO_COLOR, CLICOLOR and CLICOLOR_FORCE environment variables, then the default set in modulecmd.tcl script configuration. Which means MODULES_COLOR overrides default configuration and the NO_COLOR and CLICOLOR/CLICOLOR_FORCE variables.  --color command line switch overrides every other ways to enable or disable this mode.
NO_COLOR, CLICOLOR and CLICOLOR_FORCE environment variables are also honored to define color mode. The never mode is set if NO_COLOR is defined (regardless of its value) or if CLICOLOR equals to 0. If CLICOLOR is set to another value, it corresponds to the auto mode. The always mode is set if CLICOLOR_FORCE is set to a value different than 0.  NO_COLOR variable prevails over CLICOLOR and CLICOLOR_FORCE. Color mode set with these three variables is superseded by mode set with MODULES_COLOR environment variable.
MODULES_COLORS Specifies the colors and other attributes used to highlight various parts of the output. Its value is a colon-separated list of output items associated to a Select Graphic Rendition (SGR) code. It follows the same syntax than LS_COLORS.
Output items are designated by keys. Items able to be colorized are: highlighted element (hi), debug information (db), trace information (tr), tag separator (se); Error (er), warning (wa), module error (me) and info (in) message prefixes; Modulepath (mp), directory (di), module alias (al), module variant (va), module symbolic version (sy), module default version (de) and modulefile command (cm).
Module tags can also be colorized. The key to set in the color palette to get a graphical rendering of a tag is the tag name or the tag abbreviation if one is defined for tag. The SGR code applied to a tag name is ignored if an abbreviation is set for this tag thus the SGR code should be defined for this abbreviation to get a graphical rendering. Each basic tag has by default a key set in the color palette, based on its abbreviated string: auto-loaded (aL), forbidden (F), hidden and hidden-loaded (H), loaded (L), nearly-forbidden (nF), sticky (S) and super-sticky (sS).
See the Select Graphic Rendition (SGR) section in the documentation of the text terminal that is used for permitted values and their meaning as character attributes. These substring values are integers in decimal representation and can be concatenated with semicolons. Modules takes care of assembling the result into a complete SGR sequence (\33[...m). Common values to concatenate include 1 for bold, 4 for underline, 30 to 37 for foreground colors and 90 to 97 for 16-color mode foreground colors. See also https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters for a complete SGR code reference.
No graphical rendition will be applied to an output item that could normally be colored but which is not defined in the color set. Thus if MODULES_COLORS is defined empty, no output will be colored at all.
The color set is defined for Modules in the following order of preference: MODULES_COLORS environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_COLORS overrides default configuration.
MODULES_EDITOR Text editor command name or path for use to open modulefile through the edit sub-command.
Editor command is defined for Modules in the following order of preference: MODULES_EDITOR, or VISUAL or EDITOR environment variables, then the default set in modulecmd.tcl script configuration. Which means MODULES_EDITOR overrides VISUAL or EDITOR environment variables and default configuration.
MODULES_EXTENDED_DEFAULT If set to 1, a specified module version is matched against starting portion of existing module versions, where portion is a substring separated from the rest of the version string by a . character. For example specified modules mod/1 and mod/1.2 will match existing  modulefile mod/1.2.3.
In case multiple modulefiles match the specified module version and a single module has to be selected, the explicitly set default version is returned if it is part of matching modulefiles. Otherwise the implicit default among matching modulefiles is returned if defined (see MODULES_IMPLICIT_DEFAULT section)
This environment variable supersedes the value of the configuration option extended_default set in modulecmd.tcl script.
MODULES_ICASE When module specification are passed as argument to module sub-commands or modulefile Tcl commands, defines the case sensitiveness to apply to match them. When MODULES_ICASE is set to never, a case sensitive match is applied in any cases. When set to search, a case insensitive match is applied to the avail, whatis and paths sub-commands. When set to always, a case insensitive match is also applied to the other module sub-commands and modulefile Tcl commands for the module specification they receive as argument.
Case sensitiveness behavior is defined in the following order of preference: --icase command line switch, which corresponds to the always mode, then MODULES_ICASE environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_ICASE overrides default configuration and --icase command line switch overrides every other ways to set case sensitiveness behavior.
MODULES_IMPLICIT_DEFAULT Defines (if set to 1) or not (if set to 0) an implicit default version for modules without a default version explicitly defined (see Locating Modulefiles section in the modulefile(4) man page).
Without either an explicit or implicit default version defined a module must be fully qualified (version should be specified in addition to its name) to get:
• targeted by module load, switch, display, help, test and path sub-commands.
• restored from a collection, unless already loaded in collection-specified order.
• automatically loaded by automated module handling mechanisms (see MODULES_AUTO_HANDLING section) when declared as module requirement, with prereq or module load modulefile commands.
An error is returned in the above situations if either no explicit or implicit default version is defined.
This environment variable supersedes the value of the configuration option implicit_default set in modulecmd.tcl script. This environment variable is ignored if implicit_default has been declared locked in locked_configs configuration option.
MODULES_IMPLICIT_REQUIREMENT Defines (if set to 1) or not (if set to 0) an implicit prereq or conflict requirement onto modules specified respectively on module load or module unload commands in modulefile. When enabled an implicit conflict requirement onto switched-off module and a prereq requirement onto switched-on module are also defined for module switch commands used in modulefile.
This environment variable supersedes the value of the configuration option implicit_requirement set in modulecmd.tcl script.  MODULES_IMPLICIT_REQUIREMENT is in turn superseded by the --not-req option that applies to a module command in a modulefile.
MODULES_LIST_OUTPUT A colon separated list of the elements to report in addition to module names on list sub-command regular output mode.
• header: sentence to introduce the list of loaded modules or to state that no modules are loaded currently.
• idx: index position of each loaded module.
• variant: variant values selected for loaded modules.
• sym: symbolic versions associated with loaded modules.
• tag: tags associated with loaded modules.
list sub-command regular output content is defined in the following order of preference: --output/-o command line switches, then MODULES_LIST_OUTPUT environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_LIST_OUTPUT overrides default configuration and --output/‐ -o command line switches override every other ways to configure regular output content.
MODULES_LIST_TERSE_OUTPUT A colon separated list of the elements to report in addition to module names on list sub-command terse output mode.
See MODULES_LIST_OUTPUT to get the accepted elements that can be set in value list.
list sub-command regular output content is defined in the following order of preference: --output/-o command line switches, then MODULES_LIST_TERSE_OUTPUT environment variable, then the default set in modulecmd.tcl script configuration. Which means MODULES_LIST_TERSE_OUTPUT overrides default configuration and --output/-o command line switches override every other ways to configure regular output content.
MODULES_MCOOKIE_VERSION_CHECK If set to 1, the version set in the Modules magic cookie in modulefile is checked against the current version of modulecmd.tcl to determine if the modulefile can be evaluated.
MODULES_ML If set to 1, define ml command when initializing Modules (see Package Initialization section). If set to 0, ml command is not defined.
ml command enablement is defined in the following order of preference: MODULES_ML environment variable then the default set in modulecmd.tcl script configuration. Which means MODULES_ML overrides default configuration.