always-load [--optional] [--tag taglist] modulefile...

Load modulefile and apply the keep-loaded tag to it in order to avoid the automatic unload of this modulefile when modules dependent of it are unloaded.

modulefile is declared as a requirement of currently loading module. This command acts as an alias of module load command. If more than one modulefile are specified, then this list acts as a Boolean AND operation, which means all specified modulefiles are required.

When the --optional option is set, each specified modulefile is declared as an optional requirement. A modulefile that cannot be loaded, will not stop the evaluation.

The --tag option accepts a list of module tags to apply to modulefile once loaded in addition to the keep-loaded tag. taglist corresponds to the concatenation of multiple tags separated by colon character. taglist should not contain tags inherited from modulefile state or from other modulefile commands. If module is already loaded, tags from taglist are added to the list of tags already applied to this module.

append-path [-d C|--delim C|--delim=C] [--duplicates] variable value...

See prepend-path.

break

This is not a Modules-specific command, it's actually part of Tcl, which has been overloaded similar to the continue and exit commands to have the effect of causing the module not to be listed as loaded and not affect other modules being loaded concurrently. All non-environment commands within the module will be performed up to this point. Processing will continue on to the next module on the command line unless if abort_on_error configuration option is enabled for running module sub-command. The break command will only have this effect if not used within a Tcl loop though.

An example: Suppose that a full selection of modulefiles are needed for various different architectures, but some of the modulefiles are not needed and the user should be alerted. Having the unnecessary modulefile be a link to the following notavail modulefile will perform the task as required.

#%Module
proc ModulesHelp {} {


    puts stderr {This module does nothing but alert the user}


    puts stderr "that the [module-info name] module is not available"
}
module-whatis {Notifies user that module is not available.}
set curMod [module-info name]
if {[module-info mode load]} {


    puts stderr "Note: '$curMod' is not available for [uname sysname]."
}
break

Modulefile using break command when unloading may be unloaded anyway if --force option is set. To forbid the unload of a modulefile, it is recommended to tag it super-sticky with module-tag command.

chdir directory

Set the current working directory to directory.

complete shell name body

Define shell completion for command name with specified body if shell is the current shell under which modulecmd.tcl was invoked. Body corresponds to argument options accepted by the shell command which defines completion. When a modulefile is unloaded, complete becomes uncomplete.

The following shells are supported: bash, tcsh, bash and fish. Please refer to the documentation of these shells to learn how to define completion. The command is ignored if an unsupported shell is specified.

conflict modulefile...

conflict controls whether or not the modulefile will be loaded. The conflict command lists modulefiles which conflict with the current modulefile. If a list contains more than one modulefile, then each member of the list acts as a Boolean OR operation. Multiple conflict commands may be used to create a Boolean AND operation. If one of the requirements have not been satisfied, an error is reported and the current modulefile makes no changes to the user's environment.

If an argument for conflict is a directory and any other modulefile from that directory has been loaded, then a conflict will occur. For example, specifying X11 as a conflict will stop X11/R4 and X11/R5 from being loaded at the same time.

The parameter modulefile may also be a symbolic modulefile name or a modulefile alias. It may also leverage a specific syntax to finely select module version (see Advanced module version specifiers section below).

continue

This is not a modules specific command but another overloaded Tcl command and is similar to the break or exit commands except the module will be listed as loaded as well as performing any environment or Tcl commands up to this point and then continuing on to the next module on the command line. The continue command will only have this effect if not used within a Tcl loop though.

depends-on [--optional] [--tag taglist] modulefile...

Alias of prereq-all command.

exit [N]

This is not a modules specific command but another overloaded Tcl command and is similar to the break or continue commands. However, this command will cause the immediate cessation of this module. Any additional modules on the command line will not be evaluated even if the abort_on_error configuration option is disabled for running module sub-command. This module and the subsequent modules will not be listed as loaded. No environment commands will be performed in the current module.

family name

Defines loading modulefile as a member of family name. Only one member of a family could be loaded. Error is raised when attempting to load another member of the same family name.

family corresponds to the definition of a conflict on name and the definition of a module-alias name targeting currently loading module.

