envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-05-30 00:12:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: add version added/changed info in latex output

Browse Source 
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
This commit is contained in:
Xavier Delaruelle
2026-01-11 20:18:01 +01:00
parent f4209b409a
commit b62adbe7f6
3 changed files with 351 additions and 351 deletions
Download Patch File Download Diff File Expand all files Collapse all files

152
INSTALL.rst
View File

@@ -404,7 +404,7 @@ is displayed within brackets):
Directory to host Emacs addon files [``DATAROOTDIR/emacs/lisp``]
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -413,7 +413,7 @@ is displayed within brackets):
Directory for the executable configuration scripts
[``PREFIX/etc``]
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -440,7 +440,7 @@ is displayed within brackets):
Directory of main modulefiles also called system modulefiles
[``PREFIX/modulefiles``]
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -448,7 +448,7 @@ is displayed within brackets):
Directory to host Nagelfar linter addon files [``DATAROOTDIR/nagelfar``]
.. only:: html
.. only:: html or latex
.. versionadded:: 5.2
@@ -460,7 +460,7 @@ is displayed within brackets):
Directory to host Vim addon files [``DATAROOTDIR/vim/vimfiles``]
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -479,7 +479,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`advanced_version_spec` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.4
@@ -491,7 +491,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
Append rather prepend binary directory to the PATH environment variable when
the :instopt:`--enable-set-binpath` option is enabled. (default=no)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.2
@@ -500,7 +500,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
Append rather prepend man page directory to the MANPATH environment variable
when the :instopt:`--enable-set-manpath` option is enabled. (default=no)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.2
@@ -514,7 +514,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`auto_handling` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.2
@@ -533,7 +533,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`avail_indepth` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -547,7 +547,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`color` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -563,7 +563,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`conflict_unload` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.5
@@ -575,7 +575,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
installation process handled via a package manager which handles by itself
the installation of this kind of documents. (default=yes)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -584,7 +584,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
Install the Emacs addon files in the Emacs addons directory defined with the
:instopt:`--emacsdatadir` option. (default=yes)
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -593,7 +593,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
Install some modulefiles provided as example in the system modulefiles
directory defined with the :instopt:`--modulefilesdir` option. (default=yes)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -607,7 +607,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`extended_default` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.4
@@ -626,7 +626,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`implicit_default` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -640,7 +640,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`implicit_requirement` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -649,7 +649,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
Build and install the Modules Tcl extension library which provides optimized
Tcl commands for the modulecmd.tcl script. (default=yes)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -664,7 +664,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`mcookie_version_check` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -677,7 +677,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
configuration option which could be changed after installation with the
:subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.5
@@ -692,7 +692,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:instopt:`--initdir` option rather than within the ``modulerc`` file.
(default=no)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -705,7 +705,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
location where to find the Modules Tcl extension library depending on current
machine architecture. (default=no)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.6
@@ -715,7 +715,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
modulefiles and modulercs) in the Nagelfar addons directory defined with the
:instopt:`--nagelfardatadir` option. (default=yes)
.. only:: html
.. only:: html or latex
.. versionadded:: 5.2
@@ -728,7 +728,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:instopt:`--enable-conflict-unload` and :instopt:`--enable-require-via`.
(default=no)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -760,7 +760,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`quarantine_support` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -776,7 +776,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`require_via` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -785,7 +785,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
Prepend binary directory defined by the :instopt:`--bindir` option to the
PATH environment variable in the shell initialization scripts. (default=yes)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -795,7 +795,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
MANPATH environment variable in the shell initialization scripts.
(default=yes)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -808,7 +808,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`set_shell_startup` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -824,7 +824,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`silent_shell_debug` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.2
@@ -841,7 +841,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`source_cache` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.4
@@ -857,7 +857,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`spider_indepth` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -878,7 +878,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:mconfig:`unique_name_loaded` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.4
@@ -887,7 +887,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
Install the Vim addon files in the Vim addons directory defined with the
:instopt:`--vimdatadir` option. (default=yes)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -902,7 +902,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
configuration option which could be changed after installation with the
:subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -912,7 +912,7 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
:command:`ml` and :command:`envml` command batch file and ``cmd.cmd``
initialization script). (default=no)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.5
@@ -935,7 +935,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`abort_on_error` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.4
@@ -952,7 +952,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`avail_output` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -982,7 +982,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`avail_terse_output` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -1004,7 +1004,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
completion script for Modules is installed in the initialization script
directory and is sourced from Modules Bash initialization script. (default=)
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -1013,7 +1013,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
List of paths to look at when searching the location of tools required to
build and configure Modules (default=\ ``/usr/bin:/bin:/usr/local/bin``)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.2
@@ -1051,7 +1051,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
equals ``dark``. :mconfig:`colors` could be changed after installation with
the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -1084,7 +1084,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
configuration option which could be changed after installation with the
:subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.8
@@ -1094,7 +1094,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
completion script for Modules is installed in the initialization script
directory and is sourced from Modules Fish initialization script. (default=)
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -1111,7 +1111,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
configuration option which could be changed after installation with the
:subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.4
@@ -1123,7 +1123,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
Location where to install Modules initialization configuration files. Either
``initdir`` or ``etcdir`` (default=\ ``etcdir``)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -1142,7 +1142,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
equals ``light``. :mconfig:`colors` could be changed after installation with
the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -1178,7 +1178,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`list_output` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -1203,7 +1203,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`list_terse_output` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -1223,7 +1223,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:file:`initrc` configuration file or in the ``modulerc`` file if
:instopt:`--with-initconf-in` is set to ``initdir``. (default=)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -1238,7 +1238,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`locked_configs` configuration option which cannot not be changed
after installation.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -1256,7 +1256,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`logged_events` configuration option which cannot not be changed
after installation.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.5
@@ -1269,7 +1269,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
value of the :mconfig:`logger` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.5
@@ -1281,7 +1281,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
value of the :mconfig:`logger` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.5
@@ -1299,7 +1299,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
``BASEPREFIX/$MODULE_VERSION/modulefiles`` if versioning installation mode
enabled)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -1311,7 +1311,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
configuration option which could be changed after installation with the
:subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.4
@@ -1325,7 +1325,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`nearly_forbidden_days` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.6
@@ -1339,7 +1339,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
value of the :mconfig:`pager` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -1351,7 +1351,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
of the :mconfig:`pager` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -1360,7 +1360,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
Name or full path of Python interpreter command to set as shebang for helper
scripts. (default=\ ``python``)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.5
@@ -1377,7 +1377,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:subcmd:`config` sub-command on :mconfig:`run_quarantine` configuration
option.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -1391,7 +1391,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`search_match` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -1409,7 +1409,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`spider_output` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -1427,7 +1427,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`spider_terse_output` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -1441,7 +1441,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`sticky_purge` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.4
@@ -1456,7 +1456,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`tag_abbrev` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -1477,7 +1477,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`tag_color_name` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -1497,7 +1497,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
Name or full path of Tcl interpreter shell (default=\ ``tclsh``)
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -1510,7 +1510,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
default value of the :mconfig:`tcl_linter` configuration option which could
be changed after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.2
@@ -1522,7 +1522,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
value of the :mconfig:`tcl_linter` configuration option which could be
changed after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.2
@@ -1536,7 +1536,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`term_background` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -1550,7 +1550,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`unload_match_order` configuration option which could be changed
after installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -1567,7 +1567,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`variant_shortcut` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.8
@@ -1581,7 +1581,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
:mconfig:`verbosity` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.3
@@ -1592,7 +1592,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
directory and :envvar:`FPATH` is set in Zsh initialization script to point to
this location. (default=)
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1

