"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/build/module.1.in" between
modules-5.1.1.tar.bz2 and modules-5.2.0.tar.bz2

About: The Environment Modules package provides for the dynamic modification of a user’s environment via modulefiles.

module.1.in  (modules-5.1.1.tar.bz2)	:	module.1.in  (modules-5.2.0.tar.bz2)
skipping to change at line 30		skipping to change at line 30
.\" .rstReportMargin post:		.\" .rstReportMargin post:
..		..
.de UNINDENT		.de UNINDENT
. RE		. RE
.\" indent \\n[an-margin]		.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]		.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1		.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]		.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u		.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..		..
.TH "MODULE" "1" "2022-05-31" "5.1.1" "Modules"		.TH "MODULE" "1" "2022-11-08" "5.2.0" "Modules"
.SH NAME		.SH NAME
module \- command interface to the Modules package		module \- command interface to the Modules package
.SH SYNOPSIS		.SH SYNOPSIS
.sp		.sp
\fBmodule\fP [\fIswitches\fP] [\fIsub\-command\fP [\fIsub\-command\-args\fP]]		\fBmodule\fP [\fIswitches\fP] [\fIsub\-command\fP [\fIsub\-command\-args\fP]]
.SH DESCRIPTION		.SH DESCRIPTION
.sp		.sp
\fBmodule\fP is a user interface to the Modules package. The Modules		\fBmodule\fP is a user interface to the Modules package. The Modules
package provides for the dynamic modification of the user\(aqs environment		package provides for the dynamic modification of the user\(aqs environment
via \fImodulefiles\fP\&.		via \fImodulefiles\fP\&.
skipping to change at line 89		skipping to change at line 89
a \fI\%module refresh\fP is automatically applied to restore in the		a \fI\%module refresh\fP is automatically applied to restore in the
current environment all non\-persistent components set by loaded modules.		current environment all non\-persistent components set by loaded modules.
.sp		.sp
The \fBmodule\fP alias or function executes the \fBmodulecmd.tcl\fP		The \fBmodule\fP alias or function executes the \fBmodulecmd.tcl\fP
program and has the shell evaluate the command\(aqs output. The first argument t o		program and has the shell evaluate the command\(aqs output. The first argument t o
\fBmodulecmd.tcl\fP specifies the type of shell.		\fBmodulecmd.tcl\fP specifies the type of shell.
.sp		.sp
The initialization scripts are kept in \fB@initdir@/<shell>\fP where		The initialization scripts are kept in \fB@initdir@/<shell>\fP where
\fI<shell>\fP is the name of the sourcing shell. For example, a C Shell user		\fI<shell>\fP is the name of the sourcing shell. For example, a C Shell user
sources the \fB@initdir@/csh\fP script. The sh, csh, tcsh, bash, ksh,		sources the \fB@initdir@/csh\fP script. The sh, csh, tcsh, bash, ksh,
zsh and fish shells are supported by \fBmodulecmd.tcl\fP\&. In addition,		zsh, fish and cmd shells are supported by \fBmodulecmd.tcl\fP\&. In addition,
python, perl, ruby, tcl, cmake, r and lisp "shells" are supported which		python, perl, ruby, tcl, cmake, r and lisp "shells" are supported which
writes the environment changes to stdout as python, perl, ruby, tcl, lisp,		writes the environment changes to stdout as python, perl, ruby, tcl, lisp,
r or cmake code.		r or cmake code.
.sp		.sp
Initialization may also be performed by directly calling the		Initialization may also be performed by directly calling the
\fBautoinit\fP sub\-command of the \fBmodulecmd.tcl\fP program.		\fBautoinit\fP sub\-command of the \fBmodulecmd.tcl\fP program.
.sp		.sp
A \fBml\fP alias or function may also be defined at initialization time		A \fBml\fP alias or function may also be defined at initialization time
if enabled (see \fI\%MODULES_ML\fP section). \fBml\fP is a handy		if enabled (see \fI\%MODULES_ML\fP section). \fBml\fP is a handy
frontend leveraging all \fBmodule\fP command capabilities with less		frontend leveraging all \fBmodule\fP command capabilities with less
skipping to change at line 170		skipping to change at line 170
.nf		.nf
.ft C		.ft C
eval "$(@libexecdir@/modulecmd.tcl sh autoinit)"		eval "$(@libexecdir@/modulecmd.tcl sh autoinit)"
.ft P		.ft P
.fi		.fi
.UNINDENT		.UNINDENT
.UNINDENT		.UNINDENT
.SS Modulecmd startup		.SS Modulecmd startup
.sp		.sp
Upon invocation \fBmodulecmd.tcl\fP sources a site\-specific configuration		Upon invocation \fBmodulecmd.tcl\fP sources a site\-specific configuration
script if it exists. The location for this script is		script if it exists. Siteconfig script is a Tcl script located at
\fB@etcdir@/siteconfig.tcl\fP\&. An additional siteconfig script may be		\fB@etcdir@/siteconfig.tcl\fP\&. It enables to supersede any global variable or
specified with the \fI\%MODULES_SITECONFIG\fP environment variable, if		procedure definition of \fBmodulecmd.tcl\fP\&. See \fI\%Site\-specific configura
allowed by \fBmodulecmd.tcl\fP configuration, and will be loaded if it		tion\fP for detailed information.
exists after \fB@etcdir@/siteconfig.tcl\fP\&. Siteconfig is a Tcl script that en
ables
to supersede any global variable or procedure definition of
\fBmodulecmd.tcl\fP\&.
.sp		.sp
Afterward, \fBmodulecmd.tcl\fP sources rc files which contain global,		Afterward, \fBmodulecmd.tcl\fP sources rc files which contain global,
user and \fImodulefile\fP specific setups. These files are interpreted as		user and \fImodulefile\fP specific setups. These files are interpreted as
\fImodulefiles\fP\&. See modulefile(4) for detailed information.		\fImodulefiles\fP\&. See modulefile(4) for detailed information.
.sp		.sp
Upon invocation of \fBmodulecmd.tcl\fP module run\-command files are sourced		Upon invocation of \fBmodulecmd.tcl\fP module run\-command files are sourced
in the following order:		in the following order:
.INDENT 0.0		.INDENT 0.0
.IP 1. 3		.IP 1. 3
Global RC file as specified by \fI\%MODULERCFILE\fP variable or		Global RC file as specified by \fI\%MODULERCFILE\fP variable or
skipping to change at line 228		skipping to change at line 224
parameter. These may be used to control output format of all information		parameter. These may be used to control output format of all information
displayed and the \fBmodule\fP behavior in case of locating and		displayed and the \fBmodule\fP behavior in case of locating and
interpreting \fImodulefiles\fP\&.		interpreting \fImodulefiles\fP\&.
.sp		.sp
All switches may be entered either in short or long notation. The following		All switches may be entered either in short or long notation. The following
switches are accepted:		switches are accepted:
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-all, \-a		.B \-\-all, \-a
Include hidden modules in search performed with \fI\%avail\fP,		Include hidden modules in search performed with \fI\%avail\fP,
\fI\%aliases\fP, \fI\%list\fP, \fI\%search\fP or \fI\%whatis\fP		\fI\%aliases\fP, \fI\%list\fP, \fI\%lint\fP, \fI\%savelist\fP,
sub\-commands. Hard\-hidden modules are not affected by this option.		\fI\%search\fP or \fI\%whatis\fP sub\-commands. Hard\-hidden modules are
		not affected by this option.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-auto		.B \-\-auto
On \fI\%load\fP, \fI\%unload\fP and \fI\%switch\fP sub\-commands, enable		Enable automated module handling mode on sub\-commands that load or unload
automated module handling mode. See also \fI\%MODULES_AUTO_HANDLING\fP		modulefiles. See also \fI\%MODULES_AUTO_HANDLING\fP section.
section.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-color=<WHEN>		.B \-\-color=<WHEN>
Colorize the output. \fIWHEN\fP defaults to \fBalways\fP or can be \fBnever\fP o r		Colorize the output. \fIWHEN\fP defaults to \fBalways\fP or can be \fBnever\fP o r
\fBauto\fP\&. See also \fI\%MODULES_COLOR\fP section.		\fBauto\fP\&. See also \fI\%MODULES_COLOR\fP section.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-contains, \-C		.B \-\-contains, \-C
On \fI\%avail\fP and \fI\%list\fP sub\-commands, return modules whose		On \fI\%avail\fP, \fI\%list\fP and \fI\%savelist\fP sub\-commands,
fully qualified name contains search query string.		return modules or collections whose fully qualified name contains search
		query string.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-debug, \-D, \-DD		.B \-\-debug, \-D, \-DD
Debug mode. Causes \fBmodule\fP to print debugging messages about its		Debug mode. Causes \fBmodule\fP to print debugging messages about its
progress. Multiple \fI\%\-D\fP options increase the debug verbosity. The		progress. Multiple \fI\%\-D\fP options increase the debug verbosity. The
maximum is 2.		maximum is 2.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
skipping to change at line 270		skipping to change at line 267
On \fI\%avail\fP sub\-command, display only the default version of each		On \fI\%avail\fP sub\-command, display only the default version of each
module name. Default version is the explicitly set default version or also		module name. Default version is the explicitly set default version or also
the implicit default version if the configuration option		the implicit default version if the configuration option
\fI\%implicit_default\fP is enabled (see Locating Modulefiles		\fI\%implicit_default\fP is enabled (see Locating Modulefiles
section in the modulefile(4) man page for further details on implicit		section in the modulefile(4) man page for further details on implicit
default version).		default version).
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-force, \-f		.B \-\-force, \-f
On \fI\%load\fP, \fI\%unload\fP and \fI\%switch\fP sub\-commands,		On \fI\%load\fP, \fI\%unload\fP, \fI\%switch\fP, \fI\%load\-any\fP,
		\fI\%try\-load\fP, \fI\%mod\-to\-sh\fP and \fI\%source\fP sub\-commands
by\-pass any unsatisfied modulefile constraint corresponding to the declared		by\-pass any unsatisfied modulefile constraint corresponding to the declared
\fBprereq\fP and \fBconflict\fP\&. Which means for instance that a		\fBprereq\fP and \fBconflict\fP\&. Which means for instance that a
\fImodulefile\fP will be loaded even if it comes in conflict with another loaded		\fImodulefile\fP will be loaded even if it comes in conflict with another loaded
\fImodulefile\fP or that a \fImodulefile\fP will be unloaded even if it is requi red		\fImodulefile\fP or that a \fImodulefile\fP will be unloaded even if it is requi red
as a prereq by another \fImodulefile\fP\&.		as a prereq by another \fImodulefile\fP\&.
.sp		.sp
On \fI\%clear\fP sub\-command, skip the confirmation dialog and proceed.		On \fI\%clear\fP sub\-command, skip the confirmation dialog and proceed.
		.sp
		On \fI\%purge\fP sub\-command also unload \fI\%sticky modules\fP and modulefiles
		that are depended by non\-unloadable modules.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-help, \-h		.B \-\-help, \-h
Give some helpful usage information, and terminates the command.		Give some helpful usage information, and terminates the command.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-icase, \-i		.B \-\-icase, \-i
Match module specification arguments in a case insensitive manner.		Match module specification arguments in a case insensitive manner.
skipping to change at line 299		skipping to change at line 300
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-indepth		.B \-\-indepth
On \fI\%avail\fP sub\-command, include in search results the matching		On \fI\%avail\fP sub\-command, include in search results the matching
modulefiles and directories and recursively the modulefiles and directories		modulefiles and directories and recursively the modulefiles and directories
contained in these matching directories.		contained in these matching directories.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-json, \-j		.B \-\-json, \-j
Display \fI\%avail\fP, \fI\%list\fP, \fI\%savelist\fP, \fI\%whatis\fP		Display \fI\%avail\fP, \fI\%list\fP, \fI\%savelist\fP,
and \fI\%search\fP output in JSON format.		\fI\%stashlist\fP, \fI\%whatis\fP and \fI\%search\fP output in JSON
		format.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-latest, \-L		.B \-\-latest, \-L
On \fI\%avail\fP sub\-command, display only the highest numerically sorted		On \fI\%avail\fP sub\-command, display only the highest numerically sorted
version of each module name (see Locating Modulefiles section in the		version of each module name (see Locating Modulefiles section in the
modulefile(4) man page).		modulefile(4) man page).
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-long, \-l		.B \-\-long, \-l
Display \fI\%avail\fP, \fI\%list\fP and \fI\%savelist\fP output in long		Display \fI\%avail\fP, \fI\%list\fP, \fI\%savelist\fP and
format.		\fI\%stashlist\fP output in long format.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-no\-auto		.B \-\-no\-auto
On \fI\%load\fP, \fI\%unload\fP and \fI\%switch\fP sub\-commands,		Disable automated module handling mode on sub\-commands that load or unload
disable automated module handling mode. See also		modulefiles. See also \fI\%MODULES_AUTO_HANDLING\fP section.
\fI\%MODULES_AUTO_HANDLING\fP section.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-no\-indepth		.B \-\-no\-indepth
On \fI\%avail\fP sub\-command, limit search results to the matching		On \fI\%avail\fP sub\-command, limit search results to the matching
modulefiles and directories found at the depth level expressed by the search		modulefiles and directories found at the depth level expressed by the search
query. Thus modulefiles contained in directories part of the result are		query. Thus modulefiles contained in directories part of the result are
excluded.		excluded.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
skipping to change at line 382		skipping to change at line 383
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-silent, \-s		.B \-\-silent, \-s
Turn off error, warning and informational messages. \fBmodule\fP command		Turn off error, warning and informational messages. \fBmodule\fP command
output result is not affected by silent mode.		output result is not affected by silent mode.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-starts\-with, \-S		.B \-\-starts\-with, \-S
On \fI\%avail\fP and \fI\%list\fP sub\-commands, return modules whose name		On \fI\%avail\fP, \fI\%list\fP and \fI\%savelist\fP sub\-commands,
starts with search query string.		return modules or collections whose name starts with search query string.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-tag=LIST		.B \-\-tag=LIST
On \fI\%load\fP, \fI\%load\-any\fP, \fI\%switch\fP and		On \fI\%load\fP, \fI\%load\-any\fP, \fI\%switch\fP and
\fI\%try\-load\fP sub\-commands, apply LIST of module tags to the loading		\fI\%try\-load\fP sub\-commands, apply LIST of module tags to the loading
\fImodulefile\fP\&. \fILIST\fP corresponds to the concatenation of multiple tags		\fImodulefile\fP\&. \fILIST\fP corresponds to the concatenation of multiple tags
separated by colon character (\fB:\fP). \fILIST\fP should not contain tags		separated by colon character (\fB:\fP). \fILIST\fP should not contain tags
inherited from \fImodulefile\fP state or from other modulefile commands. If		inherited from \fImodulefile\fP state or from other modulefile commands. If
module is already loaded, tags from \fILIST\fP are added to the list of tags		module is already loaded, tags from \fILIST\fP are added to the list of tags
already applied to this module.		already applied to this module.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-terse, \-t		.B \-\-terse, \-t
Display \fI\%avail\fP, \fI\%list\fP and \fI\%savelist\fP output in		Display \fI\%avail\fP, \fI\%list\fP, \fI\%savelist\fP and
short format.		\fI\%stashlist\fP output in short format.
		.UNINDENT
		.INDENT 0.0
		.TP
		.B \-\-timer
		Prints at the end of the output an evaluation of the total execution time of
		the \fBmodule\fP command. When mixed with a single or multiple
		\fI\%\-\-debug\fP options, replaces regular debug messages by reports of the
		execution time of every internal procedure calls.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-trace, \-T		.B \-\-trace, \-T
Trace mode. Report details on module searches, resolutions, selections and		Trace mode. Report details on module searches, resolutions, selections and
evaluations in addition to printing verbose messages.		evaluations in addition to printing verbose messages.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B \-\-verbose, \-v, \-vv		.B \-\-verbose, \-v, \-vv
skipping to change at line 696		skipping to change at line 705
.sp		.sp
Default value is \fBvi\fP\&. It can be changed at installation time with		Default value is \fBvi\fP\&. It can be changed at installation time with
\fB\-\-with\-editor\fP option. The \fI\%MODULES_EDITOR\fP environment		\fB\-\-with\-editor\fP option. The \fI\%MODULES_EDITOR\fP environment
variable is defined by \fI\%config\fP sub\-command when changing this		variable is defined by \fI\%config\fP sub\-command when changing this
configuration option from its default value. See \fI\%MODULES_EDITOR\fP		configuration option from its default value. See \fI\%MODULES_EDITOR\fP
description for details.		description for details.
.UNINDENT		.UNINDENT
.INDENT 7.0		.INDENT 7.0
.TP		.TP
.B extra_siteconfig		.B extra_siteconfig
Additional site\-specific configuration script location.		Additional site\-specific configuration script location. See
		\fI\%Site\-specific configuration\fP section for details.
.sp		.sp
This configuration option is unset by default. The		This configuration option is unset by default. The
\fI\%MODULES_SITECONFIG\fP environment variable is defined by		\fI\%MODULES_SITECONFIG\fP environment variable is defined by
\fI\%config\fP sub\-command when changing this configuration option from		\fI\%config\fP sub\-command when changing this configuration option from
its default value. See \fI\%MODULES_SITECONFIG\fP description for details.		its default value. See \fI\%MODULES_SITECONFIG\fP description for details.
.UNINDENT		.UNINDENT
.INDENT 7.0		.INDENT 7.0
.TP		.TP
.B home		.B home
Location of Modules package main directory.		Location of Modules package main directory.
skipping to change at line 861		skipping to change at line 871
Text viewer to paginate message output.		Text viewer to paginate message output.
.sp		.sp
Default value is \fBless \-eFKRX\fP\&. It can be changed at installation time		Default value is \fBless \-eFKRX\fP\&. It can be changed at installation time
with \fB\-\-with\-pager\fP and \fB\-\-with\-pager\-opts\fP options. The		with \fB\-\-with\-pager\fP and \fB\-\-with\-pager\-opts\fP options. The
\fI\%MODULES_PAGER\fP environment variable is defined by \fI\%config\fP		\fI\%MODULES_PAGER\fP environment variable is defined by \fI\%config\fP
sub\-command when changing this configuration option from its default value.		sub\-command when changing this configuration option from its default value.
See \fI\%MODULES_PAGER\fP description for details.		See \fI\%MODULES_PAGER\fP description for details.
.UNINDENT		.UNINDENT
.INDENT 7.0		.INDENT 7.0
.TP		.TP
		.B protected_envvars
		Prevents any modification of listed environment variables (colon \fI:\fP
		separator).
		.sp
		This configuration option is unset by default. The
		\fI\%MODULES_PROTECTED_ENVVARS\fP environment variable is defined by
		\fI\%config\fP sub\-command when changing this configuration option from
		its default value. See \fI\%MODULES_PROTECTED_ENVVARS\fP description for
		details.
		.UNINDENT
		.INDENT 7.0
		.TP
.B quarantine_support		.B quarantine_support
Defines if code for quarantine mechanism support should be generated in		Defines if code for quarantine mechanism support should be generated in
\fBmodule\fP shell function definition.		\fBmodule\fP shell function definition.
.sp		.sp
Default value is \fB0\fP\&. It can be changed at installation time with		Default value is \fB0\fP\&. It can be changed at installation time with
\fB\-\-enable\-quarantine\-support\fP option. The		\fB\-\-enable\-quarantine\-support\fP option. The
\fI\%MODULES_QUARANTINE_SUPPORT\fP environment variable is defined by		\fI\%MODULES_QUARANTINE_SUPPORT\fP environment variable is defined by
\fI\%config\fP sub\-command when changing this configuration option from		\fI\%config\fP sub\-command when changing this configuration option from
its default value. See \fI\%MODULES_QUARANTINE_SUPPORT\fP description for		its default value. See \fI\%MODULES_QUARANTINE_SUPPORT\fP description for
details.		details.
skipping to change at line 897		skipping to change at line 919
.sp		.sp
Default value is \fB1\fP\&. The \fI\%MODULES_REDIRECT_OUTPUT\fP environment		Default value is \fB1\fP\&. The \fI\%MODULES_REDIRECT_OUTPUT\fP environment
variable is defined by \fI\%config\fP sub\-command when changing this		variable is defined by \fI\%config\fP sub\-command when changing this
configuration option from its default value. The \fI\%\-\-redirect\fP and		configuration option from its default value. The \fI\%\-\-redirect\fP and
\fI\%\-\-no\-redirect\fP command line switches change the value of this		\fI\%\-\-no\-redirect\fP command line switches change the value of this
configuration option. See \fI\%MODULES_REDIRECT_OUTPUT\fP description for		configuration option. See \fI\%MODULES_REDIRECT_OUTPUT\fP description for
details.		details.
.UNINDENT		.UNINDENT
.INDENT 7.0		.INDENT 7.0
.TP		.TP
		.B reset_target_state
		Control behavior of \fI\%reset\fP sub\-command. Whether environment should
		be purged (\fB__purge__\fP), initial environment (\fB__init__\fP) or a named
		collection (any other value) should restored.
		.sp
		Default value is \fB__init__\fP\&. The \fI\%MODULES_RESET_TARGET_STATE\fP
		environment variable is defined by \fI\%config\fP sub\-command when
		changing this configuration option from its default value. See
		\fI\%MODULES_RESET_TARGET_STATE\fP description for details.
		.UNINDENT
		.INDENT 7.0
		.TP
.B run_quarantine		.B run_quarantine
Environment variables to indirectly pass to \fBmodulecmd.tcl\fP\&.		Environment variables to indirectly pass to \fBmodulecmd.tcl\fP\&.
.sp		.sp
This configuration option is set to an empty value by default. It can be		This configuration option is set to an empty value by default. It can be
changed at installation time with \fB\-\-with\-quarantine\-vars\fP option		changed at installation time with \fB\-\-with\-quarantine\-vars\fP option
that sets \fI\%MODULES_RUN_QUARANTINE\fP\&. This environment variable is		that sets \fI\%MODULES_RUN_QUARANTINE\fP\&. This environment variable is
also defined by \fI\%config\fP sub\-command when changing this		also defined by \fI\%config\fP sub\-command when changing this
configuration option. See \fI\%MODULES_RUN_QUARANTINE\fP description for		configuration option. See \fI\%MODULES_RUN_QUARANTINE\fP description for
details.		details.
.UNINDENT		.UNINDENT
skipping to change at line 961		skipping to change at line 995
Default value is \fB0\fP\&. It can be changed at installation time with		Default value is \fB0\fP\&. It can be changed at installation time with
\fB\-\-enable\-silent\-shell\-debug\-support\fP option. The		\fB\-\-enable\-silent\-shell\-debug\-support\fP option. The
\fI\%MODULES_SILENT_SHELL_DEBUG\fP environment variable is defined by		\fI\%MODULES_SILENT_SHELL_DEBUG\fP environment variable is defined by
\fI\%config\fP sub\-command when changing this configuration option from		\fI\%config\fP sub\-command when changing this configuration option from
its default value. See \fI\%MODULES_SILENT_SHELL_DEBUG\fP description for		its default value. See \fI\%MODULES_SILENT_SHELL_DEBUG\fP description for
details.		details.
.UNINDENT		.UNINDENT
.INDENT 7.0		.INDENT 7.0
.TP		.TP
.B siteconfig		.B siteconfig
Primary site\-specific configuration script location.		Primary site\-specific configuration script location. See
		\fI\%Site\-specific configuration\fP section for details.
.sp		.sp
Default value is \fB@etcdir@/siteconfig.tcl\fP\&. It can be changed at installat ion		Default value is \fB@etcdir@/siteconfig.tcl\fP\&. It can be changed at installat ion
time with \fB\-\-prefix\fP or \fB\-\-etcdir\fP options. The value of		time with \fB\-\-prefix\fP or \fB\-\-etcdir\fP options. The value of
this option cannot be altered.		this option cannot be altered.
.UNINDENT		.UNINDENT
.INDENT 7.0		.INDENT 7.0
.TP		.TP
.B tag_abbrev		.B tag_abbrev
Abbreviations to use to report module tags.		Abbreviations to use to report module tags.
.sp		.sp
skipping to change at line 1001		skipping to change at line 1036
.TP		.TP
.B tcl_ext_lib		.B tcl_ext_lib
Modules Tcl extension library location.		Modules Tcl extension library location.
.sp		.sp
Default value is \fB@libdir@/libtclenvmodules.so\fP\&. It can be changed at		Default value is \fB@libdir@/libtclenvmodules.so\fP\&. It can be changed at
installation time with \fB\-\-prefix\fP or \fB\-\-libdir\fP options.		installation time with \fB\-\-prefix\fP or \fB\-\-libdir\fP options.
The value of this option cannot be altered.		The value of this option cannot be altered.
.UNINDENT		.UNINDENT
.INDENT 7.0		.INDENT 7.0
.TP		.TP
		.B tcl_linter
		Command to check syntax of modulefiles with through \fI\%lint\fP
		sub\-command.
		.sp
		Default value is \fBnagelfar.tcl\fP\&. It can be changed at installation time
		with \fB\-\-with\-tcl\-linter\fP and \fB\-\-with\-tcl\-linter\-opts\fP
		options. The \fI\%MODULES_TCL_LINTER\fP environment variable is defined by
		\fI\%config\fP sub\-command when changing this configuration option from
		its default value. See \fI\%MODULES_TCL_LINTER\fP description for details.
		.UNINDENT
		.INDENT 7.0
		.TP
.B term_background		.B term_background
Terminal background color kind.		Terminal background color kind.
.sp		.sp
Default value is \fBdark\fP\&. It can be changed at installation time with		Default value is \fBdark\fP\&. It can be changed at installation time with
\fB\-\-with\-terminal\-background\fP option. The		\fB\-\-with\-terminal\-background\fP option. The
\fI\%MODULES_TERM_BACKGROUND\fP environment variable is defined by		\fI\%MODULES_TERM_BACKGROUND\fP environment variable is defined by
\fI\%config\fP sub\-command when changing this configuration option from		\fI\%config\fP sub\-command when changing this configuration option from
its default value. See \fI\%MODULES_TERM_BACKGROUND\fP description for		its default value. See \fI\%MODULES_TERM_BACKGROUND\fP description for
details.		details.
.UNINDENT		.UNINDENT
skipping to change at line 1242		skipping to change at line 1289
provided. Returns a false value otherwise. See \fBis\-used\fP in the		provided. Returns a false value otherwise. See \fBis\-used\fP in the
modulefile(4) man page for further explanation.		modulefile(4) man page for further explanation.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B keyword [\-a] [\-j] string		.B keyword [\-a] [\-j] string
See \fI\%search\fP\&.		See \fI\%search\fP\&.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
		.B lint [\-a] [modulefile...]
		Analyze syntax of one or more \fImodulefiles\fP with the linter command
		designated by the \fI\%tcl_linter\fP configuration option.
		.sp
		The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
		modulefile alias. It may also leverage a specific syntax to finely select
		module version (see \fI\%Advanced module version specifiers\fP section below).
		.sp
		If no \fImodulefile\fP is specified, all the \fImodulefiles\fP and modulerc
		available in enabled modulepaths are analyzed as well as global and user rc
		files. Hidden modulefiles are also analyzed when \fI\%\-\-all\fP/\fI\%\-a\fP
		option is set.
		.sp
		When \fBnagelfar.tcl\fP is the selected linter command, a static Tcl
		syntax analysis is performed. In addition, syntax of modulefile commands are
		checked in these files based on their kind (global/user rc, modulerc or
		modulefile).
		.UNINDENT
		.INDENT 0.0
		.TP
.B list [\-t|\-l|\-j] [\-a] [\-o LIST] [\-S|\-C] [pattern...]		.B list [\-t|\-l|\-j] [\-a] [\-o LIST] [\-S|\-C] [pattern...]
List loaded modules. If a \fIpattern\fP is given, then the loaded modules are		List loaded modules. If a \fIpattern\fP is given, then the loaded modules are
filtered to only list those whose name match this \fIpattern\fP\&. It may contai n		filtered to only list those whose name matches this \fIpattern\fP\&. It may cont ain
wildcard characters. \fIpattern\fP is matched in a case insensitive manner by		wildcard characters. \fIpattern\fP is matched in a case insensitive manner by
default. If multiple \fIpatterns\fP are given, loaded modules has to		default. If multiple \fIpatterns\fP are given, loaded module has to match at
match at least one of them to be listed.		least one of them to be listed.
.sp		.sp
Module tags applying to the loaded modules are reported along the module name		Module tags applying to the loaded modules are reported along the module name
they are associated to (see \fI\%Module tags\fP section).		they are associated to (see \fI\%Module tags\fP section).
.sp		.sp
Module variants selected on the loaded modules are reported along the module		Module variants selected on the loaded modules are reported along the module
name they belong to (see \fI\%Module variants\fP section).		name they belong to (see \fI\%Module variants\fP section).
.sp		.sp
A \fIKey\fP section is added at the end of the output in case some elements are		A \fIKey\fP section is added at the end of the output in case some elements are
reported in parentheses or chevrons along module name or if some graphical		reported in parentheses or chevrons along module name or if some graphical
rendition is made over some output elements. This \fIKey\fP section gives hints		rendition is made over some output elements. This \fIKey\fP section gives hints
skipping to change at line 1323		skipping to change at line 1390
The parameter \fImodulefile\fP may also be a symbolic modulefile name or a		The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
modulefile alias. It may also leverage a specific syntax to finely select		modulefile alias. It may also leverage a specific syntax to finely select
module version (see \fI\%Advanced module version specifiers\fP section below).		module version (see \fI\%Advanced module version specifiers\fP section below).
.sp		.sp
The \fI\%\-\-tag\fP option accepts a list of module tags to apply to		The \fI\%\-\-tag\fP option accepts a list of module tags to apply to
\fImodulefile\fP once loaded. If module is already loaded, tags from \fItaglist\ fP		\fImodulefile\fP once loaded. If module is already loaded, tags from \fItaglist\ fP
are added to the list of tags already applied to this module.		are added to the list of tags already applied to this module.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
		.B mod\-to\-sh [options] shell modulefile...
		Evaluate \fImodulefile\fP and report resulting environment changes as code for
		\fIshell\fP\&.
		.sp
		\fI\%mod\-to\-sh\fP command accepts the following options:
		.INDENT 7.0
		.IP \(bu 2
		\fB\-\-auto|\-\-no\-auto\fP
		.IP \(bu 2
		\fB\-f|\-\-force\fP
		.UNINDENT
		.sp
		An attempt to load \fImodulefile\fP is made to get its environment changes. This
		evaluation does not change the current shell environment. Like for
		\fI\%load\fP sub\-command, no evaluation occurs if \fImodulefile\fP is found
		loaded in current environment.
		.sp
		Changes made on environment variable intended for Modules private use (e.g.,
		\fI\%LOADEDMODULES\fP, \fI\%_LMFILES_\fP, \fB__MODULES_*\fP) are ignored.
		.sp
		\fIShell\fP could be any shell name supported by \fBmodulecmd.tcl\fP\&.
		.sp
		Produced \fIshell\fP code is returned on the message output channel by
		\fBmodulecmd.tcl\fP\&. Thus it is not rendered in current environment by the
		\fBmodule\fP shell function.
		.sp
		\fI\%mod\-to\-sh\fP automatically set \fI\%verbosity\fP to the \fBsilent\fP
		mode, to avoid messages to mix with the produced shell code. Verbosity is not
		changed if set to the \fBtrace\fP mode or any higher debugging level.
		.sp
		The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
		modulefile alias. It may also leverage a specific syntax to finely select
		module version (see \fI\%Advanced module version specifiers\fP section below).
		.UNINDENT
		.INDENT 0.0
		.TP
.B path modulefile		.B path modulefile
Print path to \fImodulefile\fP\&.		Print path to \fImodulefile\fP\&.
.sp		.sp
The parameter \fImodulefile\fP may also be a symbolic modulefile name or a		The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
modulefile alias. It may also leverage a specific syntax to finely select		modulefile alias. It may also leverage a specific syntax to finely select
module version (see \fI\%Advanced module version specifiers\fP section below).		module version (see \fI\%Advanced module version specifiers\fP section below).
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B paths modulefile		.B paths modulefile
skipping to change at line 1356		skipping to change at line 1459
When \fI\%prepend\-path\fP is called as a module sub\-command, the reference		When \fI\%prepend\-path\fP is called as a module sub\-command, the reference
counter variable, which denotes the number of times \fIvalue\fP has been added t o		counter variable, which denotes the number of times \fIvalue\fP has been added t o
environment \fIvariable\fP, is not updated unless if the \fB\-\-duplicates\fP op tion		environment \fIvariable\fP, is not updated unless if the \fB\-\-duplicates\fP op tion
is set.		is set.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B purge [\-f]		.B purge [\-f]
Unload all loaded \fImodulefiles\fP\&.		Unload all loaded \fImodulefiles\fP\&.
.sp		.sp
When the \fI\%\-\-force\fP option is set, also unload modulefiles that are		When the \fI\%\-\-force\fP option is set, also unload \fI\%sticky modules\fP and
depended by unloadable modules.		modulefiles that are depended by non\-unloadable modules.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B refresh		.B refresh
Force a refresh of all non\-persistent components of currently loaded modules.		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		This should be used on derived shells where shell completions, shell aliases
need to be reinitialized but the environment variables have already been set		or shell functions need to be reinitialized but the environment variables
by the currently loaded modules.		have already been set by the currently loaded modules.
.sp		.sp
Loaded modules are evaluated in \fBrefresh\fP mode following their load order.		Loaded modules are evaluated in \fBrefresh\fP mode following their load order.
In this evaluation mode only the \fBset\-alias\fP and \fBset\-function\fP		In this evaluation mode only the \fBcomplete\fP, \fBset\-alias\fP and
modulefile commands will produce environment changes. Other modulefile		\fBset\-function\fP modulefile commands will produce environment changes.
commands that produce environment changes (like \fBsetenv\fP or		Other modulefile commands that produce environment changes (like
\fBappend\-path\fP) are ignored during a \fBrefresh\fP evaluation as their		\fBsetenv\fP or \fBappend\-path\fP) are ignored during a \fBrefresh\fP
changes should already be applied.		evaluation as their changes should already be applied.
		.sp
		Only the loaded modules defining non\-persistent environment changes are
		evaluated in \fBrefresh\fP mode. Such loaded modules are listed in the
		\fI\%__MODULES_LMREFRESH\fP environment variable.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B reload		.B reload
Unload then load all loaded \fImodulefiles\fP\&.		Unload then load all loaded \fImodulefiles\fP\&.
.sp		.sp
No unload then load is performed and an error is returned if the loaded		No unload then load is performed and an error is returned if the loaded
\fImodulefiles\fP have unsatisfied constraint corresponding to the		\fImodulefiles\fP have unsatisfied constraint corresponding to the
\fBprereq\fP and \fBconflict\fP they declare.		\fBprereq\fP and \fBconflict\fP they declare.
.UNINDENT		.UNINDENT
skipping to change at line 1397		skipping to change at line 1504
\fIvariable\fP\&. See \fBremove\-path\fP in the modulefile(4) man page for		\fIvariable\fP\&. See \fBremove\-path\fP in the modulefile(4) man page for
further explanation.		further explanation.
.sp		.sp
When \fI\%remove\-path\fP is called as a module sub\-command, the reference		When \fI\%remove\-path\fP is called as a module sub\-command, the reference
counter variable, which denotes the number of times \fIvalue\fP has been added t o		counter variable, which denotes the number of times \fIvalue\fP has been added t o
environment \fIvariable\fP, is ignored and \fIvalue\fP is removed whatever the		environment \fIvariable\fP, is ignored and \fIvalue\fP is removed whatever the
reference counter value set.		reference counter value set.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
		.B reset
		Restore initial environment, which corresponds to the loaded state after
		\fI\%Modules initialization\fP\&.
		.sp
		\fI\%reset\fP sub\-command restores the environment definition found in
		\fI\%__MODULES_LMINIT\fP environment variable.
		.sp
		\fI\%reset\fP behavior can be changed with \fI\%reset_target_state\fP\&.
		This configuration option is set by default to \fB__init__\fP, which
		corresponds to the above behavior description. When set to \fB__purge__\fP,
		\fI\%reset\fP performs a \fI\%purge\fP of the environment. When set to
		any other value, \fI\%reset\fP performs a \fI\%restore\fP of
		corresponding name collection.
		.UNINDENT
		.INDENT 0.0
		.TP
.B restore [collection]		.B restore [collection]
Restore the environment state as defined in \fIcollection\fP\&. If \fIcollection \fP		Restore the environment state as defined in \fIcollection\fP\&. If \fIcollection \fP
name is not specified, then it is assumed to be the \fIdefault\fP collection. If		name is not specified, then it is assumed to be the \fIdefault\fP collection if
\fIcollection\fP is a fully qualified path, it is restored from this location		it exists, \fB__init__\fP special collection otherwise. If \fIcollection\fP is a
rather than from a file under the user\(aqs collection directory. If		fully qualified path, it is restored from this location rather than from a
		file under the user\(aqs collection directory. If
\fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the value		\fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the value
of this variable is appended to the \fIcollection\fP file name to restore.		of this variable is appended to the \fIcollection\fP file name to restore.
.sp		.sp
		If \fIcollection\fP name is \fB__init__\fP, initial environment state defined in
		\fI\%__MODULES_LMINIT\fP environment variable is restored.
		.sp
When restoring a \fIcollection\fP, the currently set \fI\%MODULEPATH\fP		When restoring a \fIcollection\fP, the currently set \fI\%MODULEPATH\fP
directory list and the currently loaded \fImodulefiles\fP are unused and		directory list and the currently loaded \fImodulefiles\fP are unused and
unloaded then used and loaded to exactly match the \fI\%MODULEPATH\fP and		unloaded then used and loaded to exactly match the \fI\%MODULEPATH\fP and
loaded \fImodulefiles\fP lists saved in this \fIcollection\fP file. The order		loaded \fImodulefiles\fP lists saved in this \fIcollection\fP file. The order
of the paths and modulefiles set in \fIcollection\fP is preserved when		of the paths and modulefiles set in \fIcollection\fP is preserved when
restoring. It means that currently loaded modules are unloaded to get		restoring. It means that currently loaded modules are unloaded to get
the same \fI\%LOADEDMODULES\fP root than collection and currently used		the same \fI\%LOADEDMODULES\fP root than collection and currently used
module paths are unused to get the same \fI\%MODULEPATH\fP root. Then		module paths are unused to get the same \fI\%MODULEPATH\fP root. Then
missing module paths are used and missing modulefiles are loaded.		missing module paths are used and missing modulefiles are loaded.
.sp		.sp
skipping to change at line 1457		skipping to change at line 1584
\fBkeep\-loaded\fP tags) are recorded in collection. If		\fBkeep\-loaded\fP tags) are recorded in collection. If
\fI\%MODULES_COLLECTION_PIN_TAG\fP is set to \fB1\fP, all tags are recorded		\fI\%MODULES_COLLECTION_PIN_TAG\fP is set to \fB1\fP, all tags are recorded
in collection except \fBnearly\-forbidden\fP tag.		in collection except \fBnearly\-forbidden\fP tag.
.sp		.sp
No \fIcollection\fP is recorded and an error is returned if the loaded		No \fIcollection\fP is recorded and an error is returned if the loaded
\fImodulefiles\fP have unsatisfied constraint corresponding to the		\fImodulefiles\fP have unsatisfied constraint corresponding to the
\fBprereq\fP and \fBconflict\fP they declare.		\fBprereq\fP and \fBconflict\fP they declare.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B savelist [\-t|\-l|\-j]		.B savelist [\-t|\-l|\-j] [\-a] [\-S|\-C] [pattern...]
List collections that are currently saved under the user\(aqs collection		List collections that are currently saved under the user\(aqs collection
directory. If \fI\%MODULES_COLLECTION_TARGET\fP is set, only collections		directory. If \fI\%MODULES_COLLECTION_TARGET\fP is set, only collections
matching the target suffix will be displayed.		matching the target suffix will be displayed unless if the
		\fI\%\-\-all\fP/\fI\%\-a\fP option is set.
		.sp
		If a \fIpattern\fP is given, then the collections are filtered to only list
		those whose name matches this \fIpattern\fP\&. It may contain wildcard character
		s.
		\fIpattern\fP is matched in a case insensitive manner by default. If multiple
		\fIpatterns\fP are given, collection has to match at least one of them to be
		listed.
		.sp
		Stash collections are not listed unless if the \fI\%\-\-all\fP/\fI\%\-a\fP
		option is set. Stash collections can be listed with \fI\%stashlist\fP
		sub\-command.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B saverm [collection]		.B saverm [collection]
Delete the \fIcollection\fP file under the user\(aqs collection directory. If		Delete the \fIcollection\fP file under the user\(aqs collection directory. If
\fIcollection\fP name is not specified, then it is assumed to be the \fIdefault\ fP		\fIcollection\fP name is not specified, then it is assumed to be the \fIdefault\ fP
collection. If \fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix		collection. If \fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix
equivalent to the value of this variable will be appended to the \fIcollection\f P		equivalent to the value of this variable will be appended to the \fIcollection\f P
file name.		file name.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B saveshow [collection]		.B saveshow [collection]
Display the content of \fIcollection\fP\&. If \fIcollection\fP name is not speci fied,		Display the content of \fIcollection\fP\&. If \fIcollection\fP name is not speci fied,
then it is assumed to be the \fIdefault\fP collection. If \fIcollection\fP is a		then it is assumed to be the \fIdefault\fP collection if it exists, \fB__init__\
fully qualified path, this location is displayed rather than a collection		fP
file under the user\(aqs collection directory. If		special collection otherwise. If \fIcollection\fP is a fully qualified path, thi
\fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the value		s
of this variable will be appended to the \fIcollection\fP file name.		location is displayed rather than a collection file under the user\(aqs
		collection directory. If \fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix
		equivalent to the value of this variable will be appended to the \fIcollection\f
		P
		file name.
		.sp
		If \fIcollection\fP name is \fB__init__\fP, initial environment content defined
		in
		\fI\%__MODULES_LMINIT\fP environment variable is displayed.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B search [\-a] [\-j] string		.B search [\-a] [\-j] string
Seeks through the \fBmodule\-whatis\fP information of all \fImodulefiles\fP		Seeks through the \fBmodule\-whatis\fP information of all \fImodulefiles\fP
for the specified \fIstring\fP\&. All \fImodule\-whatis\fP information matching the		for the specified \fIstring\fP\&. All \fImodule\-whatis\fP information matching the
\fIstring\fP in a case insensitive manner will be displayed. \fIstring\fP may co ntain		\fIstring\fP in a case insensitive manner will be displayed. \fIstring\fP may co ntain
wildcard characters.		wildcard characters.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
skipping to change at line 1515		skipping to change at line 1657
The following shells are supported: sh, dash, csh, tcsh, bash, ksh, ksh93,		The following shells are supported: sh, dash, csh, tcsh, bash, ksh, ksh93,
zsh and fish.		zsh and fish.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B show modulefile...		.B show modulefile...
See \fI\%display\fP\&.		See \fI\%display\fP\&.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B source scriptfile...		.B source [options] modulefile...
Execute \fIscriptfile\fP into the shell environment. \fIscriptfile\fP must be wr		Execute \fImodulefile\fP into the shell environment. Once executed \fImodulefile
itten		\fP
with \fImodulefile\fP syntax and specified with a fully qualified path. Once		is not marked loaded in shell environment which differ from \fI\%load\fP
executed \fIscriptfile\fP is not marked loaded in shell environment which differ		sub\-command.
from \fI\%load\fP sub\-command.		.sp
		\fI\%source\fP command accepts the following options:
		.INDENT 7.0
		.IP \(bu 2
		\fB\-\-auto|\-\-no\-auto\fP
		.IP \(bu 2
		\fB\-f|\-\-force\fP
		.UNINDENT
		.sp
		If \fImodulefile\fP corresponds to a fully qualified path, this file is executed
		.
		Otherwise \fImodulefile\fP is searched among the available modulefiles.
		.sp
		The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
		modulefile alias. It may also leverage a specific syntax to finely select
		module version (see \fI\%Advanced module version specifiers\fP section below).
		.UNINDENT
		.INDENT 0.0
		.TP
		.B stash
		\fI\%Save\fP current environment in a stash collection then
		\fI\%reset\fP to initial environment.
		.sp
		A collection is created only if current environment state differs from
		initial environment. Stash collection is named
		\fIstash\-<unix_millis_timestamp>\fP where \fI<unix_millis_timestamp>\fP is the
		number
		of milliseconds between Unix Epoch and when this command is run.
		.sp
		If \fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the
		value of this variable will be appended to the stash collection file name.
		.UNINDENT
		.INDENT 0.0
		.TP
		.B stashclear
		Remove all stash collection files of current \fI\%collection_target\fP\&. If
		no collection target is currently set, remove stash collection files without
		a target suffix.
		.UNINDENT
		.INDENT 0.0
		.TP
		.B stashlist [\-t|\-l|\-j]
		List all stash collection files of current \fI\%collection_target\fP\&. If
		no collection target is currently set, list stash collection files without a
		target suffix.
		.UNINDENT
		.INDENT 0.0
		.TP
		.B stashpop [stash]
		\fI\%Restore\fP \fIstash\fP collection then delete corresponding
		collection file.
		.sp
		\fIstash\fP is either a full stash collection name (i.e.,
		\fIstash\-<unix_millis_timestamp>\fP) or a stash index. Most recent stash
		collection has index \fI0\fP, \fI1\fP is the one before it. When no \fIstash\fP
		is given
		the latest stash collection is assumed (that is stash index \fI0\fP).
		.sp
		If \fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the
		value of this variable will be appended to the stash collection file name to
		restore.
		.UNINDENT
		.INDENT 0.0
		.TP
		.B stashrm [stash]
		\fI\%Remove\fP \fIstash\fP collection file.
		.sp
		\fIstash\fP is either a full stash collection name (i.e.,
		\fIstash\-<unix_millis_timestamp>\fP) or a stash index. Most recent stash
		collection has index \fI0\fP, \fI1\fP is the one before it. When no \fIstash\fP
		is given
		the latest stash collection is assumed (that is stash index \fI0\fP).
		.sp
		If \fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the
		value of this variable will be appended to the stash collection file name to
		delete.
		.UNINDENT
		.INDENT 0.0
		.TP
		.B stashshow [stash]
		\fI\%Display\fP the content of \fIstash\fP collection file.
		.sp
		\fIstash\fP is either a full stash collection name (i.e.,
		\fIstash\-<unix_millis_timestamp>\fP) or a stash index. Most recent stash
		collection has index \fI0\fP, \fI1\fP is the one before it. When no \fIstash\fP
		is given
		the latest stash collection is assumed (that is stash index \fI0\fP).
		.sp
		If \fI\%MODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the
		value of this variable will be appended to the stash collection file name to
		display.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B state [name]		.B state [name]
Gets \fBmodulecmd.tcl\fP states. Reports the currently set value		Gets \fBmodulecmd.tcl\fP states. Reports the currently set value
of passed state \fIname\fP or all existing states if no \fIname\fP passed.		of passed state \fIname\fP or all existing states if no \fIname\fP passed.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B swap [options] [modulefile1] modulefile2		.B swap [options] [modulefile1] modulefile2
skipping to change at line 1868		skipping to change at line 2095
color rendering do not apply on JSON output.		color rendering do not apply on JSON output.
.sp		.sp
Module tags cannot be used in search query to designate a modulefile.		Module tags cannot be used in search query to designate a modulefile.
.SS Sticky modules		.SS Sticky modules
.sp		.sp
Modules are said \fIsticky\fP when they cannot be unloaded (they stick to the		Modules are said \fIsticky\fP when they cannot be unloaded (they stick to the
loaded environment). Two kind of stickiness can be distinguished:		loaded environment). Two kind of stickiness can be distinguished:
.INDENT 0.0		.INDENT 0.0
.IP \(bu 2		.IP \(bu 2
\fBsticky\fP module: cannot be unloaded unless if the unload is forced or if		\fBsticky\fP module: cannot be unloaded unless if the unload is forced or if
the module is reloaded after being unloaded		the module is reloaded after being unloaded or if restoring a collection.
.IP \(bu 2		.IP \(bu 2
\fBsuper\-sticky\fP module: cannot be unloaded unless if the module is reloaded		\fBsuper\-sticky\fP module: cannot be unloaded unless if the module is reloaded
after being unloaded; super\-sticky modules cannot be unloaded even if the		after being unloaded; super\-sticky modules cannot be unloaded even if the
unload is forced.		unload is forced.
.UNINDENT		.UNINDENT
.sp		.sp
Modules are designated sticky by associating them the \fBsticky\fP or the		Modules are designated sticky by associating them the \fBsticky\fP or the
\fBsuper\-sticky\fP \fI\%module tag\fP with the \fBmodule\-tag\fP		\fBsuper\-sticky\fP \fI\%module tag\fP with the \fBmodule\-tag\fP
modulefile command.		modulefile command.
.sp		.sp
When stickiness is defined over the generic module name (and not over a		When stickiness is defined over the generic module name (and not over a
specific module version, a version list or a version range), sticky or		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		super\-sticky module can be swapped by another version of module. For instance
if the \fBsticky\fP tag is defined over \fIfoo\fP module, loaded module \fIfoo/1 .2\fP		if the \fBsticky\fP tag is defined over \fIfoo\fP module, loaded module \fIfoo/1 .2\fP
can be swapped by \fIfoo/2.0\fP\&. Such stickiness definition means one version of		can be swapped by \fIfoo/2.0\fP\&. Such stickiness definition means one version of
module should stay loaded whatever version it is.		module should stay loaded whatever version it is.
		.sp
		When restoring a \fI\%collection\fP or resetting to the initial
		environment, sticky modules are unloaded to ensure \fI\%restore\fP or
		\fI\%reset\fP sub\-commands fully set the environment in target collection or
		initial state. Super\-sticky modules still cannot be unloaded with
		\fI\%restore\fP and \fI\%reset\fP sub\-commands.
.SS Module variants		.SS Module variants
.sp		.sp
Module variants are alternative evaluation of the same \fImodulefile\fP\&. A var iant		Module variants are alternative evaluation of the same \fImodulefile\fP\&. A var iant
is specified by associating a value to its name when designating module.		is specified by associating a value to its name when designating module.
Variant specification relies on the \fI\%Advanced module version specifiers\fP		Variant specification relies on the \fI\%Advanced module version specifiers\fP
mechanism.		mechanism.
.sp		.sp
Once specified, variant\(aqs value is transmitted to the evaluating \fImodulefil e\fP		Once specified, variant\(aqs value is transmitted to the evaluating \fImodulefil e\fP
which instantiates the variant in the \fBModuleVariant\fP array variable		which instantiates the variant in the \fBModuleVariant\fP array variable
when reaching the \fBvariant\fP modulefile command declaring this variant.		when reaching the \fBvariant\fP modulefile command declaring this variant.
skipping to change at line 1937		skipping to change at line 2170
.sp		.sp
When the JSON output mode is enabled (with \fI\%\-\-json\fP), variants are		When the JSON output mode is enabled (with \fI\%\-\-json\fP), variants are
reported under the \fBvariants\fP JSON object as name/value pairs. Values of		reported under the \fBvariants\fP JSON object as name/value pairs. Values of
Boolean variant are set as JSON Boolean. Other values are set as JSON strings.		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.		Variant shortcut and color rendering do not apply on JSON output.
.SS Collections		.SS Collections
.sp		.sp
Collections describe a sequence of \fI\%module use\fP then		Collections describe a sequence of \fI\%module use\fP then
\fI\%module load\fP commands that are interpreted by		\fI\%module load\fP commands that are interpreted by
\fBmodulecmd.tcl\fP to set the user environment as described by this		\fBmodulecmd.tcl\fP to set the user environment as described by this
sequence. When a collection is activated, with the \fI\%restore\fP		sequence.
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.
.sp		.sp
Collections are generated by the \fI\%save\fP sub\-command that dumps the		Collections are generated by the \fI\%save\fP sub\-command that dumps the
current user environment state in terms of module paths and loaded modules. By		current user environment state in terms of module paths and loaded modules. By
default collections are saved under the \fB$HOME/.module\fP directory.		default collections are saved under the \fB$HOME/.module\fP directory.
		.INDENT 0.0
		.INDENT 3.5
.sp		.sp
Collections may be valid for a given target if they are suffixed. In this		.nf
case these collections can only be restored if their suffix correspond to		.ft C
the current value of the \fI\%MODULES_COLLECTION_TARGET\fP environment		$ module list
variable (see the dedicated section of this topic below).		Currently Loaded Modulefiles:
		1) foo/1.2 2) bar/2.0 3) qux/3.5
		$ module save foo
		$ cat $HOME/.module/foo
		module use \-\-append /path/to/modulefiles
		module load foo
		module load bar/2.0
		module load qux/3.5
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		The content of a collection can also be displayed with the \fI\%saveshow\fP
		sub\-command. Note that in the above example, bare module name is recorded for
		\fBfoo\fP modulefile as loaded version is the implicit default. Loaded version
		recording can be enforced by enabling \fI\%collection_pin_version\fP
		configuration option.
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module config collection_pin_version 1
		$ module save foo
		$ module saveshow foo
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		/home/user/.module/foo:
		module use \-\-append /path/to/modulefiles
		module load foo/1.2
		module load bar/2.0
		module load qux/3.5
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		When a collection is activated, with the \fI\%restore\fP
		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.
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module list
		Currently Loaded Modulefiles:
		1) foo/1.2 2) bar/2.1 3) qux/3.5
		$ module restore foo
		Unloading qux/3.5
		Unloading bar/2.1
		Loading bar/2.0
		Loading qux/3.5
		$ module list
		Currently Loaded Modulefiles:
		1) foo/1.2 2) bar/2.0 3) qux/3.5
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		In the above example, second and third module loaded are changed. First loaded
		module is not changed or reloaded as it is the same module between current
		environment and collection. As second loaded module was different, this module
		and all those loaded afterward are unloaded to then load the sequence
		described by collection. As a result, third loaded module is reloaded, even if
		is was the same module between current environment and collection.
		.sp
		Existing collections can be listed with \fI\%savelist\fP sub\-command. They
		can be deleted with \fI\%saverm\fP sub\-command.
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module savelist
		Named collection list:
		1) default 2) foo
		$ module saverm default
		$ module savelist
		Named collection list:
		1) foo
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		When no argument is provided to \fI\%save\fP, \fI\%restore\fP,
		\fI\%saveshow\fP or \fI\%saverm\fP sub\-commands, the \fBdefault\fP
		collection is assumed.
		.sp
		Collection can also be specified as a full pathname:
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module save /path/to/collections/bar
		$ module saveshow /path/to/collections/bar
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		/path/to/collections/bar:
		module use \-\-append /path/to/modulefiles
		module load foo/1.2
		module load bar/2.0
		module load qux/3.5
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.SS Initial environment
		.sp
		Initial environment state, which corresponds to modulepaths enabled and
		modules loaded during \fI\%Modules initialization\fP,
		is referred as the \fB__init__\fP collection. This collection is virtual as
		its content is stored in the \fI\%__MODULES_LMINIT\fP and not in a file. It
		can be displayed with \fI\%saveshow\fP and restored with \fI\%restore\fP
		sub\-command.
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module saveshow __init__
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		initial environment:
		module use \-\-append /path/to/modulefiles
		module load foo/1.2
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		If the \fBdefault\fP collection does not exist, \fI\%saveshow\fP and
		\fI\%restore\fP sub\-commands assume \fB__init__\fP collection when no argument
		provided to them.
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module list
		Currently Loaded Modulefiles:
		1) foo/1.2 2) bar/2.1 3) qux/3.5
		$ module savelist
		Named collection list:
		1) foo
		$ module restore
		Unloading qux/3.5
		Unloading bar/2.1
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		Initial environment state can also be restored with the \fI\%reset\fP
		sub\-command. This sub\-command behavior can be changed with
		\fI\%reset_target_state\fP configuration option to choose to just purge
		loaded modules or to restore a specific collection.
		.SS Collection targets
		.sp
		A collection target can be defined for current environment session with the
		\fI\%collection_target\fP configuration option. When set, available
		collections are reduced to those suffixed with target name. Which means
		\fI\%restore\fP, \fI\%saveshow\fP, \fI\%savelist\fP and \fI\%saverm\fP
		only find collections matching currently set target.
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module savelist
		Named collection list:
		1) foo
		$ module config collection_target mytarget
		$ module savelist
		No named collection (for target "mytarget").
		$ module restore foo
		ERROR: Collection foo (for target "mytarget") cannot be found
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		When saving a new collection, generated file is suffixed with currently set
		target name.
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module save bar
		$ module savelist
		Named collection list (for target "mytarget"):
		1) bar
		$ ls $HOME/.module
		bar.mytarget foo
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		Collection targets help to distinguish contexts and make collection reachable
		only from the context they have been made for. For instance the same user
		account may be used to access different OSes or machine architectures. With a
		target set, users are ensured to only access collections built for the context
		they are currently connected to. See also \fI\%MODULES_COLLECTION_TARGET\fP
		section.
		.SS Stash collections
		.sp
		Current user environment can be stashed with \fI\%stash\fP sub\-command. When
		this sub\-command is called, current module environment is saved in a stash
		collection then \fI\%initial environment\fP is restored.
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module list
		Currently Loaded Modulefiles:
		1) foo/1.2 2) qux/4.2
		$ module stash
		Unloading qux/4.2
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		Specific sub\-commands are available to handle stash collections:
		\fI\%stashpop\fP, \fI\%stashlist\fP, \fI\%stashshow\fP,
		\fI\%stashrm\fP and \fI\%stashclear\fP\&. A stash collection is restored
		with \fI\%stashpop\fP which also deletes the collection once restored.
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module stashlist
		Stash collection list (for target "mytarget"):
		0) stash\-1667669750191
		$ module stashpop
		Loading qux/4.2
		$ module stashlist
		No stash collection (for target "mytarget").
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		Stash collections have same format and are saved in the same location than
		other collections. Collection target also applies to stash collection.
		Creation timestamp is saved in stash collection name.
		.sp
		Stash collection can be designated by their full collection name (i.e.,
		\fIstash\-<creation_timestamp>\fP) or a stash index. Most recent stash
		collection has index \fI0\fP, \fI1\fP is the one before it. When no argument is
		provided on stash sub\-commands, the latest stash collection is assumed (that
		is stash index \fI0\fP).
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		$ module stashlist
		Stash collection list (for target "mytarget"):
		0) stash\-1667669750783 1) stash\-1667669750253
		$ module stashshow 1
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		/home/user/.module/stash\-1667669750253.mytarget:
		module use \-\-append /path/to/modulefiles
		module load foo/1.2
		module load bar/2.0
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.SS Site\-specific configuration
		.sp
		Siteconfig, the site\-specific configuration script, is a way to extend
		\fBmodulecmd.tcl\fP\&. Siteconfig is a Tcl script. Its location is
		\fB@etcdir@/siteconfig.tcl\fP\&.
		.sp
		When \fBmodulecmd.tcl\fP is invoked it sources siteconfig script if it
		exists. Any global variable or procedure of \fBmodulecmd.tcl\fP can be
		redefined in siteconfig.
		.sp
		An additional siteconfig script may be specified through the
		\fI\%extra_siteconfig\fP configuration option. The
		\fI\%MODULES_SITECONFIG\fP environment variable is defined by
		\fI\%config\fP sub\-command when setting \fI\%extra_siteconfig\fP\&. If it
		exists the extra siteconfig is sourced by \fBmodulecmd.tcl\fP right after
		main siteconfig script.
		.SS Hooks
		.sp
		Siteconfig relies on the ability of the Tcl language to overwrite previously
		defined variables and procedures. Sites may deploy their own Tcl code in
		siteconfig to adapt \fBmodulecmd.tcl\fP to their specific needs. The
		\fBtrace\fP Tcl command may especially be used to define hooks that are run when
		entering or leaving a given procedure, or when a variable is read or written.
		See \fBtrace(n)\fP man page for detailed information. The following
		example setup a procedure that is executed before each modulefile evaluation:
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		proc beforeEval {cmdstring code result op} {
		# code to run right before each modulefile evaluation
		}
		trace add execution execute\-modulefile enter beforeEval
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		Another possibility is to override the definition of an existing procedure by
		first renaming its original version then creating a new procedure that will add
		specific code and rely on the renamed original procedure for the rest. See
		\fBrename(n)\fP man page for details. As an example, the following code
		adds a new query option to the \fBmodule\-info\fP modulefile command:
		.INDENT 0.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		rename module\-info __module\-info
		proc module\-info {what {more {}}} {
		switch \-\- $what {
		platform { return myhost\-$::tcl_platform(machine) }
		default { return [__module\-info $what $more] }
		}
		}
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.SS Siteconfig hook variables
		.sp
		Some Tcl variables can be defined in siteconfig script with special hook
		meaning. The following variables are recognized:
		.INDENT 0.0
		.TP
		.B modulefile_extra_vars
		List of variable names and associated values to setup in modulefile
		evaluation context. These variables can be accessed when modulefile is
		executed. In case code in a modulefile changes the value of such variable,
		its value is reset to the one defined in \fI\%modulefile_extra_vars\fP
		prior the evaluation of the next modulefile.
		.INDENT 7.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		set modulefile_extra_vars {myvar 1 othervar {some text}}
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		In the above siteconfig example, \fI\%modulefile_extra_vars\fP sets the
		\fBmyvar\fP and \fBothervar\fP variables in the modulefile evaluation context
		with respectively \fB1\fP and \fBsome text\fP as value.
		.UNINDENT
		.INDENT 0.0
		.TP
		.B modulefile_extra_cmds
		List of command and associated local procedure to setup in modulefile
		evaluation context. These commands can be called from the modulefile to
		execute associated procedure. In case a modulefile changes the definition
		of such command, its definition is bound again on the procedure defined in
		\fI\%modulefile_extra_cmds\fP prior the evaluation of the next modulefile.
		.INDENT 7.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		proc mycmd {} {
		# Tcl code
		}
		proc anotherproc {args} {
		# Tcl code
		}
		set modulefile_extra_cmds {mycmd mycmd othercmd anotherproc}
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		In the above siteconfig example, \fI\%modulefile_extra_cmds\fP sets the
		\fBmycmd\fP and \fBothercmd\fP commands in the modulefile evaluation context and
		bind them respectively to the \fBmycmd\fP and \fBanotherproc\fP procedures
		defined in siteconfig script.
		.UNINDENT
		.INDENT 0.0
		.TP
		.B modulerc_extra_vars
		List of variable names and associated values to setup in modulerc evaluation
		context. These variables can be accessed when modulerc is executed. In case
		code in a modulerc changes the value of such variable, its value
		is reset to the one defined in \fI\%modulerc_extra_vars\fP prior the
		evaluation of the next modulerc.
		.INDENT 7.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		set modulerc_extra_vars {myvar 1 othervar {some text}}
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		In the above siteconfig example, \fI\%modulerc_extra_vars\fP sets the
		\fBmyvar\fP and \fBothervar\fP variables in the modulerc evaluation context with
		respectively \fB1\fP and \fBsome text\fP as value.
		.UNINDENT
		.INDENT 0.0
		.TP
		.B modulerc_extra_cmds
		List of command and associated local procedure to setup in modulerc
		evaluation context. These commands can be called from the modulerc to execute
		associated procedure. In case a modulerc changes the definition of such
		command, its definition is bound again on the procedure defined in
		\fI\%modulerc_extra_cmds\fP prior the evaluation of the next modulerc.
		.INDENT 7.0
		.INDENT 3.5
		.sp
		.nf
		.ft C
		proc mycmd {} {
		# Tcl code
		}
		proc anotherproc {args} {
		# Tcl code
		}
		set modulerc_extra_cmds {mycmd mycmd othercmd anotherproc}
		.ft P
		.fi
		.UNINDENT
		.UNINDENT
		.sp
		In the above siteconfig example, \fI\%modulerc_extra_cmds\fP sets the
		\fBmycmd\fP and \fBothercmd\fP commands in the modulerc evaluation context and
		bind them respectively to the \fBmycmd\fP and \fBanotherproc\fP procedures
		defined in siteconfig script.
		.UNINDENT