In addition, the MODULES_FAMILY_<NAME> environment variable is defined and set to the currently loading module name minus version. This variable helps to know what module provides for the family name in the currently loaded environment. For instance if loading modulefile foo/1.0 defines being member of the bar family, the MODULES_FAMILY_BAR will be set to the foo value. For compatibility, the LMOD_FAMILY_<NAME> environment variable is also defined and set to the same value than MODULES_FAMILY_<NAME>.

name should be a non-empty string only containing characters that could be part of an environment variable name (i.e., [a-zA-Z0-9_]).

getenv [--return-value] variable [value]

Returns value of environment variable. If variable is not defined, value is returned if set, an empty string is returned otherwise. The getenv command should be preferred over the Tcl global variable env to query environment variables.

When modulefile is evaluated in display mode, getenv returns variable name prefixed with dollar sign (e.g., $variable) unless if the --return-value option is set. When this option is set the value of environment variable or defined fallback value is returned in display mode.

getvariant [--return-value] variant [value]

Returns value of designated variant. If variant is not defined, value is returned if set, an empty string is returned otherwise. The getvariant command should be preferred over the ModuleVariant Tcl array to query a variant value.

When modulefile is evaluated in display mode, getvariant returns variant name enclosed in curly braces (e.g., {variant}) unless if the --return-value option is set. When this option is set the value of variant or defined fallback value is returned in display mode.

is-avail modulefile...

The is-avail command returns a true value if any of the listed modulefiles exists in enabled MODULEPATH. If a list contains more than one modulefile, then each member acts as a boolean OR operation. If an argument for is-avail is a directory and a modulefile exists in the directory is-avail would return a true value.

The parameter modulefile may also be a symbolic modulefile name or a modulefile alias. It may also leverage a specific syntax to finely select module version (see Advanced module version specifiers section below).

is-loaded [modulefile...]

The is-loaded command 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. If a list contains more than one modulefile, then each member acts as a boolean OR operation. If an argument for is-loaded is a directory and any modulefile from the directory has been loaded is-loaded would return a true value.

The parameter modulefile may also be a symbolic modulefile name or a modulefile alias. It may also leverage a specific syntax to finely select module version (see Advanced module version specifiers section below).

is-saved [collection...]

The is-saved command returns a true value if any of the listed collections exists or if any collection exists in case no argument is provided. If a list contains more than one collection, then each member acts as a boolean OR operation.

If MODULES_COLLECTION_TARGET is set, a suffix equivalent to the value of this variable is appended to the passed collection name. In case no collection argument is provided, a true value will only be returned if a collection matching currently set target exists.

is-used [directory...]

The is-used command 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. If a list contains more than one directory, then each member acts as a boolean OR operation.

module [sub-command] [sub-command-options] [sub-command-args]

This command permits a modulefile to load or unload other modulefiles or to use or unuse modulepaths. No checks are made to ensure that the modulefile does not try to load itself. Often it is useful to have a single modulefile that performs a number of module load commands. For example, if every user on the system requires a basic set of applications loaded, then a core modulefile would contain the necessary module load commands.

The --not-req option may be set for the load, try-load, load-any, unload and switch sub-commands to inhibit the definition of an implicit prereq or conflict requirement onto specified modules.

On try-load sub-command, modulefiles are considered optional prereq requirement. However an error is raised if they cannot be loaded unless if they are not found or forbidden.

The load-any sub-command loads one modulefile from the specified list. An error is obtained if no modulefile from the list can be loaded. No operation is performed if a modulefile from the list is found already loaded.

The unuse sub-command accepts the --remove-on-unload, --noop-on-unload, --append-on-unload and --prepend-on-unload options to control the behavior to apply when modulefile is unloaded. See remove-path for further explanation.

The load, try-load, load-any and switch sub-commands accept the --tag option to apply specified tags to modulefile once loaded. Option accepts a concatenation of multiple module tags separated by colon character. taglist should not contain tags inherited from modulefile state or from other modulefile commands. If module is already loaded, tags from taglist are added to the list of tags already applied to this module.

Command line switches --auto, --no-auto and --force are ignored when passed to a module command set in a modulefile.

Not all the sub-commands described in the Module Sub-Commands section of the module man page are available when module is used as a Modules specific Tcl command. The following table summarizes the different sub-commands available for each interpretation context.

