Debian Codegraph @

doc/build/ml.1

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