.SH EXIT STATUS		.SH EXIT STATUS
.sp		.sp
The \fBmodule\fP command exits with \fB0\fP if its execution succeed.		The \fBmodule\fP command exits with \fB0\fP if its execution succeed.
Otherwise \fB1\fP is returned.		Otherwise \fB1\fP is returned.
.SH ENVIRONMENT		.SH ENVIRONMENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B __MODULES_AUTOINIT_INPROGRESS		.B __MODULES_AUTOINIT_INPROGRESS
If set to \fB1\fP, the \fBautoinit\fP sub\-command process is skipped.		If set to \fB1\fP, the \fBautoinit\fP sub\-command process is skipped.
.sp		.sp
skipping to change at line 2006		skipping to change at line 2695
modulefiles it declares a conflict with. These loaded modulefiles and		modulefiles it declares a conflict with. These loaded modulefiles and
conflicting modulefile names are separated by the ampersand character.		conflicting modulefile names are separated by the ampersand character.
.sp		.sp
This environment variable is intended for \fBmodule\fP command internal		This environment variable is intended for \fBmodule\fP command internal
use to get knowledge of the conflicts declared by the loaded \fImodulefiles\fP		use to get knowledge of the conflicts declared by the loaded \fImodulefiles\fP
in order to keep environment consistent when a conflicting module is asked		in order to keep environment consistent when a conflicting module is asked
for load afterward.		for load afterward.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
		.B __MODULES_LMINIT
		A colon separated list describing the modulepaths that have been enabled and
		the \fImodulefiles\fP that have been loaded with their tags during \fI\%Modules
		initialization\fP\&. Each element in this list
		corresponds to a \fI\%collection\fP definition line.
		.sp
		This environment variable is intended for \fBmodule\fP command internal
		use to get knowledge of the initial loaded state after initialization.
		.sp
		This initial environment state can then be restored with \fI\%reset\fP
		sub\-command. It can also be restored with \fI\%restore\fP sub\-command when
		\fB__init__\fP collection name is specified or when no collection name is
		specified and no \fIdefault\fP collection exists.
		.sp
		The content of the initial environment can be displayed with
		\fI\%saveshow\fP sub\-command when \fB__init__\fP collection name is specified
		or when no collection name is specified and no \fIdefault\fP collection exists.
		.UNINDENT
		.INDENT 0.0
		.TP