Sub-commands available from modulefile interpretation	Sub-commands available from initrc configuration file and sourced script file	Sub-commands available from run-command (rc) file interpretation
load, load-any, switch, try-load, unload, unuse, use. Also available but not recommended for use from regular modulefile: aliases, avail, display, initadd, initclear, initlist, initprepend, initrm, initswitch, list, purge, reload, restore, save, savelist, saverm, saveshow, search, test, whatis	Same sub-commands available than for modulefile and config sub-command.	None

module-alias name modulefile

Assigns the modulefile to the alias name. This command should be placed in one of the modulecmd.tcl rc files in order to provide shorthand invocations of frequently used modulefile names.

The parameter modulefile may be either

module-forbid [options] modulefile...

Forbid use of modulefile. An error is obtained when trying to evaluate a forbidden module. This command should be placed in one of the modulecmd.tcl rc files.

module-forbid command accepts the following options:

If --after option is set, forbidding is only effective after specified date time. Following the same principle, if --before option is set, forbidding is only effective before specified date time. Accepted date time format is YYYY-MM-DD[THH:MM]. If no time (HH:MM) is specified, 00:00 is assumed. --after and --before options are not supported on Tcl versions prior to 8.5.

If --not-user option is set, forbidding is not applied if the username of the user currently running modulecmd.tcl is part of the list of username specified. Following the same approach, if --not-group option is set, forbidding is not applied if current user is member of one the group specified. When both options are set, forbidding is not applied if a match is found for --not-user or --not-group.

If --user option is set, forbidding is applied only if the username of the user currently running modulecmd.tcl is part of the list of username specified. Following the same approach, if --group option is set, forbidding is applied only if current user is member of one the group specified. When both options are set, forbidding is applied if a match is found for --user or --group. These two options prevail over --not-user and --not-group options.

Error message returned when trying to evaluate a forbidden module can be supplemented with the text message set through --message option.

If --after option is set, modules are considered nearly forbidden during a number of days defined by the nearly_forbidden_days modulecmd.tcl configuration option (see MODULES_NEARLY_FORBIDDEN_DAYS), prior reaching the expiry date fixed by --after option. When a nearly forbidden module is evaluated a warning message is issued to inform module will soon be forbidden. This warning message can be supplemented with the text message set through --nearly-message option.

If a module-forbid command applies to a modulefile also targeted by a module-hide --hard command, this module is unveiled when precisely named to return an access error.

Forbidden modules included in the result of an avail sub-command are reported with a forbidden tag applied to them. Nearly forbidden modules included in the result of an avail or a list sub-command are reported with a nearly-forbidden tag applied to them. See Module tags section in module.

The parameter modulefile may leverage a specific syntax to finely select module version (see Advanced module version specifiers section below). It may also be a full path file name to precisely designate one module in a specific modulepath.

module-hide [options] modulefile...

Hide modulefile to exclude it from available module search or module selection unless query refers to modulefile by its exact name. This command should be placed in one of the modulecmd.tcl rc files.

module-hide command accepts the following options:

When --soft option is set, modulefile is also set hidden, but hiding is disabled when search or selection query's root name matches module's root name. This soft hiding mode enables to hide modulefiles from bare module availability listing yet keeping the ability to select such module for load with the regular resolution mechanism (i.e., no need to use module exact name to select it)

When --hard option is set, modulefile is also set hidden and stays hidden even if search or selection query refers to modulefile by its exact name.

When --hidden-loaded option is set, hidden state also applies to the modulefile when it is loaded. Hidden loaded modules do not appear on list sub-command output, unless --all option is set. Their loading or unloading informational messages are not reported unless the verbosity of Modules is set to a level higher than verbose. Hidden loaded modules are detected in any cases by state query commands like is-loaded.

If --after option is set, hiding is only effective after specified date time. Following the same principle, if --before option is set, hiding is only effective before specified date time. Accepted date time format is YYYY-MM-DD[THH:MM]. If no time (HH:MM) is specified, 00:00 is assumed. --after and --before options are not supported on Tcl versions prior to 8.5.

If --not-user option is set, hiding is not applied if the username of the user currently running modulecmd.tcl is part of the list of username specified. Following the same approach, if --not-group option is set, hiding is not applied if current user is member of one the group specified. When both options are set, hiding is not applied if a match is found for --not-user or --not-group.

If --user option is set, hiding is applied only if the username of the user currently running modulecmd.tcl is part of the list of username specified. Following the same approach, if --group option is set, hiding is applied only if current user is member of one the group specified. When both options are set, hiding is applied if a match is found for --user or --group. These two options prevail over --not-user and --not-group options.

