| 1 |
.. _ml(1): |
| 2 |
|
| 3 |
ml |
| 4 |
== |
| 5 |
|
| 6 |
SYNOPSIS |
| 7 |
-------- |
| 8 |
|
| 9 |
**ml** [*switches*] [*sub-command* [*sub-command-args*]] |
| 10 |
|
| 11 |
**ml** [*switches*] [[-]\ *modulefile*...] |
| 12 |
|
| 13 |
|
| 14 |
DESCRIPTION |
| 15 |
----------- |
| 16 |
|
| 17 |
:command:`ml` is a user interface to the Modules package. The Modules package |
| 18 |
provides for the dynamic modification of the user's environment via |
| 19 |
*modulefiles*. |
| 20 |
|
| 21 |
:command:`ml` acts as a shortcut command to the :command:`module` command thus |
| 22 |
it supports all the command line switches and module sub-commands that are |
| 23 |
supported by :command:`module`. |
| 24 |
|
| 25 |
:command:`ml` also provides handy shortcuts to list currently loaded |
| 26 |
modulefiles, when no argument is provided to :command:`ml`; to load |
| 27 |
modulefiles, when modulefile names are passed right after :command:`ml` |
| 28 |
command name; to unload modulefiles, when modulefile names prefixed by a minus |
| 29 |
sign (``-``) are passed right after :command:`ml` command name. |
| 30 |
|
| 31 |
Multiple modulefiles to load and to unload can be specified on a single |
| 32 |
:command:`ml` command line. In this situation unloads are treated first in |
| 33 |
specified order, then loads are processed also in specified order (see |
| 34 |
`EXAMPLES`_ section below). |
| 35 |
|
| 36 |
If an error occurs among either modulefile loads or unloads, command line |
| 37 |
processing is stopped and every unloads and loads performed are rolled back. |
| 38 |
Conversely, if :command:`ml` is removed from :mconfig:`abort_on_error` |
| 39 |
configuration option list or if :option:`--force` option is set, unload and |
| 40 |
load sequence continues: already achieved module evaluations are kept and |
| 41 |
unload then load sequence is resumed with the remaining modulefiles. |
| 42 |
|
| 43 |
:command:`ml` command line is parsed first to match every known command line |
| 44 |
switches or module sub-commands. So to load a modulefile via the :command:`ml` |
| 45 |
shortcut syntax, modulefile name should not equal a module sub-command name. |
| 46 |
Moreover to unload a modulefile via the :command:`ml` shortcut syntax, |
| 47 |
modulefile name should not equal a command line switch short name. |
| 48 |
|
| 49 |
See the :ref:`DESCRIPTION<module DESCRIPTION>` section in :ref:`module(1)` for |
| 50 |
the list of supported command line switches and module sub-commands. |
| 51 |
|
| 52 |
|
| 53 |
EXAMPLES |
| 54 |
-------- |
| 55 |
|
| 56 |
Loading modulefile ``foo`` then look at currently loaded modulefiles:: |
| 57 |
|
| 58 |
$ ml foo |
| 59 |
$ ml |
| 60 |
Currently Loaded Modulefiles: |
| 61 |
1) foo |
| 62 |
|
| 63 |
Unloading modulefile ``foo`` then list modulefiles still loaded:: |
| 64 |
|
| 65 |
$ ml -foo |
| 66 |
$ ml |
| 67 |
No Modulefiles Currently Loaded. |
| 68 |
|
| 69 |
Mixing load and unload of modulefiles in a single command. All specified |
| 70 |
unloads are processed first then loads are performed:: |
| 71 |
|
| 72 |
$ ml -v -foo bar -baz qux |
| 73 |
Unloading foo |
| 74 |
Unloading baz |
| 75 |
Loading bar |
| 76 |
Loading qux |
| 77 |
|
| 78 |
|
| 79 |
EXIT STATUS |
| 80 |
----------- |
| 81 |
|
| 82 |
The :command:`ml` command exits with **0** if its execution succeed. Elsewhere |
| 83 |
``1`` is returned. |
| 84 |
|
| 85 |
|
| 86 |
ENVIRONMENT |
| 87 |
----------- |
| 88 |
|
| 89 |
See the :ref:`ENVIRONMENT<module ENVIRONMENT>` section in :ref:`module(1)` for |
| 90 |
the list of supported environment variables. |
| 91 |
|
| 92 |
|
| 93 |
SEE ALSO |
| 94 |
-------- |
| 95 |
|
| 96 |
:ref:`envml(1)`, :ref:`module(1)`, :ref:`modulecmd(1)`, :ref:`modulefile(5)` |
| 97 |
|