.B __MODULES_LMPREREQ		.B __MODULES_LMPREREQ
A colon separated list of the \fBprereq\fP statements defined by all		A colon separated list of the \fBprereq\fP statements defined by all
loaded \fImodulefiles\fP\&. Each element in this list starts by the name of the		loaded \fImodulefiles\fP\&. Each element in this list starts by the name of the
loaded \fImodulefile\fP declaring the pre\-requirement followed by the name of a ll		loaded \fImodulefile\fP declaring the pre\-requirement followed by the name of a ll
modulefiles it declares a \fBprereq\fP with. These loaded modulefiles and		modulefiles it declares a \fBprereq\fP with. These loaded modulefiles and
pre\-required modulefile names are separated by the ampersand character. When		pre\-required modulefile names are separated by the ampersand character. When
a \fBprereq\fP statement is composed of multiple modulefiles, these		a \fBprereq\fP statement is composed of multiple modulefiles, these
modulefile names are separated by the pipe character.		modulefile names are separated by the pipe character.
.sp		.sp
This environment variable is intended for \fBmodule\fP command internal		This environment variable is intended for \fBmodule\fP command internal
use to get knowledge of the pre\-requirement declared by the loaded		use to get knowledge of the pre\-requirement declared by the loaded
\fImodulefiles\fP in order to keep environment consistent when a pre\-required		\fImodulefiles\fP in order to keep environment consistent when a pre\-required
module is asked for unload afterward.		module is asked for unload afterward.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
		.B __MODULES_LMREFRESH
		A colon separated list of the loaded modules that are qualified for refresh
		evaluation. Loaded modules listed in this variable are those defining
		volatile environment changes like shell completion, alias and function.
		.UNINDENT
		.INDENT 0.0
		.TP
