| 1 |
.\" Man page generated from reStructuredText. |
| 2 |
. |
| 3 |
. |
| 4 |
.nr rst2man-indent-level 0 |
| 5 |
. |
| 6 |
.de1 rstReportMargin |
| 7 |
\\$1 \\n[an-margin] |
| 8 |
level \\n[rst2man-indent-level] |
| 9 |
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| 10 |
- |
| 11 |
\\n[rst2man-indent0] |
| 12 |
\\n[rst2man-indent1] |
| 13 |
\\n[rst2man-indent2] |
| 14 |
.. |
| 15 |
.de1 INDENT |
| 16 |
.\" .rstReportMargin pre: |
| 17 |
. RS \\$1 |
| 18 |
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
| 19 |
. nr rst2man-indent-level +1 |
| 20 |
.\" .rstReportMargin post: |
| 21 |
.. |
| 22 |
.de UNINDENT |
| 23 |
. RE |
| 24 |
.\" indent \\n[an-margin] |
| 25 |
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| 26 |
.nr rst2man-indent-level -1 |
| 27 |
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| 28 |
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
| 29 |
.. |
| 30 |
.TH "ML" "1" "2025-11-25" "5.6.1" "Modules" |
| 31 |
.SH NAME |
| 32 |
ml \- handy command interface to the Modules package |
| 33 |
.SH SYNOPSIS |
| 34 |
.sp |
| 35 |
\fBml\fP [\fIswitches\fP] [\fIsub\-command\fP [\fIsub\-command\-args\fP]] |
| 36 |
.sp |
| 37 |
\fBml\fP [\fIswitches\fP] [[\-]\fImodulefile\fP\&...] |
| 38 |
.SH DESCRIPTION |
| 39 |
.sp |
| 40 |
\fBml\fP is a user interface to the Modules package. The Modules package |
| 41 |
provides for the dynamic modification of the user\(aqs environment via |
| 42 |
\fImodulefiles\fP\&. |
| 43 |
.sp |
| 44 |
\fBml\fP acts as a shortcut command to the \fBmodule\fP command thus |
| 45 |
it supports all the command line switches and module sub\-commands that are |
| 46 |
supported by \fBmodule\fP\&. |
| 47 |
.sp |
| 48 |
\fBml\fP also provides handy shortcuts to list currently loaded |
| 49 |
modulefiles, when no argument is provided to \fBml\fP; to load |
| 50 |
modulefiles, when modulefile names are passed right after \fBml\fP |
| 51 |
command name; to unload modulefiles, when modulefile names prefixed by a minus |
| 52 |
sign (\fB\-\fP) are passed right after \fBml\fP command name. |
| 53 |
.sp |
| 54 |
Multiple modulefiles to load and to unload can be specified on a single |
| 55 |
\fBml\fP command line. In this situation unloads are treated first in |
| 56 |
specified order, then loads are processed also in specified order (see |
| 57 |
\fI\%EXAMPLES\fP section below). |
| 58 |
.sp |
| 59 |
If an error occurs among either modulefile loads or unloads, command line |
| 60 |
processing is stopped and every unloads and loads performed are rolled back. |
| 61 |
Conversely, if \fBml\fP is removed from \fI\%abort_on_error\fP |
| 62 |
configuration option list or if \fI\%\-\-force\fP option is set, unload and |
| 63 |
load sequence continues: already achieved module evaluations are kept and |
| 64 |
unload then load sequence is resumed with the remaining modulefiles. |
| 65 |
.sp |
| 66 |
\fBml\fP command line is parsed first to match every known command line |
| 67 |
switches or module sub\-commands. So to load a modulefile via the \fBml\fP |
| 68 |
shortcut syntax, modulefile name should not equal a module sub\-command name. |
| 69 |
Moreover to unload a modulefile via the \fBml\fP shortcut syntax, |
| 70 |
modulefile name should not equal a command line switch short name. |
| 71 |
.sp |
| 72 |
See the \fI\%DESCRIPTION\fP section in \fI\%module\fP for |
| 73 |
the list of supported command line switches and module sub\-commands. |
| 74 |
.SH EXAMPLES |
| 75 |
.sp |
| 76 |
Loading modulefile \fBfoo\fP then look at currently loaded modulefiles: |
| 77 |
.INDENT 0.0 |
| 78 |
.INDENT 3.5 |
| 79 |
.sp |
| 80 |
.EX |
| 81 |
$ ml foo |
| 82 |
$ ml |
| 83 |
Currently Loaded Modulefiles: |
| 84 |
1) foo |
| 85 |
.EE |
| 86 |
.UNINDENT |
| 87 |
.UNINDENT |
| 88 |
.sp |
| 89 |
Unloading modulefile \fBfoo\fP then list modulefiles still loaded: |
| 90 |
.INDENT 0.0 |
| 91 |
.INDENT 3.5 |
| 92 |
.sp |
| 93 |
.EX |
| 94 |
$ ml \-foo |
| 95 |
$ ml |
| 96 |
No Modulefiles Currently Loaded. |
| 97 |
.EE |
| 98 |
.UNINDENT |
| 99 |
.UNINDENT |
| 100 |
.sp |
| 101 |
Mixing load and unload of modulefiles in a single command. All specified |
| 102 |
unloads are processed first then loads are performed: |
| 103 |
.INDENT 0.0 |
| 104 |
.INDENT 3.5 |
| 105 |
.sp |
| 106 |
.EX |
| 107 |
$ ml \-v \-foo bar \-baz qux |
| 108 |
Unloading foo |
| 109 |
Unloading baz |
| 110 |
Loading bar |
| 111 |
Loading qux |
| 112 |
.EE |
| 113 |
.UNINDENT |
| 114 |
.UNINDENT |
| 115 |
.SH EXIT STATUS |
| 116 |
.sp |
| 117 |
The \fBml\fP command exits with \fB0\fP if its execution succeed. Elsewhere |
| 118 |
\fB1\fP is returned. |
| 119 |
.SH ENVIRONMENT |
| 120 |
.sp |
| 121 |
See the \fI\%ENVIRONMENT\fP section in \fI\%module\fP for |
| 122 |
the list of supported environment variables. |
| 123 |
.SH SEE ALSO |
| 124 |
.sp |
| 125 |
\fI\%module\fP, \fI\%modulefile\fP, \fI\%envml\fP |
| 126 |
.SH COPYRIGHT |
| 127 |
1996-2025, Modules Contributors |
| 128 |
.\" Generated by docutils manpage writer. |
| 129 |
. |