Debian Codegraph @

doc/build/modulecmd.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 "MODULECMD" "1" "2026-09-21" "5.7.0" "Modules"
32 .SH NAME
33 modulecmd \- generic wrapper pointing to Modules execution engine
34 .SH SYNOPSIS
35 .sp
36 \fBmodulecmd\fP \fIshell\fP [\fIswitches\fP] [\fIsub\-command\fP [\fIsub\-command\-args\fP]]
37 .SH DESCRIPTION
38 .sp
39 The \fBmodulecmd\fP command is a generic wrapper pointing to Modules
40 execution engine \fBmodulecmd.tcl\fP\&.
41 .sp
42 The \fBmodulecmd.tcl\fP command is the low\-level execution engine of the
43 Environment Modules system. It is responsible for evaluating modulefile
44 logic and emitting shell\-specific commands that modify the user\(aqs
45 environment.
46 .sp
47 Unlike the user\-facing \fBmodule\fP command, \fBmodulecmd.tcl\fP
48 does not directly alter the environment. Instead, it writes shell code to
49 standard output, which must be evaluated by the calling shell.
50 .sp
51 The \fBmodule\fP shell function or wrapper script invokes
52 \fBmodulecmd.tcl\fP internally and evaluates its output to apply
53 environment changes.
54 .sp
55 The following shells are supported: sh, csh, tcsh, bash, ksh, zsh, fish, cmd,
56 pwsh, python, perl, ruby, tcl, cmake, r and lisp.
57 .sp
58 See the Modulecmd startup \%<#\:modulecmd-startup>, Command line switches \%<#\:command-line-switches> and
59 Module Sub\-Commands \%<#\:module-sub-commands> sections in the module \%<#\:module-1> man page.
60 .sp
61 Direct invocation of \fBmodulecmd\fP is primarily intended for debugging
62 and advanced usage. End users should normally use the \fBmodule\fP
63 command instead.
64 .SH EXIT STATUS
65 .sp
66 \fBmodulecmd\fP exits with \fB0\fP on successful execution. Otherwise \fB1\fP
67 is returned.
68 .SH ENVIRONMENT
69 .sp
70 See the ENVIRONMENT \%<#\:module-environment> section in the module \%<#\:module-1>
71 man page.
72 .SH FILES
73 .sp
74 See the FILES \%<#\:module-files> section in the module \%<#\:module-1> man page.
75 .SH SEE ALSO
76 .sp
77 envml \%<#\:envml-1>, ml \%<#\:ml-1>, module \%<#\:module-1>, modulefile \%<#\:modulefile-5>
78 .SH Copyright
79 1996-2026, Modules Contributors
80 .\" End of generated man page.