.B __MODULES_LMSOURCESH		.B __MODULES_LMSOURCESH
A colon separated list of the \fBsource\-sh\fP statements defined by all		A colon separated list of the \fBsource\-sh\fP statements defined by all
loaded \fImodulefiles\fP\&. Each element in this list starts by the name of the		loaded \fImodulefiles\fP\&. Each element in this list starts by the name of the
loaded \fImodulefile\fP declaring the environment changes made by the evaluation		loaded \fImodulefile\fP declaring the environment changes made by the evaluation
of \fBsource\-sh\fP scripts. This name is followed by each		of \fBsource\-sh\fP scripts. This name is followed by each
\fBsource\-sh\fP statement call and corresponding result achieved in		\fBsource\-sh\fP statement call and corresponding result achieved in
modulefile. The loaded modulefile name and each \fBsource\-sh\fP statement		modulefile. The loaded modulefile name and each \fBsource\-sh\fP statement
description are separated by the ampersand character. The \fBsource\-sh\fP		description are separated by the ampersand character. The \fBsource\-sh\fP
statement call and each resulting modulefile command (corresponding to the		statement call and each resulting modulefile command (corresponding to the
environment changes done by sourced script) are separated by the pipe		environment changes done by sourced script) are separated by the pipe
skipping to change at line 2373		skipping to change at line 3089
.B MODULES_COLLECTION_TARGET		.B MODULES_COLLECTION_TARGET
The collection target that determines what collections are valid thus		The collection target that determines what collections are valid thus
reachable on the current system.		reachable on the current system.
.sp		.sp
Collection directory may sometimes be shared on multiple machines which may		Collection directory may sometimes be shared on multiple machines which may
use different modules setup. For instance modules users may access with the		use different modules setup. For instance modules users may access with the
same \fBHOME\fP directory multiple systems using different OS versions.		same \fBHOME\fP directory multiple systems using different OS versions.
When it happens a collection made on machine 1 may be erroneous on machine 2.		When it happens a collection made on machine 1 may be erroneous on machine 2.
.sp		.sp
When a target is set, only the collections made for that target are		When a target is set, only the collections made for that target are
available to the \fI\%restore\fP, \fI\%savelist\fP, \fI\%saveshow\fP		available to the \fI\%restore\fP, \fI\%savelist\fP, \fI\%saveshow\fP,
and \fI\%saverm\fP sub\-commands. Saving a collection registers the target		\fI\%saverm\fP, \fI\%stash\fP, \fI\%stashpop\fP, \fI\%stashlist\fP,
footprint by suffixing the collection filename with		\fI\%stashshow\fP, and \fI\%stashrm\fP sub\-commands. Saving a collection
		registers the target footprint by suffixing the collection filename with
