| 1 |
.. _modulecmd(1): |
| 2 |
|
| 3 |
modulecmd |
| 4 |
========= |
| 5 |
|
| 6 |
SYNOPSIS |
| 7 |
-------- |
| 8 |
|
| 9 |
**modulecmd** *shell* [*switches*] [*sub-command* [*sub-command-args*]] |
| 10 |
|
| 11 |
DESCRIPTION |
| 12 |
----------- |
| 13 |
|
| 14 |
The :command:`modulecmd` command is a generic wrapper pointing to Modules |
| 15 |
execution engine :command:`modulecmd.tcl`. |
| 16 |
|
| 17 |
The :command:`modulecmd.tcl` command is the low-level execution engine of the |
| 18 |
Environment Modules system. It is responsible for evaluating modulefile |
| 19 |
logic and emitting shell-specific commands that modify the user's |
| 20 |
environment. |
| 21 |
|
| 22 |
Unlike the user-facing :command:`module` command, :command:`modulecmd.tcl` |
| 23 |
does not directly alter the environment. Instead, it writes shell code to |
| 24 |
standard output, which must be evaluated by the calling shell. |
| 25 |
|
| 26 |
The :command:`module` shell function or wrapper script invokes |
| 27 |
:command:`modulecmd.tcl` internally and evaluates its output to apply |
| 28 |
environment changes. |
| 29 |
|
| 30 |
The following shells are supported: sh, csh, tcsh, bash, ksh, zsh, fish, cmd, |
| 31 |
pwsh, python, perl, ruby, tcl, cmake, r and lisp. |
| 32 |
|
| 33 |
See the :ref:`modulecmd startup`, :ref:`command line switches` and |
| 34 |
:ref:`module sub-commands` sections in the :ref:`module(1)` man page. |
| 35 |
|
| 36 |
Direct invocation of :command:`modulecmd` is primarily intended for debugging |
| 37 |
and advanced usage. End users should normally use the :command:`module` |
| 38 |
command instead. |
| 39 |
|
| 40 |
EXIT STATUS |
| 41 |
----------- |
| 42 |
|
| 43 |
:command:`modulecmd` exits with ``0`` on successful execution. Otherwise ``1`` |
| 44 |
is returned. |
| 45 |
|
| 46 |
ENVIRONMENT |
| 47 |
----------- |
| 48 |
|
| 49 |
See the :ref:`ENVIRONMENT<module ENVIRONMENT>` section in the :ref:`module(1)` |
| 50 |
man page. |
| 51 |
|
| 52 |
FILES |
| 53 |
----- |
| 54 |
|
| 55 |
See the :ref:`FILES<module FILES>` section in the :ref:`module(1)` man page. |
| 56 |
|
| 57 |
SEE ALSO |
| 58 |
-------- |
| 59 |
|
| 60 |
:ref:`envml(1)`, :ref:`ml(1)`, :ref:`module(1)`, :ref:`modulefile(5)` |