.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "ML" "1" "2024-02-20" "5.4.0" "Modules"
.SH NAME
ml \- handy command interface to the Modules package
.SH SYNOPSIS
.sp
\fBml\fP [\fIswitches\fP] [\fIsub\-command\fP [\fIsub\-command\-args\fP]]
.sp
\fBml\fP [\fIswitches\fP] [[\-]\fImodulefile\fP\&...]
.SH DESCRIPTION
.sp
\fBml\fP is a user interface to the Modules package. The Modules package
provides for the dynamic modification of the user\(aqs environment via
\fImodulefiles\fP\&.
.sp
\fBml\fP acts as a shortcut command to the \fBmodule\fP command thus
it supports all the command line switches and module sub\-commands that are
supported by \fBmodule\fP\&.
.sp
\fBml\fP also provides handy shortcuts to list currently loaded
modulefiles, when no argument is provided to \fBml\fP; to load
modulefiles, when modulefile names are passed right after \fBml\fP
command name; to unload modulefiles, when modulefile names prefixed by a minus
sign (\fB\-\fP) are passed right after \fBml\fP command name.
.sp
Multiple modulefiles to load and to unload can be specified on a single
\fBml\fP command line. In this situation unloads are treated first in
specified order, then loads are processed also in specified order (see
\fI\%EXAMPLES\fP section below).
.sp
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 \fBml\fP is removed from \fI\%abort_on_error\fP
configuration option list or if \fI\%\-\-force\fP 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.
.sp
\fBml\fP command line is parsed first to match every known command line
switches or module sub\-commands. So to load a modulefile via the \fBml\fP
shortcut syntax, modulefile name should not equal a module sub\-command name.
Moreover to unload a modulefile via the \fBml\fP shortcut syntax,
modulefile name should not equal a command line switch short name.
.sp
See the \fI\%DESCRIPTION\fP section in \fI\%module\fP for
the list of supported command line switches and module sub\-commands.
.SH EXAMPLES
.sp
Loading modulefile \fBfoo\fP then look at currently loaded modulefiles:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ ml foo
$ ml
Currently Loaded Modulefiles:
 1) foo
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Unloading modulefile \fBfoo\fP then list modulefiles still loaded:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ ml \-foo
$ ml
No Modulefiles Currently Loaded.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Mixing load and unload of modulefiles in a single command. All specified
unloads are processed first then loads are performed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ ml \-v \-foo bar \-baz qux
Unloading foo
Unloading baz
Loading bar
Loading qux
.ft P
.fi
.UNINDENT
.UNINDENT
.SH EXIT STATUS
.sp
The \fBml\fP command exits with \fB0\fP if its execution succeed. Elsewhere
\fB1\fP is returned.
.SH ENVIRONMENT
.sp
See the \fI\%ENVIRONMENT\fP section in \fI\%module\fP for
the list of supported environment variables.
.SH SEE ALSO
.sp
\fI\%module\fP, \fI\%modulefile\fP
.SH COPYRIGHT
1996-1999 John L. Furlani & Peter W. Osel, 1998-2017 R.K.Owen, 2002-2004 Mark Lakata, 2004-2017 Kent Mein, 2016-2024 Xavier Delaruelle
.\" Generated by docutils manpage writer.
.