\fB\&.$MODULES_COLLECTION_TARGET\fP\&. The collection target is not involved whe n		\fB\&.$MODULES_COLLECTION_TARGET\fP\&. The collection target is not involved whe n
collection is specified as file path on the \fI\%saveshow\fP,		collection is specified as file path on the \fI\%saveshow\fP,
\fI\%restore\fP and \fI\%save\fP sub\-commands.		\fI\%restore\fP and \fI\%save\fP sub\-commands.
.sp		.sp
For example, the \fI\%MODULES_COLLECTION_TARGET\fP variable may be set with		For example, the \fI\%MODULES_COLLECTION_TARGET\fP variable may be set with
results from commands like \fBlsb_release\fP, \fBhostname\fP,		results from commands like \fBlsb_release\fP, \fBhostname\fP,
\fBdnsdomainname\fP, etc.		\fBdnsdomainname\fP, etc.
.sp		.sp
This environment variable value supersedes the default value set in the		This environment variable value supersedes the default value set in the
\fI\%collection_target\fP configuration option. It can be defined with		\fI\%collection_target\fP configuration option. It can be defined with
skipping to change at line 2511		skipping to change at line 3228
This environment variable is generated by \fBmodule\fP command and		This environment variable is generated by \fBmodule\fP command and
should not be modified externally.		should not be modified externally.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B MODULES_ICASE		.B MODULES_ICASE
When module specification are passed as argument to module sub\-commands or		When module specification are passed as argument to module sub\-commands or
modulefile Tcl commands, defines the case sensitiveness to apply to match		modulefile Tcl commands, defines the case sensitiveness to apply to match
them. When \fI\%MODULES_ICASE\fP is set to \fBnever\fP, a case sensitive		them. When \fI\%MODULES_ICASE\fP is set to \fBnever\fP, a case sensitive
match is applied in any cases. When set to \fBsearch\fP, a case insensitive		match is applied in any cases. When set to \fBsearch\fP, a case insensitive
match is applied to the \fI\%avail\fP, \fI\%list\fP, \fI\%whatis\fP and		match is applied to the \fI\%avail\fP, \fI\%list\fP, \fI\%whatis\fP,
\fI\%paths\fP sub\-commands. When set to \fBalways\fP, a case insensitive		\fI\%paths\fP and \fI\%savelist\fP sub\-commands. When set to \fBalways\fP,
match is also applied to the other module sub\-commands and modulefile Tcl		a case insensitive match is also applied to the other module sub\-commands
commands for the module specification they receive as argument.		and modulefile Tcl commands for the module specification they receive as
		argument.