If the --all option is set on avail, aliases, whatis or search sub-commands, hiding is disabled thus hidden modulefiles are included in module search. Hard-hidden modules (i.e., declared hidden with --hard option) are not affected by --all and stay hidden even if option is set. --all option does not apply to module selection sub-commands like load. Thus in such context a hidden module should always be referred by its exact full name (e.g., foo/1.2.3 not foo) unless if it has been hidden in --soft mode. A hard-hidden module cannot be unveiled or selected in any case.

If several module-hide commands target the same modulefile, the strongest hiding level is retained which means if both a regular, a --soft hiding command match a given module, regular hiding mode is considered. If both a regular and a --hard hiding command match a given module, hard hiding mode is retained. A set --hidden-loaded option is retained even if the module-hide statement on which it is declared is superseded by a stronger module-hide statement with no --hidden-loaded option set.

Hidden modules included in the result of an avail sub-command are reported with a hidden tag applied to them. Hidden loaded modules included in the result of a list sub-command are reported with a hidden-loaded tag applied to them. This tag is not reported on avail sub-command context. See Module tags section in module.

The parameter modulefile may also be a symbolic modulefile name or a modulefile alias. It may also leverage a specific syntax to finely select module version (see Advanced module version specifiers section below). Moreover it may also be a full path file name to precisely designate one module in a specific modulepath.

module-info option [info-args]

Provide information about the modulecmd.tcl program's state. Some of the information is specific to the internals of modulecmd.tcl. option is the type of information to be provided, and info-args are any arguments needed.

module-info alias name

module-info command [commandname]

module-info loaded modulefile

module-info mode [modetype]

module-info name

module-info shell [shellname]

module-info shelltype [shelltypename]

module-info specified

module-info symbols modulefile

module-info tags [tag]

module-info type

module-info usergroups [name]

module-info username [name]

module-info version modulefile

module-tag [options] tag modulefile...

Associate tag to designated modulefile. This tag information will be reported along modulefile on avail and list sub-commands (see Module tags section in module). Tag information can be queried during modulefile evaluation with the module-info tags modulefile command. module-tag commands should be placed in one of the modulecmd.tcl rc files.

module-tag command accepts the following options:

If --not-user option is set, the tag is not applied if the username of the user currently running modulecmd.tcl is part of the list of username specified. Following the same approach, if --not-group option is set, the tag is not applied if current user is member of one the group specified. When both options are set, the tag is not applied if a match is found for --not-user or --not-group.

If --user option is set, the tag is applied only if the username of the user currently running modulecmd.tcl is part of the list of username specified. Following the same approach, if --group option is set, the tag is applied only if current user is member of one the group specified. When both options are set, the tag is applied if a match is found for --user or --group. These two options prevail over --not-user and --not-group options.

The parameter modulefile may also be a symbolic modulefile name or a modulefile alias. It may also leverage a specific syntax to finely select module version (see Advanced module version specifiers section below). Moreover it may also be a full path file name to precisely designate one module in a specific modulepath.

Tags inherited from other modulefile commands or module states cannot be set with module-tag. Otherwise an error is returned. Those special tags are: auto-loaded, forbidden, hidden, hidden-loaded, loaded and nearly-forbidden.

When tag equals sticky or super-sticky, designated modulefile is defined Sticky modules.

When tag equals keep-loaded, designated modulefile is not automatically unloaded when it has been auto-loaded and its dependent modules are getting unloaded.

module-version modulefile version-name...

Assigns the symbolic version-name to the modulefile. This command should be placed in one of the modulecmd.tcl rc files in order to provide shorthand invocations of frequently used modulefile names.

The special version-name default specifies the default version to be used for module commands, if no specific version is given. This replaces the definitions made in the .version file in former modulecmd.tcl releases.

The parameter modulefile may be either

module-virtual name modulefile

Assigns the modulefile to the virtual module name. This command should be placed in rc files in order to define virtual modules.

A virtual module stands for a module name associated to a modulefile. The modulefile is the script interpreted when loading or unloading the virtual module which appears or can be found with its virtual name.

The parameter modulefile corresponds to the relative or absolute file location of a modulefile.

module-whatis string

Defines a string which is displayed in case of the invocation of the module whatis command. There may be more than one module-whatis line in a modulefile. This command takes no actions in case of load, display, etc. invocations of modulecmd.tcl.