434
doc/source/module.rst
View File

File diff suppressed because it is too large Load Diff

116
doc/source/modulefile.rst
View File

@@ -72,7 +72,7 @@ the *modulefile* is being loaded.
*name* is ignored. See :mfcmd:`module-tag` command for more information on
tags.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -120,7 +120,7 @@ the *modulefile* is being loaded.
enabled modulepath, *modulefile* will be searched into
``/path/to/modulefiles`` and ``/another/path`` directories.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -171,7 +171,7 @@ the *modulefile* is being loaded.
if :option:`--force` option is set. To forbid the unload of a modulefile, it
is recommended to tag it ``super-sticky`` with :mfcmd:`module-tag` command.
.. only:: html
.. only:: html or latex
.. versionchanged:: 5.4
Breaking modulefile is unloaded anyway when :option:`--force` option is
@@ -193,7 +193,7 @@ the *modulefile* is being loaded.
to the documentation of these shells to learn how to define completion. The
command is ignored if an unsupported shell is specified.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -221,7 +221,7 @@ the *modulefile* is being loaded.
modules that match specification. (see :ref:`Automated module handling
mechanisms<MODULES_AUTO_HANDLING>` in :ref:`module(1)`).
.. only:: html
.. only:: html or latex
.. versionchanged:: 5.5
An attempt to unload module is made if :mconfig:`conflict_unload` and
@@ -240,7 +240,7 @@ the *modulefile* is being loaded.
Alias of :mfcmd:`prereq-all` command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -254,7 +254,7 @@ the *modulefile* is being loaded.
Alias of :mfcmd:`prereq` command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -272,7 +272,7 @@ the *modulefile* is being loaded.
Alias of :mfcmd:`provide` command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -307,7 +307,7 @@ the *modulefile* is being loaded.
family is made. (see :ref:`Automated module handling
mechanisms<MODULES_AUTO_HANDLING>` in :ref:`module(1)`).
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -329,7 +329,7 @@ the *modulefile* is being loaded.
environment *variable* or defined fallback value is returned in *display*
mode.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -355,7 +355,7 @@ the *modulefile* is being loaded.
``--return-value`` option is set. When this option is set the value of
*variant* or defined fallback value is returned in *display* mode.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.8
@@ -374,7 +374,7 @@ the *modulefile* is being loaded.
context of the current user to determine whether :envvar:`MODULEPATH` is
updated.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -382,7 +382,7 @@ the *modulefile* is being loaded.
Alias of :mfcmd:`module-hide` command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.5
@@ -390,7 +390,7 @@ the *modulefile* is being loaded.
Alias of :mfcmd:`module-hide` command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.5
@@ -406,7 +406,7 @@ the *modulefile* is being loaded.
modulefile alias. It may also leverage a specific syntax to finely select
module version (see `Advanced module version specifiers`_ section below).
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -435,7 +435,7 @@ the *modulefile* is being loaded.
no *collection* argument is provided, a true value will only be returned if
a collection matching currently set target exists.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -446,7 +446,7 @@ the *modulefile* is being loaded.
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.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -462,7 +462,7 @@ the *modulefile* is being loaded.
* ``release``: release number of distribution
* ``codename``: codename according to distribution release
.. only:: html
.. only:: html or latex
.. versionadded:: 5.5
@@ -560,7 +560,7 @@ the *modulefile* is being loaded.
| :subcmd:`whatis` | | |
+--------------------------------+---------------------+---------------------+
.. only:: html
.. only:: html or latex
.. versionchanged:: 4.7
Option ``--not-req`` added for ``load``, ``unload`` and ``switch``
@@ -676,7 +676,7 @@ the *modulefile* is being loaded.
may also be a full path file name to precisely designate one module in a
specific modulepath.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.6
@@ -700,7 +700,7 @@ the *modulefile* is being loaded.
with :mfcmd:`module-help` is printed before running this procedure on
``help`` evaluation mode.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -797,7 +797,7 @@ the *modulefile* is being loaded.
Moreover it may also be a full path file name to precisely designate one
module in a specific modulepath.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.6
@@ -834,7 +834,7 @@ the *modulefile* is being loaded.
``try-load``, ``load-any``, ``mod-to-sh``, ``reset``, ``stash``,
``stashpop`` or ``spider``.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -850,7 +850,7 @@ the *modulefile* is being loaded.
The defined variants of the loaded module are not included in the returned
string.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -924,7 +924,7 @@ the *modulefile* is being loaded.
Returns ``1`` if one of the tags applying to currently evaluated
*modulefile* is *tag*. Returns ``0`` otherwise.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -945,7 +945,7 @@ the *modulefile* is being loaded.
If the Modules Tcl extension library is disabled, the :manpage:`id(1)`
command is invoked to fetch groups of current user.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.6
@@ -960,7 +960,7 @@ the *modulefile* is being loaded.
If the Modules Tcl extension library is disabled, the :manpage:`id(1)`
command is invoked to fetch username of current user.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.6
@@ -1023,7 +1023,7 @@ the *modulefile* is being loaded.
automatically unloaded when it has been auto-loaded and its dependent modules
are getting unloaded.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -1069,7 +1069,7 @@ the *modulefile* is being loaded.
The parameter *modulefile* corresponds to the relative or absolute file
location of a *modulefile*.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.1
@@ -1122,7 +1122,7 @@ the *modulefile* is being loaded.
may also be a full path file name to precisely designate one module in a
specific modulepath.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -1148,7 +1148,7 @@ the *modulefile* is being loaded.
modulepath. If *directory* is ``.`` (dot) then the current directory of the
modulerc file defining this command is assumed.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.4
@@ -1193,7 +1193,7 @@ the *modulefile* is being loaded.
configuration option is activated, the *modulefile* is considered a
dependency by the loaded modulefiles stored in the added modulepaths.
.. only:: html
.. only:: html or latex
.. versionchanged:: 4.1
Option ``--duplicates`` added
@@ -1264,7 +1264,7 @@ the *modulefile* is being loaded.
enabled modulepath, *modulefile* will be searched into
``/path/to/modulefiles`` and ``/another/path`` directories.
.. only:: html
.. only:: html or latex
.. versionchanged:: 4.2
An attempt to load modulefile is made if :mconfig:`auto_handling`
@@ -1296,7 +1296,7 @@ the *modulefile* is being loaded.
declared as an optional requirement. A *modulefile* that cannot be loaded,
will not stop the evaluation.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -1310,7 +1310,7 @@ the *modulefile* is being loaded.
Alias of :mfcmd:`prereq` command.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -1335,7 +1335,7 @@ the *modulefile* is being loaded.
:mfcmd:`module-alias` command to define an alias that points to the default
resolution target.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.6
@@ -1356,7 +1356,7 @@ the *modulefile* is being loaded.
which is named by prefixing *variable* by :envvar:`__MODULES_PUSHENV_\
<__MODULES_PUSHENV_\<VAR\>>`.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -1382,7 +1382,7 @@ the *modulefile* is being loaded.
When *channelId* equals ``log``, content is sent to the log system through
the defined :mconfig:`logger` command.
.. only:: html
.. only:: html or latex
.. versionchanged:: 4.1
Content sent to ``stdout`` is spooled to apply it after the rendering
@@ -1445,7 +1445,7 @@ the *modulefile* is being loaded.
An error is raised if *value* equals *delimiter* character.
.. only:: html
.. only:: html or latex
.. versionchanged:: 4.1
Option ``--index`` added
@@ -1461,7 +1461,7 @@ the *modulefile* is being loaded.
Output *string* as a message during *modulefile* evaluation.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -1472,7 +1472,7 @@ the *modulefile* is being loaded.
the :manpage:`error(n)` Tcl command to abort evaluation in addition to emit
an error message.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -1480,7 +1480,7 @@ the *modulefile* is being loaded.
Output *string* as a warning message during *modulefile* evaluation.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.0
@@ -1490,7 +1490,7 @@ the *modulefile* is being loaded.
not the fully qualified one. Module alias or a symbolic version names are
considered fully qualified names, exception made for the *default* symbol.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -1509,7 +1509,7 @@ the *modulefile* is being loaded.
*modulefile* is unloaded, :mfcmd:`set-function` becomes
:mfcmd:`unset-function`.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.2
@@ -1534,7 +1534,7 @@ the *modulefile* is being loaded.
Any newline character in *value* is chopped if using *csh* or *tcsh* shells.
.. only:: html
.. only:: html or latex
.. versionchanged:: 5.1
Option ``--set-if-undef`` added
@@ -1574,7 +1574,7 @@ the *modulefile* is being loaded.
multiple shell element separated by colon character. Accepted shell elements
are: ``envvar``, ``alias``, ``function``, ``chdir`` and ``complete``.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.6
@@ -1630,7 +1630,7 @@ the *modulefile* is being loaded.
The following shells are supported: bash, tcsh and fish.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1
@@ -1642,7 +1642,7 @@ the *modulefile* is being loaded.
Removes a function with the name *function-name* from the user's environment.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.2
@@ -1658,7 +1658,7 @@ the *modulefile* is being loaded.
environment *variable* is also unset when *modulefile* is unloaded. These
behaviors are applied even if an optional *value* is defined.
.. only:: html
.. only:: html or latex
.. versionchanged:: 5.0
*variable* is not unset when unloading *modulefile* and no optional
@@ -1706,7 +1706,7 @@ the *modulefile* is being loaded.
A variant cannot be named ``version``. An error is raised otherwise.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.8
@@ -1726,7 +1726,7 @@ the *modulefile* is being loaded.
``-1``, ``0`` or ``1`` respectively if *version1* is less than, equal to or
greater than *version2*.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -1808,7 +1808,7 @@ Modules Variables
implementation currently in use. The value of this variable is set to
``Modules`` for this implementation.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -1818,7 +1818,7 @@ Modules Variables
implementation currently in use. The value of this variable is set to
|code version| for this version of Modules.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.7
@@ -1835,7 +1835,7 @@ Modules Variables
The list of the currently defined variants can be retrieved with
``[array names ModuleVariant]`` Tcl code.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.8
@@ -2069,7 +2069,7 @@ version already exists for these ``default`` or ``latest`` version names.
Using the ``mod@latest`` (or ``mod/latest``) syntax ensures highest available
version will be selected.
.. only:: html
.. only:: html or latex
.. versionadded:: 4.4
@@ -2120,7 +2120,7 @@ part of the name or version of a module. These specific characters are ``+``,
``+`` and ``~`` characters if string that follows after does not correspond to
a valid variant name (e.g., *name+*, *name++*, *name/version+1*).
.. only:: html
.. only:: html or latex
.. versionadded:: 4.8
@@ -2232,7 +2232,7 @@ pre-requirement modulefile gets loaded or conflicting modulefile gets unloaded
the inconsistent loaded module will be automatically reloaded to make user
environment consistent again.
.. only:: html
.. only:: html or latex
.. versionchanged:: 4.2
Options :option:`--force`, :option:`--auto` and :option:`--no-auto`
@@ -2363,7 +2363,7 @@ specified is considered an optional pre-requirement. If it is loaded
afterward and if the :mconfig:`auto_handling` configuration option is enabled,
the dependent module will get automatically reloaded.
.. only:: html
.. only:: html or latex
.. versionadded:: 5.1