.sp		.sp
This environment variable value supersedes the default value set in the		This environment variable value supersedes the default value set in the
\fI\%icase\fP configuration option. It can be defined with the		\fI\%icase\fP configuration option. It can be defined with the
\fI\%config\fP sub\-command. The \fI\%\-\-icase\fP/\fI\%\-i\fP command line		\fI\%config\fP sub\-command. The \fI\%\-\-icase\fP/\fI\%\-i\fP command line
switches, which correspond to the \fBalways\fP mode, override this environment		switches, which correspond to the \fBalways\fP mode, override this environment
variable.		variable.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B MODULES_IMPLICIT_DEFAULT		.B MODULES_IMPLICIT_DEFAULT
skipping to change at line 2699		skipping to change at line 3417
.sp		.sp
This environment variable value supersedes the default value set in the		This environment variable value supersedes the default value set in the
\fI\%pager\fP configuration option. It can be defined with the		\fI\%pager\fP configuration option. It can be defined with the
\fI\%config\fP sub\-command.		\fI\%config\fP sub\-command.
.sp		.sp
If \fI\%MODULES_PAGER\fP variable is set to an empty string or to the value		If \fI\%MODULES_PAGER\fP variable is set to an empty string or to the value
\fBcat\fP, pager will not be launched.		\fBcat\fP, pager will not be launched.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
		.B MODULES_PROTECTED_ENVVARS
		A colon separated list of environment variable names that should not be
		modified by any modulefile command.
		.sp
		Prevents modifications by \fBappend\-path\fP, \fBprepend\-path\fP,
		\fBremove\-path\fP, \fBsetenv\fP and \fBunsetenv\fP\&. When these
		modulefile commands attempt to modify a protected environment variable,
		a warning message is emitted and modification is ignored.
		.sp
		This environment variable value supersedes the default value set in the
		\fI\%protected_envvars\fP configuration option. It can be defined with the
		\fI\%config\fP sub\-command.
		.UNINDENT
		.INDENT 0.0
		.TP