The string parameter has to be enclosed in double-quotes if there's more than one word specified. Words are defined to be separated by whitespace characters (space, tab, cr).

modulepath-label directory label

Assigns label string to modulepath directory. This label is used on avail output to refer to the modulepath.

The parameter directory corresponds to a fully or partially qualified modulepath. If directory is . (dot) then the current directory of the modulerc file defining this command is assumed.

prepend-path [-d C|--delim C|--delim=C] [--duplicates] variable value...

Append or prepend value to environment variable. The variable is a colon, or delimiter, separated list such as PATH=directory:directory:directory. The default delimiter is a colon :, but an arbitrary one can be given by the --delim option. For example a space can be used instead (which will need to be handled in the Tcl specially by enclosing it in " " or { }). A space, however, can not be specified by the --delim=C form.

A reference counter environment variable is also set to know the number of times value has been added to environment variable when it is added more than one time. This reference counter environment variable is named by prefixing variable by __MODULES_SHARE_.

When value is already defined in environment variable, it is not added again or moved at the end or at the beginning of variable. Exception is made when the --duplicates option is set in which case value is added again to variable.

If the variable is not set, it is created. When a modulefile is unloaded, append-path and prepend-path become remove-path.

If value corresponds to the concatenation of multiple elements separated by colon, or delimiter, character, each element is treated separately.

prereq [--optional] [--tag taglist] modulefile...

prereq controls whether or not the modulefile will be loaded. The prereq command lists modulefiles which must have been previously loaded before the current modulefile will be loaded. If a list contains more than one modulefile, then each member of the list acts as a Boolean OR operation. Multiple prereq commands may be used to create a Boolean AND operation. If one of the requirements have not been satisfied, an error is reported and the current modulefile makes no changes to the user's environment.

If an argument for prereq is a directory and any modulefile from the directory has been loaded, then the prerequisite is met. For example, specifying X11 as a prereq means that any version of X11, X11/R4 or X11/R5, must be loaded before proceeding.

The parameter modulefile may also be a symbolic modulefile name or a modulefile alias. It may also leverage a specific syntax to finely select module version (see Advanced module version specifiers section below).

When the --optional option is set, the whole list of specified modulefiles is declared as an optional requirement list. Evaluation is not stopped if no modulefile from the list is loaded.

If the auto_handling configuration option is enabled prereq will attempt to load specified modulefile if not found loaded yet (see MODULES_AUTO_HANDLING in module).

The --tag option accepts a list of module tags to apply to modulefile once loaded. taglist corresponds to the concatenation of multiple tags separated by colon character. taglist should not contain tags inherited from modulefile state or from other modulefile commands. If module is already loaded, tags from taglist are added to the list of tags already applied to this module.

prereq-all [--optional] [--tag taglist] modulefile...

Declare modulefile as a requirement of currently loading module. This command acts as an alias of prereq command. If more than one modulefile are specified, then this list acts as a Boolean AND operation, which means all specified modulefiles are required.

When the --optional option is set, each specified modulefile is declared as an optional requirement. A modulefile that cannot be loaded, will not stop the evaluation.

prereq-any [--optional] [--tag taglist] modulefile...

Alias of prereq command.

pushenv variable value

Set environment variable to value and save previous value of variable to restore it when modulefile is unloaded. Like for setenv modulefile command, changes made to variable with pushenv are applied to variable in Tcl's env array to update environment variable value in current evaluation context.

When modulefile is unloaded, the value saved from the pushenv command of this modulefile is removed from saved value stack list. variable is then set to the remaining value on top of the stack or it is unset if stack becomes empty.

Saved value stack list for variable is stored in an environment variable which is named by prefixing variable by __MODULES_PUSHENV_.

puts [-nonewline] [channelId] string

Writes the characters given by string to the channel given by channelId. This command is not a Modules-specific command, it is actually part of Tcl. See the puts(n) Tcl man page for a complete description of this command.

Content written to the stderr channel is rendered as output message produced by modulefile. Content written to the stdout channel is rendered as shell command evaluated in the user current shell environment. Content sent to stdout is spooled to be rendered after the environment changes made by modulefile.

When channelId equals prestdout, content is rendered as shell command evaluated in current shell environment. This content is spooled and rendered prior any other environment changes.

