1ML(1)                               Modules                              ML(1)
2
3
4

NAME

6       ml - handy command interface to the Modules package
7

SYNOPSIS

9       ml [switches] [sub-command [sub-command-args]]
10
11       ml [switches] [[-]modulefile...]
12

DESCRIPTION

14       ml is a user interface to the Modules package. The Modules package pro‐
15       vides for the dynamic modification of the user's environment  via  mod‐
16       ulefiles.
17
18       ml  acts  as  a shortcut command to the module command thus it supports
19       all the command line switches and module  sub-commands  that  are  sup‐
20       ported by module.
21
22       ml  also provides handy shortcuts to list currently loaded modulefiles,
23       when no argument is provided to ml; to load modulefiles,  when  module‐
24       file  names  are  passed right after ml command name; to unload module‐
25       files, when modulefile names prefixed by a minus sign  (-)  are  passed
26       right after ml command name.
27
28       Multiple modulefiles to load and to unload can be specified on a single
29       ml command line. In this situation unloads are treated first in  speci‐
30       fied  order,  then  loads  are  processed  also in specified order (see
31       EXAMPLES section below). If an error  occurs  among  either  modulefile
32       loads  or unloads, command line processing is stopped and every unloads
33       and loads performed are rolled back.
34
35       ml command line is parsed first  to  match  every  known  command  line
36       switches  or  module  sub-commands.  So to load a modulefile via the ml
37       shortcut syntax, modulefile name should not equal a module  sub-command
38       name.  Moreover to unload a modulefile via the ml shortcut syntax, mod‐
39       ulefile name should not equal a command line switch short name.
40
41       See the DESCRIPTION section in module(1) for the list of supported com‐
42       mand line switches and module sub-commands.
43

EXAMPLES

45       Loading modulefile foo then look at currently loaded modulefiles:
46
47          $ ml foo
48          $ ml
49          Currently Loaded Modulefiles:
50           1) foo
51
52       Unloading modulefile foo then list modulefiles still loaded:
53
54          $ ml -foo
55          $ ml
56          No Modulefiles Currently Loaded.
57
58       Mixing  load  and unload of modulefiles in a single command. All speci‐
59       fied unloads are processed first then loads are performed:
60
61          $ ml -v -foo bar -baz qux
62          Unloading foo
63          Unloading baz
64          Loading bar
65          Loading qux
66

EXIT STATUS

68       The ml command exits with 0 if its execution succeed.  Elsewhere  1  is
69       returned.
70

ENVIRONMENT

72       See  the  ENVIRONMENT  section  in  module(1) for the list of supported
73       environment variables.
74

SEE ALSO

76       module(1), modulefile(4)
77

79       1996-1999  John  L.  Furlani  &  Peter  W.  Osel,  1998-2017  R.K.Owen,
80       2002-2004 Mark Lakata, 2004-2017 Kent Mein, 2016-2020 Xavier Delaruelle
81
82
83
84
854.5.3                             2020-08-31                             ML(1)
Impressum