.B MODULES_QUARANTINE_SUPPORT		.B MODULES_QUARANTINE_SUPPORT
If set to \fB1\fP, produces the shell code for quarantine mechanism when the		If set to \fB1\fP, produces the shell code for quarantine mechanism when the
\fBautoinit\fP sub\-command generates the \fBmodule\fP shell		\fBautoinit\fP sub\-command generates the \fBmodule\fP shell
function.		function.
.sp		.sp
The generated shell code for quarantine mechanism indirectly passes the		The generated shell code for quarantine mechanism indirectly passes the
environment variable defined in \fI\%MODULES_RUN_QUARANTINE\fP to the		environment variable defined in \fI\%MODULES_RUN_QUARANTINE\fP to the
\fBmodulecmd.tcl\fP script to protect its run\-time environment from		\fBmodulecmd.tcl\fP script to protect its run\-time environment from
side\-effect coming from the current definition of these variables.		side\-effect coming from the current definition of these variables.
.sp		.sp
skipping to change at line 2737		skipping to change at line 3470
not redirected to stdout channel.		not redirected to stdout channel.
.sp		.sp
This environment variable value supersedes the default value set in the		This environment variable value supersedes the default value set in the
\fI\%redirect_output\fP configuration option. It can be defined with		\fI\%redirect_output\fP configuration option. It can be defined with
the \fI\%config\fP sub\-command. The \fI\%\-\-redirect\fP and		the \fI\%config\fP sub\-command. The \fI\%\-\-redirect\fP and
\fI\%\-\-no\-redirect\fP command line switches override this environment		\fI\%\-\-no\-redirect\fP command line switches override this environment
variable.		variable.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
		.B MODULES_RESET_TARGET_STATE
		Defines behavior of \fI\%reset\fP sub\-command. When set to \fB__init__\fP,
		initial environment is restored. When set to \fB__purge__\fP, \fI\%reset\fP
		performs a \fI\%purge\fP sub\-command. Any other value designates a name
		collection to \fI\%restore\fP\&.
		.sp
		This environment variable value supersedes the default value set in the
		\fI\%reset_target_state\fP configuration option. It can be defined with
		the \fI\%config\fP sub\-command.
		.UNINDENT
		.INDENT 0.0
		.TP