remove-path [options] variable value... [--append-on-unload|--prepend-on-unload value...]

Remove value from the colon, or delimiter, separated list in variable.

remove-path command accepts the following options:

See prepend-path or append-path for further explanation of using an arbitrary delimiter. Every string between colons, or delimiters, in variable is compared to value. If the two match, value is removed from variable if its reference counter is equal to 1 or unknown.

When --index option is set, value refers to an index in variable list. The string element pointed by this index is set for removal.

When --glob option is set, value refers to a glob-style pattern which is matched against values in variable to find those to remove. * character in value matches any sequence of characters, including a null string. ? character in value matches any single character. See string(n) Tcl command for the full list of special characters.

When modulefile is unloaded, no operation is performed by default or if the --noop-on-unload option is set. If the --remove-on-unload option is set, value is removed. If the --append-on-unload option is set, append back value removed at load time or specific value if any set. If the --prepend-on-unload option is set, prepend back value removed at load time or specific value if any set. These options cannot be set if --index option is also set. The --append-on-unload and --prepend-on-unload options cannot be set if --glob option is also set.

Reference counter of value in variable denotes the number of times value has been added to variable. This information is stored in environment __MODULES_SHARE_variable. When attempting to remove value from variable, relative reference counter is checked and value is removed only if counter is equal to 1 or not defined. Otherwise value is kept in variable and reference counter is decreased by 1. If counter equals 1 after being decreased, value and its counter are removed from reference counter variable.

If value corresponds to the concatenation of multiple elements separated by colon, or delimiter, character, each element is treated separately.

An error is raised if value equals delimiter character.

reportError string

Output string as an error message during modulefile evaluation and raise error count. reportError does not abort modulefile evaluation. Use the error(n) Tcl command to abort evaluation in addition to emit an error message.

reportWarning string

Output string as a warning message during modulefile evaluation.

require-fullname

Abort load evaluation of modulefile if name specified to designate it is not the fully qualified one. Module alias or a symbolic version names are considered fully qualified names, exception made for the default symbol.

set-alias alias-name alias-string

Sets an alias with the name alias-name in the user's environment to the string alias-string. For some shells, aliases are not possible and the command has no effect (see Shell support section). When a modulefile is unloaded, set-alias becomes unset-alias.

set-function function-name function-string

Creates a function with the name function-name in the user's environment with the function body function-string. For some shells, functions are not possible and the command has no effect (see Shell support section). When a modulefile is unloaded, set-function becomes unset-function.

setenv [--set-if-undef] variable value

Set environment variable to value. The setenv command will also change the process' environment. A reference using Tcl's env associative array will reference changes made with the setenv command. Changes made using Tcl's env associative array will NOT change the user's environment variable like the setenv command. An environment change made this way will only affect the module parsing process. The setenv command is also useful for changing the environment prior to the exec or system command. When a modulefile is unloaded, setenv becomes unsetenv. If the environment variable had been defined it will be overwritten while loading the modulefile. A subsequent unload will unset the environment variable - the previous value cannot be restored! (Unless you handle it explicitly or if you use the pushenv modulefile command instead of setenv)

When the --set-if-undef option is set, environment variable is defined when modulefile is loaded only if not yet defined.

source-sh [--ignore eltlist] shell script [arg...]

Evaluate with shell the designated script with defined arguments to find out the environment changes it does. Those changes obtained by comparing environment prior and after script evaluation are then translated into corresponding modulefile commands, which are then applied during modulefile evaluation as if they were directly written in it.

When modulefile is unloaded, environment changes done are reserved by evaluating in the unload context the resulting modulefile commands, which were recorded in the __MODULES_LMSOURCESH environment variable at load time.

Changes on environment variables, shell aliases, shell functions, shell completions and current working directory are tracked.

Changes made on environment variable intended for Modules private use (e.g., LOADEDMODULES, _LMFILES_, __MODULES_*) are ignored.

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.

Shell could also be set to bash-eval. In this mode, bash shell script is not sourced but the output resulting from its execution is evaluated to determine the environment changes it does.

The --ignore option accepts a list of shell elements whose changes made by script should be ignored. eltlist corresponds to the concatenation of multiple shell element separated by colon character. Accepted shell elements are: envvar, alias, function, chdir and complete.

system string

