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