.B MODULES_RUN_QUARANTINE		.B MODULES_RUN_QUARANTINE
A space separated list of environment variable names that should be passed		A space separated list of environment variable names that should be passed
indirectly to \fBmodulecmd.tcl\fP to protect its run\-time environment from		indirectly to \fBmodulecmd.tcl\fP to protect its run\-time environment from
side\-effect coming from their current definition.		side\-effect coming from their current definition.
.sp		.sp
If the quarantine mechanism has been included in \fBmodule\fP shell		If the quarantine mechanism has been included in \fBmodule\fP shell
function (see \fI\%MODULES_QUARANTINE_SUPPORT\fP), each variable found in		function (see \fI\%MODULES_QUARANTINE_SUPPORT\fP), each variable found in
\fI\%MODULES_RUN_QUARANTINE\fP will have its value emptied or set to the		\fI\%MODULES_RUN_QUARANTINE\fP will have its value emptied or set to the
value of the corresponding \fI\%MODULES_RUNENV_<VAR>\fP variable when		value of the corresponding \fI\%MODULES_RUNENV_<VAR>\fP variable when
defining \fBmodulecmd.tcl\fP run\-time environment.		defining \fBmodulecmd.tcl\fP run\-time environment.
skipping to change at line 2839		skipping to change at line 3584
To generate the code to silence shell debugging property in the		To generate the code to silence shell debugging property in the
\fBmodule\fP shell function, \fI\%MODULES_SILENT_SHELL_DEBUG\fP should		\fBmodule\fP shell function, \fI\%MODULES_SILENT_SHELL_DEBUG\fP should
be set to \fB1\fP prior Modules initialization or the		be set to \fB1\fP prior Modules initialization or the
\fI\%silent_shell_debug\fP configuration option should be set to \fB1\fP in		\fI\%silent_shell_debug\fP configuration option should be set to \fB1\fP in
the \fBinitrc\fP configuration file.		the \fBinitrc\fP configuration file.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B MODULES_SITECONFIG		.B MODULES_SITECONFIG
Location of a site\-specific configuration script to source into		Location of a site\-specific configuration script to source into
\fBmodulecmd.tcl\fP\&. See also \fI\%Modulecmd startup\fP section.		\fBmodulecmd.tcl\fP\&. See \fI\%Site\-specific configuration\fP section for
		details.
.sp		.sp
This environment variable value supersedes the default value set in the		This environment variable value supersedes the default value set in the
\fI\%extra_siteconfig\fP configuration option. It can be defined with the		\fI\%extra_siteconfig\fP configuration option. It can be defined with the
\fI\%config\fP sub\-command. This environment variable is ignored if		\fI\%config\fP sub\-command. This environment variable is ignored if
\fI\%extra_siteconfig\fP has been declared locked in		\fI\%extra_siteconfig\fP has been declared locked in
\fI\%locked_configs\fP configuration option.		\fI\%locked_configs\fP configuration option.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
.B MODULES_TAG_ABBREV		.B MODULES_TAG_ABBREV
skipping to change at line 2883		skipping to change at line 3629
tag and tag name or abbreviation is not displayed. When listed in		tag and tag name or abbreviation is not displayed. When listed in
\fI\%MODULES_TAG_COLOR_NAME\fP environment variable, a tag name or		\fI\%MODULES_TAG_COLOR_NAME\fP environment variable, a tag name or
abbreviation is displayed and select graphic rendition is applied over it.		abbreviation is displayed and select graphic rendition is applied over it.
.sp		.sp
This environment variable value supersedes the default value set in the		This environment variable value supersedes the default value set in the
\fI\%tag_color_name\fP configuration option. It can be defined with the		\fI\%tag_color_name\fP configuration option. It can be defined with the
\fI\%config\fP sub\-command.		\fI\%config\fP sub\-command.
.UNINDENT		.UNINDENT
.INDENT 0.0		.INDENT 0.0
.TP		.TP
		.B MODULES_TCL_LINTER
		Command name or path for use to check syntax of modulefile through the
		\fI\%lint\fP sub\-command.
		.sp
		This environment variable value supersedes the default value set in the
		\fI\%tcl_linter\fP configuration option. It can be defined with the
		\fI\%config\fP sub\-command.
		.UNINDENT
		.INDENT 0.0
		.TP
.B MODULES_TERM_BACKGROUND		.B MODULES_TERM_BACKGROUND
Inform Modules of the terminal background color to determine if the color set		Inform Modules of the terminal background color to determine if the color set
for dark background or the color set for light background should be used to		for dark background or the color set for light background should be used to
color output in case no specific color set is defined with the		color output in case no specific color set is defined with the
\fI\%MODULES_COLORS\fP variable. Accepted values are \fBdark\fP and		\fI\%MODULES_COLORS\fP variable. Accepted values are \fBdark\fP and
\fBlight\fP\&.		\fBlight\fP\&.
.sp		.sp
This environment variable value supersedes the default value set in the		This environment variable value supersedes the default value set in the
\fI\%term_background\fP configuration option. It can be defined with the		\fI\%term_background\fP configuration option. It can be defined with the
\fI\%config\fP sub\-command.		\fI\%config\fP sub\-command.
skipping to change at line 3054		skipping to change at line 3810
is evaluated before the \fBinitrc\fP configuration file. See the		is evaluated before the \fBinitrc\fP configuration file. See the
\fI\%Package Initialization\fP section for details.		\fI\%Package Initialization\fP section for details.
.UNINDENT		.UNINDENT
.UNINDENT		.UNINDENT
.sp		.sp
\fB@etcdir@/siteconfig.tcl\fP		\fB@etcdir@/siteconfig.tcl\fP
.INDENT 0.0		.INDENT 0.0
.INDENT 3.5		.INDENT 3.5
The site\-specific configuration script of \fBmodulecmd.tcl\fP\&. An		The site\-specific configuration script of \fBmodulecmd.tcl\fP\&. An
additional configuration script could be defined using the		additional configuration script could be defined using the
\fI\%MODULES_SITECONFIG\fP environment variable.		\fI\%MODULES_SITECONFIG\fP environment variable. See \fI\%Site\-specific configu ration\fP for detailed information.
.UNINDENT		.UNINDENT
.UNINDENT		.UNINDENT
.sp		.sp
\fB@etcdir@/rc\fP		\fB@etcdir@/rc\fP
.INDENT 0.0		.INDENT 0.0
.INDENT 3.5		.INDENT 3.5
The system\-wide modules rc file. The location of this file can be changed		The system\-wide modules rc file. The location of this file can be changed
using the \fI\%MODULERCFILE\fP environment variable as described above.		using the \fI\%MODULERCFILE\fP environment variable as described above.
.UNINDENT		.UNINDENT
.UNINDENT		.UNINDENT
End of changes. 46 change blocks.
77 lines changed or deleted		851 lines changed or added

---