Run string command through shell. On Unix, command is passed to the /bin/sh shell whereas on Windows it is passed to cmd.exe. modulecmd.tcl redirects stdout to stderr since stdout would be parsed by the evaluating shell. The exit status of the executed command is returned.

uname field

Provide lookup of system information. Most field information are retrieved from the tcl_platform array (see the tclvars(n) man page). Uname will return the string unknown if information is unavailable for the field.

uname will invoke the uname(1) command in order to get the operating system version and domainname(1) to figure out the name of the domain.

field values are:

uncomplete name

Unsets completion for command name in the user's environment. When a modulefile is unloaded, no operation is performed.

The following shells are supported: bash, tcsh and fish.

unset-alias alias-name

Unsets an alias with the name alias-name in the user's environment.

unset-function function-name

Removes a function with the name function-name from the user's environment.

unsetenv [options] variable [value]

Unsets environment variable. When a modulefile is unloaded, no operation is performed unless if an optional value is defined, in which case variable is to value. The unsetenv command changes the process' environment like setenv.

If the --noop-on-unload option is set, no operation is performed when modulefile is unloaded. If the --unset-on-unload option is set, environment variable is also unset when modulefile is unloaded. These behaviors are applied even if an optional value is defined.

variant [--boolean] [--default value] name [value...]

Declare module variant name with list of accepted value and instantiate it in the ModuleVariant array variable.

Variant's value is selected through the module designation that leads to the modulefile evaluation. See Advanced module version specifiers section to learn how variants could be specified.

Selected variant value is transmitted to the evaluating modulefile. A value must be specified for variant name and it must corresponds to a value in the accepted value list if such list is defined. Otherwise an error is raised. An exception is made if modulefile is evaluated in display mode: no error is raised if no value is specified for a given variant and variant is not instantiated in the ModuleVariant array variable. When no list of accepted value is defined, variant could be set to any value.

When the --default option is set, variant name is set to the value associated with this option in case no value is specified for variant in module designation.

If the --boolean option is set, variant name is defined as a Boolean variant. No list of accepted value should be defined in this case. All values recognized as Boolean value in Tcl are accepted (i.e., 1, true, t, yes, y, on, 0, false, f, no, n or off). Boolean variants are instantiated in ModuleVariant using Tcl canonical form of Boolean value (i.e., 0 or 1).

A variant which is not defined as a Boolean variant cannot define Boolean values in its accepted value list, exception made for the 0 and 1 integers. An error is raised otherwise.

A variant cannot be named version. An error is raised otherwise.

versioncmp version1 version2

Compare version string version1 against version string version2. Returns -1, 0 or 1 respectively if version1 is less than, equal to or greater than version2.

x-resource [resource-string|filename]

Merge resources into the X11 resource database. The resources are used to control look and behavior of X11 applications. The command will attempt to read resources from filename. If the argument isn't a valid file name, then string will be interpreted as a resource. Either filename or resource-string is then passed down to be xrdb(1) command.

modulefiles that use this command, should in most cases contain one or more x-resource lines, each defining one X11 resource. The DISPLAY environment variable should be properly set and the X11 server should be accessible. If x-resource can't manipulate the X11 resource database, the modulefile will exit with an error message.

Examples:

x-resource /u2/staff/leif/.xres/Ileaf

x-resource [glob ~/.xres/ileaf]

x-resource {Ileaf.popup.saveUnder: True}

ModulesCurrentModulefile

The ModulesCurrentModulefile variable contains the full pathname of the modulefile being interpreted.

ModulesVersion

The ModulesVersion variable can be set in .version file to designate the name of the modulefile version which should be considered as default in current directory (see Locating Modulefiles section below).

ModuleTool

The ModuleTool variable contains the name of the module implementation currently in use. The value of this variable is set to Modules for this implementation.

ModuleToolVersion

The ModuleToolVersion variable contains the version of the module implementation currently in use. The value of this variable is set to 5.4.0 for this version of Modules.

ModuleVariant

The ModuleVariant array variable contains an element entry for each defined variant associated to the value of this variant (e.g., the $ModuleVariant(foo) syntax corresponds to the value of variant foo if defined). A Tcl evaluation error is obtained when accessing an undefined variant in ModuleVariant array. Use preferably the getvariant command to retrieve a variant value when this variant state is not known.

The list of the currently defined variants can be retrieved with [array names ModuleVariant] Tcl code.