Debian Codegraph @

doc/build/module.1.in

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 "MODULE" "1" "2026-09-07" "5.6.2" "Modules"
32 .SH NAME
33 module \- command interface to the Modules package
34 .SH SYNOPSIS
35 .sp
36 \fBmodule\fP [\fIswitches\fP] [\fIsub\-command\fP [\fIsub\-command\-args\fP]]
37 .SH DESCRIPTION
38 .sp
39 \fBmodule\fP is a user interface to the Modules package. The Modules
40 package provides for the dynamic modification of the user\(aqs environment
41 via \fImodulefiles\fP\&.
42 .sp
43 Each \fImodulefile\fP contains the information needed to configure the
44 shell for an application. Once the Modules package is initialized, the
45 environment can be modified on a per\-module basis using the \fBmodule\fP
46 command which interprets \fImodulefiles\fP\&. Typically \fImodulefiles\fP instruct
47 the \fBmodule\fP command to alter or set shell environment variables such
48 as \fBPATH\fP, \fBMANPATH\fP, etc. \fIModulefiles\fP may be shared by many
49 users on a system and users may have their own set to supplement or replace
50 the shared \fImodulefiles\fP\&.
51 .sp
52 The \fImodulefiles\fP are added to and removed from the current environment
53 by the user. The environment changes contained in a \fImodulefile\fP can be
54 summarized through the \fBmodule\fP command as well. If no arguments are
55 given, a summary of the \fBmodule\fP usage and \fIsub\-commands\fP are shown.
56 .sp
57 The action for the \fBmodule\fP command to take is described by the
58 \fIsub\-command\fP and its associated arguments.
59 .SS Package Initialization
60 .sp
61 The Modules package and the \fBmodule\fP command are initialized when a
62 shell\-specific initialization script is sourced into the shell. The script
63 executes the \fBautoinit\fP sub\-command of the \fBmodulecmd.tcl\fP
64 program located in \fB@libexecdir@\fP for the corresponding shell. The output
65 of this execution is evaluated by shell which creates the \fBmodule\fP
66 command as either an alias or function and creates Modules environment
67 variables.
68 .sp
69 During this initialization process, if the Modules environment is found
70 undefined (when both \fBMODULEPATH\fP and \fBLOADEDMODULES\fP are
71 found either unset or empty), the \fBmodulespath\fP and \fBinitrc\fP
72 configuration files located in \fB@etcdir@\fP are evaluated if present and
73 following this order. \fBmodulespath\fP file contains the list of
74 modulepaths to enable during initialization. In this file, the modulepaths are
75 separated by newline or colon characters. \fBinitrc\fP is a modulefile that
76 defines during initialization the modulepaths to enable, the modules to load
77 and the \fBmodule\fP configuration to apply.
78 .sp
79 During the initialization process, if the Modules environment is found defined
80 a \fBmodule refresh\fP is automatically applied to restore in the
81 current environment all non\-persistent components set by loaded modules.
82 .sp
83 The \fBmodule\fP alias or function executes the \fBmodulecmd.tcl\fP
84 program and has the shell evaluate the command\(aqs output. The first argument to
85 \fBmodulecmd.tcl\fP specifies the type of shell.
86 .sp
87 The initialization scripts are kept in \fB@initdir@/<shell>\fP where
88 \fI<shell>\fP is the name of the sourcing shell. For example, a C Shell user
89 sources the \fB@initdir@/csh\fP script. The sh, csh, tcsh, bash, ksh,
90 zsh, fish and cmd shells are supported by \fBmodulecmd.tcl\fP\&. In addition,
91 python, perl, ruby, tcl, cmake, r and lisp \(dqshells\(dq are supported which
92 writes the environment changes to stdout as python, perl, ruby, tcl, lisp,
93 r or cmake code.
94 .sp
95 Initialization may also be performed by directly calling the
96 \fBautoinit\fP sub\-command of the \fBmodulecmd.tcl\fP program.
97 .sp
98 A \fBml\fP alias or function may also be defined at initialization time
99 if enabled (see \fBMODULES_ML\fP section). \fBml\fP is a handy
100 frontend leveraging all \fBmodule\fP command capabilities with less
101 character typed. See ml \%<#\:ml-1> for detailed information.
102 .sp
103 A \fBmogui\fP alias or function may also be defined at initialization
104 time if \fBmogui\-cmd\fP command is found in \fBPATH\fP\&.
105 \fBmogui\fP is the Graphical User Interface for Modules. Environment
106 changes performed in the GUI is applied onto the shell session that executed
107 \fBmogui\fP\&.
108 .SS Examples of initialization
109 .sp
110 C Shell initialization (and derivatives):
111 .INDENT 0.0
112 .INDENT 3.5
113 .sp
114 .EX
115 source @initdir@/csh
116 module load modulefile modulefile ...
117 .EE
118 .UNINDENT
119 .UNINDENT
120 .sp
121 Bourne Shell (sh) (and derivatives):
122 .INDENT 0.0
123 .INDENT 3.5
124 .sp
125 .EX
126 \&. @initdir@/sh
127 module load modulefile modulefile ...
128 .EE
129 .UNINDENT
130 .UNINDENT
131 .sp
132 PowerShell (pwsh):
133 .INDENT 0.0
134 .INDENT 3.5
135 .sp
136 .EX
137 \&. @initdir@/pwsh.ps1
138 envmodule load modulefile modulefile ...
139 .EE
140 .UNINDENT
141 .UNINDENT
142 .sp
143 Perl:
144 .INDENT 0.0
145 .INDENT 3.5
146 .sp
147 .EX
148 require \(dq@initdir@/perl.pm\(dq;
149 &module(\(aqload\(aq, \(aqmodulefile\(aq, \(aqmodulefile\(aq, \(aq...\(aq);
150 .EE
151 .UNINDENT
152 .UNINDENT
153 .sp
154 Python:
155 .INDENT 0.0
156 .INDENT 3.5
157 .sp
158 .EX
159 import os
160 exec(open(\(dq@initdir@/python.py\(dq).read(), globals())
161 module(\(dqload\(dq, \(dqmodulefile\(dq, \(dqmodulefile\(dq, \(dq...\(dq)
162 .EE
163 .UNINDENT
164 .UNINDENT
165 .sp
166 Ruby:
167 .INDENT 0.0
168 .INDENT 3.5
169 .sp
170 .EX
171 require \(aq@initdir@/ruby.rb\(aq
172 ENVModule.module(\(aqload\(aq, \(aqmodulefile\(aq, \(aqmodulefile\(aq, \(aq...\(aq)
173 .EE
174 .UNINDENT
175 .UNINDENT
176 .sp
177 Bourne Shell (sh) (and derivatives) with \fBautoinit\fP sub\-command:
178 .INDENT 0.0
179 .INDENT 3.5
180 .sp
181 .EX
182 eval \(dq$(@libexecdir@/modulecmd.tcl sh autoinit)\(dq
183 .EE
184 .UNINDENT
185 .UNINDENT
186 .SS Modulecmd startup
187 .sp
188 Upon invocation \fBmodulecmd.tcl\fP sources a site\-specific configuration
189 script if it exists. Siteconfig script is a Tcl script located at
190 \fB@etcdir@/siteconfig.tcl\fP\&. It enables to supersede any global variable or
191 procedure definition of \fBmodulecmd.tcl\fP\&. See Site\-specific configuration for detailed information.
192 .sp
193 Afterward, \fBmodulecmd.tcl\fP sources rc files which contain global,
194 user and \fImodulefile\fP specific setups. These files are interpreted as
195 \fImodulefiles\fP\&. See modulefile \%<#\:modulefile-5> for detailed information.
196 .sp
197 Upon invocation of \fBmodulecmd.tcl\fP module run\-command files are sourced
198 in the following order:
199 .INDENT 0.0
200 .IP 1. 3
201 Global RC file(s) as specified by \fBMODULERCFILE\fP variable or
202 \fB@etcdir@/rc\fP\&. If a path element in \fBMODULERCFILE\fP points to a
203 directory, the \fBmodulerc\fP file in this directory is used as a global
204 RC file.
205 .IP 2. 3
206 User specific module RC file \fB$HOME/.modulerc\fP
207 .IP 3. 3
208 All \fB\&.modulerc\fP and \fB\&.version\fP files found during modulefile
209 seeking.
210 .UNINDENT
211 .sp
212 These module run\-command files must begins like \fImodulefiles\fP with the
213 \fB#%Module\fP file signature, also called the Modules magic cookie. A version
214 number may be placed after this string. The version number reflects the
215 minimum version of \fBmodulecmd.tcl\fP required to interpret the run\-command
216 file. If a version number doesn\(aqt exist, then \fBmodulecmd.tcl\fP will
217 assume the run\-command file is compatible. Files without the magic cookie or
218 with a version number greater than the current version of
219 \fBmodulecmd.tcl\fP will not be interpreted and an error is reported. Such
220 error does not abort the whole \fBmodule\fP evaluation. If the
221 \fBmcookie_version_check\fP configuration is disabled the version number
222 set is not checked.
223 .sp
224 \fBNote:\fP
225 .INDENT 0.0
226 .INDENT 3.5
227 Run\-command files are intended to set parameters for modulefiles,
228 not to configure the \fBmodule\fP command itself.
229 .UNINDENT
230 .UNINDENT
231 .SS Command line switches
232 .sp
233 The \fBmodule\fP command accepts command line switches as its first
234 parameter. These may be used to control output format of all information
235 displayed and the \fBmodule\fP behavior in case of locating and
236 interpreting \fImodulefiles\fP\&.
237 .sp
238 All switches may be entered either in short or long notation. The following
239 switches are accepted:
240 .INDENT 0.0
241 .TP
242 .B \-\-all, \-a
243 Include hidden modules in search performed with \fBavail\fP,
244 \fBaliases\fP, \fBlist\fP, \fBlint\fP, \fBsavelist\fP,
245 \fBsearch\fP, \fBspider\fP or \fBwhatis\fP sub\-commands.
246 Hard\-hidden modules are not affected by this option.
247 .UNINDENT
248 .INDENT 0.0
249 .TP
250 .B \-\-auto
251 Enable automated module handling mode on sub\-commands that load or unload
252 modulefiles. See also \fBMODULES_AUTO_HANDLING\fP section.
253 .UNINDENT
254 .INDENT 0.0
255 .TP
256 .B \-\-color=<WHEN>
257 Colorize the output. \fIWHEN\fP defaults to \fBalways\fP or can be \fBnever\fP or
258 \fBauto\fP\&. See also \fBMODULES_COLOR\fP section.
259 .UNINDENT
260 .INDENT 0.0
261 .TP
262 .B \-\-contains, \-C
263 On \fBavail\fP, \fBlist\fP, \fBsavelist\fP and \fBspider\fP
264 sub\-commands, return modules or collections whose fully qualified name
265 contains search query string.
266 .UNINDENT
267 .INDENT 0.0
268 .TP
269 .B \-\-debug, \-D, \-DD
270 Debug mode. Causes \fBmodule\fP to print debugging messages about its
271 progress. Multiple \fB\-D\fP options increase the debug verbosity. The
272 maximum is 2.
273 .UNINDENT
274 .INDENT 0.0
275 .TP
276 .B \-\-default, \-d
277 On \fBavail\fP and \fBspider\fP sub\-commands, display only the
278 default version of each module name. Default version is the explicitly set
279 default version or also the implicit default version if the configuration
280 option \fBimplicit_default\fP is enabled (see Locating Modulefiles \%<#\:locating-modulefiles> section in the modulefile \%<#\:modulefile-5> man page for further details
281 on implicit default version).
282 .UNINDENT
283 .INDENT 0.0
284 .TP
285 .B \-\-dumpname
286 Report the name of the current implementation of the \fBmodule\fP
287 command. This option returns \fBModules\fP for this implementation. The command
288 then terminates without further processing.
289 .UNINDENT
290 .INDENT 0.0
291 .TP
292 .B \-\-force, \-f
293 On \fBload\fP, \fBunload\fP, \fBswitch\fP, \fBload\-any\fP,
294 \fBtry\-load\fP, \fBmod\-to\-sh\fP and \fBsource\fP sub\-commands
295 by\-pass any unsatisfied modulefile constraint corresponding to the declared
296 \fBprereq\fP \%<#\:mfcmd-prereq>, via requirement and
297 \fBconflict\fP \%<#\:mfcmd-conflict>\&. Which means for instance that a \fImodulefile\fP will be
298 loaded even if it comes in conflict with another loaded \fImodulefile\fP or that
299 a \fImodulefile\fP will be unloaded even if it is a requirement of another
300 \fImodulefile\fP\&.
301 .sp
302 On \fBload\fP, \fBml\fP, \fBmod\-to\-sh\fP, \fBpurge\fP,
303 \fBreload\fP, \fBswitch\fP, \fBtry\-load\fP and \fBunload\fP
304 sub\-commands applies \fIcontinue on error\fP behavior when an error occurs even
305 if \fBabort_on_error\fP option is enabled.
306 .sp
307 On \fBml\fP, \fBpurge\fP, \fBreload\fP, \fBreset\fP,
308 \fBrestore\fP, \fBstash\fP, \fBstashpop\fP, \fBswitch\fP and
309 \fBunload\fP sub\-commands, unloads modulefile anyway even if an
310 evaluation error occurs.
311 .sp
312 On \fBclear\fP sub\-command, skip the confirmation dialog and proceed.
313 .sp
314 On \fBpurge\fP sub\-command also unload sticky modules and modulefiles
315 that are depended by non\-unloadable modules.
316 .UNINDENT
317 .INDENT 0.0
318 .TP
319 .B \-\-help, \-h
320 Give some helpful usage information, and terminates the command.
321 .UNINDENT
322 .INDENT 0.0
323 .TP
324 .B \-\-icase, \-i
325 Match module specification arguments in a case insensitive manner.
326 .UNINDENT
327 .INDENT 0.0
328 .TP
329 .B \-\-ignore\-cache
330 Ignore module cache.
331 .UNINDENT
332 .INDENT 0.0
333 .TP
334 .B \-\-ignore\-user\-rc
335 Skip evaluation of user\-specific module rc file (\fB$HOME/.modulerc\fP).
336 .UNINDENT
337 .INDENT 0.0
338 .TP
339 .B \-\-indepth
340 On \fBavail\fP and \fBspider\fP sub\-commands, include in search
341 results the matching modulefiles and directories and recursively the
342 modulefiles and directories contained in these matching directories.
343 .UNINDENT
344 .INDENT 0.0
345 .TP
346 .B \-\-json, \-j
347 Display \fBavail\fP, \fBlist\fP, \fBsavelist\fP,
348 \fBsearch\fP, \fBspider\fP, \fBstashlist\fP and \fBwhatis\fP
349 output in JSON format.
350 .UNINDENT
351 .INDENT 0.0
352 .TP
353 .B \-\-latest, \-L
354 On \fBavail\fP and \fBspider\fP sub\-commands, display only the
355 highest numerically sorted version of each module name (see Locating Modulefiles \%<#\:locating-modulefiles> section in the modulefile \%<#\:modulefile-5> man page).
356 .UNINDENT
357 .INDENT 0.0
358 .TP
359 .B \-\-long, \-l
360 Display \fBavail\fP, \fBlist\fP, \fBsavelist\fP, \fBspider\fP
361 and \fBstashlist\fP output in long format.
362 .UNINDENT
363 .INDENT 0.0
364 .TP
365 .B \-\-no\-auto
366 Disable automated module handling mode on sub\-commands that load or unload
367 modulefiles. See also \fBMODULES_AUTO_HANDLING\fP section.
368 .UNINDENT
369 .INDENT 0.0
370 .TP
371 .B \-\-no\-indepth
372 On \fBavail\fP and \fBspider\fP sub\-commands, limit search results to
373 the matching modulefiles and directories found at the depth level expressed
374 by the search query. Thus modulefiles contained in directories part of the
375 result are excluded.
376 .UNINDENT
377 .INDENT 0.0
378 .TP
379 .B \-\-no\-pager
380 Do not pipe message output into a pager.
381 .UNINDENT
382 .INDENT 0.0
383 .TP
384 .B \-\-no\-redirect
385 Do not send message output to stdout. Keep it on stderr.
386 .UNINDENT
387 .INDENT 0.0
388 .TP
389 .B \-\-output=LIST, \-o LIST
390 Define the content to report in addition to module names. This option is
391 supported by \fBavail\fP, \fBlist\fP and \fBspider\fP
392 sub\-commands on their regular or terse output modes. Accepted values are a
393 \fILIST\fP of elements to report separated by colon character (\fB:\fP). The order
394 of the elements in \fILIST\fP does not matter.
395 .sp
396 Accepted elements in \fILIST\fP for \fBavail\fP and \fBspider\fP
397 sub\-command are: \fImodulepath\fP, \fIalias\fP, \fIprovided\-alias\fP, \fIdirwsym\fP,
398 \fIindesym\fP, \fIsym\fP, \fItag\fP, \fIkey\fP, \fIhidden\fP, \fIvariant\fP, \fIvariantifspec\fP and
399 \fIvia\fP\&. \fIvia\fP element is not accepted on terse output mode.
400 .sp
401 Accepted elements in \fILIST\fP for \fBlist\fP sub\-command are: \fIheader\fP,
402 \fIidx\fP, \fIvariant\fP, \fIalias\fP, \fIindesym\fP, \fIsym\fP, \fItag\fP, \fIhidden\fP and \fIkey\fP\&.
403 .sp
404 The order of the elements in \fILIST\fP does not matter. Module names are the
405 only content reported when \fILIST\fP is set to an empty value.
406 .sp
407 \fILIST\fP may be prefixed by \fB+\fP or \fB\-\fP character to indicate respectively
408 to append it to or subtract it from current configuration option value.
409 .sp
410 See also \fBMODULES_AVAIL_OUTPUT\fP, \fBMODULES_LIST_OUTPUT\fP and
411 \fBMODULES_SPIDER_OUTPUT\fP\&.
412 .UNINDENT
413 .INDENT 0.0
414 .TP
415 .B \-\-paginate
416 Pipe all message output into \fBless\fP (or if set, to the command
417 referred in \fBMODULES_PAGER\fP variable) if error output stream is a
418 terminal. See also \fBMODULES_PAGER\fP section.
419 .UNINDENT
420 .INDENT 0.0
421 .TP
422 .B \-\-redirect
423 Send message output to stdout instead of stderr. Only supported on sh, bash,
424 ksh, zsh and fish shells.
425 .UNINDENT
426 .INDENT 0.0
427 .TP
428 .B \-\-silent, \-s
429 Turn off error, warning and informational messages. \fBmodule\fP command
430 output result is not affected by silent mode.
431 .UNINDENT
432 .INDENT 0.0
433 .TP
434 .B \-\-starts\-with, \-S
435 On \fBavail\fP, \fBlist\fP, \fBsavelist\fP and \fBspider\fP
436 sub\-commands, return modules or collections whose name starts with search
437 query string.
438 .UNINDENT
439 .INDENT 0.0
440 .TP
441 .B \-\-tag=LIST
442 On \fBload\fP, \fBload\-any\fP, \fBswitch\fP and
443 \fBtry\-load\fP sub\-commands, apply LIST of module tags to the loading
444 \fImodulefile\fP\&. \fILIST\fP corresponds to the concatenation of multiple tags
445 separated by colon character (\fB:\fP). \fILIST\fP should not contain tags
446 inherited from \fImodulefile\fP state or from other modulefile commands. If
447 module is already loaded, tags from \fILIST\fP are added to the list of tags
448 already applied to this module.
449 .UNINDENT
450 .INDENT 0.0
451 .TP
452 .B \-\-terse, \-t
453 Display \fBavail\fP, \fBlist\fP, \fBsavelist\fP, \fBspider\fP
454 and \fBstashlist\fP output in short format.
455 .UNINDENT
456 .INDENT 0.0
457 .TP
458 .B \-\-timer
459 Prints at the end of the output an evaluation of the total execution time of
460 the \fBmodule\fP command. When mixed with a single or multiple
461 \fB\-\-debug\fP options, replaces regular debug messages by reports of the
462 execution time of every internal procedure calls.
463 .UNINDENT
464 .INDENT 0.0
465 .TP
466 .B \-\-trace, \-T
467 Trace mode. Report details on module searches, resolutions, selections and
468 evaluations in addition to printing verbose messages.
469 .UNINDENT
470 .INDENT 0.0
471 .TP
472 .B \-\-verbose, \-v, \-vv
473 Enable verbose messages during \fBmodule\fP command execution. Multiple
474 \fB\-v\fP options increase the verbosity level. The maximum is 2.
475 .UNINDENT
476 .INDENT 0.0
477 .TP
478 .B \-\-version, \-V
479 Lists the current version of the \fBmodule\fP command. The command then
480 terminates without further processing.
481 .UNINDENT
482 .INDENT 0.0
483 .TP
484 .B \-\-width=COLS, \-w COLS
485 Set the width of the output to \fICOLS\fP columns. See also
486 \fBMODULES_TERM_WIDTH\fP section.
487 .UNINDENT
488 .SS Module Sub\-Commands
489 .INDENT 0.0
490 .TP
491 .B add [options] modulefile...
492 See \fBload\fP\&.
493 .UNINDENT
494 .INDENT 0.0
495 .TP
496 .B add\-any [options] modulefile...
497 See \fBload\-any\fP\&.
498 .UNINDENT
499 .INDENT 0.0
500 .TP
501 .B aliases [\-a]
502 List all available symbolic version\-names and aliases in the current
503 \fBMODULEPATH\fP\&. All directories in the \fBMODULEPATH\fP are
504 recursively searched in the same manner than for the \fBavail\fP
505 sub\-command. Only the symbolic version\-names and aliases found in the search
506 are displayed.
507 .UNINDENT
508 .INDENT 0.0
509 .TP
510 .B append\-path [options] variable value...
511 Append \fIvalue\fP to environment \fIvariable\fP\&. The \fIvariable\fP is a colon, or
512 \fIdelimiter\fP, separated list. See \fBappend\-path\fP \%<#\:mfcmd-append-path> in the
513 modulefile \%<#\:modulefile-5> man page for \fIoptions\fP description and further
514 explanation.
515 .sp
516 When \fBappend\-path\fP is called as a module sub\-command, the reference
517 counter variable, which denotes the number of times \fIvalue\fP has been added to
518 environment \fIvariable\fP, is not updated unless if the \fB\-\-duplicates\fP option
519 is set.
520 .UNINDENT
521 .INDENT 0.0
522 .TP
523 .B apropos [\-a] [\-j] string
524 See \fBsearch\fP\&.
525 .UNINDENT
526 .INDENT 0.0
527 .TP
528 .B avail [\-d|\-L] [\-t|\-l|\-j] [\-a] [\-o LIST] [\-S|\-C] [\-\-indepth|\-\-no\-indepth] [pattern...]
529 List all available \fImodulefiles\fP in the current \fBMODULEPATH\fP\&. All
530 directories in the \fBMODULEPATH\fP are recursively searched for files
531 containing the Modules magic cookie. If a \fIpattern\fP argument is given, then
532 each directory in the \fBMODULEPATH\fP is searched for \fImodulefiles\fP
533 whose pathname, symbolic version\-name or alias match \fIpattern\fP in a case
534 insensitive manner by default. \fIpattern\fP may contain wildcard characters.
535 Multiple versions of an application can be supported by creating a
536 subdirectory for the application containing \fImodulefiles\fP for each version.
537 .sp
538 Symbolic version\-names and aliases found in the search are displayed in the
539 result of this sub\-command. Symbolic version\-names are displayed next to
540 the \fImodulefile\fP they are assigned to within parenthesis. Aliases are listed
541 in the \fBMODULEPATH\fP section where they have been defined. To
542 distinguish aliases from \fImodulefiles\fP a \fB@\fP symbol is added within
543 parenthesis next to their name. Aliases defined through a global or user
544 specific module RC file are listed under the \fBglobal/user modulerc\fP
545 section.
546 .sp
547 When colored output is enabled and a specific graphical rendition is defined
548 for module \fIdefault\fP version, the \fBdefault\fP symbol is omitted and instead
549 the defined graphical rendition is applied to the relative modulefile. When
550 colored output is enabled and a specific graphical rendition is defined for
551 module alias, the \fB@\fP symbol is omitted. The defined graphical rendition
552 applies to the module alias name. See \fBMODULES_COLOR\fP and
553 \fBMODULES_COLORS\fP sections for details on colored output.
554 .sp
555 Module tags applying to the available \fImodulefiles\fP returned by the
556 \fBavail\fP sub\-command are reported along the module name they are
557 associated to (see Module tags section).
558 .sp
559 Module variants and their available values may be reported along the module
560 name they belong to (see Module variants section) if defined in avail
561 output configuration option (see \fB\-\-output\fP/\fB\-o\fP option). The
562 Extra match search process is triggered to collect variant
563 information.
564 .sp
565 A \fIKey\fP section is added at the end of the output in case some elements are
566 reported in parentheses or chevrons along module name or if some graphical
567 rendition is made over some output elements. This \fIKey\fP section gives hints
568 on the meaning of such elements.
569 .sp
570 The parameter \fIpattern\fP may also refer to a symbolic modulefile name or a
571 modulefile alias. It may also leverage a specific syntax to finely select
572 module version (see Advanced module version specifiers section below).
573 .sp
574 If \fIpattern\fP contains variant specification or Extra specifier, the
575 Extra match search process is triggered to collect command information
576 used in modulefiles. Modules are included in results only if they match
577 \fIpattern\fP variant specification and extra specifier. \fIpattern\fP may be a bare
578 variant specification or extra specifier without mention of a module name.
579 .sp
580 When several \fIpatterns\fP are provided all modulefiles matching at least one of
581 these \fIpatterns\fP are listed.
582 .UNINDENT
583 .INDENT 0.0
584 .TP
585 .B cachebuild [modulepath...]
586 Build module cache file for designated modulepaths. If no argument is
587 provided cache file is built for every modulepath currently enabled. Cache
588 file creation is skipped for modulepaths where user cannot write in.
589 .sp
590 The name and content of every readable modulefiles and rc files are recorded
591 into cache file. Also last modification time of modulefiles and invalid
592 modulefile error messages are recorded. With all these information, the sole
593 cache file is evaluated to know what is available within modulepath.
594 .sp
595 See Module cache section for more details on module cache mechanism.
596 .UNINDENT
597 .INDENT 0.0
598 .TP
599 .B cacheclear
600 Delete module cache file in every modulepath currently enabled. If user
601 cannot write in a modulepath directory, cache file deletion is skipped for
602 this modulepath.
603 .sp
604 See Module cache section for more details on module cache mechanism.
605 .UNINDENT
606 .INDENT 0.0
607 .TP
608 .B clear [\-f]
609 Force the Modules package to believe that no modules are currently loaded. A
610 confirmation is requested if command\-line switch \fB\-f\fP (or
611 \fB\-\-force\fP) is not passed. Typed confirmation should equal to \fByes\fP
612 or \fBy\fP in order to proceed.
613 .UNINDENT
614 .INDENT 0.0
615 .TP
616 .B config [\-\-dump\-state|name [value]|\-\-reset name]
617 Gets or sets \fBmodulecmd.tcl\fP options. Reports the currently set value
618 of passed option \fIname\fP or all existing options if no \fIname\fP passed. If a
619 \fIname\fP and a \fIvalue\fP are provided, the value of option \fIname\fP is set to
620 \fIvalue\fP\&. If command\-line switch \fB\-\-reset\fP is passed in addition to a
621 \fIname\fP, overridden value for option \fIname\fP is cleared.
622 .sp
623 When a reported option value differs from default value a mention is added
624 to indicate whether the overridden value is coming from a command\-line switch
625 (\fBcmd\-line\fP) or from an environment variable (\fBenv\-var\fP). When a reported
626 option value is locked and cannot be altered a (\fBlocked\fP) mention is added.
627 .sp
628 If no value is currently set for an option \fIname\fP, the mention \fB<undef>\fP is
629 reported.
630 .sp
631 For options whose value is a colon\-separated list, \fIvalue\fP may be prefixed by
632 \fB+\fP or \fB\-\fP character. It indicates respectively to append it to or
633 subtract it from current option value.
634 .sp
635 When command\-line switch \fB\-\-dump\-state\fP is passed, current
636 \fBmodulecmd.tcl\fP state and Modules\-related environment variables are
637 reported in addition to currently set \fBmodulecmd.tcl\fP options.
638 .sp
639 Existing option \fInames\fP are:
640 .INDENT 7.0
641 .TP
642 .B abort_on_error
643 List of module sub\-commands that abort evaluation sequence when an error is
644 raised by an evaluated module. Evaluations already performed are withdrawn
645 and remaining modules to evaluate are skipped.
646 .sp
647 This configuration option can be changed at installation time with
648 \fB\-\-with\-abort\-on\-error\fP \%<#\:instopt-with-abort-on-error> option. The
649 \fBMODULES_ABORT_ON_ERROR\fP environment variable is defined by
650 \fBconfig\fP sub\-command when changing this configuration option from
651 its default value. See \fBMODULES_ABORT_ON_ERROR\fP description for
652 details.
653 .UNINDENT
654 .INDENT 7.0
655 .TP
656 .B advanced_version_spec
657 Advanced module version specification to finely select modulefiles.
658 .sp
659 Default value is \fB1\fP\&. It can be changed at installation time with
660 \fB\-\-disable\-advanced\-version\-spec\fP \%<#\:instopt-enable-advanced-version-spec>
661 option. The \fBMODULES_ADVANCED_VERSION_SPEC\fP environment variable is
662 defined by \fBconfig\fP sub\-command when changing this configuration
663 option from its default value. See \fBMODULES_ADVANCED_VERSION_SPEC\fP
664 description for details.
665 .UNINDENT
666 .INDENT 7.0
667 .TP
668 .B auto_handling
669 Automated module handling mode.
670 .sp
671 Default value is \fB1\fP\&. It can be changed at installation time with
672 \fB\-\-disable\-auto\-handling\fP \%<#\:instopt-enable-auto-handling> option. The
673 \fBMODULES_AUTO_HANDLING\fP environment variable is defined by
674 \fBconfig\fP sub\-command when changing this configuration option from
675 its default value. The \fB\-\-auto\fP and \fB\-\-no\-auto\fP
676 command line switches change the value of this configuration option. See
677 \fBMODULES_AUTO_HANDLING\fP description for details.
678 .UNINDENT
679 .INDENT 7.0
680 .TP
681 .B avail_indepth
682 \fBavail\fP sub\-command in depth search mode.
683 .sp
684 Default value is \fB1\fP\&. It can be changed at installation time with
685 \fB\-\-disable\-avail\-indepth\fP \%<#\:instopt-enable-avail-indepth> option. The
686 \fBMODULES_AVAIL_INDEPTH\fP environment variable is defined by
687 \fBconfig\fP sub\-command when changing this configuration option from
688 its default value. The \fB\-\-indepth\fP and \fB\-\-no\-indepth\fP
689 command line switches change the value of this configuration option. See
690 \fBMODULES_AVAIL_INDEPTH\fP description for details.
691 .UNINDENT
692 .INDENT 7.0
693 .TP
694 .B avail_output
695 Content to report in addition to module names on \fBavail\fP sub\-command
696 regular output mode.
697 .sp
698 Default value is \fBmodulepath:alias:dirwsym:sym:tag:variantifspec:key\fP\&. It
699 can be changed at installation time with \fB\-\-with\-avail\-output\fP \%<#\:instopt-with-avail-output>
700 option. The \fBMODULES_AVAIL_OUTPUT\fP environment variable is defined
701 by \fBconfig\fP sub\-command when changing this configuration option from
702 its default value. The \fB\-\-output\fP/\fB\-o\fP command line switches
703 change the value of this configuration option. See
704 \fBMODULES_AVAIL_OUTPUT\fP description for details.
705 .UNINDENT
706 .INDENT 7.0
707 .TP
708 .B avail_terse_output
709 Content to report in addition to module names on \fBavail\fP sub\-command
710 terse output mode.
711 .sp
712 Default value is \fBmodulepath:alias:dirwsym:sym:tag:variantifspec\fP\&. It can
713 be changed at installation time with \fB\-\-with\-avail\-terse\-output\fP \%<#\:instopt-with-avail-terse-output>
714 option. The \fBMODULES_AVAIL_TERSE_OUTPUT\fP environment variable is
715 defined by \fBconfig\fP sub\-command when changing this configuration
716 option from its default value. The \fB\-\-output\fP/\fB\-o\fP command
717 line switches change the value of this configuration option. See
718 \fBMODULES_AVAIL_TERSE_OUTPUT\fP description for details.
719 .UNINDENT
720 .INDENT 7.0
721 .TP
722 .B cache_buffer_bytes
723 Size of the buffer used when reading or writing cache files.
724 .sp
725 Default value is \fB32768\fP\&. Values between 4096 and 1000000 are accepted.
726 The \fBMODULES_CACHE_BUFFER_BYTES\fP environment variable is defined by
727 \fBconfig\fP sub\-command when changing this configuration option from
728 its default value.
729 .UNINDENT
730 .INDENT 7.0
731 .TP
732 .B cache_expiry_secs
733 Number of seconds a cache file is considered valid after being generated.
734 .sp
735 Default value is \fB0\fP\&. Values between 0 and 31536000 are accepted.
736 The \fBMODULES_CACHE_EXPIRY_SECS\fP environment variable is defined by
737 \fBconfig\fP sub\-command when changing this configuration option from
738 its default value.
739 .UNINDENT
740 .INDENT 7.0
741 .TP
742 .B collection_pin_version
743 Register exact modulefile version in collection.
744 .sp
745 Default value is \fB0\fP\&. The \fBMODULES_COLLECTION_PIN_VERSION\fP
746 environment variable is defined by \fBconfig\fP sub\-command when
747 changing this configuration option from its default value. See
748 \fBMODULES_COLLECTION_PIN_VERSION\fP description for details.
749 .UNINDENT
750 .INDENT 7.0
751 .TP
752 .B collection_pin_tag
753 Register full tag list applying to modulefiles in collection.
754 .sp
755 Default value is \fB0\fP\&. The \fBMODULES_COLLECTION_PIN_TAG\fP
756 environment variable is defined by \fBconfig\fP sub\-command when
757 changing this configuration option from its default value. See
758 \fBMODULES_COLLECTION_PIN_TAG\fP description for details.
759 .UNINDENT
760 .INDENT 7.0
761 .TP
762 .B collection_target
763 Collection target which is valid for current system.
764 .sp
765 This configuration option is unset by default. The
766 \fBMODULES_COLLECTION_TARGET\fP environment variable is defined by
767 \fBconfig\fP sub\-command when changing this configuration option from
768 its default value. See \fBMODULES_COLLECTION_TARGET\fP description for
769 details.
770 .UNINDENT
771 .INDENT 7.0
772 .TP
773 .B color
774 Colored output mode.
775 .sp
776 Default value is \fBauto\fP\&. It can be changed at installation time with
777 \fB\-\-disable\-color\fP \%<#\:instopt-enable-color> option. The
778 \fBMODULES_COLOR\fP environment variable is defined by
779 \fBconfig\fP sub\-command when changing this configuration option from
780 its default value. The \fB\-\-color\fP command line switches changes the
781 value of this configuration option. See \fBMODULES_COLOR\fP description
782 for details.
783 .UNINDENT
784 .INDENT 7.0
785 .TP
786 .B colors
787 Chosen colors to highlight output items.
788 .sp
789 Default value is \fBhi=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp=1;94:di=94:al=96:va=93:sy=95:de=4:cm=92:aL=100:L=90;47:H=2:F=41:nF=31;43:S=46:sS=44:kL=30;48;5;109:W=30;43\fP\&.
790 It can be changed at installation time with
791 \fB\-\-with\-dark\-background\-colors\fP \%<#\:instopt-with-dark-background-colors> or
792 \fB\-\-with\-light\-background\-colors\fP \%<#\:instopt-with-light-background-colors> options in conjunction with
793 \fB\-\-with\-terminal\-background\fP \%<#\:instopt-with-terminal-background>\&. The \fBMODULES_COLORS\fP
794 environment variable is defined by \fBconfig\fP sub\-command when
795 changing this configuration option from its default value. See
796 \fBMODULES_COLORS\fP description for details.
797 .UNINDENT
798 .INDENT 7.0
799 .TP
800 .B conflict_unload
801 Automated unload of conflicting modules when loading a module. This
802 mechanism is part of the automated module handling
803 mode and also requires enablement of
804 \fBauto_handling\fP configuration option.
805 .sp
806 Default value is \fB0\fP\&. It can be changed at installation time with
807 \fB\-\-enable\-conflict\-unload\fP \%<#\:instopt-enable-conflict-unload> option. The
808 \fBMODULES_CONFLICT_UNLOAD\fP environment variable is defined by
809 \fBconfig\fP sub\-command when changing this configuration option from
810 its default value. See \fBMODULES_CONFLICT_UNLOAD\fP description for
811 details.
812 .UNINDENT
813 .INDENT 7.0
814 .TP
815 .B contact
816 Modulefile contact address.
817 .sp
818 Default value is \fBroot@localhost\fP\&. The \fBMODULECONTACT\fP environment
819 variable is defined by \fBconfig\fP sub\-command when changing this
820 configuration option from its default value. See \fBMODULECONTACT\fP
821 description for details.
822 .UNINDENT
823 .INDENT 7.0
824 .TP
825 .B extended_default
826 Allow partial module version specification.
827 .sp
828 Default value is \fB1\fP\&. It can be changed at installation time with
829 \fB\-\-disable\-extended\-default\fP \%<#\:instopt-enable-extended-default> option. The
830 \fBMODULES_EXTENDED_DEFAULT\fP environment variable is defined by
831 \fBconfig\fP sub\-command when changing this configuration option from
832 its default value. See \fBMODULES_EXTENDED_DEFAULT\fP description for
833 details.
834 .UNINDENT
835 .INDENT 7.0
836 .TP
837 .B editor
838 Text editor command to open modulefile with through \fBedit\fP
839 sub\-command.
840 .sp
841 Default value is \fBvi\fP\&. It can be changed at installation time with
842 \fB\-\-with\-editor\fP \%<#\:instopt-with-editor> option. The \fBMODULES_EDITOR\fP environment
843 variable is defined by \fBconfig\fP sub\-command when changing this
844 configuration option from its default value. See \fBMODULES_EDITOR\fP
845 description for details.
846 .UNINDENT
847 .INDENT 7.0
848 .TP
849 .B extra_siteconfig
850 Additional site\-specific configuration script location. See
851 Site\-specific configuration section for details.
852 .sp
853 This configuration option is unset by default. The
854 \fBMODULES_SITECONFIG\fP environment variable is defined by
855 \fBconfig\fP sub\-command when changing this configuration option from
856 its default value. See \fBMODULES_SITECONFIG\fP description for details.
857 .UNINDENT
858 .INDENT 7.0
859 .TP
860 .B hide_auto_loaded
861 Tag automatically loaded modules \fBhidden\-loaded\fP
862 .sp
863 Default is \fB0\fP\&. The \fBMODULES_HIDE_AUTO_LOADED\fP environment
864 variable is defined by \fBconfig\fP sub\-command when changing this
865 configuration option from its default value.
866 .UNINDENT
867 .INDENT 7.0
868 .TP
869 .B home
870 Location of Modules package main directory.
871 .sp
872 Default value is \fB@prefix@\fP\&. It can be changed at installation time with
873 \fB\-\-prefix\fP \%<#\:instopt-prefix> or \fB\-\-with\-moduleshome\fP \%<#\:instopt-with-moduleshome> options. The
874 \fBMODULESHOME\fP environment variable is defined by \fBconfig\fP
875 sub\-command when changing this configuration option from its default value.
876 See \fBMODULESHOME\fP description for details.
877 .UNINDENT
878 .INDENT 7.0
879 .TP
880 .B icase
881 Enable case insensitive match.
882 .sp
883 Default value is \fBsearch\fP\&. It can be changed at installation time with
884 \fB\-\-with\-icase\fP \%<#\:instopt-with-icase> option. The \fBMODULES_ICASE\fP environment
885 variable is defined by \fBconfig\fP sub\-command when changing this
886 configuration option from its default value. The
887 \fB\-\-icase\fP/\fB\-i\fP command line switches change the value of
888 this configuration option. See \fBMODULES_ICASE\fP description for
889 details.
890 .UNINDENT
891 .INDENT 7.0
892 .TP
893 .B ignore_cache
894 Ignore module cache.
895 .sp
896 Default is \fB0\fP\&. The \fBMODULES_IGNORE_CACHE\fP environment variable
897 is defined by \fBconfig\fP sub\-command when changing this configuration
898 option from its default value. The \fB\-\-ignore\-cache\fP command line
899 switch changes the value of this configuration option.
900 .UNINDENT
901 .INDENT 7.0
902 .TP
903 .B ignore_user_rc
904 Skip evaluation of user\-specific module rc file (\fB$HOME/.modulerc\fP).
905 .sp
906 Default is \fB0\fP\&. The \fBMODULES_IGNORE_USER_RC\fP environment variable
907 is defined by \fBconfig\fP sub\-command when changing this configuration
908 option from its default value. The \fB\-\-ignore\-user\-rc\fP command line
909 switch changes the value of this configuration option.
910 .UNINDENT
911 .INDENT 7.0
912 .TP
913 .B ignored_dirs
914 Directories ignored when looking for modulefiles.
915 .sp
916 Default value is \fBCVS RCS SCCS .svn .git .SYNC .sos\fP\&. The value of this
917 option cannot be altered.
918 .UNINDENT
919 .INDENT 7.0
920 .TP
921 .B implicit_default
922 Set an implicit default version for modules.
923 .sp
924 Default value is \fB1\fP\&. It can be changed at installation time with
925 \fB\-\-disable\-implicit\-default\fP \%<#\:instopt-enable-implicit-default> option. The
926 \fBMODULES_IMPLICIT_DEFAULT\fP environment variable is defined by
927 \fBconfig\fP sub\-command when changing this configuration option from
928 its default value. See \fBMODULES_IMPLICIT_DEFAULT\fP description for
929 details.
930 .UNINDENT
931 .INDENT 7.0
932 .TP
933 .B implicit_requirement
934 Implicitly define a requirement onto modules specified on \fBmodule\fP \%<#\:mfcmd-module>
935 commands in modulefile.
936 .sp
937 Default value is \fB1\fP\&. It can be changed at installation time with
938 \fB\-\-disable\-implicit\-requirement\fP \%<#\:instopt-enable-implicit-requirement>
939 option. The \fBMODULES_IMPLICIT_REQUIREMENT\fP environment variable is
940 defined by \fBconfig\fP sub\-command when changing this configuration
941 option from its default value. See \fBMODULES_IMPLICIT_REQUIREMENT\fP
942 description for details.
943 .UNINDENT
944 .INDENT 7.0
945 .TP
946 .B list_output
947 Content to report in addition to module names on \fBlist\fP sub\-command
948 regular output mode.
949 .sp
950 Default value is \fBheader:idx:variant:sym:tag:key\fP\&. It can be changed at
951 installation time with \fB\-\-with\-list\-output\fP \%<#\:instopt-with-list-output> option. The
952 \fBMODULES_LIST_OUTPUT\fP environment variable is defined by
953 \fBconfig\fP sub\-command when changing this configuration option from
954 its default value. The \fB\-\-output\fP/\fB\-o\fP command line switches
955 change the value of this configuration option. See
956 \fBMODULES_LIST_OUTPUT\fP description for details.
957 .UNINDENT
958 .INDENT 7.0
959 .TP
960 .B list_terse_output
961 Content to report in addition to module names on \fBlist\fP sub\-command
962 terse output mode.
963 .sp
964 Default value is \fBheader\fP\&. It can be changed at installation time with
965 \fB\-\-with\-list\-terse\-output\fP \%<#\:instopt-with-list-terse-output> option. The
966 \fBMODULES_LIST_TERSE_OUTPUT\fP environment variable is defined by
967 \fBconfig\fP sub\-command when changing this configuration option from
968 its default value. The \fB\-\-output\fP/\fB\-o\fP command line switches
969 change the value of this configuration option. See
970 \fBMODULES_LIST_TERSE_OUTPUT\fP description for details.
971 .UNINDENT
972 .INDENT 7.0
973 .TP
974 .B locked_configs
975 Configuration options that cannot be superseded. All options referred in
976 \fBlocked_configs\fP value are locked, thus their value cannot be
977 altered.
978 .sp
979 This configuration option is set to an empty value by default. It can be
980 changed at installation time with \fB\-\-with\-locked\-configs\fP \%<#\:instopt-with-locked-configs> option.
981 The value of this option cannot be altered.
982 .UNINDENT
983 .INDENT 7.0
984 .TP
985 .B logged_events
986 List of the events to log.
987 .sp
988 This configuration option is set to an empty value by default. It can be
989 changed at installation time with \fB\-\-with\-logged\-events\fP \%<#\:instopt-with-logged-events> option.
990 The \fBMODULES_LOGGED_EVENTS\fP environment variable is defined by
991 \fBconfig\fP sub\-command when changing this configuration option from
992 its default value. See \fBMODULES_LOGGED_EVENTS\fP description for
993 details.
994 .UNINDENT
995 .INDENT 7.0
996 .TP
997 .B logger
998 Command to log messages.
999 .sp
1000 Default value is \fBlogger \-t modules\fP\&. It can be changed at installation
1001 time with \fB\-\-with\-logger\fP \%<#\:instopt-with-logger> and \fB\-\-with\-logger\-opts\fP \%<#\:instopt-with-logger-opts>
1002 options. The \fBMODULES_LOGGER\fP environment variable is defined by
1003 \fBconfig\fP sub\-command when changing this configuration option from
1004 its default value. See \fBMODULES_LOGGER\fP description for details.
1005 .UNINDENT
1006 .INDENT 7.0
1007 .TP
1008 .B mcookie_check
1009 Defines if the Modules magic cookie (i.e., \fB#%Module\fP file signature)
1010 should be checked to determine if a file is a modulefile.
1011 .sp
1012 Default value is \fBalways\fP\&. The \fBMODULES_MCOOKIE_CHECK\fP environment
1013 variable is defined by \fBconfig\fP sub\-command when changing this
1014 configuration option from its default value. See
1015 \fBMODULES_MCOOKIE_CHECK\fP description for details.
1016 .UNINDENT
1017 .INDENT 7.0
1018 .TP
1019 .B mcookie_version_check
1020 Defines if the version set in the Modules magic cookie used in modulefile
1021 should be checked against the version of \fBmodulecmd.tcl\fP to determine
1022 if the modulefile could be evaluated or not.
1023 .sp
1024 Default value is \fB1\fP\&. It can be changed at installation time with
1025 \fB\-\-disable\-mcookie\-version\-check\fP \%<#\:instopt-enable-mcookie-version-check>
1026 option. The \fBMODULES_MCOOKIE_VERSION_CHECK\fP environment variable is
1027 defined by \fBconfig\fP sub\-command when changing this configuration
1028 option from its default value. See \fBMODULES_MCOOKIE_VERSION_CHECK\fP
1029 description for details.
1030 .UNINDENT
1031 .INDENT 7.0
1032 .TP
1033 .B ml
1034 Define \fBml\fP command at initialization time.
1035 .sp
1036 Default value is \fB1\fP\&. It can be changed at installation time with
1037 \fB\-\-disable\-ml\fP \%<#\:instopt-enable-ml> option. The \fBMODULES_ML\fP
1038 environment variable is defined by \fBconfig\fP sub\-command when
1039 changing this configuration option from its default value. See
1040 \fBMODULES_ML\fP description for details.
1041 .UNINDENT
1042 .INDENT 7.0
1043 .TP
1044 .B nearly_forbidden_days
1045 Set the number of days a module should be considered \fInearly forbidden\fP
1046 prior reaching its expiry date.
1047 .sp
1048 Default value is \fB14\fP\&. It can be changed at installation time with
1049 \fB\-\-with\-nearly\-forbidden\-days\fP \%<#\:instopt-with-nearly-forbidden-days> option. The
1050 \fBMODULES_NEARLY_FORBIDDEN_DAYS\fP environment variable is defined by
1051 \fBconfig\fP sub\-command when changing this configuration option from
1052 its default value. See \fBMODULES_NEARLY_FORBIDDEN_DAYS\fP description
1053 for details.
1054 .UNINDENT
1055 .INDENT 7.0
1056 .TP
1057 .B pager
1058 Text viewer to paginate message output.
1059 .sp
1060 Default value is \fBless \-eFKRX\fP\&. It can be changed at installation time
1061 with \fB\-\-with\-pager\fP \%<#\:instopt-with-pager> and \fB\-\-with\-pager\-opts\fP \%<#\:instopt-with-pager-opts> options. The
1062 \fBMODULES_PAGER\fP environment variable is defined by \fBconfig\fP
1063 sub\-command when changing this configuration option from its default value.
1064 See \fBMODULES_PAGER\fP description for details.
1065 .UNINDENT
1066 .INDENT 7.0
1067 .TP
1068 .B protected_envvars
1069 Prevents any modification of listed environment variables (colon \fI:\fP
1070 separator).
1071 .sp
1072 This configuration option is unset by default. The
1073 \fBMODULES_PROTECTED_ENVVARS\fP environment variable is defined by
1074 \fBconfig\fP sub\-command when changing this configuration option from
1075 its default value. See \fBMODULES_PROTECTED_ENVVARS\fP description for
1076 details.
1077 .UNINDENT
1078 .INDENT 7.0
1079 .TP
1080 .B quarantine_support
1081 Defines if code for quarantine mechanism support should be generated in
1082 \fBmodule\fP shell function definition.
1083 .sp
1084 Default value is \fB0\fP\&. It can be changed at installation time with
1085 \fB\-\-enable\-quarantine\-support\fP \%<#\:instopt-enable-quarantine-support> option. The
1086 \fBMODULES_QUARANTINE_SUPPORT\fP environment variable is defined by
1087 \fBconfig\fP sub\-command when changing this configuration option from
1088 its default value. See \fBMODULES_QUARANTINE_SUPPORT\fP description for
1089 details.
1090 .UNINDENT
1091 .INDENT 7.0
1092 .TP
1093 .B rcfile
1094 Location of global run\-command file(s).
1095 .sp
1096 This configuration option is unset by default. The \fBMODULERCFILE\fP
1097 environment variable is defined by \fBconfig\fP sub\-command when
1098 changing this configuration option from its default value. See
1099 \fBMODULERCFILE\fP description for details.
1100 .UNINDENT
1101 .INDENT 7.0
1102 .TP
1103 .B redirect_output
1104 Control whether or not the output of module command should be redirected
1105 from stderr to stdout.
1106 .sp
1107 Default value is \fB1\fP\&. The \fBMODULES_REDIRECT_OUTPUT\fP environment
1108 variable is defined by \fBconfig\fP sub\-command when changing this
1109 configuration option from its default value. The \fB\-\-redirect\fP and
1110 \fB\-\-no\-redirect\fP command line switches change the value of this
1111 configuration option. See \fBMODULES_REDIRECT_OUTPUT\fP description for
1112 details.
1113 .UNINDENT
1114 .INDENT 7.0
1115 .TP
1116 .B require_via
1117 Consider loaded module enabling a modulepath a requirement for loaded
1118 modules stored in this modulepath.
1119 .sp
1120 Default value is \fB0\fP\&. It can be changed at installation time with
1121 \fB\-\-enable\-require\-via\fP \%<#\:instopt-enable-require-via> option. The \fBMODULES_REQUIRE_VIA\fP
1122 environment variable is defined by \fBconfig\fP sub\-command when
1123 changing this configuration option from its default value. See
1124 \fBMODULES_REQUIRE_VIA\fP description for details.
1125 .UNINDENT
1126 .INDENT 7.0
1127 .TP
1128 .B reset_target_state
1129 Control behavior of \fBreset\fP sub\-command. Whether environment should
1130 be purged (\fB__purge__\fP), initial environment (\fB__init__\fP) or a named
1131 collection (any other value) should restored.
1132 .sp
1133 Default value is \fB__init__\fP\&. The \fBMODULES_RESET_TARGET_STATE\fP
1134 environment variable is defined by \fBconfig\fP sub\-command when
1135 changing this configuration option from its default value. See
1136 \fBMODULES_RESET_TARGET_STATE\fP description for details.
1137 .UNINDENT
1138 .INDENT 7.0
1139 .TP
1140 .B run_quarantine
1141 Environment variables to indirectly pass to \fBmodulecmd.tcl\fP\&.
1142 .sp
1143 This configuration option is set to an empty value by default. It can be
1144 changed at installation time with \fB\-\-with\-quarantine\-vars\fP \%<#\:instopt-with-quarantine-vars> option
1145 that sets \fBMODULES_RUN_QUARANTINE\fP\&. This environment variable is
1146 also defined by \fBconfig\fP sub\-command when changing this
1147 configuration option. See \fBMODULES_RUN_QUARANTINE\fP description for
1148 details.
1149 .UNINDENT
1150 .INDENT 7.0
1151 .TP
1152 .B search_match
1153 Module search match style.
1154 .sp
1155 Default value is \fBstarts_with\fP\&. It can be changed at installation time
1156 with \fB\-\-with\-search\-match\fP \%<#\:instopt-with-search-match> option. The
1157 \fBMODULES_SEARCH_MATCH\fP environment variable is defined by
1158 \fBconfig\fP sub\-command when changing this configuration option from
1159 its default value. The \fB\-\-contains\fP and \fB\-\-starts\-with\fP
1160 command line switches change the value of this configuration option. See
1161 \fBMODULES_SEARCH_MATCH\fP description for details.
1162 .UNINDENT
1163 .INDENT 7.0
1164 .TP
1165 .B set_shell_startup
1166 Ensure module command definition by setting shell startup file.
1167 .sp
1168 Default value is \fB0\fP\&. It can be changed at installation time with
1169 \fB\-\-enable\-set\-shell\-startup\fP \%<#\:instopt-enable-set-shell-startup> option. The
1170 \fBMODULES_SET_SHELL_STARTUP\fP environment variable is defined by
1171 \fBconfig\fP sub\-command when changing this configuration option from
1172 its default value. See \fBMODULES_SET_SHELL_STARTUP\fP description for
1173 details.
1174 .UNINDENT
1175 .INDENT 7.0
1176 .TP
1177 .B shells_with_ksh_fpath
1178 Ensure module command is defined in ksh when it is started as a sub\-shell
1179 from the listed shells.
1180 .sp
1181 This configuration option is set to an empty value by default. The
1182 \fBMODULES_SHELLS_WITH_KSH_FPATH\fP environment variable is defined by
1183 \fBconfig\fP sub\-command when changing this configuration option from
1184 its default value. See \fBMODULES_SHELLS_WITH_KSH_FPATH\fP description
1185 for details.
1186 .UNINDENT
1187 .INDENT 7.0
1188 .TP
1189 .B silent_shell_debug
1190 Disablement of shell debugging property for the module command. Also defines
1191 if code to silence shell debugging property should be generated in
1192 \fBmodule\fP shell function definition.
1193 .sp
1194 Default value is \fB0\fP\&. It can be changed at installation time with
1195 \fB\-\-enable\-silent\-shell\-debug\-support\fP \%<#\:instopt-enable-silent-shell-debug-support> option. The
1196 \fBMODULES_SILENT_SHELL_DEBUG\fP environment variable is defined by
1197 \fBconfig\fP sub\-command when changing this configuration option from
1198 its default value. See \fBMODULES_SILENT_SHELL_DEBUG\fP description for
1199 details.
1200 .UNINDENT
1201 .INDENT 7.0
1202 .TP
1203 .B siteconfig
1204 Primary site\-specific configuration script location. See
1205 Site\-specific configuration section for details.
1206 .sp
1207 Default value is \fB@etcdir@/siteconfig.tcl\fP\&. It can be changed at installation
1208 time with \fB\-\-prefix\fP \%<#\:instopt-prefix> or \fB\-\-etcdir\fP \%<#\:instopt-etcdir> options. The value of
1209 this option cannot be altered.
1210 .UNINDENT
1211 .INDENT 7.0
1212 .TP
1213 .B source_cache
1214 Cache content of files evaluated in modulefile through \fBsource(n)\fP
1215 Tcl command.
1216 .sp
1217 Default value is \fB0\fP\&. It can be changed at installation time with
1218 \fB\-\-enable\-source\-cache\fP \%<#\:instopt-enable-source-cache> option. The \fBMODULES_SOURCE_CACHE\fP
1219 environment variable is defined by \fBconfig\fP sub\-command when
1220 changing this configuration option from its default value. See
1221 \fBMODULES_SOURCE_CACHE\fP description for details.
1222 .UNINDENT
1223 .INDENT 7.0
1224 .TP
1225 .B spider_indepth
1226 \fBspider\fP sub\-command in depth search mode.
1227 .sp
1228 Default value is \fB1\fP\&. It can be changed at installation time with
1229 \fB\-\-disable\-spider\-indepth\fP \%<#\:instopt-enable-spider-indepth> option. The
1230 \fBMODULES_SPIDER_INDEPTH\fP environment variable is defined by
1231 \fBconfig\fP sub\-command when changing this configuration option from
1232 its default value. The \fB\-\-indepth\fP and \fB\-\-no\-indepth\fP
1233 command line switches change the value of this configuration option. See
1234 \fBMODULES_SPIDER_INDEPTH\fP description for details.
1235 .UNINDENT
1236 .INDENT 7.0
1237 .TP
1238 .B spider_output
1239 Content to report in addition to module names on \fBspider\fP
1240 sub\-command regular output mode.
1241 .sp
1242 Default value is \fBmodulepath:alias:dirwsym:sym:tag:variantifspec:via:key\fP\&.
1243 It can be changed at installation time with \fB\-\-with\-spider\-output\fP \%<#\:instopt-with-spider-output>
1244 option. The \fBMODULES_SPIDER_OUTPUT\fP environment variable is defined
1245 by \fBconfig\fP sub\-command when changing this configuration option from
1246 its default value. The \fB\-\-output\fP/\fB\-o\fP command line switches
1247 change the value of this configuration option. See
1248 \fBMODULES_SPIDER_OUTPUT\fP description for details.
1249 .UNINDENT
1250 .INDENT 7.0
1251 .TP
1252 .B spider_terse_output
1253 Content to report in addition to module names on \fBspider\fP
1254 sub\-command terse output mode.
1255 .sp
1256 Default value is \fBmodulepath:alias:dirwsym:sym:tag:variantifspec\fP\&. It can
1257 be changed at installation time with \fB\-\-with\-spider\-terse\-output\fP \%<#\:instopt-with-spider-terse-output>
1258 option. The \fBMODULES_SPIDER_TERSE_OUTPUT\fP environment variable is
1259 defined by \fBconfig\fP sub\-command when changing this configuration
1260 option from its default value. The \fB\-\-output\fP/\fB\-o\fP command
1261 line switches change the value of this configuration option. See
1262 \fBMODULES_SPIDER_TERSE_OUTPUT\fP description for details.
1263 .UNINDENT
1264 .INDENT 7.0
1265 .TP
1266 .B sticky_purge
1267 Error behavior when unloading sticky or super\-sticky module during a module
1268 \fBpurge\fP\&.
1269 .sp
1270 Raise an \fBerror\fP (default) or emit a \fBwarning\fP or be \fBsilent\fP\&. It can
1271 be changed at installation time with \fB\-\-with\-sticky\-purge\fP \%<#\:instopt-with-sticky-purge> option.
1272 The \fBMODULES_STICKY_PURGE\fP environment variable is defined by
1273 \fBconfig\fP sub\-command when changing this configuration option from
1274 its default value. See \fBMODULES_STICKY_PURGE\fP description for
1275 details.
1276 .UNINDENT
1277 .INDENT 7.0
1278 .TP
1279 .B tag_abbrev
1280 Abbreviations to use to report module tags.
1281 .sp
1282 Default value is \fBauto\-loaded=aL:loaded=L:hidden=H:hidden\-loaded=H:forbidden=F:nearly\-forbidden=nF:sticky=S:super\-sticky=sS:keep\-loaded=kL:warning=W\fP\&.
1283 It can be changed at installation time with \fB\-\-with\-tag\-abbrev\fP \%<#\:instopt-with-tag-abbrev>
1284 option. The \fBMODULES_TAG_ABBREV\fP environment variable is defined by
1285 \fBconfig\fP sub\-command when changing this configuration option from
1286 its default value. See \fBMODULES_TAG_ABBREV\fP description for details.
1287 .UNINDENT
1288 .INDENT 7.0
1289 .TP
1290 .B tag_color_name
1291 Tags whose name should be colored instead of module name.
1292 .sp
1293 This configuration option is set to an empty value by default. It can be
1294 changed at installation time with \fB\-\-with\-tag\-color\-name\fP \%<#\:instopt-with-tag-color-name> option.
1295 The \fBMODULES_TAG_COLOR_NAME\fP environment variable is defined by
1296 \fBconfig\fP sub\-command when changing this configuration option from
1297 its default value. See \fBMODULES_TAG_COLOR_NAME\fP description for
1298 details.
1299 .UNINDENT
1300 .INDENT 7.0
1301 .TP
1302 .B tcl_ext_lib
1303 Modules Tcl extension library location.
1304 .sp
1305 Default value is \fB@libdir@/libtclenvmodules.so\fP\&. It can be changed at
1306 installation time with \fB\-\-prefix\fP \%<#\:instopt-prefix> or \fB\-\-libdir\fP \%<#\:instopt-libdir> options.
1307 The value of this option cannot be altered.
1308 .UNINDENT
1309 .INDENT 7.0
1310 .TP
1311 .B tcl_linter
1312 Command to check syntax of modulefiles with through \fBlint\fP
1313 sub\-command.
1314 .sp
1315 Default value is \fBnagelfar.tcl\fP\&. It can be changed at installation time
1316 with \fB\-\-with\-tcl\-linter\fP \%<#\:instopt-with-tcl-linter> and \fB\-\-with\-tcl\-linter\-opts\fP \%<#\:instopt-with-tcl-linter-opts>
1317 options. The \fBMODULES_TCL_LINTER\fP environment variable is defined by
1318 \fBconfig\fP sub\-command when changing this configuration option from
1319 its default value. See \fBMODULES_TCL_LINTER\fP description for details.
1320 .UNINDENT
1321 .INDENT 7.0
1322 .TP
1323 .B term_background
1324 Terminal background color kind.
1325 .sp
1326 Default value is \fBdark\fP\&. It can be changed at installation time with
1327 \fB\-\-with\-terminal\-background\fP \%<#\:instopt-with-terminal-background> option. The
1328 \fBMODULES_TERM_BACKGROUND\fP environment variable is defined by
1329 \fBconfig\fP sub\-command when changing this configuration option from
1330 its default value. See \fBMODULES_TERM_BACKGROUND\fP description for
1331 details.
1332 .UNINDENT
1333 .INDENT 7.0
1334 .TP
1335 .B term_width
1336 Set the width of the output.
1337 .sp
1338 Default value is \fB0\fP\&. The \fBMODULES_TERM_WIDTH\fP environment
1339 variable is defined by \fBconfig\fP sub\-command when changing this
1340 configuration option from its default value. The
1341 \fB\-\-width\fP/\fB\-w\fP command line switches change the value of
1342 this configuration option. See \fBMODULES_TERM_WIDTH\fP description for
1343 details.
1344 .UNINDENT
1345 .INDENT 7.0
1346 .TP
1347 .B unique_name_loaded
1348 Only one module loaded per module name.
1349 .sp
1350 Default value is \fB0\fP\&. It can be changed at installation time with
1351 \fB\-\-enable\-unique\-name\-loaded\fP \%<#\:instopt-enable-unique-name-loaded> option. The
1352 \fBMODULES_UNIQUE_NAME_LOADED\fP environment variable is defined by
1353 \fBconfig\fP sub\-command when changing this configuration option from
1354 its default value. See \fBMODULES_UNIQUE_NAME_LOADED\fP description for
1355 details.
1356 .UNINDENT
1357 .INDENT 7.0
1358 .TP
1359 .B unload_match_order
1360 Unload firstly loaded or lastly loaded module matching request.
1361 .sp
1362 Default value is \fBreturnlast\fP\&. It can be changed at installation time with
1363 \fB\-\-with\-unload\-match\-order\fP \%<#\:instopt-with-unload-match-order> option. The
1364 \fBMODULES_UNLOAD_MATCH_ORDER\fP environment variable is defined by
1365 \fBconfig\fP sub\-command when changing this configuration option from
1366 its default value. See \fBMODULES_UNLOAD_MATCH_ORDER\fP description for
1367 details.
1368 .UNINDENT
1369 .INDENT 7.0
1370 .TP
1371 .B variant_shortcut
1372 Shortcut characters that could be used to specify or report module variants.
1373 .sp
1374 This configuration option is set to an empty value by default. It can be
1375 changed at installation time with \fB\-\-with\-variant\-shortcut\fP \%<#\:instopt-with-variant-shortcut> option.
1376 The \fBMODULES_VARIANT_SHORTCUT\fP environment variable is defined by
1377 \fBconfig\fP sub\-command when changing this configuration option from
1378 its default value. See \fBMODULES_VARIANT_SHORTCUT\fP description for
1379 details.
1380 .UNINDENT
1381 .INDENT 7.0
1382 .TP
1383 .B verbosity
1384 Module command verbosity level.
1385 .sp
1386 Default value is \fBnormal\fP\&. It can be changed at installation time with
1387 \fB\-\-with\-verbosity\fP \%<#\:instopt-with-verbosity> option. The \fBMODULES_VERBOSITY\fP
1388 environment variable is defined by \fBconfig\fP sub\-command when
1389 changing this configuration option from its default value. The
1390 \fB\-\-debug\fP/\fB\-D\fP, \fB\-\-silent\fP/\fB\-s\fP,
1391 \fB\-\-trace\fP/\fB\-T\fP and \fB\-\-verbose\fP/\fB\-v\fP
1392 command line switches change the value of this configuration option. See
1393 \fBMODULES_VERBOSITY\fP description for details.
1394 .UNINDENT
1395 .INDENT 7.0
1396 .TP
1397 .B wa_277
1398 Workaround for Tcsh history issue.
1399 .sp
1400 Default value is \fB0\fP\&. It can be changed at installation time with
1401 \fB\-\-enable\-wa\-277\fP \%<#\:instopt-enable-wa-277> option. The \fBMODULES_WA_277\fP environment
1402 variable is defined by \fBconfig\fP sub\-command when changing this
1403 configuration option from its default value. See \fBMODULES_WA_277\fP
1404 description for details.
1405 .UNINDENT
1406 .UNINDENT
1407 .INDENT 0.0
1408 .TP
1409 .B describe [collection]
1410 See \fBsaveshow\fP\&.
1411 .UNINDENT
1412 .INDENT 0.0
1413 .TP
1414 .B disable [collection]
1415 See \fBsaverm\fP\&.
1416 .UNINDENT
1417 .INDENT 0.0
1418 .TP
1419 .B display modulefile...
1420 Display information about one or more \fImodulefiles\fP\&. The display sub\-command
1421 will list the full path of the \fImodulefile\fP and the environment changes
1422 the \fImodulefile\fP will make if loaded. (Note: It will not display any
1423 environment changes found within conditional statements.)
1424 .sp
1425 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1426 modulefile alias. It may also leverage a specific syntax to finely select
1427 module version (see Advanced module version specifiers section below).
1428 .sp
1429 When several \fImodulefiles\fP are passed, they are evaluated sequentially in the
1430 specified order. If one modulefile evaluation raises an error, display
1431 sequence continues.
1432 .UNINDENT
1433 .INDENT 0.0
1434 .TP
1435 .B edit modulefile
1436 Open \fImodulefile\fP for edition with text editor command designated by the
1437 \fBeditor\fP configuration option.
1438 .sp
1439 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1440 modulefile alias. It may also leverage a specific syntax to finely select
1441 module version (see Advanced module version specifiers section below).
1442 .UNINDENT
1443 .INDENT 0.0
1444 .TP
1445 .B help [modulefile...]
1446 Print the usage of each sub\-command. If an argument is given, print the
1447 Module\-specific help information for the \fImodulefile\fP\&.
1448 .sp
1449 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1450 modulefile alias. It may also leverage a specific syntax to finely select
1451 module version (see Advanced module version specifiers section below).
1452 .sp
1453 When several \fImodulefiles\fP are passed, they are evaluated sequentially in the
1454 specified order. If one modulefile evaluation raises an error, help sequence
1455 continues.
1456 .UNINDENT
1457 .INDENT 0.0
1458 .TP
1459 .B info\-loaded modulefile
1460 Returns the names of currently loaded modules matching passed \fImodulefile\fP\&.
1461 Returns an empty string if passed \fImodulefile\fP does not match any loaded
1462 modules. See \fBmodule\-info loaded\fP \%<#\:mfcmd-module-info> in the
1463 modulefile \%<#\:modulefile-5> man page for further explanation.
1464 .UNINDENT
1465 .INDENT 0.0
1466 .TP
1467 .B initadd modulefile...
1468 Add \fImodulefile\fP to the shell\(aqs initialization file in the user\(aqs home
1469 directory. The startup files checked (in order) are:
1470 .sp
1471 C Shell
1472 .INDENT 7.0
1473 .INDENT 3.5
1474 \fB\&.modules\fP, \fB\&.cshrc\fP, \fB\&.csh_variables\fP and \fB\&.login\fP
1475 .UNINDENT
1476 .UNINDENT
1477 .sp
1478 TENEX C Shell
1479 .INDENT 7.0
1480 .INDENT 3.5
1481 \fB\&.modules\fP, \fB\&.tcshrc\fP, \fB\&.cshrc\fP, \fB\&.csh_variables\fP
1482 and \fB\&.login\fP
1483 .UNINDENT
1484 .UNINDENT
1485 .sp
1486 Bourne and Korn Shells
1487 .INDENT 7.0
1488 .INDENT 3.5
1489 \fB\&.modules\fP, \fB\&.profile\fP
1490 .UNINDENT
1491 .UNINDENT
1492 .sp
1493 GNU Bourne Again Shell
1494 .INDENT 7.0
1495 .INDENT 3.5
1496 \fB\&.modules\fP, \fB\&.bash_profile\fP, \fB\&.bash_login\fP,
1497 \fB\&.profile\fP and \fB\&.bashrc\fP
1498 .UNINDENT
1499 .UNINDENT
1500 .sp
1501 Z Shell
1502 .INDENT 7.0
1503 .INDENT 3.5
1504 \fB\&.modules\fP, \fB\&.zshrc\fP, \fB\&.zshenv\fP and \fB\&.zlogin\fP
1505 .UNINDENT
1506 .UNINDENT
1507 .sp
1508 Friendly Interactive Shell
1509 .INDENT 7.0
1510 .INDENT 3.5
1511 \fB\&.modules\fP, \fB\&.config/fish/config.fish\fP
1512 .UNINDENT
1513 .UNINDENT
1514 .sp
1515 If a \fBmodule load\fP line is found in any of these files, the \fImodulefiles\fP
1516 are appended to any existing list of \fImodulefiles\fP\&. The \fBmodule load\fP
1517 line must be located in at least one of the files listed above for any of
1518 the \fBinit\fP sub\-commands to work properly. If the
1519 \fBmodule load\fP line is found in multiple shell initialization files, all of
1520 the lines are changed.
1521 .UNINDENT
1522 .INDENT 0.0
1523 .TP
1524 .B initclear
1525 Clear all of the \fImodulefiles\fP from the shell\(aqs initialization files.
1526 .UNINDENT
1527 .INDENT 0.0
1528 .TP
1529 .B initlist
1530 List all of the \fImodulefiles\fP loaded from the shell\(aqs initialization file.
1531 .UNINDENT
1532 .INDENT 0.0
1533 .TP
1534 .B initprepend modulefile...
1535 Does the same as \fBinitadd\fP but prepends the given modules to the
1536 beginning of the list.
1537 .UNINDENT
1538 .INDENT 0.0
1539 .TP
1540 .B initrm modulefile...
1541 Remove \fImodulefile\fP from the shell\(aqs initialization files.
1542 .UNINDENT
1543 .INDENT 0.0
1544 .TP
1545 .B initswitch modulefile1 modulefile2
1546 Switch \fImodulefile1\fP with \fImodulefile2\fP in the shell\(aqs initialization files.
1547 .UNINDENT
1548 .INDENT 0.0
1549 .TP
1550 .B is\-avail modulefile...
1551 Returns a true value if any of the listed \fImodulefiles\fP exists in enabled
1552 \fBMODULEPATH\fP\&. Returns a false value otherwise. See \fBis\-avail\fP \%<#\:mfcmd-is-avail>
1553 in the modulefile \%<#\:modulefile-5> man page for further explanation.
1554 .sp
1555 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1556 modulefile alias. It may also leverage a specific syntax to finely select
1557 module version (see Advanced module version specifiers section below).
1558 .UNINDENT
1559 .INDENT 0.0
1560 .TP
1561 .B is\-loaded [modulefile...]
1562 Returns a true value if any of the listed \fImodulefiles\fP has been loaded or if
1563 any \fImodulefile\fP is loaded in case no argument is provided. Returns a false
1564 value otherwise. See \fBis\-loaded\fP \%<#\:mfcmd-is-loaded> in the modulefile \%<#\:modulefile-5> man page
1565 for further explanation.
1566 .sp
1567 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1568 modulefile alias. It may also leverage a specific syntax to finely select
1569 module version (see Advanced module version specifiers section below).
1570 .UNINDENT
1571 .INDENT 0.0
1572 .TP
1573 .B is\-saved [collection...]
1574 Returns a true value if any of the listed \fIcollections\fP exists or if any
1575 \fIcollection\fP exists in case no argument is provided. Returns a false value
1576 otherwise. See \fBis\-saved\fP \%<#\:mfcmd-is-saved> in the modulefile \%<#\:modulefile-5> man page for
1577 further explanation.
1578 .UNINDENT
1579 .INDENT 0.0
1580 .TP
1581 .B is\-used [directory...]
1582 Returns a true value if any of the listed \fIdirectories\fP has been enabled in
1583 \fBMODULEPATH\fP or if any \fIdirectory\fP is enabled in case no argument is
1584 provided. Returns a false value otherwise. See \fBis\-used\fP \%<#\:mfcmd-is-used> in the
1585 modulefile \%<#\:modulefile-5> man page for further explanation.
1586 .UNINDENT
1587 .INDENT 0.0
1588 .TP
1589 .B keyword [\-a] [\-j] string
1590 See \fBsearch\fP\&.
1591 .UNINDENT
1592 .INDENT 0.0
1593 .TP
1594 .B lint [\-a] [modulefile...]
1595 Analyze syntax of one or more \fImodulefiles\fP with the linter command
1596 designated by the \fBtcl_linter\fP configuration option.
1597 .sp
1598 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1599 modulefile alias. It may also leverage a specific syntax to finely select
1600 module version (see Advanced module version specifiers section below).
1601 .sp
1602 If no \fImodulefile\fP is specified, all the \fImodulefiles\fP and modulerc
1603 available in enabled modulepaths are analyzed as well as global rc, user rc
1604 and modulecache files . Hidden modulefiles are also analyzed when
1605 \fB\-\-all\fP/\fB\-a\fP option is set.
1606 .sp
1607 When \fBnagelfar.tcl\fP is the selected linter command, a static Tcl
1608 syntax analysis is performed. In addition, syntax of modulefile commands are
1609 checked in these files based on their kind (global/user rc, modulerc,
1610 modulecache or modulefile).
1611 .UNINDENT
1612 .INDENT 0.0
1613 .TP
1614 .B list [\-t|\-l|\-j] [\-a] [\-o LIST] [\-S|\-C] [pattern...]
1615 List loaded modules. If a \fIpattern\fP is given, then the loaded modules are
1616 filtered to only list those whose name matches this \fIpattern\fP\&. It may contain
1617 wildcard characters. \fIpattern\fP is matched in a case insensitive manner by
1618 default. If multiple \fIpatterns\fP are given, loaded module has to match at
1619 least one of them to be listed.
1620 .sp
1621 Module tags applying to the loaded modules are reported along the module name
1622 they are associated to (see Module tags section).
1623 .sp
1624 Module variants selected on the loaded modules are reported along the module
1625 name they belong to (see Module variants section).
1626 .sp
1627 A \fIKey\fP section is added at the end of the output in case some elements are
1628 reported in parentheses or chevrons along module name or if some graphical
1629 rendition is made over some output elements. This \fIKey\fP section gives hints
1630 on the meaning of such elements.
1631 .sp
1632 The parameter \fIpattern\fP may also refer to a symbolic modulefile name or a
1633 modulefile alias. It may also leverage a specific syntax to finely select
1634 module version (see Advanced module version specifiers section below).
1635 .sp
1636 If \fIpattern\fP contains variant specification, loaded modules are included in
1637 results only if they match it. \fIpattern\fP may be a bare variant specification
1638 without mention of a module name.
1639 .UNINDENT
1640 .INDENT 0.0
1641 .TP
1642 .B load [options] modulefile...
1643 Load \fImodulefile\fP into the shell environment.
1644 .sp
1645 \fBload\fP command accepts the following options:
1646 .INDENT 7.0
1647 .IP \(bu 2
1648 \fB\-\-auto|\-\-no\-auto\fP
1649 .IP \(bu 2
1650 \fB\-f|\-\-force\fP
1651 .IP \(bu 2
1652 \fB\-\-tag=taglist\fP
1653 .UNINDENT
1654 .sp
1655 Once loaded, the \fBloaded\fP module tag is associated to the loaded module. If
1656 module has been automatically loaded by another module, the \fBauto\-loaded\fP
1657 tag is associated instead (see Module tags section).
1658 .sp
1659 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1660 modulefile alias. It may also leverage a specific syntax to finely select
1661 module version (see Advanced module version specifiers section below).
1662 .sp
1663 When several \fImodulefiles\fP are passed, they are loaded sequentially in the
1664 specified order. If one modulefile evaluation raises an error, load sequence
1665 continues: loaded modules prior the evaluation error are kept loaded and
1666 sequence is resumed with the load of remaining modulefile in list.
1667 Conversely, load sequence is aborted and already loaded modulefiles are
1668 withdrawn if \fBload\fP sub\-command is defined in
1669 \fBabort_on_error\fP configuration option and \fB\-\-force\fP option
1670 is not set.
1671 .sp
1672 The \fB\-\-tag\fP option accepts a list of module tags to apply to
1673 \fImodulefile\fP once loaded. If module is already loaded, tags from \fItaglist\fP
1674 are added to the list of tags already applied to this module.
1675 .UNINDENT
1676 .INDENT 0.0
1677 .TP
1678 .B load\-any [options] modulefile...
1679 Load into the shell environment one of the \fImodulefile\fP specified. Try to
1680 load each \fImodulefile\fP specified in list from the left to the right until
1681 one got loaded or is found already loaded. Do not complain if \fImodulefile\fP
1682 cannot be found. But if its evaluation fails, an error is reported and next
1683 modulefile in list is evaluated.
1684 .sp
1685 \fBload\-any\fP command accepts the following options:
1686 .INDENT 7.0
1687 .IP \(bu 2
1688 \fB\-\-auto|\-\-no\-auto\fP
1689 .IP \(bu 2
1690 \fB\-f|\-\-force\fP
1691 .IP \(bu 2
1692 \fB\-\-tag=taglist\fP
1693 .UNINDENT
1694 .sp
1695 Once loaded, the \fBloaded\fP module tag is associated to the loaded module. If
1696 module has been automatically loaded by another module, the \fBauto\-loaded\fP
1697 tag is associated instead (see Module tags section).
1698 .sp
1699 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1700 modulefile alias. It may also leverage a specific syntax to finely select
1701 module version (see Advanced module version specifiers section below).
1702 .sp
1703 The \fB\-\-tag\fP option accepts a list of module tags to apply to
1704 \fImodulefile\fP once loaded. If module is already loaded, tags from \fItaglist\fP
1705 are added to the list of tags already applied to this module.
1706 .UNINDENT
1707 .INDENT 0.0
1708 .TP
1709 .B mod\-to\-sh [options] shell modulefile...
1710 Evaluate \fImodulefile\fP and report resulting environment changes as code for
1711 \fIshell\fP\&.
1712 .sp
1713 \fBmod\-to\-sh\fP command accepts the following options:
1714 .INDENT 7.0
1715 .IP \(bu 2
1716 \fB\-\-auto|\-\-no\-auto\fP
1717 .IP \(bu 2
1718 \fB\-f|\-\-force\fP
1719 .UNINDENT
1720 .sp
1721 An attempt to load \fImodulefile\fP is made to get its environment changes. This
1722 evaluation does not change the current shell environment. Like for
1723 \fBload\fP sub\-command, no evaluation occurs if \fImodulefile\fP is found
1724 loaded in current environment.
1725 .sp
1726 Changes made on environment variable intended for Modules private use (e.g.,
1727 \fBLOADEDMODULES\fP, \fB_LMFILES_\fP, \fB__MODULES_*\fP) are ignored.
1728 .sp
1729 \fIShell\fP could be any shell name supported by \fBmodulecmd.tcl\fP\&.
1730 .sp
1731 Produced \fIshell\fP code is returned on the message output channel by
1732 \fBmodulecmd.tcl\fP\&. Thus it is not rendered in current environment by the
1733 \fBmodule\fP shell function.
1734 .sp
1735 \fBmod\-to\-sh\fP automatically set \fBverbosity\fP to the \fBsilent\fP
1736 mode, to avoid messages to mix with the produced shell code. Verbosity is not
1737 changed if set to the \fBtrace\fP mode or any higher debugging level.
1738 .sp
1739 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1740 modulefile alias. It may also leverage a specific syntax to finely select
1741 module version (see Advanced module version specifiers section below).
1742 .sp
1743 When several \fImodulefiles\fP are passed, they are evaluated sequentially in the
1744 specified order. If one modulefile evaluation raises an error, mod\-to\-sh
1745 sequence continues: environment change from modules evaluated prior the
1746 error are preserved and sequence is resumed with the evaluation of remaining
1747 modulefile in list. Conversely, mod\-to\-sh sequence is aborted and changes
1748 from already evaluated modules are withdrawn if \fBmod\-to\-sh\fP
1749 sub\-command is defined in \fBabort_on_error\fP configuration option and
1750 \fB\-\-force\fP option is not set.
1751 .UNINDENT
1752 .INDENT 0.0
1753 .TP
1754 .B path modulefile
1755 Print path to \fImodulefile\fP\&.
1756 .sp
1757 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
1758 modulefile alias. It may also leverage a specific syntax to finely select
1759 module version (see Advanced module version specifiers section below).
1760 .UNINDENT
1761 .INDENT 0.0
1762 .TP
1763 .B paths pattern
1764 Print path of available \fImodulefiles\fP matching \fIpattern\fP\&.
1765 .sp
1766 The parameter \fIpattern\fP may also be a symbolic modulefile name or a
1767 modulefile alias. It may also leverage a specific syntax to finely select
1768 module version (see Advanced module version specifiers section below).
1769 .sp
1770 If \fIpattern\fP contains variant specification or Extra specifier, the
1771 Extra match search process is triggered to collect command information
1772 used in modulefiles. Modules are included in results only if they match
1773 \fIpattern\fP variant specification and extra specifier. \fIpattern\fP may be a bare
1774 variant specification or extra specifier without mention of a module name.
1775 .UNINDENT
1776 .INDENT 0.0
1777 .TP
1778 .B prepend\-path [options] variable value...
1779 Prepend \fIvalue\fP to environment \fIvariable\fP\&. The \fIvariable\fP is a colon, or
1780 \fIdelimiter\fP, separated list. See \fBprepend\-path\fP \%<#\:mfcmd-prepend-path> in the
1781 modulefile \%<#\:modulefile-5> man page for \fIoptions\fP description and further
1782 explanation.
1783 .sp
1784 When \fBprepend\-path\fP is called as a module sub\-command, the reference
1785 counter variable, which denotes the number of times \fIvalue\fP has been added to
1786 environment \fIvariable\fP, is not updated unless if the \fB\-\-duplicates\fP option
1787 is set.
1788 .UNINDENT
1789 .INDENT 0.0
1790 .TP
1791 .B purge [\-f]
1792 Unload all loaded \fImodulefiles\fP\&.
1793 .sp
1794 When the \fB\-\-force\fP option is set, also unload sticky modules,
1795 modulefiles that are depended by non\-unloadable modules and modulefiles
1796 raising an evaluation error.
1797 .sp
1798 If one modulefile unload evaluation raises an error, purge sequence
1799 continues: unloaded modules prior the evaluation error are kept unloaded and
1800 sequence is resumed with the unload of remaining modulefiles. Conversely,
1801 purge sequence is aborted and already unloaded modulefiles are restored if
1802 \fBpurge\fP sub\-command is defined in \fBabort_on_error\fP
1803 configuration option and \fB\-\-force\fP option is not set.
1804 .UNINDENT
1805 .INDENT 0.0
1806 .TP
1807 .B refresh
1808 Force a refresh of all non\-persistent components of currently loaded modules.
1809 This should be used on derived shells where shell completions, shell aliases
1810 or shell functions need to be reinitialized but the environment variables
1811 have already been set by the currently loaded modules.
1812 .sp
1813 Loaded modules are evaluated in \fBrefresh\fP mode following their load order.
1814 In this evaluation mode only the \fBcomplete\fP \%<#\:mfcmd-complete>, \fBset\-alias\fP \%<#\:mfcmd-set-alias>,
1815 \fBset\-function\fP \%<#\:mfcmd-set-function> and \fBputs\fP \%<#\:mfcmd-puts> modulefile commands will produce
1816 environment changes. Other modulefile commands that produce environment
1817 changes (like \fBsetenv\fP \%<#\:mfcmd-setenv> or \fBappend\-path\fP \%<#\:mfcmd-append-path>) are ignored during a
1818 \fBrefresh\fP evaluation as their changes should already be applied.
1819 .sp
1820 Only the loaded modules defining non\-persistent environment changes are
1821 evaluated in \fBrefresh\fP mode. Such loaded modules are listed in the
1822 \fB__MODULES_LMREFRESH\fP environment variable.
1823 .sp
1824 If one modulefile evaluation raises an error, refresh sequence continues:
1825 environment changes from refreshed modules prior the evaluation error are
1826 preserved and sequence is resumed with the refresh of remaining modulefiles.
1827 .UNINDENT
1828 .INDENT 0.0
1829 .TP
1830 .B reload [\-f]
1831 Unload then load all loaded \fImodulefiles\fP\&.
1832 .sp
1833 No unload then load is performed and an error is returned if the loaded
1834 \fImodulefiles\fP have unsatisfied constraint corresponding to the
1835 \fBprereq\fP \%<#\:mfcmd-prereq> and \fBconflict\fP \%<#\:mfcmd-conflict> they declare.
1836 .sp
1837 When the \fB\-\-force\fP option is set, unload modulefiles anyway even if
1838 an evaluation error occurs.
1839 .sp
1840 If one modulefile load or unload evaluation raises an error, reload sequence
1841 aborts: environment changes coming from already evaluated modulefiles are
1842 withdrawn and remaining modulefile evaluations are skipped. Conversely, if
1843 \fBreload\fP is removed from \fBabort_on_error\fP configuration
1844 option list or if \fB\-\-force\fP option is set, reload sequence continues:
1845 already achieved module evaluations are kept and reload sequence is resumed
1846 with the remaining modulefiles.
1847 .UNINDENT
1848 .INDENT 0.0
1849 .TP
1850 .B remove\-path [options] variable value...
1851 Remove \fIvalue\fP from the colon, or \fIdelimiter\fP, separated list in environment
1852 \fIvariable\fP\&. See \fBremove\-path\fP \%<#\:mfcmd-remove-path> in the modulefile \%<#\:modulefile-5> man page for
1853 \fIoptions\fP description and further explanation.
1854 .sp
1855 When \fBremove\-path\fP is called as a module sub\-command, the reference
1856 counter variable, which denotes the number of times \fIvalue\fP has been added to
1857 environment \fIvariable\fP, is ignored and \fIvalue\fP is removed whatever the
1858 reference counter value set.
1859 .UNINDENT
1860 .INDENT 0.0
1861 .TP
1862 .B reset [\-f]
1863 Restore initial environment, which corresponds to the loaded state after
1864 Modules initialization\&.
1865 .sp
1866 \fBreset\fP sub\-command restores the environment definition found in
1867 \fB__MODULES_LMINIT\fP environment variable.
1868 .sp
1869 When the \fB\-\-force\fP option is set, unload modulefiles anyway even if
1870 an evaluation error occurs.
1871 .sp
1872 \fBreset\fP behavior can be changed with \fBreset_target_state\fP\&.
1873 This configuration option is set by default to \fB__init__\fP, which
1874 corresponds to the above behavior description. When set to \fB__purge__\fP,
1875 \fBreset\fP performs a \fBpurge\fP of the environment. When set to
1876 any other value, \fBreset\fP performs a \fBrestore\fP of
1877 corresponding name collection.
1878 .UNINDENT
1879 .INDENT 0.0
1880 .TP
1881 .B restore [\-f] [collection]
1882 Restore the environment state as defined in \fIcollection\fP\&. If \fIcollection\fP
1883 name is not specified, then it is assumed to be the \fIdefault\fP collection if
1884 it exists, \fB__init__\fP special collection otherwise. If \fIcollection\fP is a
1885 fully qualified path, it is restored from this location rather than from a
1886 file under the user\(aqs collection directory. If
1887 \fBMODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the value
1888 of this variable is appended to the \fIcollection\fP file name to restore.
1889 .sp
1890 If \fIcollection\fP name is \fB__init__\fP, initial environment state defined in
1891 \fB__MODULES_LMINIT\fP environment variable is restored.
1892 .sp
1893 When restoring a \fIcollection\fP, the currently set \fBMODULEPATH\fP
1894 directory list and the currently loaded \fImodulefiles\fP are unused and
1895 unloaded then used and loaded to exactly match the \fBMODULEPATH\fP and
1896 loaded \fImodulefiles\fP lists saved in this \fIcollection\fP file. The order
1897 of the paths and modulefiles set in \fIcollection\fP is preserved when
1898 restoring. It means that currently loaded modules are unloaded to get
1899 the same \fBLOADEDMODULES\fP root than collection and currently used
1900 module paths are unused to get the same \fBMODULEPATH\fP root. Then
1901 missing module paths are used and missing modulefiles are loaded.
1902 .sp
1903 If a module, without a default version explicitly defined, is recorded in a
1904 \fIcollection\fP by its bare name: loading this module when restoring the
1905 collection will fail if the configuration option \fBimplicit_default\fP
1906 is disabled.
1907 .sp
1908 If one modulefile load or unload evaluation raises an error, restore sequence
1909 continues: environment changes from modules unloaded or loaded prior the
1910 evaluation error are preserved and sequence is resumed with the unload or
1911 load of remaining modulefiles.
1912 .sp
1913 When the \fB\-\-force\fP option is set, unload modulefiles anyway even if
1914 an evaluation error occurs.
1915 .UNINDENT
1916 .INDENT 0.0
1917 .TP
1918 .B rm [\-\-auto|\-\-no\-auto] [\-f] modulefile...
1919 See \fBunload\fP\&.
1920 .UNINDENT
1921 .INDENT 0.0
1922 .TP
1923 .B save [collection]
1924 Record the currently set \fBMODULEPATH\fP directory list and the
1925 currently loaded \fImodulefiles\fP in a \fIcollection\fP file under the user\(aqs
1926 collection directory \fB$HOME/.module\fP\&. If \fIcollection\fP name is not
1927 specified, then it is assumed to be the \fBdefault\fP collection. If
1928 \fIcollection\fP is a fully qualified path, it is saved at this location rather
1929 than under the user\(aqs collection directory.
1930 .sp
1931 If \fBMODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the
1932 value of this variable will be appended to the \fIcollection\fP file name.
1933 .sp
1934 By default, if a loaded modulefile corresponds to the explicitly defined
1935 default module version, the bare module name is recorded. If the
1936 configuration option \fBimplicit_default\fP is enabled, the bare module
1937 name is also recorded for the implicit default module version. If
1938 \fBMODULES_COLLECTION_PIN_VERSION\fP is set to \fB1\fP, module version is
1939 always recorded even if it is the default version.
1940 .sp
1941 By default, only the module tags specifically set with the \fB\-\-tag\fP
1942 option or resulting from a specific module state (like \fBauto\-loaded\fP and
1943 \fBkeep\-loaded\fP tags) are recorded in collection. If
1944 \fBMODULES_COLLECTION_PIN_TAG\fP is set to \fB1\fP, all tags are recorded
1945 in collection except \fBnearly\-forbidden\fP tag.
1946 .sp
1947 No \fIcollection\fP is recorded and an error is returned if the loaded
1948 \fImodulefiles\fP have unsatisfied constraint corresponding to the
1949 \fBprereq\fP \%<#\:mfcmd-prereq> and \fBconflict\fP \%<#\:mfcmd-conflict> they declare.
1950 .UNINDENT
1951 .INDENT 0.0
1952 .TP
1953 .B savelist [\-t|\-l|\-j] [\-a] [\-S|\-C] [pattern...]
1954 List collections that are currently saved under the user\(aqs collection
1955 directory. If \fBMODULES_COLLECTION_TARGET\fP is set, only collections
1956 matching the target suffix will be displayed unless if the
1957 \fB\-\-all\fP/\fB\-a\fP option is set.
1958 .sp
1959 If a \fIpattern\fP is given, then the collections are filtered to only list
1960 those whose name matches this \fIpattern\fP\&. It may contain wildcard characters.
1961 \fIpattern\fP is matched in a case insensitive manner by default. If multiple
1962 \fIpatterns\fP are given, collection has to match at least one of them to be
1963 listed.
1964 .sp
1965 Stash collections are not listed unless if the \fB\-\-all\fP/\fB\-a\fP
1966 option is set. Stash collections can be listed with \fBstashlist\fP
1967 sub\-command.
1968 .UNINDENT
1969 .INDENT 0.0
1970 .TP
1971 .B saverm [collection]
1972 Delete the \fIcollection\fP file under the user\(aqs collection directory. If
1973 \fIcollection\fP name is not specified, then it is assumed to be the \fIdefault\fP
1974 collection. If \fBMODULES_COLLECTION_TARGET\fP is set, a suffix
1975 equivalent to the value of this variable will be appended to the \fIcollection\fP
1976 file name.
1977 .UNINDENT
1978 .INDENT 0.0
1979 .TP
1980 .B saveshow [collection]
1981 Display the content of \fIcollection\fP\&. If \fIcollection\fP name is not specified,
1982 then it is assumed to be the \fIdefault\fP collection if it exists, \fB__init__\fP
1983 special collection otherwise. If \fIcollection\fP is a fully qualified path, this
1984 location is displayed rather than a collection file under the user\(aqs
1985 collection directory. If \fBMODULES_COLLECTION_TARGET\fP is set, a suffix
1986 equivalent to the value of this variable will be appended to the \fIcollection\fP
1987 file name.
1988 .sp
1989 If \fIcollection\fP name is \fB__init__\fP, initial environment content defined in
1990 \fB__MODULES_LMINIT\fP environment variable is displayed.
1991 .UNINDENT
1992 .INDENT 0.0
1993 .TP
1994 .B search [\-a] [\-j] string
1995 Seeks through the \fBmodule\-whatis\fP \%<#\:mfcmd-module-whatis> information of all \fImodulefiles\fP
1996 for the specified \fIstring\fP\&. All \fImodule\-whatis\fP information matching the
1997 \fIstring\fP in a case insensitive manner will be displayed. \fIstring\fP may contain
1998 wildcard characters.
1999 .UNINDENT
2000 .INDENT 0.0
2001 .TP
2002 .B sh\-to\-mod shell script [arg...]
2003 Evaluate with \fIshell\fP the designated \fIscript\fP with defined \fIarguments\fP to
2004 find out the environment changes it does. Environment prior and after
2005 \fIscript\fP evaluation are compared to determine these changes. They are
2006 translated into \fImodulefile\fP commands to output the modulefile content
2007 equivalent to the evaluation of shell script.
2008 .sp
2009 Changes on environment variables, shell aliases, shell functions, shell
2010 completions and current working directory are tracked.
2011 .sp
2012 Changes made on environment variable intended for Modules private use (e.g.,
2013 \fBLOADEDMODULES\fP, \fB_LMFILES_\fP, \fB__MODULES_*\fP) are ignored.
2014 .sp
2015 \fIShell\fP could be specified as a command name or a fully qualified pathname.
2016 The following shells are supported: sh, dash, csh, tcsh, bash, ksh, ksh93,
2017 zsh and fish.
2018 .sp
2019 \fIShell\fP could also be set to \fBbash\-eval\fP\&. In this mode, bash shell \fIscript\fP
2020 is not sourced but the output resulting from its execution is evaluated to
2021 determine the environment changes it does.
2022 .UNINDENT
2023 .INDENT 0.0
2024 .TP
2025 .B show modulefile...
2026 See \fBdisplay\fP\&.
2027 .UNINDENT
2028 .INDENT 0.0
2029 .TP
2030 .B source [options] modulefile...
2031 Execute \fImodulefile\fP into the shell environment. Once executed \fImodulefile\fP
2032 is not marked loaded in shell environment which differ from \fBload\fP
2033 sub\-command.
2034 .sp
2035 \fBsource\fP command accepts the following options:
2036 .INDENT 7.0
2037 .IP \(bu 2
2038 \fB\-\-auto|\-\-no\-auto\fP
2039 .IP \(bu 2
2040 \fB\-f|\-\-force\fP
2041 .UNINDENT
2042 .sp
2043 If \fImodulefile\fP corresponds to a fully qualified path, this file is executed.
2044 Otherwise \fImodulefile\fP is searched among the available modulefiles.
2045 .sp
2046 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
2047 modulefile alias. It may also leverage a specific syntax to finely select
2048 module version (see Advanced module version specifiers section below).
2049 .sp
2050 When several \fImodulefiles\fP are passed, they are evaluated sequentially in the
2051 specified order. If one modulefile evaluation raises an error, source
2052 sequence continues: environment changes from modules sourced prior the
2053 evaluation error are preserved and sequence is resumed with the source of
2054 remaining modulefile in list.
2055 .UNINDENT
2056 .INDENT 0.0
2057 .TP
2058 .B spider [\-d|\-L] [\-t|\-l|\-j] [\-a] [\-o LIST] [\-S|\-C] [\-\-indepth|\-\-no\-indepth] [pattern...]
2059 List all available \fImodulefiles\fP found in enabled modulepaths and recursively
2060 found in modulepaths enabled by available \fImodulefiles\fP\&.
2061 .sp
2062 \fBspider\fP sub\-command first performs an Extra match search to
2063 get all modulepaths to look at. These modulepaths are collected from the
2064 directory arguments set to the \fBmodule use\fP \%<#\:mfcmd-module>,
2065 \fBappend\-path MODULEPATH\fP \%<#\:mfcmd-append-path> or \fBprepend\-path
2066 MODULEPATH\fP \%<#\:mfcmd-prepend-path> modulefile commands. Collecting modulepaths is
2067 first achieved in the global/user rc section and modulepaths defined in
2068 \fBMODULEPATH\fP then in each modulepath collected from modulefiles, and
2069 so on. As collecting modulepaths implies evaluating every available
2070 modulefiles, it is advised to build and use Module cache to improve
2071 search speed.
2072 .sp
2073 Once modulepaths are gathered, \fBspider\fP proceeds and reports like
2074 \fBavail\fP sub\-command. The same set of options are supported.
2075 .sp
2076 If a \fIpattern\fP argument is given, then each collected modulepath is searched
2077 for \fImodulefiles\fP whose pathname, symbolic version\-name or alias
2078 match \fIpattern\fP in a case insensitive manner by default. \fIpattern\fP may
2079 contain wildcard characters.i
2080 .sp
2081 Symbolic version\-names and aliases found in the search are displayed in the
2082 result of this sub\-command. Symbolic version\-names are displayed next to
2083 the \fImodulefile\fP they are assigned to within parenthesis. Aliases are listed
2084 in the modulepath section where they have been defined. To distinguish
2085 aliases from \fImodulefiles\fP a \fB@\fP symbol is added within parenthesis next to
2086 their name. Aliases defined through a global or user specific module RC file
2087 are listed under the \fBglobal/user modulerc\fP section.
2088 .sp
2089 When colored output is enabled and a specific graphical rendition is defined
2090 for module \fIdefault\fP version, the \fBdefault\fP symbol is omitted and instead
2091 the defined graphical rendition is applied to the relative modulefile. When
2092 colored output is enabled and a specific graphical rendition is defined for
2093 module alias, the \fB@\fP symbol is omitted. The defined graphical rendition
2094 applies to the module alias name. See \fBMODULES_COLOR\fP and
2095 \fBMODULES_COLORS\fP sections for details on colored output.
2096 .sp
2097 Module tags applying to the available \fImodulefiles\fP returned by the
2098 \fBspider\fP sub\-command are reported along the module name they are
2099 associated to (see Module tags section).
2100 .sp
2101 Module variants and their available values may be reported along the module
2102 name they belong to (see Module variants section) if defined in spider
2103 output configuration option (see \fB\-\-output\fP/\fB\-o\fP option). The
2104 Extra match search process is triggered to collect variant
2105 information.
2106 .sp
2107 A \fIKey\fP section is added at the end of the output in case some elements are
2108 reported in parentheses or chevrons along module name or if some graphical
2109 rendition is made over some output elements. This \fIKey\fP section gives hints
2110 on the meaning of such elements.
2111 .sp
2112 The parameter \fIpattern\fP may also refer to a symbolic modulefile name or a
2113 modulefile alias. It may also leverage a specific syntax to finely select
2114 module version (see Advanced module version specifiers section below).
2115 .sp
2116 If \fIpattern\fP contains variant specification or Extra specifier, the
2117 Extra match search process is triggered to collect command information
2118 used in modulefiles. Modules are included in results only if they match
2119 \fIpattern\fP variant specification and extra specifier. \fIpattern\fP may be a bare
2120 variant specification or extra specifier without mention of a module name.
2121 .sp
2122 When several \fIpatterns\fP are provided all modulefiles matching at least one of
2123 these \fIpatterns\fP are listed.
2124 .UNINDENT
2125 .INDENT 0.0
2126 .TP
2127 .B stash [\-f]
2128 \fBSave\fP current environment in a stash collection then
2129 \fBreset\fP to initial environment.
2130 .sp
2131 A collection is created only if current environment state differs from
2132 initial environment. Stash collection is named
2133 \fIstash\-<unix_millis_timestamp>\fP where \fI<unix_millis_timestamp>\fP is the number
2134 of milliseconds between Unix Epoch and when this command is run.
2135 .sp
2136 If \fBMODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the
2137 value of this variable will be appended to the stash collection file name.
2138 .sp
2139 When the \fB\-\-force\fP option is set, unload modulefiles anyway even if
2140 an evaluation error occurs.
2141 .UNINDENT
2142 .INDENT 0.0
2143 .TP
2144 .B stashclear
2145 Remove all stash collection files of current \fBcollection_target\fP\&. If
2146 no collection target is currently set, remove stash collection files without
2147 a target suffix.
2148 .UNINDENT
2149 .INDENT 0.0
2150 .TP
2151 .B stashlist [\-t|\-l|\-j]
2152 List all stash collection files of current \fBcollection_target\fP\&. If
2153 no collection target is currently set, list stash collection files without a
2154 target suffix.
2155 .UNINDENT
2156 .INDENT 0.0
2157 .TP
2158 .B stashpop [\-f] [stash]
2159 \fBRestore\fP \fIstash\fP collection then delete corresponding
2160 collection file.
2161 .sp
2162 \fIstash\fP is either a full stash collection name (i.e.,
2163 \fIstash\-<unix_millis_timestamp>\fP) or a stash index. Most recent stash
2164 collection has index \fI0\fP, \fI1\fP is the one before it. When no \fIstash\fP is given
2165 the latest stash collection is assumed (that is stash index \fI0\fP).
2166 .sp
2167 If \fBMODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the
2168 value of this variable will be appended to the stash collection file name to
2169 restore.
2170 .sp
2171 When the \fB\-\-force\fP option is set, unload modulefiles anyway even if
2172 an evaluation error occurs.
2173 .UNINDENT
2174 .INDENT 0.0
2175 .TP
2176 .B stashrm [stash]
2177 \fBRemove\fP \fIstash\fP collection file.
2178 .sp
2179 \fIstash\fP is either a full stash collection name (i.e.,
2180 \fIstash\-<unix_millis_timestamp>\fP) or a stash index. Most recent stash
2181 collection has index \fI0\fP, \fI1\fP is the one before it. When no \fIstash\fP is given
2182 the latest stash collection is assumed (that is stash index \fI0\fP).
2183 .sp
2184 If \fBMODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the
2185 value of this variable will be appended to the stash collection file name to
2186 delete.
2187 .UNINDENT
2188 .INDENT 0.0
2189 .TP
2190 .B stashshow [stash]
2191 \fBDisplay\fP the content of \fIstash\fP collection file.
2192 .sp
2193 \fIstash\fP is either a full stash collection name (i.e.,
2194 \fIstash\-<unix_millis_timestamp>\fP) or a stash index. Most recent stash
2195 collection has index \fI0\fP, \fI1\fP is the one before it. When no \fIstash\fP is given
2196 the latest stash collection is assumed (that is stash index \fI0\fP).
2197 .sp
2198 If \fBMODULES_COLLECTION_TARGET\fP is set, a suffix equivalent to the
2199 value of this variable will be appended to the stash collection file name to
2200 display.
2201 .UNINDENT
2202 .INDENT 0.0
2203 .TP
2204 .B state [name]
2205 Gets \fBmodulecmd.tcl\fP states. Reports the currently set value
2206 of passed state \fIname\fP or all existing states if no \fIname\fP passed.
2207 .UNINDENT
2208 .INDENT 0.0
2209 .TP
2210 .B swap [options] [modulefile1] modulefile2
2211 See \fBswitch\fP\&.
2212 .UNINDENT
2213 .INDENT 0.0
2214 .TP
2215 .B switch [options] [modulefile1] modulefile2
2216 Switch loaded \fImodulefile1\fP with \fImodulefile2\fP\&. If \fImodulefile1\fP is not
2217 specified, it is assumed to be the currently loaded module that shares the
2218 same root name as \fImodulefile2\fP\&. The root name is defined as the initial part
2219 of a module name, i.e., all characters preceding the first \fB/\fP\&.
2220 .sp
2221 \fBswitch\fP command accepts the following options:
2222 .INDENT 7.0
2223 .IP \(bu 2
2224 \fB\-\-auto|\-\-no\-auto\fP
2225 .IP \(bu 2
2226 \fB\-f|\-\-force\fP
2227 .IP \(bu 2
2228 \fB\-\-tag=taglist\fP
2229 .UNINDENT
2230 .sp
2231 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
2232 modulefile alias. It may also leverage a specific syntax to finely select
2233 module version (see Advanced module version specifiers section below).
2234 .sp
2235 The \fB\-\-tag\fP option accepts a list of module tags to apply to
2236 \fImodulefile\fP once loaded. If module is already loaded, tags from \fItaglist\fP
2237 are added to the list of tags already applied to this module.
2238 .sp
2239 When the \fB\-\-force\fP option is set, unload modulefiles anyway even if
2240 an evaluation error occurs.
2241 .sp
2242 If unload evaluation of \fImodulefile1\fP raises an error, switch sequence
2243 aborts: no environment change from \fImodulefile1\fP unload is applied and load
2244 of \fImodulefile2\fP is skipped. Conversely, if \fBswitch_unload\fP value is
2245 removed from \fBabort_on_error\fP configuration option list (and
2246 \fBswitch\fP value is not set there) or if \fB\-\-force\fP option is set,
2247 switch sequence continues. If \fImodulefile1\fP is tagged \fBsuper\-sticky\fP,
2248 switch sequence aborts in any case.
2249 .sp
2250 If load evaluation of \fImodulefile2\fP raises an error, switch sequence
2251 continues: environment changes from \fImodulefile1\fP unload are applied but not
2252 those from failed \fImodulefile2\fP load. Conversely, whole switch sequence is
2253 aborted and unloaded \fImodulefile1\fP is restored if \fBswitch\fP
2254 sub\-command is defined in \fBabort_on_error\fP configuration option and
2255 \fB\-\-force\fP option is not set.
2256 .UNINDENT
2257 .INDENT 0.0
2258 .TP
2259 .B test modulefile...
2260 Execute and display results of the Module\-specific tests for the
2261 \fImodulefile\fP\&.
2262 .sp
2263 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
2264 modulefile alias. It may also leverage a specific syntax to finely select
2265 module version (see Advanced module version specifiers section below).
2266 .sp
2267 When several \fImodulefiles\fP are passed, they are evaluated sequentially in the
2268 specified order. If one modulefile evaluation raises an error, test sequence
2269 continues.
2270 .UNINDENT
2271 .INDENT 0.0
2272 .TP
2273 .B try\-add [options] modulefile...
2274 See \fBtry\-load\fP\&.
2275 .UNINDENT
2276 .INDENT 0.0
2277 .TP
2278 .B try\-load [options] modulefile...
2279 Like \fBload\fP sub\-command, load \fImodulefile\fP into the shell
2280 environment, but do not complain if \fImodulefile\fP cannot be found. If
2281 \fImodulefile\fP is found but its evaluation fails, error is still reported.
2282 .sp
2283 \fBtry\-load\fP command accepts the following options:
2284 .INDENT 7.0
2285 .IP \(bu 2
2286 \fB\-\-auto|\-\-no\-auto\fP
2287 .IP \(bu 2
2288 \fB\-f|\-\-force\fP
2289 .IP \(bu 2
2290 \fB\-\-tag=taglist\fP
2291 .UNINDENT
2292 .sp
2293 Once loaded, the \fBloaded\fP module tag is associated to the loaded module. If
2294 module has been automatically loaded by another module, the \fBauto\-loaded\fP
2295 tag is associated instead (see Module tags section).
2296 .sp
2297 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
2298 modulefile alias. It may also leverage a specific syntax to finely select
2299 module version (see Advanced module version specifiers section below).
2300 .sp
2301 The \fB\-\-tag\fP option accepts a list of module tags to apply to
2302 \fImodulefile\fP once loaded. If module is already loaded, tags from \fItaglist\fP
2303 are added to the list of tags already applied to this module.
2304 .sp
2305 When several \fImodulefiles\fP are passed, they are try\-loaded sequentially in
2306 the specified order. If one modulefile evaluation raises an error, try\-load
2307 sequence continues: loaded modules prior the evaluation error are kept loaded
2308 and sequence is resumed with the load of remaining modulefile in list.
2309 Conversely, try\-load sequence is aborted and already loaded modulefiles are
2310 withdrawn if \fBtry\-load\fP sub\-command is defined in
2311 \fBabort_on_error\fP configuration option and \fB\-\-force\fP option
2312 is not set.
2313 .UNINDENT
2314 .INDENT 0.0
2315 .TP
2316 .B unload [\-\-auto|\-\-no\-auto] [\-f] modulefile...
2317 Remove \fImodulefile\fP from the shell environment.
2318 .sp
2319 The parameter \fImodulefile\fP may also be a symbolic modulefile name or a
2320 modulefile alias. It may also leverage a specific syntax to finely select
2321 module version (see Advanced module version specifiers section below).
2322 .sp
2323 When the \fB\-\-force\fP option is set, unload modulefiles anyway even if
2324 an evaluation error occurs.
2325 .sp
2326 When several \fImodulefiles\fP are passed, they are unloaded sequentially in the
2327 specified order. If one modulefile evaluation raises an error, unload
2328 sequence continues: unloaded modules prior the evaluation error are kept
2329 unloaded and sequence is resumed with the unload of remaining modulefile in
2330 list. Conversely, unload sequence is aborted and already unloaded modulefiles
2331 are restored if \fBunload\fP sub\-command is defined in
2332 \fBabort_on_error\fP configuration option and \fB\-\-force\fP option
2333 is not set.
2334 .UNINDENT
2335 .INDENT 0.0
2336 .TP
2337 .B unuse directory...
2338 Remove one or more \fIdirectories\fP from the \fBMODULEPATH\fP environment
2339 variable.
2340 .sp
2341 If \fBmodule unuse\fP \%<#\:mfcmd-module> is called during a modulefile evaluation,
2342 the reference counter environment variable
2343 \fB__MODULES_SHARE_MODULEPATH\fP, which denotes
2344 the number of times \fIdirectory\fP has been enabled, is checked and \fIdirectory\fP
2345 is removed only if its relative counter is equal to 1 or not defined.
2346 Otherwise \fIdirectory\fP is kept and reference counter is decreased by 1. When
2347 \fBmodule unuse\fP is called from the command\-line or within an
2348 initialization modulefile script \fIdirectory\fP is removed whatever the
2349 reference counter value set.
2350 .sp
2351 If \fIdirectory\fP corresponds to the concatenation of multiple paths separated
2352 by colon character, each path is treated separately.
2353 .UNINDENT
2354 .INDENT 0.0
2355 .TP
2356 .B update [\-f]
2357 See \fBreload\fP\&.
2358 .UNINDENT
2359 .INDENT 0.0
2360 .TP
2361 .B use [\-a|\-\-append] directory...
2362 Prepend one or more \fIdirectories\fP to the \fBMODULEPATH\fP environment
2363 variable. The \fB\-\-append\fP flag will append the \fIdirectory\fP to
2364 \fBMODULEPATH\fP\&.
2365 .sp
2366 When \fIdirectory\fP is already defined in \fBMODULEPATH\fP, it is not added
2367 again or moved at the end or at the beginning of the environment variable.
2368 .sp
2369 If \fBmodule use\fP \%<#\:mfcmd-module> is called during a modulefile evaluation, the
2370 reference counter environment variable
2371 \fB__MODULES_SHARE_MODULEPATH\fP is also set to
2372 increase the number of times \fIdirectory\fP has been added to
2373 \fBMODULEPATH\fP\&. Reference counter is not updated when
2374 \fBmodule use\fP is called from the command\-line or within an
2375 initialization modulefile script.
2376 .sp
2377 A \fIdirectory\fP that does not exist yet can be specified as argument and then
2378 be added to \fBMODULEPATH\fP\&.
2379 .UNINDENT
2380 .INDENT 0.0
2381 .TP
2382 .B whatis [\-a] [\-j] [pattern...]
2383 Display the information set up by the \fBmodule\-whatis\fP \%<#\:mfcmd-module-whatis> commands inside
2384 \fImodulefiles\fP matching \fIpattern\fP\&. \fIpattern\fP may contain wildcard characters.
2385 If no \fIpattern\fP is specified, all \fBmodule\-whatis\fP \%<#\:mfcmd-module-whatis> lines will be shown.
2386 .sp
2387 The parameter \fIpattern\fP may also be a symbolic modulefile name or a
2388 modulefile alias. It may also leverage a specific syntax to finely select
2389 module version (see Advanced module version specifiers section below).
2390 .sp
2391 If \fIpattern\fP contains variant specification or Extra specifier, the
2392 Extra match search process is triggered to collect command information
2393 used in modulefiles. Modules are included in results only if they match
2394 \fIpattern\fP variant specification and extra specifier. \fIpattern\fP may be a bare
2395 variant specification or extra specifier without mention of a module name.
2396 .UNINDENT
2397 .SS Modulefiles
2398 .sp
2399 \fImodulefiles\fP are written in the Tool Command Language (Tcl) and are
2400 interpreted by \fBmodulecmd.tcl\fP\&. \fImodulefiles\fP can use conditional
2401 statements. Thus the effect a \fImodulefile\fP will have on the environment
2402 may change depending upon the current state of the environment.
2403 .sp
2404 Environment variables are unset when unloading a \fImodulefile\fP\&. Thus, it is
2405 possible to \fBload\fP a \fImodulefile\fP and then \fBunload\fP it without
2406 having the environment variables return to their prior state.
2407 .SS Advanced module version specifiers
2408 .sp
2409 When the advanced module version specifiers mechanism is enabled (see
2410 \fBMODULES_ADVANCED_VERSION_SPEC\fP), the specification of modulefile
2411 passed on Modules sub\-commands changes. After the module name a version
2412 constraint and variants may be added.
2413 .SS Version specifiers
2414 .sp
2415 After the module name a version constraint prefixed by the \fB@\fP character may
2416 be added. It could be directly appended to the module name or separated from
2417 it with a space character.
2418 .sp
2419 Constraints can be expressed to refine the selection of module version to:
2420 .INDENT 0.0
2421 .IP \(bu 2
2422 a single version with the \fB@version\fP syntax, for instance \[email protected]\fP
2423 syntax will select module \fBfoo/1.2.3\fP
2424 .IP \(bu 2
2425 a list of versions with the \fB@version1,version2,...\fP syntax, for instance
2426 \[email protected],1.10\fP will match modules \fBfoo/1.2.3\fP and \fBfoo/1.10\fP
2427 .IP \(bu 2
2428 a range of versions with the \fB@version1:\fP, \fB@:version2\fP and
2429 \fB@version1:version2\fP syntaxes, for instance \[email protected]:\fP will select all
2430 versions of module \fBfoo\fP greater than or equal to \fB1.2\fP, \fBfoo@:1.3\fP
2431 will select all versions less than or equal to \fB1.3\fP and \[email protected]:1.3\fP
2432 matches all versions between \fB1.2\fP and \fB1.3\fP including \fB1.2\fP and
2433 \fB1.3\fP versions
2434 .UNINDENT
2435 .sp
2436 Advanced specification of single version or list of versions may benefit from
2437 the activation of the extended default mechanism (see
2438 \fBMODULES_EXTENDED_DEFAULT\fP) to use an abbreviated notation like \fB@1\fP
2439 to refer to more precise version numbers like \fB1.2.3\fP\&. Range of versions on
2440 its side natively handles abbreviated versions.
2441 .sp
2442 In order to be specified in a range of versions or compared to a range of
2443 versions, the version major element should corresponds to a number. For
2444 instance \fB10a\fP, \fB1.2.3\fP, \fB1.foo\fP are versions valid for range
2445 comparison whereas \fBdefault\fP or \fBfoo.2\fP versions are invalid for range
2446 comparison.
2447 .sp
2448 Range of versions can be specified in version list, for instance
2449 \fBfoo@:1.2,1.4:1.6,1.8:\fP\&. Such specification helps to exclude specific
2450 versions, like versions \fB1.3\fP and \fB1.7\fP in previous example.
2451 .sp
2452 If the implicit default mechanism is also enabled (see
2453 \fBMODULES_IMPLICIT_DEFAULT\fP), a \fBdefault\fP and \fBlatest\fP symbolic
2454 versions are automatically defined for each module name (also at each
2455 directory level for deep \fImodulefiles\fP). These automatic version symbols are
2456 defined unless a symbolic version, alias, or regular module version already
2457 exists for these \fBdefault\fP or \fBlatest\fP version names. Using the
2458 \fBmod@latest\fP (or \fBmod/latest\fP) syntax ensures highest available version
2459 will be selected.
2460 .sp
2461 The symbolic version \fBloaded\fP may be used over loaded module name to
2462 designate the loaded version of the module with associated selected variants.
2463 This version symbol should be specified using the \fB@\fP prefix notation (e.g.,
2464 \fBfoo@loaded\fP). An error is returned if no version of designated module is
2465 currently loaded.
2466 .SS Variants
2467 .sp
2468 After the module name, variants can be specified. Module variants are
2469 alternative evaluation of the same \fImodulefile\fP\&. A variant is specified by
2470 associating a value to its name. This specification is then transmitted to the
2471 evaluating \fImodulefile\fP which instantiates the variant in the
2472 \fBModuleVariant\fP \%<#\:mfvar-ModuleVariant> array variable when reaching the \fBvariant\fP \%<#\:mfcmd-variant>
2473 modulefile command declaring this variant.
2474 .sp
2475 Variant can be specified with the \fBname=value\fP syntax where \fIname\fP is the
2476 declared variant name and \fIvalue\fP, the value this variant is set to when
2477 evaluating the \fImodulefile\fP\&.
2478 .sp
2479 Boolean variants can be specified with the \fB+name\fP syntax to set this
2480 variant on and with the \fB\-name\fP or \fB~name\fP syntaxes to set this variant
2481 off. The \fB\-name\fP syntax is not supported on ml \%<#\:ml-1> command as the
2482 minus sign already means to unload designated module. The \fB~name\fP and
2483 \fB+name\fP syntaxes could also be defined appended to another specification
2484 word (e.g., the module name, version or another variant specification),
2485 whereas \fB\-name\fP syntax must be the start of a new specification word.
2486 .sp
2487 Boolean variants may also be specified with the \fBname=value\fP syntax. \fIvalue\fP
2488 should be set to \fB1\fP, \fBtrue\fP, \fBt\fP, \fByes\fP, \fBy\fP or \fBon\fP to enable
2489 the variant or it should be set to \fB0\fP, \fBfalse\fP, \fBf\fP, \fBno\fP, \fBn\fP or
2490 \fBoff\fP to disable the variant.
2491 .sp
2492 Shortcuts may be used to abbreviate variant specification. The
2493 \fBvariant_shortcut\fP configuration option associates shortcut character
2494 to variant name. With a shortcut defined, variant could be specified with the
2495 \fB<shortcut>value\fP syntax. For instance if character \fB%\fP is set as a
2496 shortcut for variant \fBfoo\fP, the \fB%value\fP syntax is equivalent to the
2497 \fBfoo=value\fP syntax.
2498 .sp
2499 A variant shortcut must be of one character length and must avoid characters
2500 used for other concerns or in module names or version specifications (i.e.,
2501 \fI[\-+~/@=:,a\-zA\-Z0\-9]\fP).
2502 .sp
2503 Variant \fIname\fP should only be composed of characters part of the
2504 \fBA\-Za\-z0\-9_\-\fP range. Also, a variant name cannot start with \fB\-\fP (minus)
2505 character and the overall name cannot just be a number.
2506 .sp
2507 Specific characters used in variant specification syntax cannot be used as
2508 part of the name or version of a module. These specific characters are \fB+\fP,
2509 \fB~\fP, \fB=\fP and all characters set as variant shortcut. Exception is made for
2510 \fB+\fP and \fB~\fP characters if string that follows after does not correspond to
2511 a valid variant name (e.g., \fIname+\fP, \fIname++\fP, \fIname/version+1\fP).
2512 .SS Extra specifier
2513 .sp
2514 After the module name, extra specifiers can be defined in module search
2515 context. Extra specifiers are an extra query to list available modulefiles
2516 based on their content definition. They rely on the Extra match search
2517 mechanism that collects content of available modulefiles.
2518 .sp
2519 Extra specifier can be set with the \fBelement:name[,name,...]\fP syntax where
2520 \fIelement\fP is a Tcl modulefile command and \fIname\fP an item defined by this
2521 command. Depending on the kind of Tcl modulefile command, \fIname\fP can refer to
2522 an environment variable, a shell alias, a module specification, etc.
2523 .sp
2524 Supported extra specifier \fIelements\fP are:
2525 .INDENT 0.0
2526 .IP \(bu 2
2527 \fBvariant\fP, \fBcomplete\fP, \fBuncomplete\fP, \fBset\-alias\fP, \fBunset\-alias\fP,
2528 \fBset\-function\fP, \fBunset\-function\fP, \fBchdir\fP, \fBtag\fP
2529 .IP \(bu 2
2530 \fBsetenv\fP, \fBunsetenv\fP, \fBappend\-path\fP, \fBprepend\-path\fP, \fBremove\-path\fP
2531 and \fBpushenv\fP: these elements related to environment variable handling may
2532 also be aliased \fBenvvar\fP
2533 .IP \(bu 2
2534 \fBfamily\fP and \fBprovide\fP: these elements related to module alias may also
2535 be aliases \fBprovided\-alias\fP
2536 .IP \(bu 2
2537 \fBprereq\fP, \fBprereq\-any\fP, \fBprereq\-all\fP, \fBdepends\-on\fP,
2538 \fBdepends\-on\-any\fP, \fBalways\-load\fP, \fBload\fP, \fBload\-any\fP, \fBtry\-load\fP,
2539 \fBswitch\fP and \fBswitch\-on\fP: these elements related to module requirement
2540 definition accept a module specification as value \fIname\fP and may be aliased
2541 \fBrequire\fP
2542 .IP \(bu 2
2543 \fBconflict\fP, \fBunload\fP, \fBswitch\fP and \fBswitch\-off\fP: these elements
2544 related to module incompatibility definition accept a module specification
2545 as value \fIname\fP and may be aliased \fBincompat\fP
2546 .IP \(bu 2
2547 \fBuse\fP
2548 .UNINDENT
2549 .sp
2550 Each of the above supported \fIelements\fP corresponds to a Tcl modulefile
2551 command. \fBload\fP, \fBload\-any\fP, \fBtry\-load\fP, \fBswitch\fP, \fBunload\fP and
2552 \fBuse\fP match corresponding module sub\-commands. \fBprereq\-any\fP is an alias on
2553 \fBprereq\fP, \fBdepends\-on\-any\fP and vice versa as both Tcl modulefile commands
2554 are the same. Following the same trend \fBprereq\-all\fP is an alias on
2555 \fBdepends\-on\fP and vice versa. Regarding \fBswitch\-off\fP and \fBswitch\-on\fP
2556 elements they correspond respectively to the module to unload (if specified)
2557 and the module to load on a \fBmodule switch\fP command. \fBswitch\fP is an alias
2558 that matches both \fBswitch\-off\fP and \fBswitch\-on\fP elements. \fBrequire\fP and
2559 \fBincompat\fP \fIelements\fP do not match module commands where \fB\-\-not\-req\fP
2560 option is set. Setting the \fBMODULEPATH\fP environment variable with
2561 \fBappend\-path\fP or \fBprepend\-path\fP commands can be queried with \fBuse\fP
2562 element.
2563 .sp
2564 When several \fInames\fP are set on one \fIelement\fP criterion (e.g.,
2565 \fBenv:PATH,LD_LIBRARY_PATH\fP), they act as an \fIOR\fP operation. Which means
2566 modules listed in result are those matching any of the \fIelement\fP \fInames\fP
2567 defined.
2568 .sp
2569 When several extra specifiers are set on a module search query (e.g.,
2570 \fBenv:PATH env:LD_LIBRARY_PATH\fP), they act as an \fIAND\fP operation. Which means
2571 modules listed in result are those matching all extra specifiers defined.
2572 .sp
2573 When an extra specifier is prefixed by \fBnot:\fP (e.g., \fBnot:env:PATH\fP), it
2574 acts as a \fINOT\fP operation. Which means modules listed in result are those not
2575 matching the extra specifier defined.
2576 .sp
2577 Module specification used as \fIname\fP value for some extra specifier \fIelements\fP
2578 may leverage Advanced module version specifiers syntax. However if a
2579 module version range or list is implied, it is currently resolved to existing
2580 modules. Thus it may not match modulefile definitions targeting modules that
2581 do not exist. In addition, module aliases and symbolic versions are not
2582 resolved to their target either if set in extra specifier query or in
2583 modulefile definition.
2584 .sp
2585 Extra specifier can only be set in a module search context (\fBavail\fP,
2586 \fBspider\fP, \fBwhatis\fP and \fBpaths\fP sub\-commands). An error
2587 is raised if used on a module specification query in another context. An error
2588 is also raised if an unknown extra specifier \fIelement\fP is defined in search
2589 query.
2590 .SS Module tags
2591 .sp
2592 Module tags are piece of information that can be associated to individual
2593 modulefiles. Tags could be purely informational or may lead to specific
2594 behaviors.
2595 .sp
2596 Module tags may be inherited from the module state set by a modulefile command
2597 or consequence of a module action. The inherited tags are:
2598 .INDENT 0.0
2599 .IP \(bu 2
2600 \fBauto\-loaded\fP: module has been automatically loaded by another module
2601 .IP \(bu 2
2602 \fBforbidden\fP: module has been set \fIforbidden\fP through the use of the
2603 \fBmodule\-forbid\fP \%<#\:mfcmd-module-forbid> command and thus this module cannot be loaded.
2604 .IP \(bu 2
2605 \fBhidden\fP: module has been set \fIhidden\fP through the use of the
2606 \fBmodule\-hide\fP \%<#\:mfcmd-module-hide> command and thus it is not reported by default among
2607 the result of \fBavail\fP or \fBspider\fP sub\-commands.
2608 .IP \(bu 2
2609 \fBhidden\-loaded\fP: module has been set \fIhidden once loaded\fP through the use
2610 of the \fBmodule\-hide \-\-hidden\-loaded\fP \%<#\:mfcmd-module-hide> command thus it is
2611 not reported by default among the result of a \fBlist\fP sub\-command.
2612 .IP \(bu 2
2613 \fBloaded\fP: module is currently loaded
2614 .IP \(bu 2
2615 \fBnearly\-forbidden\fP: module will soon be \fIforbidden\fP, which has been set
2616 through the use of the \fBmodule\-forbid\fP \%<#\:mfcmd-module-forbid> command. Thus this module
2617 will soon not be able to load anymore.
2618 .IP \(bu 2
2619 \fBwarning\fP: a warning message for the use of the module is set through the
2620 use of the \fBmodule\-warn\fP \%<#\:mfcmd-module-warn> command.
2621 .UNINDENT
2622 .sp
2623 Tags may also be associated to modules by using the \fBmodule\-tag\fP \%<#\:mfcmd-module-tag>
2624 modulefile command. Among tags that could be set this way, some have a special
2625 meaning:
2626 .INDENT 0.0
2627 .IP \(bu 2
2628 \fBkeep\-loaded\fP: auto\-loaded module cannot be automatically unloaded. This
2629 tag is also set through the use of the \fBalways\-load\fP \%<#\:mfcmd-always-load> command.
2630 .IP \(bu 2
2631 \fBsticky\fP: module once loaded cannot be unloaded unless forced or reloaded
2632 (see Sticky modules section)
2633 .IP \(bu 2
2634 \fBsuper\-sticky\fP: module once loaded cannot be unloaded unless reloaded,
2635 module cannot be unloaded even if forced (see Sticky modules section)
2636 .UNINDENT
2637 .sp
2638 The \fB\-\-tag\fP option helps to apply additional tags to modules. It is
2639 available on \fBload\fP, \fBload\-any\fP, \fBswitch\fP and
2640 \fBtry\-load\fP sub\-commands and on \fBalways\-load\fP \%<#\:mfcmd-always-load>,
2641 \fBdepends\-on\fP \%<#\:mfcmd-depends-on>, \fBdepends\-on\-any\fP \%<#\:mfcmd-depends-on-any>, \fBmodule\fP \%<#\:mfcmd-module>,
2642 \fBprereq\fP \%<#\:mfcmd-prereq>, \fBprereq\-all\fP \%<#\:mfcmd-prereq-all> and \fBprereq\-any\fP \%<#\:mfcmd-prereq-any> modulefile
2643 commands. In case the designated module is already loaded, the additional tags
2644 are added to the list of tags already applied to this module.
2645 .sp
2646 Module tags are reported along the module they are associated to on
2647 \fBavail\fP, \fBlist\fP and \fBspider\fP sub\-command results and
2648 also when module\(aqs loading, unloading, refreshing or tagging evaluation is
2649 mentioned. Tags could be reported either:
2650 .INDENT 0.0
2651 .IP \(bu 2
2652 along the module name, all tags set within angle brackets, each tag
2653 separated from the others with a colon character (e.g.,
2654 \fBfoo/1.2 <tag1:tag2>\fP).
2655 .IP \(bu 2
2656 graphically rendered over the module name for each tag associated to a
2657 Select Graphic Rendition (SGR) code in the color palette (see
2658 \fBMODULES_COLORS\fP)
2659 .UNINDENT
2660 .sp
2661 When an abbreviated string is associated to a tag name (see
2662 \fBMODULES_TAG_ABBREV\fP), this abbreviation is used to report tag along
2663 the module name or the tag is graphically rendered over the module name if a
2664 SGR code is associated with tag abbreviation in the color palette. With an
2665 abbreviation set, the SGR code associated to the tag full name is ignored thus
2666 an SGR code should be associated to the abbreviation to get a graphical
2667 rendering of tag. If the abbreviation associated to a tag corresponds to the
2668 empty string, tag is not reported.
2669 .sp
2670 Graphical rendering is made over the tag name or abbreviation instead of over
2671 the module name for each tag name or abbreviation set in the
2672 \fBMODULES_TAG_COLOR_NAME\fP environment variable.
2673 .sp
2674 When several tags have to be rendered graphically over the same module name,
2675 each tag is rendered over a sub\-part of the module name. In case more tags
2676 need to be rendered than the total number of characters in the module name,
2677 the remaining tags are graphically rendered over the tag name instead of over
2678 the module name.
2679 .sp
2680 When the JSON output mode is enabled (with \fB\-\-json\fP), tags are
2681 reported by their name under the \fBtags\fP attribute. Tag abbreviation and
2682 color rendering do not apply on JSON output.
2683 .sp
2684 Module tags cannot be used in search query to designate a modulefile.
2685 .SS Sticky modules
2686 .sp
2687 Modules are said \fIsticky\fP when they cannot be unloaded (they stick to the
2688 loaded environment). Two kind of stickiness can be distinguished:
2689 .INDENT 0.0
2690 .IP \(bu 2
2691 \fBsticky\fP module: cannot be unloaded unless if the unload is forced or if
2692 the module is reloaded after being unloaded or if restoring a collection.
2693 .IP \(bu 2
2694 \fBsuper\-sticky\fP module: cannot be unloaded unless if the module is reloaded
2695 after being unloaded; super\-sticky modules cannot be unloaded even if the
2696 unload is forced.
2697 .UNINDENT
2698 .sp
2699 Modules are designated sticky by associating them the \fBsticky\fP or the
2700 \fBsuper\-sticky\fP module tag with the \fBmodule\-tag\fP \%<#\:mfcmd-module-tag>
2701 modulefile command.
2702 .sp
2703 When stickiness is defined over the generic module name (and not over a
2704 specific module version, a version list or a version range), sticky or
2705 super\-sticky module can be swapped by another version of module. For instance
2706 if the \fBsticky\fP tag is defined over \fIfoo\fP module, loaded module \fIfoo/1.2\fP
2707 can be swapped by \fIfoo/2.0\fP\&. Such stickiness definition means one version of
2708 module should stay loaded whatever version it is.
2709 .sp
2710 When restoring a collection or resetting to the initial
2711 environment, sticky modules are unloaded to ensure \fBrestore\fP or
2712 \fBreset\fP sub\-commands fully set the environment in target collection or
2713 initial state. Super\-sticky modules still cannot be unloaded with
2714 \fBrestore\fP and \fBreset\fP sub\-commands.
2715 .SS Module variants
2716 .sp
2717 Module variants are alternative evaluation of the same \fImodulefile\fP\&. A variant
2718 is specified by associating a value to its name when designating module.
2719 Variant specification relies on the Advanced module version specifiers
2720 mechanism.
2721 .sp
2722 Once specified, variant\(aqs value is transmitted to the evaluating \fImodulefile\fP
2723 which instantiates the variant in the \fBModuleVariant\fP \%<#\:mfvar-ModuleVariant> array variable
2724 when reaching the \fBvariant\fP \%<#\:mfcmd-variant> modulefile command declaring this variant.
2725 For instance the \fBmodule load foo/1.2 bar=value1\fP command leads to the
2726 evaluation of \fIfoo/1.2\fP modulefile with \fIbar=value1\fP variant specification.
2727 When reaching the \fBvariant bar value1 value2 value3\fP command in modulefile
2728 during its evaluation, the \fBModuleVariant(bar)\fP array element is set to
2729 the \fBvalue1\fP string.
2730 .sp
2731 Once variants are instantiated, modulefile\(aqs code could check the variant
2732 values to adapt the evaluation and define for instance different module
2733 requirements or produce different environment variable setup.
2734 .sp
2735 Variants are interpreted in contexts where \fImodulefiles\fP are evaluated.
2736 Variants specified on module designation are ignored by the
2737 \fBis\-avail\fP or \fBpath\fP sub\-commands. On search sub\-commands
2738 (\fBavail\fP, \fBspider\fP, \fBwhatis\fP and \fBpaths\fP),
2739 variants are interpreted and trigger the Extra match search process to
2740 filter results.
2741 .sp
2742 When modulefile is evaluated a value should be specified for each variant this
2743 modulefile declares. When reaching the \fBvariant\fP \%<#\:mfcmd-variant> modulefile command
2744 declaring a variant, an error is raised if no value is specified for this
2745 variant and if no default value is declared. Specified variant value should
2746 match a value from the declared accepted value list if such list is defined
2747 otherwise an error is raised. Additionally if a variant is specified but does
2748 not correspond to a variant declared in modulefile, an error is raised.
2749 .sp
2750 When searching for modules with variants specified in search query, the
2751 Extra match search process triggers a specific \fIscan\fP modulefile
2752 evaluation. Variants defined in modulefile are collected during this
2753 evaluation then compared to the variants specified in search query. If there
2754 is a match, module is included in search results otherwise it is withdrawn.
2755 .sp
2756 When searching for available modules, if one variant is specified multiple
2757 times, matching modules are those providing all specified variant values. For
2758 instance \fBbar=value1 bar=value2\fP will return modules defining a \fBbar\fP
2759 variant with \fBvalue1\fP and \fBvalue2\fP as available values. On a module
2760 selection context, only the last specified value is retained. Which means on
2761 previous example that \fBbar\fP variant is set to \fBvalue2\fP\&.
2762 .sp
2763 When searching for available modules, multiple values may be set on one
2764 variant criterion, which matches modules that provide any of these variant
2765 values. For instance \fBbar=value1,value2\fP will return modules defining a
2766 \fBbar\fP variant with either \fBvalue1\fP or \fBvalue2\fP as available value.
2767 .sp
2768 When searching for available modules, \fBnot:\fP prefix may be added on variant
2769 criterion, which matches modules that do not provide these variant values. For
2770 instance \fBnot:bar=value1\fP will return modules not defining a \fBbar\fP variant
2771 or defining a \fBbar\fP variant but without \fBvalue1\fP among available values.
2772 .sp
2773 Module variants are reported along the module they are associated to on
2774 \fBlist\fP sub\-command results. They are also reported on \fBavail\fP
2775 and \fBspider\fP sub\-commands if specified in search query or added to the
2776 element to report in sub\-command output (see \fB\-\-output\fP/\fB\-o\fP
2777 option).
2778 .sp
2779 Variants are reported within curly braces next to module name, each variant
2780 definition separated from the others with a colon character (e.g.,
2781 \fBfoo/1.2{variant1=value:+variant2}\fP). Boolean variants are reported with the
2782 \fB+name\fP or \fB\-name\fP syntaxes on \fBlist\fP sub\-command or with the
2783 \fBname=on,off\fP syntax on \fBavail\fP and \fBspider\fP sub\-commands.
2784 When a shortcut character is defined for a variant (see
2785 \fBMODULES_VARIANT_SHORTCUT\fP) it is reported with the
2786 \fB<shortcut>value\fP syntax. For instance if \fB%\fP character is defined as a
2787 shortcut for \fIvariant1\fP: \fBfoo/1.2{%value:+variant2}\fP\&.
2788 .sp
2789 When the JSON output mode is enabled (with \fB\-\-json\fP), variants are
2790 reported under the \fBvariants\fP JSON object as name/value pairs. Values of
2791 Boolean variant are set as JSON Boolean. Other values are set as JSON strings.
2792 Variant shortcut and color rendering do not apply on JSON output.
2793 .SS Extra match search
2794 .sp
2795 Extra match search is a mechanism that evaluates available modulefiles during
2796 a module search to find those matching an extra query or to report additional
2797 information. After selecting modulefiles that match the module name and
2798 version specified in search query, these remaining modulefiles are evaluated
2799 to collect their content.
2800 .sp
2801 Extra match search is available on the following module search sub\-commands:
2802 \fBavail\fP, \fBspider\fP, \fBwhatis\fP and \fBpaths\fP\&.
2803 .sp
2804 Extra match search is triggered when:
2805 .INDENT 0.0
2806 .IP \(bu 2
2807 Module variants and their available values have to be reported in
2808 avail and spider outputs (see \fB\-\-output\fP/\fB\-o\fP option): extra
2809 match search is triggered to collect variant information
2810 .IP \(bu 2
2811 Provided module aliases have to be reported in avail and spider outputs (see
2812 \fB\-\-output\fP/\fB\-o\fP option): extra match search is triggered to
2813 collect these module aliases defined within modulefiles
2814 .IP \(bu 2
2815 Module variant is specified in search query: extra match search is triggered
2816 to collect variant information then match them against variant specified in
2817 query
2818 .IP \(bu 2
2819 Extra specifier is specified in search query: extra match search is
2820 triggered to collect commands used in modulefiles or modulercs then match
2821 them against extra specifier query
2822 .UNINDENT
2823 .sp
2824 If search query does not contain an extra query and if variant or provided
2825 alias information should not be reported, no extra match search is performed.
2826 If search query does not contain any module name and version but contains an
2827 extra query or if variant information should be reported, extra match search
2828 is applied to all available modulefiles. If provided alias information should
2829 be reported, extra match search is applied to all available modulefiles even
2830 if search query contains a module specification.
2831 .sp
2832 During this specific evaluation, modulefiles are interpreted in \fIscan\fP mode.
2833 This mode aims to collect the different Tcl modulefile commands used. Special
2834 care should be given when writing modulefiles to ensure they cope with such
2835 evaluation mode.
2836 .sp
2837 Modulefiles tagged \fIforbidden\fP are excluded from extra match search
2838 evaluation. Thus they are excluded from result when this mechanism is
2839 triggered.
2840 .sp
2841 No \fIscan\fP modulefile evaluation is performed if search query is only composed
2842 of \fBtag\fP extra specifier. Module tags are defined in modulercs thus no
2843 modulefile evaluation is required to get tags applying to a modulefile.
2844 .sp
2845 As extra match search implies additional modulefile evaluations, it is advised
2846 to build and use Module cache to improve search speed.
2847 .SS Collections
2848 .sp
2849 Collections describe a sequence of \fBmodule use\fP then
2850 \fBmodule load\fP commands that are interpreted by
2851 \fBmodulecmd.tcl\fP to set the user environment as described by this
2852 sequence.
2853 .sp
2854 Collections are generated by the \fBsave\fP sub\-command that dumps the
2855 current user environment state in terms of module paths and loaded modules. By
2856 default collections are saved under the \fB$HOME/.module\fP directory.
2857 .INDENT 0.0
2858 .INDENT 3.5
2859 .sp
2860 .EX
2861 $ module list
2862 Currently Loaded Modulefiles:
2863 1) foo/1.2 2) bar/2.0 3) qux/3.5
2864 $ module save foo
2865 $ cat $HOME/.module/foo
2866 module use \-\-append /path/to/modulefiles
2867 module load foo
2868 module load bar/2.0
2869 module load qux/3.5
2870 .EE
2871 .UNINDENT
2872 .UNINDENT
2873 .sp
2874 The content of a collection can also be displayed with the \fBsaveshow\fP
2875 sub\-command. Note that in the above example, bare module name is recorded for
2876 \fBfoo\fP modulefile as loaded version is the implicit default. Loaded version
2877 recording can be enforced by enabling \fBcollection_pin_version\fP
2878 configuration option.
2879 .INDENT 0.0
2880 .INDENT 3.5
2881 .sp
2882 .EX
2883 $ module config collection_pin_version 1
2884 $ module save foo
2885 $ module saveshow foo
2886 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
2887 /home/user/.module/foo:
2888
2889 module use \-\-append /path/to/modulefiles
2890 module load foo/1.2
2891 module load bar/2.0
2892 module load qux/3.5
2893
2894 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
2895 .EE
2896 .UNINDENT
2897 .UNINDENT
2898 .sp
2899 When a collection is activated, with the \fBrestore\fP
2900 sub\-command, module paths and loaded modules are unused or unloaded if they
2901 are not part or if they are not ordered the same way as in the collection.
2902 .INDENT 0.0
2903 .INDENT 3.5
2904 .sp
2905 .EX
2906 $ module list
2907 Currently Loaded Modulefiles:
2908 1) foo/1.2 2) bar/2.1 3) qux/3.5
2909 $ module restore foo
2910 Unloading qux/3.5
2911 Unloading bar/2.1
2912 Loading bar/2.0
2913 Loading qux/3.5
2914 $ module list
2915 Currently Loaded Modulefiles:
2916 1) foo/1.2 2) bar/2.0 3) qux/3.5
2917 .EE
2918 .UNINDENT
2919 .UNINDENT
2920 .sp
2921 In the above example, second and third module loaded are changed. First loaded
2922 module is not changed or reloaded as it is the same module between current
2923 environment and collection. As second loaded module was different, this module
2924 and all those loaded afterward are unloaded to then load the sequence
2925 described by collection. As a result, third loaded module is reloaded, even if
2926 is was the same module between current environment and collection.
2927 .sp
2928 Existing collections can be listed with \fBsavelist\fP sub\-command. They
2929 can be deleted with \fBsaverm\fP sub\-command.
2930 .INDENT 0.0
2931 .INDENT 3.5
2932 .sp
2933 .EX
2934 $ module savelist
2935 Named collection list:
2936 1) default 2) foo
2937 $ module saverm default
2938 $ module savelist
2939 Named collection list:
2940 1) foo
2941 .EE
2942 .UNINDENT
2943 .UNINDENT
2944 .sp
2945 When no argument is provided to \fBsave\fP, \fBrestore\fP,
2946 \fBsaveshow\fP or \fBsaverm\fP sub\-commands, the \fBdefault\fP
2947 collection is assumed.
2948 .sp
2949 Collection can also be specified as a full pathname:
2950 .INDENT 0.0
2951 .INDENT 3.5
2952 .sp
2953 .EX
2954 $ module save /path/to/collections/bar
2955 $ module saveshow /path/to/collections/bar
2956 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
2957 /path/to/collections/bar:
2958
2959 module use \-\-append /path/to/modulefiles
2960 module load foo/1.2
2961 module load bar/2.0
2962 module load qux/3.5
2963
2964 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
2965 .EE
2966 .UNINDENT
2967 .UNINDENT
2968 .SS Initial environment
2969 .sp
2970 Initial environment state, which corresponds to modulepaths enabled and
2971 modules loaded during Modules initialization,
2972 is referred as the \fB__init__\fP collection. This collection is virtual as
2973 its content is stored in the \fB__MODULES_LMINIT\fP and not in a file. It
2974 can be displayed with \fBsaveshow\fP and restored with \fBrestore\fP
2975 sub\-command.
2976 .INDENT 0.0
2977 .INDENT 3.5
2978 .sp
2979 .EX
2980 $ module saveshow __init__
2981 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
2982 initial environment:
2983
2984 module use \-\-append /path/to/modulefiles
2985 module load foo/1.2
2986
2987 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
2988 .EE
2989 .UNINDENT
2990 .UNINDENT
2991 .sp
2992 If the \fBdefault\fP collection does not exist, \fBsaveshow\fP and
2993 \fBrestore\fP sub\-commands assume \fB__init__\fP collection when no argument
2994 provided to them.
2995 .INDENT 0.0
2996 .INDENT 3.5
2997 .sp
2998 .EX
2999 $ module list
3000 Currently Loaded Modulefiles:
3001 1) foo/1.2 2) bar/2.1 3) qux/3.5
3002 $ module savelist
3003 Named collection list:
3004 1) foo
3005 $ module restore
3006 Unloading qux/3.5
3007 Unloading bar/2.1
3008 .EE
3009 .UNINDENT
3010 .UNINDENT
3011 .sp
3012 Initial environment state can also be restored with the \fBreset\fP
3013 sub\-command. This sub\-command behavior can be changed with
3014 \fBreset_target_state\fP configuration option to choose to just purge
3015 loaded modules or to restore a specific collection.
3016 .SS Collection targets
3017 .sp
3018 A collection target can be defined for current environment session with the
3019 \fBcollection_target\fP configuration option. When set, available
3020 collections are reduced to those suffixed with target name. Which means
3021 \fBrestore\fP, \fBsaveshow\fP, \fBsavelist\fP and \fBsaverm\fP
3022 only find collections matching currently set target.
3023 .INDENT 0.0
3024 .INDENT 3.5
3025 .sp
3026 .EX
3027 $ module savelist
3028 Named collection list:
3029 1) foo
3030 $ module config collection_target mytarget
3031 $ module savelist
3032 No named collection (for target \(dqmytarget\(dq).
3033 $ module restore foo
3034 ERROR: Collection foo (for target \(dqmytarget\(dq) cannot be found
3035 .EE
3036 .UNINDENT
3037 .UNINDENT
3038 .sp
3039 When saving a new collection, generated file is suffixed with currently set
3040 target name.
3041 .INDENT 0.0
3042 .INDENT 3.5
3043 .sp
3044 .EX
3045 $ module save bar
3046 $ module savelist
3047 Named collection list (for target \(dqmytarget\(dq):
3048 1) bar
3049 $ ls $HOME/.module
3050 bar.mytarget foo
3051 .EE
3052 .UNINDENT
3053 .UNINDENT
3054 .sp
3055 Collection targets help to distinguish contexts and make collection reachable
3056 only from the context they have been made for. For instance the same user
3057 account may be used to access different OSes or machine architectures. With a
3058 target set, users are ensured to only access collections built for the context
3059 they are currently connected to. See also \fBMODULES_COLLECTION_TARGET\fP
3060 section.
3061 .SS Stash collections
3062 .sp
3063 Current user environment can be stashed with \fBstash\fP sub\-command. When
3064 this sub\-command is called, current module environment is saved in a stash
3065 collection then initial environment is restored.
3066 .INDENT 0.0
3067 .INDENT 3.5
3068 .sp
3069 .EX
3070 $ module list
3071 Currently Loaded Modulefiles:
3072 1) foo/1.2 2) qux/4.2
3073 $ module stash
3074 Unloading qux/4.2
3075 .EE
3076 .UNINDENT
3077 .UNINDENT
3078 .sp
3079 Specific sub\-commands are available to handle stash collections:
3080 \fBstashpop\fP, \fBstashlist\fP, \fBstashshow\fP,
3081 \fBstashrm\fP and \fBstashclear\fP\&. A stash collection is restored
3082 with \fBstashpop\fP which also deletes the collection once restored.
3083 .INDENT 0.0
3084 .INDENT 3.5
3085 .sp
3086 .EX
3087 $ module stashlist
3088 Stash collection list (for target \(dqmytarget\(dq):
3089 0) stash\-1667669750191
3090 $ module stashpop
3091 Loading qux/4.2
3092 $ module stashlist
3093 No stash collection (for target \(dqmytarget\(dq).
3094 .EE
3095 .UNINDENT
3096 .UNINDENT
3097 .sp
3098 Stash collections have same format and are saved in the same location than
3099 other collections. Collection target also applies to stash collection.
3100 Creation timestamp is saved in stash collection name.
3101 .sp
3102 Stash collection can be designated by their full collection name (i.e.,
3103 \fIstash\-<creation_timestamp>\fP) or a stash index. Most recent stash
3104 collection has index \fI0\fP, \fI1\fP is the one before it. When no argument is
3105 provided on stash sub\-commands, the latest stash collection is assumed (that
3106 is stash index \fI0\fP).
3107 .INDENT 0.0
3108 .INDENT 3.5
3109 .sp
3110 .EX
3111 $ module stashlist
3112 Stash collection list (for target \(dqmytarget\(dq):
3113 0) stash\-1667669750783 1) stash\-1667669750253
3114 $ module stashshow 1
3115 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
3116 /home/user/.module/stash\-1667669750253.mytarget:
3117
3118 module use \-\-append /path/to/modulefiles
3119 module load foo/1.2
3120 module load bar/2.0
3121
3122 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
3123 .EE
3124 .UNINDENT
3125 .UNINDENT
3126 .SS Site\-specific configuration
3127 .sp
3128 Siteconfig, the site\-specific configuration script, is a way to extend
3129 \fBmodulecmd.tcl\fP\&. Siteconfig is a Tcl script. Its location is
3130 \fB@etcdir@/siteconfig.tcl\fP\&.
3131 .sp
3132 When \fBmodulecmd.tcl\fP is invoked it sources siteconfig script if it
3133 exists. Any global variable or procedure of \fBmodulecmd.tcl\fP can be
3134 redefined in siteconfig.
3135 .sp
3136 An additional siteconfig script may be specified through the
3137 \fBextra_siteconfig\fP configuration option. The
3138 \fBMODULES_SITECONFIG\fP environment variable is defined by
3139 \fBconfig\fP sub\-command when setting \fBextra_siteconfig\fP\&. If it
3140 exists the extra siteconfig is sourced by \fBmodulecmd.tcl\fP right after
3141 main siteconfig script.
3142 .SS Hooks
3143 .sp
3144 Siteconfig relies on the ability of the Tcl language to overwrite previously
3145 defined variables and procedures. Sites may deploy their own Tcl code in
3146 siteconfig to adapt \fBmodulecmd.tcl\fP to their specific needs. The
3147 \fBtrace\fP Tcl command may especially be used to define hooks that are run when
3148 entering or leaving a given procedure, or when a variable is read or written.
3149 See \fBtrace(n)\fP man page for detailed information. The following
3150 example setup a procedure that is executed before each modulefile evaluation:
3151 .INDENT 0.0
3152 .INDENT 3.5
3153 .sp
3154 .EX
3155 proc beforeEval {cmdstring code result op} {
3156 # code to run right before each modulefile evaluation
3157 }
3158 trace add execution execute\-modulefile enter beforeEval
3159 .EE
3160 .UNINDENT
3161 .UNINDENT
3162 .sp
3163 Another possibility is to override the definition of an existing procedure by
3164 first renaming its original version then creating a new procedure that will add
3165 specific code and rely on the renamed original procedure for the rest. See
3166 \fBrename(n)\fP man page for details. As an example, the following code
3167 adds a new query option to the \fBmodule\-info\fP \%<#\:mfcmd-module-info> modulefile command:
3168 .INDENT 0.0
3169 .INDENT 3.5
3170 .sp
3171 .EX
3172 rename module\-info __module\-info
3173 proc module\-info {what {more {}}} {
3174 switch \-\- $what {
3175 platform { return myhost\-$::tcl_platform(machine) }
3176 default { return [__module\-info $what $more] }
3177 }
3178 }
3179 .EE
3180 .UNINDENT
3181 .UNINDENT
3182 .sp
3183 If a hook procedure needs to execute modulefile commands (for example, to
3184 define environment variables), these commands should be run through the
3185 current modulefile Tcl interpreter. This ensures that the commands behave
3186 consistently with the current modulefile evaluation mode.
3187 .INDENT 0.0
3188 .INDENT 3.5
3189 .sp
3190 .EX
3191 proc hook_procedure {value} {
3192 # get the name of the current modulefile Tcl interpreter
3193 set modfile_interp [getCurrentModfileInterpName]
3194
3195 # execute a modulefile command in the current interpreter context
3196 interp eval $modfile_interp setenv MYVAR $value
3197 }
3198 .EE
3199 .UNINDENT
3200 .UNINDENT
3201 .SS Siteconfig hook variables
3202 .sp
3203 Some Tcl variables can be defined in siteconfig script with special hook
3204 meaning. The following variables are recognized:
3205 .INDENT 0.0
3206 .TP
3207 .B modulefile_extra_vars
3208 List of variable names and associated values to setup in modulefile
3209 evaluation context. These variables can be accessed when modulefile is
3210 executed. In case code in a modulefile changes the value of such variable,
3211 its value is reset to the one defined in \fBmodulefile_extra_vars\fP
3212 prior the evaluation of the next modulefile.
3213 .INDENT 7.0
3214 .INDENT 3.5
3215 .sp
3216 .EX
3217 set modulefile_extra_vars {myvar 1 othervar {some text}}
3218 .EE
3219 .UNINDENT
3220 .UNINDENT
3221 .sp
3222 In the above siteconfig example, \fBmodulefile_extra_vars\fP sets the
3223 \fBmyvar\fP and \fBothervar\fP variables in the modulefile evaluation context
3224 with respectively \fB1\fP and \fBsome text\fP as value.
3225 .UNINDENT
3226 .INDENT 0.0
3227 .TP
3228 .B modulefile_extra_cmds
3229 List of command and associated local procedure to setup in modulefile
3230 evaluation context. These commands can be called from the modulefile to
3231 execute associated procedure. In case a modulefile changes the definition
3232 of such command, its definition is bound again on the procedure defined in
3233 \fBmodulefile_extra_cmds\fP prior the evaluation of the next modulefile.
3234 .INDENT 7.0
3235 .INDENT 3.5
3236 .sp
3237 .EX
3238 proc mycmd {} {
3239 # Tcl code
3240 }
3241 proc anotherproc {args} {
3242 # Tcl code
3243 }
3244 set modulefile_extra_cmds {mycmd mycmd othercmd anotherproc}
3245 .EE
3246 .UNINDENT
3247 .UNINDENT
3248 .sp
3249 In the above siteconfig example, \fBmodulefile_extra_cmds\fP sets the
3250 \fBmycmd\fP and \fBothercmd\fP commands in the modulefile evaluation context and
3251 bind them respectively to the \fBmycmd\fP and \fBanotherproc\fP procedures
3252 defined in siteconfig script.
3253 .UNINDENT
3254 .INDENT 0.0
3255 .TP
3256 .B modulerc_extra_vars
3257 List of variable names and associated values to setup in modulerc evaluation
3258 context. These variables can be accessed when modulerc is executed. In case
3259 code in a modulerc changes the value of such variable, its value
3260 is reset to the one defined in \fBmodulerc_extra_vars\fP prior the
3261 evaluation of the next modulerc.
3262 .INDENT 7.0
3263 .INDENT 3.5
3264 .sp
3265 .EX
3266 set modulerc_extra_vars {myvar 1 othervar {some text}}
3267 .EE
3268 .UNINDENT
3269 .UNINDENT
3270 .sp
3271 In the above siteconfig example, \fBmodulerc_extra_vars\fP sets the
3272 \fBmyvar\fP and \fBothervar\fP variables in the modulerc evaluation context with
3273 respectively \fB1\fP and \fBsome text\fP as value.
3274 .UNINDENT
3275 .INDENT 0.0
3276 .TP
3277 .B modulerc_extra_cmds
3278 List of command and associated local procedure to setup in modulerc
3279 evaluation context. These commands can be called from the modulerc to execute
3280 associated procedure. In case a modulerc changes the definition of such
3281 command, its definition is bound again on the procedure defined in
3282 \fBmodulerc_extra_cmds\fP prior the evaluation of the next modulerc.
3283 .INDENT 7.0
3284 .INDENT 3.5
3285 .sp
3286 .EX
3287 proc mycmd {} {
3288 # Tcl code
3289 }
3290 proc anotherproc {args} {
3291 # Tcl code
3292 }
3293 set modulerc_extra_cmds {mycmd mycmd othercmd anotherproc}
3294 .EE
3295 .UNINDENT
3296 .UNINDENT
3297 .sp
3298 In the above siteconfig example, \fBmodulerc_extra_cmds\fP sets the
3299 \fBmycmd\fP and \fBothercmd\fP commands in the modulerc evaluation context and
3300 bind them respectively to the \fBmycmd\fP and \fBanotherproc\fP procedures
3301 defined in siteconfig script.
3302 .UNINDENT
3303 .SS Module cache
3304 .sp
3305 To improve module search efficiency, a module cache can be setup in each
3306 modulepath. A module cache is represented by a \fB\&.modulecache\fP file
3307 stored at the root of modulepath directory. This file aggregates contents of
3308 all valid modulercs and modulefiles and issue description of all
3309 non\-modulefiles stored in modulepath directory.
3310 .sp
3311 When cache file is available, a module search analyzes this file rather
3312 walking through the content of modulepath directory to check if files are
3313 modulefiles or not. Cache file reduces module search processing time
3314 especially when hundreds of modulefiles are available and if these files are
3315 located on busy storage systems. Having one file to read per modulepath rather
3316 walking through a whole directory content extremely reduces the number of
3317 required I/O operations.
3318 .sp
3319 When modulefiles or directories in the modulepath are not accessible for
3320 everyone, a \fIlimited access\fP indication is recorded in cache file rather
3321 content of these modulefiles and content of these directories. When cache file
3322 containing such indication is processed, the limited access modulefiles are
3323 tested to check if they are available to the current running user. Limited
3324 access directories are walked down to find all available modulefiles and
3325 modulercs.
3326 .sp
3327 Cache files are generated with \fBcachebuild\fP sub\-command. This command
3328 has to be run by someone who owns write access in modulepath directory to
3329 create cache file.
3330 .sp
3331 Cache files are used any time a module search occurs in modulepaths. They are
3332 analyzed for instance during \fBavail\fP, \fBspider\fP,
3333 \fBload\fP, \fBdisplay\fP or \fBwhatis\fP sub\-commands.
3334 .sp
3335 Cache files are removed with \fBcacheclear\fP sub\-command. This command
3336 has to be run by someone who own write access in modulepath directory to
3337 effectively delete cache file.
3338 .SH EXIT STATUS
3339 .sp
3340 The \fBmodule\fP command exits with \fB0\fP if its execution succeed.
3341 Otherwise \fB1\fP is returned.
3342 .SH ENVIRONMENT
3343 .INDENT 0.0
3344 .TP
3345 .B __MODULES_AUTOINIT_INPROGRESS
3346 If set to \fB1\fP, the \fBautoinit\fP sub\-command process is skipped.
3347 .sp
3348 This environment variable is set to \fB1\fP by the \fBautoinit\fP
3349 sub\-command after checking it is not set. It ensures no nested initialization
3350 of Modules occur. At the end of the processing of the \fBautoinit\fP
3351 sub\-command, \fB__MODULES_AUTOINIT_INPROGRESS\fP is unset.
3352 .UNINDENT
3353 .INDENT 0.0
3354 .TP
3355 .B __MODULES_LMALTNAME
3356 A colon separated list of the alternative names set through
3357 \fBmodule\-version\fP \%<#\:mfcmd-module-version> and \fBmodule\-alias\fP \%<#\:mfcmd-module-alias> statements corresponding to
3358 all loaded \fImodulefiles\fP\&. Each element in this list starts by the name of the
3359 loaded \fImodulefile\fP followed by all alternative names resolving to it. The
3360 loaded modulefile and its alternative names are separated by the ampersand
3361 character.
3362 .sp
3363 Each alternative name stored in \fB__MODULES_LMALTNAME\fP is prefixed by
3364 the \fBal|\fP string if it corresponds to a module alias or prefixed by the
3365 \fBas|\fP string if it corresponds to an automatic version symbol. These
3366 prefixes help to distinguish the different kind of alternative name.
3367 .sp
3368 This environment variable is intended for \fBmodule\fP command internal
3369 use to get knowledge of the alternative names matching loaded \fImodulefiles\fP
3370 in order to keep environment consistent when conflicts or pre\-requirements
3371 are set over these alternative designations. It also helps to find a match
3372 after \fImodulefiles\fP being loaded when \fBunload\fP, \fBis\-loaded\fP
3373 or \fBinfo\-loaded\fP actions are run over these names.
3374 .sp
3375 Starting version 4.7 of Modules, \fB__MODULES_LMALTNAME\fP is also used
3376 on \fBlist\fP sub\-command to report the symbolic versions associated with
3377 the loaded modules.
3378 .UNINDENT
3379 .INDENT 0.0
3380 .TP
3381 .B __MODULES_LMCONFLICT
3382 A colon separated list of the \fBconflict\fP \%<#\:mfcmd-conflict> statements defined by all
3383 loaded \fImodulefiles\fP\&. Each element in this list starts by the name of the
3384 loaded \fImodulefile\fP declaring the conflict followed by the name of all
3385 modulefiles it declares a conflict with. These loaded modulefiles and
3386 conflicting modulefile names are separated by the ampersand character.
3387 .sp
3388 This environment variable is intended for \fBmodule\fP command internal
3389 use to get knowledge of the conflicts declared by the loaded \fImodulefiles\fP
3390 in order to keep environment consistent when a conflicting module is asked
3391 for load afterward.
3392 .UNINDENT
3393 .INDENT 0.0
3394 .TP
3395 .B __MODULES_LMEXTRATAG
3396 A colon separated list of the tags corresponding to all loaded \fImodulefiles\fP
3397 that have been set through the \fB\-\-tag\fP option. Each element in this
3398 list starts by the name of the loaded \fImodulefile\fP followed by all explicitly
3399 set tags applying to it. The loaded modulefile and its tags are separated by
3400 the ampersand character.
3401 .sp
3402 This environment variable is intended for \fBmodule\fP command internal
3403 use to distinguish from all tags those that have been specifically set with
3404 \fB\-\-tag\fP option.
3405 .UNINDENT
3406 .INDENT 0.0
3407 .TP
3408 .B __MODULES_LMINIT
3409 A colon separated list describing the modulepaths that have been enabled and
3410 the \fImodulefiles\fP that have been loaded with their tags during Modules
3411 initialization\&. Each element in this list
3412 corresponds to a collection definition line.
3413 .sp
3414 This environment variable is intended for \fBmodule\fP command internal
3415 use to get knowledge of the initial loaded state after initialization.
3416 .sp
3417 This initial environment state can then be restored with \fBreset\fP
3418 sub\-command. It can also be restored with \fBrestore\fP sub\-command when
3419 \fB__init__\fP collection name is specified or when no collection name is
3420 specified and no \fIdefault\fP collection exists.
3421 .sp
3422 The content of the initial environment can be displayed with
3423 \fBsaveshow\fP sub\-command when \fB__init__\fP collection name is specified
3424 or when no collection name is specified and no \fIdefault\fP collection exists.
3425 .UNINDENT
3426 .INDENT 0.0
3427 .TP
3428 .B __MODULES_LMPREREQ
3429 A colon separated list of the \fBprereq\fP \%<#\:mfcmd-prereq> statements defined by all
3430 loaded \fImodulefiles\fP\&. Each element in this list starts by the name of the
3431 loaded \fImodulefile\fP declaring the pre\-requirement followed by the name of all
3432 modulefiles it declares a \fBprereq\fP \%<#\:mfcmd-prereq> with. These loaded modulefiles and
3433 pre\-required modulefile names are separated by the ampersand character. When
3434 a \fBprereq\fP \%<#\:mfcmd-prereq> statement is composed of multiple modulefiles, these
3435 modulefile names are separated by the pipe character.
3436 .sp
3437 This environment variable is intended for \fBmodule\fP command internal
3438 use to get knowledge of the pre\-requirement declared by the loaded
3439 \fImodulefiles\fP in order to keep environment consistent when a pre\-required
3440 module is asked for unload afterward.
3441 .UNINDENT
3442 .INDENT 0.0
3443 .TP
3444 .B __MODULES_LMPREREQPATH
3445 A colon separated list of the \fBprereq\fP \%<#\:mfcmd-prereq> statements set with a specific
3446 \fB\-\-modulepath\fP option defined by all loaded \fImodulefiles\fP\&. Each element in
3447 this list starts by the name of the loaded \fImodulefile\fP declaring the
3448 pre\-requirement followed by the name of all modulefiles it declares a
3449 \fBprereq\fP \%<#\:mfcmd-prereq> with and their specific modulepath. These loaded modulefiles,
3450 pre\-required modulefile names and specific modulepaths set are separated by
3451 the ampersand character. When a \fBprereq\fP \%<#\:mfcmd-prereq> statement is composed of
3452 multiple modulefiles or multiple specific modulepaths, these names are
3453 separated by the pipe character.
3454 .sp
3455 This environment variable is intended for \fBmodule\fP command internal
3456 use to get knowledge of the pre\-requirement declared by the loaded
3457 \fImodulefiles\fP in order to keep environment consistent.
3458 .UNINDENT
3459 .INDENT 0.0
3460 .TP
3461 .B __MODULES_LMREFRESH
3462 A colon separated list of the loaded modules that are qualified for refresh
3463 evaluation. Loaded modules listed in this variable are those defining
3464 volatile environment changes like shell completion, alias and function.
3465 .UNINDENT
3466 .INDENT 0.0
3467 .TP
3468 .B __MODULES_LMSOURCESH
3469 A colon separated list of the \fBsource\-sh\fP \%<#\:mfcmd-source-sh> statements defined by all
3470 loaded \fImodulefiles\fP\&. Each element in this list starts by the name of the
3471 loaded \fImodulefile\fP declaring the environment changes made by the evaluation
3472 of \fBsource\-sh\fP \%<#\:mfcmd-source-sh> scripts. This name is followed by each
3473 \fBsource\-sh\fP \%<#\:mfcmd-source-sh> statement call and corresponding result achieved in
3474 modulefile. The loaded modulefile name and each \fBsource\-sh\fP \%<#\:mfcmd-source-sh> statement
3475 description are separated by the ampersand character. The \fBsource\-sh\fP \%<#\:mfcmd-source-sh>
3476 statement call and each resulting modulefile command (corresponding to the
3477 environment changes done by sourced script) are separated by the pipe
3478 character.
3479 .sp
3480 This environment variable is intended for \fBmodule\fP command internal
3481 use to get knowledge of the modulefile commands applied for each
3482 \fBsource\-sh\fP \%<#\:mfcmd-source-sh> command when loading the modulefile. In order to reverse
3483 these modulefile commands when modulefile is unloaded to undo the environment
3484 changes.
3485 .UNINDENT
3486 .INDENT 0.0
3487 .TP
3488 .B __MODULES_LMSTICKYRULE
3489 A colon separated list of the sticky or super\-sticky tag definitions applying
3490 to loaded \fImodulefiles\fP\&. Each element in this list starts by the name of the
3491 loaded \fImodulefile\fP followed by the sticky tag name and the module
3492 specifications on which the tag applies. These loaded modulefiles and sticky
3493 tag definitions are separated by the ampersand character. Tag name and module
3494 specifications on which it applies are separated by the pipe character.
3495 .sp
3496 When stickiness applies specifically to the loaded module name and version,
3497 sticky rule is not recorded in \fB__MODULES_LMSTICKYRULE\fP\&.
3498 .sp
3499 This environment variable is intended for \fBmodule\fP command internal
3500 use to get knowledge of the stickiness scope when sticky module is changed.
3501 .UNINDENT
3502 .INDENT 0.0
3503 .TP
3504 .B __MODULES_LMTAG
3505 A colon separated list of the tags corresponding to all loaded \fImodulefiles\fP
3506 that have been set through \fBmodule\-tag\fP \%<#\:mfcmd-module-tag> statements or from other
3507 modulefile statements like \fBmodule\-forbid\fP \%<#\:mfcmd-module-forbid> (that may apply the
3508 \fInearly\-forbidden\fP tag in specific situation) (see Module tags section).
3509 Each element in this list starts by the name of the loaded \fImodulefile\fP
3510 followed by all tags applying to it. The loaded modulefile and its tags are
3511 separated by the ampersand character.
3512 .sp
3513 This environment variable is intended for \fBmodule\fP command internal
3514 use to get knowledge of the tags applying to loaded \fImodulefiles\fP in order
3515 to report these tags on \fBlist\fP sub\-command output or to apply
3516 specific behavior when unloading \fImodulefile\fP\&.
3517 .UNINDENT
3518 .INDENT 0.0
3519 .TP
3520 .B __MODULES_LMUSE
3521 A colon separated list of the modulepaths enabled by all loaded
3522 \fImodulefiles\fP\&. Each element in this list starts by the name of the loaded
3523 \fImodulefile\fP enabling modulepath followed by all modulepaths it enables.
3524 These loaded modulefiles and enabled modulepaths are separated by the
3525 ampersand character.
3526 .sp
3527 This environment variable is intended for \fBmodule\fP command internal
3528 use to get knowledge of the modulepath enabled by the loaded \fImodulefiles\fP
3529 in order to keep environment consistent when unloading these modules whereas
3530 modulefiles from the enabled modulepaths are loaded.
3531 .UNINDENT
3532 .INDENT 0.0
3533 .TP
3534 .B __MODULES_LMVARIANT
3535 A colon separated list of the variant instantiated through \fBvariant\fP \%<#\:mfcmd-variant>
3536 statements by all loaded \fImodulefiles\fP (see Module variants section).
3537 Each element in this list starts by the name of the loaded \fImodulefile\fP
3538 followed by all the variant definitions set during the load of this module.
3539 The loaded modulefile and each of its variant definition are separated by the
3540 ampersand character. Each variant definition starts with the variant name,
3541 followed by the variant value set, then a flag to know if variant is of the
3542 Boolean type and last element in this definition is a flag to know if the
3543 chosen value is the default one for this variant and if it has been
3544 automatically set or not. These four elements composing the variant
3545 definition are separated by the pipe character.
3546 .sp
3547 This environment variable is intended for \fBmodule\fP command internal
3548 use to get knowledge of the variant value defined by the loaded \fImodulefiles\fP
3549 in order to keep environment consistent when requirements are set over a
3550 specific variant value or just to report these variant values when listing
3551 loaded modules.
3552 .UNINDENT
3553 .INDENT 0.0
3554 .TP
3555 .B __MODULES_PUSHENV_<VAR>
3556 Stack of saved values for \fB<VAR>\fP environment variable. A colon\-separated list containing pairs of elements. A pair is formed by a loaded
3557 module name followed by the value set to \fB<VAR>\fP in this module with
3558 \fBpushenv\fP \%<#\:mfcmd-pushenv> command. An ampersand character separates the two parts of
3559 the pair.
3560 .sp
3561 First element in list corresponds to the lastly set value of \fB<VAR>\fP\&.
3562 If a value were set to \fB<VAR>\fP prior the first evaluated
3563 \fBpushenv\fP \%<#\:mfcmd-pushenv> command, this value is associated to an empty module name to
3564 record it as a pair element in \fB__MODULES_PUSHENV_<VAR>\fP\&.
3565 .UNINDENT
3566 .INDENT 0.0
3567 .TP
3568 .B __MODULES_QUAR_<VAR>
3569 Value of environment variable \fB<VAR>\fP passed to \fBmodulecmd.tcl\fP
3570 in order to restore \fB<VAR>\fP to this value once started.
3571 .UNINDENT
3572 .INDENT 0.0
3573 .TP
3574 .B __MODULES_QUARANTINE_SET
3575 If set to \fB1\fP, restore the environment variables set on hold by the
3576 quarantine mechanism when starting \fBmodulecmd.tcl\fP script. This
3577 variable is automatically defined by Modules shell initialization scripts or
3578 \fBmodule\fP shell function when they apply the quarantine mechanism.
3579 (see \fBMODULES_QUARANTINE_SUPPORT\fP).
3580 .UNINDENT
3581 .INDENT 0.0
3582 .TP
3583 .B __MODULES_SHARE_<VAR>
3584 Reference counter variable for path\-like variable \fB<VAR>\fP\&. A colon
3585 separated list containing pairs of elements. A pair is formed by a path
3586 element followed its usage counter which represents the number of times
3587 this path has been enabled in variable \fB<VAR>\fP\&. A colon separates the
3588 two parts of the pair.
3589 .sp
3590 An element of a path\-like variable is added to the reference counter variable
3591 as soon as it is added more than one time. When an element of a path\-like
3592 variable is not found in the reference counter variable, it means this
3593 element has only be added once to the path\-like variable.
3594 .sp
3595 When an empty string is added as an element in the path\-like variable, it is
3596 added to the reference counter variable even if added only once to
3597 distinguish between an empty path\-like variable and a path\-like variable
3598 containing an empty string as single element.
3599 .UNINDENT
3600 .INDENT 0.0
3601 .TP
3602 .B _LMFILES_
3603 A colon separated list of the full pathname for all loaded \fImodulefiles\fP\&.
3604 .sp
3605 This environment variable is generated by \fBmodule\fP command and
3606 should not be modified externally.
3607 .UNINDENT
3608 .INDENT 0.0
3609 .TP
3610 .B LOADEDMODULES
3611 A colon separated list of all loaded \fImodulefiles\fP\&.
3612 .sp
3613 This environment variable is generated by \fBmodule\fP command and
3614 should not be modified externally.
3615 .UNINDENT
3616 .INDENT 0.0
3617 .TP
3618 .B MODULECONTACT
3619 Email address to contact in case any issue occurs during the interpretation
3620 of modulefiles.
3621 .sp
3622 This environment variable value supersedes the default value set in the
3623 \fBcontact\fP configuration option. It can be defined with the
3624 \fBconfig\fP sub\-command.
3625 .UNINDENT
3626 .INDENT 0.0
3627 .TP
3628 .B MODULEPATH
3629 The path that the \fBmodule\fP command searches when looking for
3630 \fImodulefiles\fP\&. Typically, it is set to the main \fImodulefiles\fP directory,
3631 \fB@modulefilesdir@\fP, by the initialization script. \fBMODULEPATH\fP
3632 can be set using \fBmodule use\fP or by the module initialization
3633 script to search group or personal \fImodulefile\fP directories before or after
3634 the main \fImodulefile\fP directory.
3635 .sp
3636 Path elements registered in the \fBMODULEPATH\fP environment variable may
3637 contain reference to environment variables which are converted to their
3638 corresponding value by \fBmodule\fP command each time it looks at the
3639 \fBMODULEPATH\fP value. If an environment variable referred in a path
3640 element is not defined, its reference is converted to an empty string.
3641 .UNINDENT
3642 .INDENT 0.0
3643 .TP
3644 .B MODULERCFILE
3645 The location of a global run\-command file(s) containing \fImodulefile\fP specific
3646 setup. See Modulecmd startup section for detailed information.
3647 .sp
3648 Several global run\-command files may be defined in this environment variable
3649 by separating each of them by colon character.
3650 .sp
3651 This environment variable value supersedes the default value set in the
3652 \fBrcfile\fP configuration option. It can be defined with the
3653 \fBconfig\fP sub\-command.
3654 .UNINDENT
3655 .INDENT 0.0
3656 .TP
3657 .B MODULES_ABORT_ON_ERROR
3658 A colon separated list of the module sub\-commands that abort their evaluation
3659 sequence when an error is raised by an evaluated module. When error occurs,
3660 evaluations already done are withdrawn and the remaining modules to evaluate
3661 are skipped.
3662 .sp
3663 Accepted sub\-commands that can be set in value list are:
3664 .INDENT 7.0
3665 .IP \(bu 2
3666 \fBload\fP
3667 .IP \(bu 2
3668 \fBml\fP
3669 .IP \(bu 2
3670 \fBmod\-to\-sh\fP
3671 .IP \(bu 2
3672 \fBpurge\fP
3673 .IP \(bu 2
3674 \fBreload\fP
3675 .IP \(bu 2
3676 \fBswitch\fP
3677 .IP \(bu 2
3678 \fBswitch_unload\fP
3679 .IP \(bu 2
3680 \fBtry\-load\fP
3681 .IP \(bu 2
3682 \fBunload\fP
3683 .UNINDENT
3684 .sp
3685 Module sub\-commands not configured to follow the \fIabort on error\fP behavior,
3686 apply the \fIcontinue on error\fP behavior. In this case if one modulefile
3687 evaluation fails, sequence continues with remaining modulefiles. When
3688 \fB\-\-force\fP option is used, \fIcontinue on error\fP behavior applies.
3689 .sp
3690 This environment variable value supersedes the default value set in the
3691 \fBabort_on_error\fP configuration option. It can be defined with the
3692 \fBconfig\fP sub\-command.
3693 .UNINDENT
3694 .INDENT 0.0
3695 .TP
3696 .B MODULES_ADVANCED_VERSION_SPEC
3697 If set to \fB1\fP, enable advanced module version specifiers (see Advanced
3698 module version specifiers section). If set to \fB0\fP, disable advanced
3699 module version specifiers.
3700 .sp
3701 This environment variable value supersedes the default value set in the
3702 \fBadvanced_version_spec\fP configuration option. It can be defined with
3703 the \fBconfig\fP sub\-command.
3704 .UNINDENT
3705 .INDENT 0.0
3706 .TP
3707 .B MODULES_AUTO_HANDLING
3708 If set to \fB1\fP, enable automated module handling mode. If set to \fB0\fP
3709 disable automated module handling mode. Other values are ignored.
3710 .sp
3711 Automated module handling mode consists in additional actions triggered when
3712 loading or unloading a \fImodulefile\fP to satisfy the constraints it declares.
3713 When loading a \fImodulefile\fP, following actions are triggered:
3714 .INDENT 7.0
3715 .IP \(bu 2
3716 Conflict Unload: unload of the \fImodulefiles\fP declared as a
3717 \fBconflict\fP \%<#\:mfcmd-conflict> of the loading \fImodulefile\fP or if it is the same
3718 \fImodulefile\fP than the one loading but with a different set of variant or
3719 coming from a different modulepath.
3720 .IP \(bu 2
3721 Requirement Load: load of the \fImodulefiles\fP declared as a \fBprereq\fP \%<#\:mfcmd-prereq>
3722 of the loading \fImodulefile\fP\&.
3723 .IP \(bu 2
3724 Useless Requirement Unload: unload of the \fBprereq\fP \%<#\:mfcmd-prereq> modulefiles that
3725 have been automatically loaded for either an unloaded conflicting
3726 modulefile or a modulefile part of this useless requirement unloading
3727 batch. Modulefiles are added to this unloading batch only if they are not
3728 required by any other loaded modulefiles and if they are not tagged
3729 \fBkeep\-loaded\fP, \fBsticky\fP or \fBsuper\-sticky\fP\&.
3730 .IP \(bu 2
3731 Dependent Reload: reload of the modulefiles declaring a \fBprereq\fP \%<#\:mfcmd-prereq>
3732 onto loading \fImodulefile\fP or declaring a \fBprereq\fP \%<#\:mfcmd-prereq> or a via
3733 requirement onto a \fImodulefile\fP part of this
3734 reloading batch.
3735 .UNINDENT
3736 .sp
3737 When unloading a \fImodulefile\fP, following actions are triggered:
3738 .INDENT 7.0
3739 .IP \(bu 2
3740 Dependent Unload: unload of the modulefiles declaring a non\-optional
3741 \fBprereq\fP \%<#\:mfcmd-prereq> or a via requirement onto
3742 unloaded modulefile or a modulefile part of this unloading batch. A
3743 \fBprereq\fP \%<#\:mfcmd-prereq> modulefile is considered optional if the \fBprereq\fP \%<#\:mfcmd-prereq>
3744 definition order is made of multiple modulefiles and at least one
3745 alternative modulefile is loaded.
3746 .IP \(bu 2
3747 Useless Requirement Unload: unload of the \fBprereq\fP \%<#\:mfcmd-prereq> modulefiles that
3748 have been automatically loaded for either the unloaded modulefile, an
3749 unloaded dependent modulefile or a modulefile part of this useless
3750 requirement unloading batch. Modulefiles are added to this unloading batch
3751 only if they are not required by any other loaded modulefiles and if they
3752 are not tagged \fBkeep\-loaded\fP, \fBsticky\fP or \fBsuper\-sticky\fP\&.
3753 .IP \(bu 2
3754 Dependent Reload: reload of the modulefiles declaring a \fBconflict\fP \%<#\:mfcmd-conflict>
3755 or an optional \fBprereq\fP \%<#\:mfcmd-prereq> onto either the unloaded modulefile, an
3756 unloaded dependent or an unloaded useless requirement or declaring a
3757 \fBprereq\fP \%<#\:mfcmd-prereq> or a via requirement onto a
3758 modulefile part of this reloading batch.
3759 .UNINDENT
3760 .sp
3761 In case a loaded \fImodulefile\fP has some of its declared constraints
3762 unsatisfied (pre\-required modulefile not loaded or conflicting modulefile
3763 loaded for instance), this loaded \fImodulefile\fP is excluded from the automatic
3764 reload actions described above.
3765 .sp
3766 For the specific case of the \fBswitch\fP sub\-command, where a modulefile
3767 is unloaded to then load another modulefile. Dependent modulefiles to Unload
3768 are merged into the Dependent modulefiles to Reload that are reloaded after
3769 the load of the switched\-to modulefile. Such process also applies to the
3770 Dependent Unload modulefiles of Conflict Unload modules.
3771 .sp
3772 The reload phase of all Dependent Reload modulefiles occurs after the
3773 evaluation of the main \fImodulefile\fP (either load, unload or switch
3774 evaluation).
3775 .sp
3776 The reload phase of a Dependent Reload modulefile is skipped if any of the
3777 following conditions are met:
3778 .INDENT 7.0
3779 .IP \(bu 2
3780 The required modules for this modulefile are not loaded.
3781 .IP \(bu 2
3782 A conflict is detected with the currently loaded environment.
3783 .IP \(bu 2
3784 The enabled modulepaths have changed, and the modulefile is no longer
3785 available.
3786 .UNINDENT
3787 .sp
3788 However, reload is always attempted if the modulefile is tagged as
3789 \fBsuper\-sticky\fP or \fBsticky\fP, and force mode is not enabled. \fIAbort on
3790 error\fP behavior is applied if reload of such module kind fails whatever the
3791 value of the \fBabort_on_error\fP configuration option. Dependent
3792 Reload modulefiles whose reload has been skipped are treated as Dependent
3793 Unload modulefiles.
3794 .sp
3795 Conflict Unload mechanism is activated only if \fBconflict_unload\fP
3796 configuration option is also enabled.
3797 .sp
3798 This environment variable value supersedes the default value set on the
3799 \fBauto_handling\fP configuration option. It can be defined with the
3800 \fBconfig\fP sub\-command. The \fB\-\-auto\fP and \fB\-\-no\-auto\fP
3801 command line switches override this environment variable.
3802 .UNINDENT
3803 .INDENT 0.0
3804 .TP
3805 .B MODULES_AVAIL_INDEPTH
3806 If set to \fB1\fP, enable in depth search results for \fBavail\fP
3807 sub\-command. If set to \fB0\fP disable \fBavail\fP sub\-command in depth
3808 mode. Other values are ignored.
3809 .sp
3810 When in depth mode is enabled, modulefiles and directories contained in
3811 directories matching search query are also included in search results. When
3812 disabled these modulefiles and directories contained in matching directories
3813 are excluded.
3814 .sp
3815 This environment variable value supersedes the default value set in the
3816 \fBavail_indepth\fP configuration option. It can be defined with the
3817 \fBconfig\fP sub\-command. The \fB\-\-indepth\fP and
3818 \fB\-\-no\-indepth\fP command line switches override this environment
3819 variable.
3820 .UNINDENT
3821 .INDENT 0.0
3822 .TP
3823 .B MODULES_AVAIL_OUTPUT
3824 A colon separated list of the elements to report in addition to module names
3825 on \fBavail\fP sub\-command regular output mode.
3826 .sp
3827 Accepted elements that can be set in value list are:
3828 .INDENT 7.0
3829 .IP \(bu 2
3830 \fBalias\fP: module aliases.
3831 .IP \(bu 2
3832 \fBprovided\-alias\fP: show module aliases and evaluate all modulefiles to get
3833 aliases provided by them.
3834 .IP \(bu 2
3835 \fBdirwsym\fP: directories associated with symbolic versions.
3836 .IP \(bu 2
3837 \fBhidden\fP: show all hidden modules.
3838 .IP \(bu 2
3839 \fBindesym\fP: symbolic versions reported independently from the module or
3840 directory they are attached to.
3841 .IP \(bu 2
3842 \fBkey\fP: legend appended at the end of the output to explain it.
3843 .IP \(bu 2
3844 \fBmodulepath\fP: modulepath names set as header prior the list of available
3845 modules found in them.
3846 .IP \(bu 2
3847 \fBsym\fP: symbolic versions associated with available modules.
3848 .IP \(bu 2
3849 \fBtag\fP: tags associated with available modules.
3850 .IP \(bu 2
3851 \fBvariant\fP: variants and their possible values associated with available
3852 modules.
3853 .IP \(bu 2
3854 \fBvariantifspec\fP: like \fBvariant\fP but only if a variant has been
3855 specified in search query.
3856 .IP \(bu 2
3857 \fBvia\fP: mention next to modulepath name which loaded module enables it if
3858 any.
3859 .UNINDENT
3860 .sp
3861 The order of the elements in the list does not matter. Module names are the
3862 only content reported when \fILIST\fP is set to an empty value.
3863 .sp
3864 In case the \fBmodulepath\fP element is missing from value list, the available
3865 modules from global/user rc and all enabled modulepaths are reported as a
3866 single list.
3867 .sp
3868 When \fBindesym\fP element is set, \fBdirwsym\fP and \fBsym\fP elements are
3869 disabled.
3870 .sp
3871 This environment variable value supersedes the default value set in the
3872 \fBavail_output\fP configuration option. It can be defined with
3873 the \fBconfig\fP sub\-command. The \fB\-\-output\fP/\fB\-o\fP command
3874 line switches override this environment variable.
3875 .UNINDENT
3876 .INDENT 0.0
3877 .TP
3878 .B MODULES_AVAIL_TERSE_OUTPUT
3879 A colon separated list of the elements to report in addition to module names
3880 on \fBavail\fP sub\-command terse output mode.
3881 .sp
3882 See \fBMODULES_AVAIL_OUTPUT\fP to get the accepted elements that can be
3883 set in value list. Exception for \fBvia\fP element which is not accepted for
3884 terse output mode.
3885 .sp
3886 The order of the elements in the list does not matter. Module names are the
3887 only content reported when \fILIST\fP is set to an empty value.
3888 .sp
3889 This environment variable value supersedes the default value set in the
3890 \fBavail_terse_output\fP configuration option. It can be defined with
3891 the \fBconfig\fP sub\-command. The \fB\-\-output\fP/\fB\-o\fP
3892 command line switches override this environment variable.
3893 .UNINDENT
3894 .INDENT 0.0
3895 .TP
3896 .B MODULES_CACHE_BUFFER_BYTES
3897 Size of the buffer used when reading or writing cache files. Accepted values
3898 are integers comprised between 4096 and 1000000.
3899 .UNINDENT
3900 .INDENT 0.0
3901 .TP
3902 .B MODULES_CACHE_EXPIRY_SECS
3903 Number of seconds a cache file is considered valid after being generated. For
3904 example, if set to \fB3600\fP it means a cache file expires one hour after
3905 being generated and is then ignored.
3906 .sp
3907 When set to \fB0\fP cache file never expires. Accepted values are integers
3908 comprised between 0 (cache files never expire) and 31536000 (equivalent to
3909 one year duration).
3910 .UNINDENT
3911 .INDENT 0.0
3912 .TP
3913 .B MODULES_CMD
3914 The location of the active module command script.
3915 .sp
3916 This environment variable is generated by \fBmodule\fP command and
3917 should not be modified externally.
3918 .UNINDENT
3919 .INDENT 0.0
3920 .TP
3921 .B MODULES_COLLECTION_PIN_VERSION
3922 If set to \fB1\fP, register exact version number of modulefiles when saving a
3923 collection. Otherwise modulefile version number is omitted if it corresponds
3924 to the explicitly set default version and also to the implicit default when
3925 the configuration option \fBimplicit_default\fP is enabled.
3926 .sp
3927 This environment variable value supersedes the default value set in the
3928 \fBcollection_pin_version\fP configuration option. It can be defined
3929 with the \fBconfig\fP sub\-command.
3930 .UNINDENT
3931 .INDENT 0.0
3932 .TP
3933 .B MODULES_COLLECTION_PIN_TAG
3934 If set to \fB1\fP, register all tags applying to modulefiles when saving a
3935 collection. Otherwise only the extra tags set through the \fB\-\-tag\fP
3936 option and tags resulting from specific module states (like \fBauto\-loaded\fP
3937 and \fBkeep\-loaded\fP tags) are recorded in collection. Note that the
3938 \fBnearly\-forbidden\fP tag due to its temporal meaning is not saved in
3939 collection even when this configuration option is enabled.
3940 .sp
3941 This environment variable value supersedes the default value set in the
3942 \fBcollection_pin_tag\fP configuration option. It can be defined with
3943 the \fBconfig\fP sub\-command.
3944 .UNINDENT
3945 .INDENT 0.0
3946 .TP
3947 .B MODULES_COLLECTION_TARGET
3948 The collection target that determines what collections are valid thus
3949 reachable on the current system.
3950 .sp
3951 Collection directory may sometimes be shared on multiple machines which may
3952 use different modules setup. For instance modules users may access with the
3953 same \fBHOME\fP directory multiple systems using different OS versions.
3954 When it happens a collection made on machine 1 may be erroneous on machine 2.
3955 .sp
3956 When a target is set, only the collections made for that target are
3957 available to the \fBrestore\fP, \fBsavelist\fP, \fBsaveshow\fP,
3958 \fBsaverm\fP, \fBstash\fP, \fBstashpop\fP, \fBstashlist\fP,
3959 \fBstashshow\fP, and \fBstashrm\fP sub\-commands. Saving a collection
3960 registers the target footprint by suffixing the collection filename with
3961 \fB\&.$MODULES_COLLECTION_TARGET\fP\&. The collection target is not involved when
3962 collection is specified as file path on the \fBsaveshow\fP,
3963 \fBrestore\fP and \fBsave\fP sub\-commands.
3964 .sp
3965 For example, the \fBMODULES_COLLECTION_TARGET\fP variable may be set with
3966 results from commands like \fBlsb_release\fP, \fBhostname\fP,
3967 \fBdnsdomainname\fP, etc.
3968 .sp
3969 This environment variable value supersedes the default value set in the
3970 \fBcollection_target\fP configuration option. It can be defined with
3971 the \fBconfig\fP sub\-command.
3972 .UNINDENT
3973 .INDENT 0.0
3974 .TP
3975 .B MODULES_COLOR
3976 Defines if output should be colored or not. Accepted values are \fBnever\fP,
3977 \fBauto\fP and \fBalways\fP\&.
3978 .sp
3979 When color mode is set to \fBauto\fP, output is colored only if the standard
3980 error output channel is attached to a terminal.
3981 .sp
3982 This environment variable value supersedes the default value set in the
3983 \fBcolor\fP configuration option. It can be defined with the
3984 \fBconfig\fP sub\-command. The \fB\-\-color\fP command line switch
3985 overrides this environment variable.
3986 .sp
3987 \fBNO_COLOR\fP, \fBCLICOLOR\fP and \fBCLICOLOR_FORCE\fP
3988 environment variables are also honored to define color mode. The \fBnever\fP
3989 mode is set if \fBNO_COLOR\fP is defined (regardless of its value) or if
3990 \fBCLICOLOR\fP equals to \fB0\fP\&. If \fBCLICOLOR\fP is set to another
3991 value, it corresponds to the \fBauto\fP mode. The \fBalways\fP mode is set if
3992 \fBCLICOLOR_FORCE\fP is set to a value different than \fB0\fP\&.
3993 \fBNO_COLOR\fP variable prevails over \fBCLICOLOR\fP and
3994 \fBCLICOLOR_FORCE\fP\&. Color mode set with these three variables is
3995 superseded by mode set with \fBMODULES_COLOR\fP environment variable or
3996 with \fB\-\-color\fP command line switch..
3997 .UNINDENT
3998 .INDENT 0.0
3999 .TP
4000 .B MODULES_COLORS
4001 Specifies the colors and other attributes used to highlight various parts of
4002 the output. Its value is a colon\-separated list of output items associated to
4003 a Select Graphic Rendition (SGR) code. It follows the same syntax than
4004 \fBLS_COLORS\fP\&.
4005 .sp
4006 Output items are designated by keys. Items able to be colorized are:
4007 highlighted element (\fBhi\fP), debug information (\fBdb\fP), trace information
4008 (\fBtr\fP), tag separator (\fBse\fP); Error (\fBer\fP), warning (\fBwa\fP), module
4009 error (\fBme\fP) and info (\fBin\fP) message prefixes; Modulepath (\fBmp\fP),
4010 directory (\fBdi\fP), module alias (\fBal\fP), module variant (\fBva\fP), module
4011 symbolic version (\fBsy\fP), module \fBdefault\fP version (\fBde\fP) and modulefile
4012 command (\fBcm\fP).
4013 .sp
4014 Module tags can also be colorized. The key to set in the color palette to
4015 get a graphical rendering of a tag is the tag name or the tag abbreviation if
4016 one is defined for tag. The SGR code applied to a tag name is ignored if an
4017 abbreviation is set for this tag thus the SGR code should be defined for this
4018 abbreviation to get a graphical rendering. Each basic tag has by default a
4019 key set in the color palette, based on its abbreviated string: auto\-loaded
4020 (\fBaL\fP), forbidden (\fBF\fP), hidden and hidden\-loaded (\fBH\fP), loaded
4021 (\fBL\fP), nearly\-forbidden (\fBnF\fP), sticky (\fBS\fP), super\-sticky (\fBsS\fP),
4022 keep\-loaded (\fBkL\fP) and warning (\fBW\fP).
4023 .sp
4024 See the Select Graphic Rendition (SGR) section in the documentation of the
4025 text terminal that is used for permitted values and their meaning as
4026 character attributes. These substring values are integers in decimal
4027 representation and can be concatenated with semicolons. Modules takes care of
4028 assembling the result into a complete SGR sequence (\fB\e33[...m\fP). Common
4029 values to concatenate include \fB1\fP for bold, \fB4\fP for underline, \fB30\fP to
4030 \fB37\fP for foreground colors and \fB90\fP to \fB97\fP for 16\-color mode
4031 foreground colors. See also \%<https://\:en\:.wikipedia\:.org/\:wiki/\:ANSI_escape_code#\:Select_Graphic_Rendition_parameters>
4032 for a complete SGR code reference.
4033 .sp
4034 No graphical rendition will be applied to an output item that could normally
4035 be colored but which is not defined in the color set. Thus if
4036 \fBMODULES_COLORS\fP is defined empty, no output will be colored at all.
4037 .sp
4038 This environment variable value supersedes the default value set in the
4039 \fBcolors\fP configuration option. It can be defined with the
4040 \fBconfig\fP sub\-command.
4041 .UNINDENT
4042 .INDENT 0.0
4043 .TP
4044 .B MODULES_CONFLICT_UNLOAD
4045 If set to \fB1\fP, enable automated unload of conflicting modules when loading
4046 a module. If set to \fB0\fP, disable this automated conflict unload mechanism.
4047 .sp
4048 Conflict Unload is a mechanism part of the automated module handling
4049 mode\&. To activate this mechanism,
4050 \fBauto_handling\fP configuration option should also be enabled.
4051 .sp
4052 This environment variable value supersedes the default value set in the
4053 \fBconflict_unload\fP configuration option. It can be defined with
4054 the \fBconfig\fP sub\-command.
4055 .UNINDENT
4056 .INDENT 0.0
4057 .TP
4058 .B MODULES_EDITOR
4059 Text editor command name or path for use to open modulefile through the
4060 \fBedit\fP sub\-command.
4061 .sp
4062 This environment variable value supersedes the default value set in the
4063 \fBeditor\fP configuration option. It can be defined with the
4064 \fBconfig\fP sub\-command.
4065 .sp
4066 Text editor could also be defined through the \fBVISUAL\fP or
4067 \fBEDITOR\fP environment variables. These environment variables are
4068 overridden by \fBMODULES_EDITOR\fP\&.
4069 .UNINDENT
4070 .INDENT 0.0
4071 .TP
4072 .B MODULES_EXTENDED_DEFAULT
4073 If set to \fB1\fP, a specified module version is matched against starting
4074 portion of existing module versions, where portion is a substring separated
4075 from the rest of the version string by a \fB\&.\fP character. For example
4076 specified modules \fBmod/1\fP and \fBmod/1.2\fP will match existing modulefile
4077 \fBmod/1.2.3\fP\&.
4078 .sp
4079 In case multiple modulefiles match the specified module version and a single
4080 module has to be selected, the explicitly set default version is returned if
4081 it is part of matching modulefiles. Otherwise the implicit default among
4082 matching modulefiles is returned if defined (see
4083 \fBMODULES_IMPLICIT_DEFAULT\fP section)
4084 .sp
4085 This environment variable value supersedes the default value set in the
4086 \fBextended_default\fP configuration option. It can be defined with the
4087 \fBconfig\fP sub\-command.
4088 .UNINDENT
4089 .INDENT 0.0
4090 .TP
4091 .B MODULES_FAMILY_<NAME>
4092 Module name minus version that provides for the \fIname\fP family in currently
4093 loaded environment. This environment variable is defined through the use of
4094 the \fBfamily\fP \%<#\:mfcmd-family> modulefile command.
4095 .sp
4096 For instance if loading modulefile \fBfoo/1.0\fP defines being member of the
4097 \fBbar\fP family, the \fBMODULES_FAMILY_BAR\fP
4098 will be set to the \fBfoo\fP value.
4099 .sp
4100 This environment variable is generated by \fBmodule\fP command and
4101 should not be modified externally.
4102 .UNINDENT
4103 .INDENT 0.0
4104 .TP
4105 .B MODULES_HIDE_AUTO_LOADED
4106 If set to \fB1\fP, tag automatically loaded modules \fBhidden\-loaded\fP\&. These
4107 modules will not appear on \fBlist\fP sub\-command unless \fB\-\-all\fP
4108 option is set.
4109 .sp
4110 This environment variable value supersedes the default value set in the
4111 \fBhide_auto_loaded\fP configuration option. It can be defined with the
4112 \fBconfig\fP sub\-command.
4113 .UNINDENT
4114 .INDENT 0.0
4115 .TP
4116 .B MODULES_ICASE
4117 When module specification are passed as argument to module sub\-commands or
4118 modulefile Tcl commands, defines the case sensitiveness to apply to match
4119 them. When \fBMODULES_ICASE\fP is set to \fBnever\fP, a case sensitive
4120 match is applied in any cases. When set to \fBsearch\fP, a case insensitive
4121 match is applied to the \fBavail\fP, \fBlist\fP, \fBwhatis\fP,
4122 \fBpaths\fP, \fBsavelist\fP and \fBspider\fP sub\-commands. When
4123 set to \fBalways\fP, a case insensitive match is also applied to the other
4124 module sub\-commands and modulefile Tcl commands for the module specification
4125 they receive as argument.
4126 .sp
4127 This environment variable value supersedes the default value set in the
4128 \fBicase\fP configuration option. It can be defined with the
4129 \fBconfig\fP sub\-command. The \fB\-\-icase\fP/\fB\-i\fP command line
4130 switches, which correspond to the \fBalways\fP mode, override this environment
4131 variable.
4132 .UNINDENT
4133 .INDENT 0.0
4134 .TP
4135 .B MODULES_IGNORE_CACHE
4136 Ignore (if set to \fB1\fP) or not (if set to \fB0\fP) module cache.
4137 .sp
4138 This environment variable value supersedes the default value set in the
4139 \fBignore_cache\fP configuration option. It can be defined with the
4140 \fBconfig\fP sub\-command. The \fB\-\-ignore\-cache\fP command line
4141 switch overrides this environment variable.
4142 .UNINDENT
4143 .INDENT 0.0
4144 .TP
4145 .B MODULES_IGNORE_USER_RC
4146 Skip evaluation (if set to \fB1\fP) or not (if set to \fB0\fP) of user\-specific
4147 module rc file (\fB$HOME/.modulerc\fP).
4148 .sp
4149 This environment variable value supersedes the default value set in the
4150 \fBignore_user_rc\fP configuration option. It can be defined with the
4151 \fBconfig\fP sub\-command. The \fB\-\-ignore\-user\-rc\fP command line
4152 switch overrides this environment variable.
4153 .UNINDENT
4154 .INDENT 0.0
4155 .TP
4156 .B MODULES_IMPLICIT_DEFAULT
4157 Defines (if set to \fB1\fP) or not (if set to \fB0\fP) an implicit default
4158 version for modules without a default version explicitly defined (see
4159 Locating Modulefiles \%<#\:locating-modulefiles> section in the modulefile \%<#\:modulefile-5> man page).
4160 .sp
4161 Without either an explicit or implicit default version defined a module must
4162 be fully qualified (version should be specified in addition to its name) to
4163 get:
4164 .INDENT 7.0
4165 .IP \(bu 2
4166 targeted by module \fBload\fP, \fBswitch\fP, \fBdisplay\fP,
4167 \fBhelp\fP, \fBtest\fP and \fBpath\fP sub\-commands.
4168 .IP \(bu 2
4169 restored from a collection, unless already loaded in collection\-specified
4170 order.
4171 .IP \(bu 2
4172 automatically loaded by automated module handling
4173 mechanisms when declared as module requirement,
4174 with \fBprereq\fP \%<#\:mfcmd-prereq> or \fBmodule load\fP \%<#\:mfcmd-module> modulefile commands.
4175 .UNINDENT
4176 .sp
4177 An error is returned in the above situations if either no explicit or
4178 implicit default version is defined.
4179 .sp
4180 This environment variable value supersedes the default value set in the
4181 \fBimplicit_default\fP configuration option. It can be defined with the
4182 \fBconfig\fP sub\-command. This environment variable is ignored if
4183 \fBimplicit_default\fP has been declared locked in
4184 \fBlocked_configs\fP configuration option.
4185 .UNINDENT
4186 .INDENT 0.0
4187 .TP
4188 .B MODULES_IMPLICIT_REQUIREMENT
4189 Defines (if set to \fB1\fP) or not (if set to \fB0\fP) an implicit prereq or
4190 conflict requirement onto modules specified respectively on
4191 \fBmodule load\fP \%<#\:mfcmd-module> or \fBmodule unload\fP \%<#\:mfcmd-module> commands in
4192 modulefile. When enabled an implicit conflict requirement onto switched\-off
4193 module and a prereq requirement onto switched\-on module are also defined for
4194 \fBmodule switch\fP \%<#\:mfcmd-module> commands used in modulefile.
4195 .sp
4196 This environment variable value supersedes the default value set in the
4197 \fBimplicit_requirement\fP configuration option. It can be defined with
4198 the \fBconfig\fP sub\-command. The \fB\-\-not\-req\fP option, applied to a
4199 \fBmodule\fP \%<#\:mfcmd-module> command in a modulefile, overrides this environment variable.
4200 .UNINDENT
4201 .INDENT 0.0
4202 .TP
4203 .B MODULES_LIST_OUTPUT
4204 A colon separated list of the elements to report in addition to module names
4205 on \fBlist\fP sub\-command regular output mode.
4206 .sp
4207 Accepted elements that can be set in value list are:
4208 .INDENT 7.0
4209 .IP \(bu 2
4210 \fBalias\fP: module aliases targeting loaded modules.
4211 .IP \(bu 2
4212 \fBheader\fP: sentence to introduce the list of loaded modules or to state
4213 that no modules are loaded currently.
4214 .IP \(bu 2
4215 \fBhidden\fP: show hidden loaded modules.
4216 .IP \(bu 2
4217 \fBidx\fP: index position of each loaded module.
4218 .IP \(bu 2
4219 \fBindesym\fP: symbolic versions reported independently from the loaded
4220 module they are attached to.
4221 .IP \(bu 2
4222 \fBkey\fP: legend appended at the end of the output to explain it.
4223 .IP \(bu 2
4224 \fBvariant\fP: variant values selected for loaded modules.
4225 .IP \(bu 2
4226 \fBsym\fP: symbolic versions associated with loaded modules.
4227 .IP \(bu 2
4228 \fBtag\fP: tags associated with loaded modules.
4229 .UNINDENT
4230 .sp
4231 The order of the elements in the list does not matter. Module names are the
4232 only content reported when \fILIST\fP is set to an empty value.
4233 .sp
4234 This environment variable value supersedes the default value set in the
4235 \fBlist_output\fP configuration option. It can be defined with the
4236 \fBconfig\fP sub\-command. The \fB\-\-output\fP/\fB\-o\fP command
4237 line switches override this environment variable.
4238 .UNINDENT
4239 .INDENT 0.0
4240 .TP
4241 .B MODULES_LIST_TERSE_OUTPUT
4242 A colon separated list of the elements to report in addition to module names
4243 on \fBlist\fP sub\-command terse output mode.
4244 .sp
4245 See \fBMODULES_LIST_OUTPUT\fP to get the accepted elements that can be
4246 set in value list.
4247 .sp
4248 The order of the elements in the list does not matter. Module names are the
4249 only content reported when \fILIST\fP is set to an empty value.
4250 .sp
4251 This environment variable value supersedes the default value set in the
4252 \fBlist_terse_output\fP configuration option. It can be defined with the
4253 \fBconfig\fP sub\-command. The \fB\-\-output\fP/\fB\-o\fP command
4254 line switches override this environment variable.
4255 .UNINDENT
4256 .INDENT 0.0
4257 .TP
4258 .B MODULES_LOGGED_EVENTS
4259 A colon separated list of the events to log. Accepted events that can be set
4260 in value list are:
4261 .INDENT 7.0
4262 .IP \(bu 2
4263 \fBauto_eval\fP: log automatically triggered modulefile evaluations
4264 .IP \(bu 2
4265 \fBrequested_eval\fP: log modulefile evaluations directly requested by user
4266 .IP \(bu 2
4267 \fBrequested_cmd\fP: log module commands directly requested by user
4268 .UNINDENT
4269 .sp
4270 This environment variable value supersedes the default value set in the
4271 \fBlogged_events\fP configuration option. It can be defined with the
4272 \fBconfig\fP sub\-command. This environment variable is ignored if
4273 \fBlogged_events\fP has been declared locked in
4274 \fBlocked_configs\fP configuration option.
4275 .UNINDENT
4276 .INDENT 0.0
4277 .TP
4278 .B MODULES_LOGGER
4279 Command to log informational messages. The value of this variable is composed
4280 of a logger command name or path eventually followed by command\-line options.
4281 .sp
4282 This environment variable value supersedes the default value set in the
4283 \fBlogger\fP configuration option. It can be defined with the
4284 \fBconfig\fP sub\-command. This environment variable is ignored if
4285 \fBlogger\fP has been declared locked in \fBlocked_configs\fP
4286 configuration option.
4287 .sp
4288 If \fBMODULES_LOGGER\fP variable is set to an empty string, logger
4289 will not be launched.
4290 .UNINDENT
4291 .INDENT 0.0
4292 .TP
4293 .B MODULES_MCOOKIE_CHECK
4294 If set to \fBeval\fP, the Modules magic cookie (i.e., \fB#%Module\fP
4295 file signature) is only checked to determine if a file is a modulefile when
4296 evaluating these files. If set to \fBalways\fP, the Modules magic cookie is
4297 also checked when searching for modules.
4298 .sp
4299 The \fBeval\fP mode is made to significantly reduce file checks when walking
4300 through modulepaths to search for \fImodulefiles\fP\&. Special care should be given
4301 to the content of modulepaths when this \fBeval\fP mode is set as the following
4302 kind of files are included in search results:
4303 .INDENT 7.0
4304 .IP \(bu 2
4305 \fImodulefiles\fP with a magic cookie requiring a higher version of
4306 \fBmodulecmd.tcl\fP
4307 .IP \(bu 2
4308 files not beginning with the magic cookie \fB#%Module\fP
4309 .IP \(bu 2
4310 read\-protected files
4311 .UNINDENT
4312 .sp
4313 When a module cache file is available for a given
4314 modulepath, \fBeval\fP mode is not applied as cache content is generated in
4315 \fBalways\fP mode.
4316 .sp
4317 This environment variable value supersedes the default value set in the
4318 \fBmcookie_check\fP configuration option. It can be defined with the
4319 \fBconfig\fP sub\-command.
4320 .UNINDENT
4321 .INDENT 0.0
4322 .TP
4323 .B MODULES_MCOOKIE_VERSION_CHECK
4324 If set to \fB1\fP, the version set in the Modules magic cookie in modulefile
4325 is checked against the current version of \fBmodulecmd.tcl\fP to determine
4326 if the modulefile can be evaluated.
4327 .sp
4328 When a module cache file is available for a given
4329 modulepath, version check is considered enabled as cache content is generated
4330 in this mode.
4331 .sp
4332 This environment variable value supersedes the default value set in the
4333 \fBmcookie_version_check\fP configuration option. It can be defined with
4334 the \fBconfig\fP sub\-command.
4335 .UNINDENT
4336 .INDENT 0.0
4337 .TP
4338 .B MODULES_ML
4339 If set to \fB1\fP, define \fBml\fP command when initializing Modules (see
4340 Package Initialization section). If set to \fB0\fP, \fBml\fP command is
4341 not defined.
4342 .sp
4343 This environment variable value supersedes the default value set in the
4344 \fBml\fP configuration option. It can be defined with the
4345 \fBconfig\fP sub\-command.
4346 .sp
4347 To enable or disable \fBml\fP command, \fBMODULES_ML\fP should be set
4348 prior Modules initialization or the \fBml\fP configuration option should
4349 be set in the \fBinitrc\fP configuration file.
4350 .UNINDENT
4351 .INDENT 0.0
4352 .TP
4353 .B MODULES_NEARLY_FORBIDDEN_DAYS
4354 Number of days a module is considered \fInearly forbidden\fP prior reaching its
4355 expiry date set by \fBmodule\-forbid\fP \%<#\:mfcmd-module-forbid> modulefile command. When a \fInearly
4356 forbidden\fP module is evaluated a warning message is issued to inform module
4357 will soon be forbidden. If set to \fB0\fP, modules will never be considered
4358 \fInearly forbidden\fP\&. Accepted values are integers comprised between 0 and 365.
4359 .sp
4360 This environment variable value supersedes the default value set in the
4361 \fBnearly_forbidden_days\fP configuration option. It can be defined with
4362 the \fBconfig\fP sub\-command.
4363 .UNINDENT
4364 .INDENT 0.0
4365 .TP
4366 .B MODULES_PAGER
4367 Text viewer for use to paginate message output if error output stream is
4368 attached to a terminal. The value of this variable is composed of a pager
4369 command name or path eventually followed by command\-line options.
4370 .sp
4371 This environment variable value supersedes the default value set in the
4372 \fBpager\fP configuration option. It can be defined with the
4373 \fBconfig\fP sub\-command.
4374 .sp
4375 If \fBMODULES_PAGER\fP variable is set to an empty string or to the value
4376 \fBcat\fP, pager will not be launched.
4377 .sp
4378 Pager is never launched if \fBmodulecmd.tcl\fP program is run for scripting
4379 language rather shells.
4380 .UNINDENT
4381 .INDENT 0.0
4382 .TP
4383 .B MODULES_PROTECTED_ENVVARS
4384 A colon separated list of environment variable names that should not be
4385 modified by any modulefile command.
4386 .sp
4387 Prevents modifications by \fBappend\-path\fP \%<#\:mfcmd-append-path>, \fBprepend\-path\fP \%<#\:mfcmd-prepend-path>,
4388 \fBremove\-path\fP \%<#\:mfcmd-remove-path>, \fBsetenv\fP \%<#\:mfcmd-setenv> and \fBunsetenv\fP \%<#\:mfcmd-unsetenv>\&. When these
4389 modulefile commands attempt to modify a protected environment variable,
4390 a warning message is emitted and modification is ignored.
4391 .sp
4392 This environment variable value supersedes the default value set in the
4393 \fBprotected_envvars\fP configuration option. It can be defined with the
4394 \fBconfig\fP sub\-command.
4395 .UNINDENT
4396 .INDENT 0.0
4397 .TP
4398 .B MODULES_QUARANTINE_SUPPORT
4399 If set to \fB1\fP, produces the shell code for quarantine mechanism when the
4400 \fBautoinit\fP sub\-command generates the \fBmodule\fP shell
4401 function.
4402 .sp
4403 The generated shell code for quarantine mechanism indirectly passes the
4404 environment variable defined in \fBMODULES_RUN_QUARANTINE\fP to the
4405 \fBmodulecmd.tcl\fP script to protect its run\-time environment from
4406 side\-effect coming from the current definition of these variables.
4407 .sp
4408 To enable quarantine support, \fBMODULES_QUARANTINE_SUPPORT\fP should be
4409 set to \fB1\fP prior Modules initialization or the
4410 \fBquarantine_support\fP configuration should be set to \fB1\fP in the
4411 \fBinitrc\fP configuration file.
4412 .sp
4413 Generated code for quarantine mechanism sets the
4414 \fB__MODULES_QUARANTINE_SET\fP environment variable when calling the
4415 \fBmodulecmd.tcl\fP script to make it restore the environment variable put
4416 in quarantine.
4417 .sp
4418 This environment variable value supersedes the default value set in the
4419 \fBquarantine_support\fP configuration option. It can be defined with
4420 the \fBconfig\fP sub\-command.
4421 .UNINDENT
4422 .INDENT 0.0
4423 .TP
4424 .B MODULES_REDIRECT_OUTPUT
4425 If set to \fB0\fP, the output generated by module command is kept on stderr and
4426 not redirected to stdout channel.
4427 .sp
4428 This environment variable value supersedes the default value set in the
4429 \fBredirect_output\fP configuration option. It can be defined with
4430 the \fBconfig\fP sub\-command. The \fB\-\-redirect\fP and
4431 \fB\-\-no\-redirect\fP command line switches override this environment
4432 variable.
4433 .UNINDENT
4434 .INDENT 0.0
4435 .TP
4436 .B MODULES_REQUIRE_VIA
4437 If set to \fB1\fP, consider loaded module that enables a modulepath (through
4438 the use of the modulefile commands \fBmodule use\fP \%<#\:mfcmd-module>,
4439 \fBappend\-path MODULEPATH\fP \%<#\:mfcmd-append-path>, or \fBprepend\-path
4440 MODULEPATH\fP \%<#\:mfcmd-prepend-path>) a requirement for loaded modules stored in this
4441 modulepath. If set to \fB0\fP, no dependency is made between these modules.
4442 .sp
4443 This environment variable value supersedes the default value set in the
4444 \fBrequire_via\fP configuration option. It can be defined with the
4445 \fBconfig\fP sub\-command.
4446 .UNINDENT
4447 .INDENT 0.0
4448 .TP
4449 .B MODULES_RESET_TARGET_STATE
4450 Defines behavior of \fBreset\fP sub\-command. When set to \fB__init__\fP,
4451 initial environment is restored. When set to \fB__purge__\fP, \fBreset\fP
4452 performs a \fBpurge\fP sub\-command. Any other value designates a name
4453 collection to \fBrestore\fP\&.
4454 .sp
4455 This environment variable value supersedes the default value set in the
4456 \fBreset_target_state\fP configuration option. It can be defined with
4457 the \fBconfig\fP sub\-command.
4458 .UNINDENT
4459 .INDENT 0.0
4460 .TP
4461 .B MODULES_RUN_QUARANTINE
4462 A space separated list of environment variable names that should be passed
4463 indirectly to \fBmodulecmd.tcl\fP to protect its run\-time environment from
4464 side\-effect coming from their current definition.
4465 .sp
4466 If the quarantine mechanism has been included in \fBmodule\fP shell
4467 function (see \fBMODULES_QUARANTINE_SUPPORT\fP), each variable found in
4468 \fBMODULES_RUN_QUARANTINE\fP will have its value emptied or set to the
4469 value of the corresponding \fBMODULES_RUNENV_<VAR>\fP variable when
4470 defining \fBmodulecmd.tcl\fP run\-time environment.
4471 .sp
4472 Original values of these environment variables set in quarantine are passed
4473 to \fBmodulecmd.tcl\fP via \fB__MODULES_QUAR_<VAR>\fP variables.
4474 .sp
4475 This environment variable value supersedes the default value set in the
4476 \fBrun_quarantine\fP configuration option. It can be defined with the
4477 \fBconfig\fP sub\-command.
4478 .UNINDENT
4479 .INDENT 0.0
4480 .TP
4481 .B MODULES_RUNENV_<VAR>
4482 Value to set to environment variable \fB<VAR>\fP for
4483 \fBmodulecmd.tcl\fP run\-time execution if \fB<VAR>\fP is referred in
4484 \fBMODULES_RUN_QUARANTINE\fP\&.
4485 .UNINDENT
4486 .INDENT 0.0
4487 .TP
4488 .B MODULES_SEARCH_MATCH
4489 When searching for modules with \fBavail\fP, \fBlist\fP,
4490 \fBspider\fP or collections with \fBsavelist\fP sub\-commands, defines
4491 the way query string should match against available module/collection names.
4492 With \fBstarts_with\fP value, returned modules/collections are those whose
4493 name begins by search query string. When set to \fBcontains\fP, any
4494 modules/collections whose fully qualified name contains search query string
4495 are returned.
4496 .sp
4497 This environment variable value supersedes the default value set in the
4498 \fBsearch_match\fP configuration option. It can be defined with the
4499 \fBconfig\fP sub\-command. The \fB\-\-starts\-with\fP and
4500 \fB\-\-contains\fP command line switches override this environment
4501 variable.
4502 .UNINDENT
4503 .INDENT 0.0
4504 .TP
4505 .B MODULES_SET_SHELL_STARTUP
4506 If set to \fB1\fP, defines when \fBmodule\fP command initializes the shell
4507 startup file to ensure that the \fBmodule\fP command is still defined in
4508 sub\-shells. Setting shell startup file means defining the \fBENV\fP and
4509 \fBBASH_ENV\fP environment variable to the Modules bourne shell
4510 initialization script. If set to \fB0\fP, shell startup file is not defined.
4511 .sp
4512 This environment variable value supersedes the default value set in the
4513 \fBset_shell_startup\fP configuration option. It can be defined with the
4514 \fBconfig\fP sub\-command.
4515 .sp
4516 To enable shell startup file, \fBMODULES_SET_SHELL_STARTUP\fP should be
4517 set to \fB1\fP prior Modules initialization or the \fBset_shell_startup\fP
4518 configuration option should be set to \fB1\fP in the \fBinitrc\fP
4519 configuration file.
4520 .UNINDENT
4521 .INDENT 0.0
4522 .TP
4523 .B MODULES_SHELLS_WITH_KSH_FPATH
4524 A list of shell on which the \fBFPATH\fP environment variable should be
4525 defined at initialization time to point to the \fBksh\-functions\fP
4526 directory where the ksh initialization script for module command is located.
4527 It enables for the listed shells to get module function defined when starting
4528 ksh as sub\-shell from there.
4529 .sp
4530 Accepted values are a list of shell among \fIsh\fP, \fIbash\fP, \fIcsh\fP, \fItcsh\fP and
4531 \fIfish\fP separated by colon character (\fB:\fP).
4532 .sp
4533 This environment variable value supersedes the default value set in the
4534 \fBshells_with_ksh_fpath\fP configuration option. It can be defined with
4535 the \fBconfig\fP sub\-command.
4536 .sp
4537 To enable the setup of \fBFPATH\fP for some shells,
4538 \fBMODULES_SHELLS_WITH_KSH_FPATH\fP should be set to the list of these
4539 shells prior Modules initialization or the \fBshells_with_ksh_fpath\fP
4540 configuration option should be set to the list of these shells in the
4541 \fBinitrc\fP configuration file.
4542 .UNINDENT
4543 .INDENT 0.0
4544 .TP
4545 .B MODULES_SILENT_SHELL_DEBUG
4546 If set to \fB1\fP, disable any \fBxtrace\fP or \fBverbose\fP debugging property set
4547 on current shell session for the duration of either the \fBmodule\fP
4548 command or the module shell initialization script. Only applies to Bourne
4549 Shell (sh) and its derivatives.
4550 .sp
4551 This environment variable value supersedes the default value set in the
4552 \fBsilent_shell_debug\fP configuration option. It can be defined with the
4553 \fBconfig\fP sub\-command.
4554 .sp
4555 To generate the code to silence shell debugging property in the
4556 \fBmodule\fP shell function, \fBMODULES_SILENT_SHELL_DEBUG\fP should
4557 be set to \fB1\fP prior Modules initialization or the
4558 \fBsilent_shell_debug\fP configuration option should be set to \fB1\fP in
4559 the \fBinitrc\fP configuration file.
4560 .UNINDENT
4561 .INDENT 0.0
4562 .TP
4563 .B MODULES_SITECONFIG
4564 Location of a site\-specific configuration script to source into
4565 \fBmodulecmd.tcl\fP\&. See Site\-specific configuration section for
4566 details.
4567 .sp
4568 This environment variable value supersedes the default value set in the
4569 \fBextra_siteconfig\fP configuration option. It can be defined with the
4570 \fBconfig\fP sub\-command. This environment variable is ignored if
4571 \fBextra_siteconfig\fP has been declared locked in
4572 \fBlocked_configs\fP configuration option.
4573 .UNINDENT
4574 .INDENT 0.0
4575 .TP
4576 .B MODULES_SOURCE_CACHE
4577 If set to \fB1\fP, cache content of files evaluated in modulefile through
4578 \fBsource(n)\fP Tcl command. When same file is sourced multiple times,
4579 cached content is reused rather reading file again.
4580 .sp
4581 This environment variable value supersedes the default value set in the
4582 \fBsource_cache\fP configuration option. It can be defined with the
4583 \fBconfig\fP sub\-command.
4584 .UNINDENT
4585 .INDENT 0.0
4586 .TP
4587 .B MODULES_SPIDER_INDEPTH
4588 If set to \fB1\fP, enable in depth search results for \fBspider\fP
4589 sub\-command. If set to \fB0\fP disable \fBspider\fP sub\-command in depth
4590 mode. Other values are ignored.
4591 .sp
4592 When in depth mode is enabled, modulefiles and directories contained in
4593 directories matching search query are also included in search results. When
4594 disabled these modulefiles and directories contained in matching directories
4595 are excluded.
4596 .sp
4597 This environment variable value supersedes the default value set in the
4598 \fBspider_indepth\fP configuration option. It can be defined with the
4599 \fBconfig\fP sub\-command. The \fB\-\-indepth\fP and
4600 \fB\-\-no\-indepth\fP command line switches override this environment
4601 variable.
4602 .UNINDENT
4603 .INDENT 0.0
4604 .TP
4605 .B MODULES_SPIDER_OUTPUT
4606 A colon separated list of the elements to report in addition to module names
4607 on \fBspider\fP sub\-command regular output mode.
4608 .sp
4609 Accepted elements that can be set in value list are:
4610 .INDENT 7.0
4611 .IP \(bu 2
4612 \fBalias\fP: module aliases.
4613 .IP \(bu 2
4614 \fBprovided\-alias\fP: show module aliases and evaluate all modulefiles to get
4615 aliases provided by them.
4616 .IP \(bu 2
4617 \fBdirwsym\fP: directories associated with symbolic versions.
4618 .IP \(bu 2
4619 \fBhidden\fP: show all hidden modules.
4620 .IP \(bu 2
4621 \fBindesym\fP: symbolic versions reported independently from the module or
4622 directory they are attached to.
4623 .IP \(bu 2
4624 \fBkey\fP: legend appended at the end of the output to explain it.
4625 .IP \(bu 2
4626 \fBmodulepath\fP: modulepath names set as header prior the list of available
4627 modules found in them.
4628 .IP \(bu 2
4629 \fBsym\fP: symbolic versions associated with available modules.
4630 .IP \(bu 2
4631 \fBtag\fP: tags associated with available modules.
4632 .IP \(bu 2
4633 \fBvariant\fP: variants and their possible values associated with available
4634 modules.
4635 .IP \(bu 2
4636 \fBvariantifspec\fP: like \fBvariant\fP but only if a variant has been
4637 specified in search query.
4638 .IP \(bu 2
4639 \fBvia\fP: mention next to modulepath name which module enables it if any.
4640 .UNINDENT
4641 .sp
4642 The order of the elements in the list does not matter. Module names are the
4643 only content reported when \fILIST\fP is set to an empty value.
4644 .sp
4645 In case the \fBmodulepath\fP element is missing from value list, the available
4646 modules from global/user rc and all enabled modulepaths are reported as a
4647 single list.
4648 .sp
4649 When \fBindesym\fP element is set, \fBdirwsym\fP and \fBsym\fP elements are
4650 disabled.
4651 .sp
4652 This environment variable value supersedes the default value set in the
4653 \fBspider_output\fP configuration option. It can be defined with
4654 the \fBconfig\fP sub\-command. The \fB\-\-output\fP/\fB\-o\fP command
4655 line switches override this environment variable.
4656 .UNINDENT
4657 .INDENT 0.0
4658 .TP
4659 .B MODULES_SPIDER_TERSE_OUTPUT
4660 A colon separated list of the elements to report in addition to module names
4661 on \fBspider\fP sub\-command terse output mode.
4662 .sp
4663 See \fBMODULES_SPIDER_OUTPUT\fP to get the accepted elements that can be
4664 set in value list. Exception for \fBvia\fP element which is not accepted for
4665 terse output mode.
4666 .sp
4667 The order of the elements in the list does not matter. Module names are the
4668 only content reported when \fILIST\fP is set to an empty value.
4669 .sp
4670 This environment variable value supersedes the default value set in the
4671 \fBspider_terse_output\fP configuration option. It can be defined with
4672 the \fBconfig\fP sub\-command. The \fB\-\-output\fP/\fB\-o\fP
4673 command line switches override this environment variable.
4674 .UNINDENT
4675 .INDENT 0.0
4676 .TP
4677 .B MODULES_STICKY_PURGE
4678 When unloading a sticky or super\-sticky module during a module
4679 \fBpurge\fP, raise an \fBerror\fP or emit a \fBwarning\fP message or be
4680 \fBsilent\fP\&.
4681 .sp
4682 This environment variable value supersedes the default value set in the
4683 \fBsticky_purge\fP configuration option. It can be defined with the
4684 \fBconfig\fP sub\-command.
4685 .UNINDENT
4686 .INDENT 0.0
4687 .TP
4688 .B MODULES_TAG_ABBREV
4689 Specifies the abbreviation strings used to report module tags (see Module
4690 tags section). Its value is a colon\-separated list of module tag names
4691 associated to an abbreviation string (e.g. \fItagname=abbrev\fP).
4692 .sp
4693 If a tag is associated to an empty string abbreviation, this tag will not be
4694 reported. In case the whole \fBMODULES_TAG_ABBREV\fP environment variable
4695 is set to an empty string, tags are reported but not abbreviated.
4696 .sp
4697 This environment variable value supersedes the default value set in the
4698 \fBtag_abbrev\fP configuration option. It can be defined with the
4699 \fBconfig\fP sub\-command.
4700 .UNINDENT
4701 .INDENT 0.0
4702 .TP
4703 .B MODULES_TAG_COLOR_NAME
4704 Specifies the tag names or abbreviations whose graphical rendering should be
4705 applied over themselves instead of being applied over the name of the module
4706 they are attached to. Value of \fBMODULES_TAG_COLOR_NAME\fP is a
4707 colon\-separated list of module tag names or abbreviation strings (see Module
4708 tags section).
4709 .sp
4710 When a select graphic rendition is defined for a tag name or a tag
4711 abbreviation string, it is applied over the module name associated with the
4712 tag and tag name or abbreviation is not displayed. When listed in
4713 \fBMODULES_TAG_COLOR_NAME\fP environment variable, a tag name or
4714 abbreviation is displayed and select graphic rendition is applied over it.
4715 .sp
4716 This environment variable value supersedes the default value set in the
4717 \fBtag_color_name\fP configuration option. It can be defined with the
4718 \fBconfig\fP sub\-command.
4719 .UNINDENT
4720 .INDENT 0.0
4721 .TP
4722 .B MODULES_TCL_LINTER
4723 Command name or path for use to check syntax of modulefile through the
4724 \fBlint\fP sub\-command.
4725 .sp
4726 This environment variable value supersedes the default value set in the
4727 \fBtcl_linter\fP configuration option. It can be defined with the
4728 \fBconfig\fP sub\-command.
4729 .UNINDENT
4730 .INDENT 0.0
4731 .TP
4732 .B MODULES_TERM_BACKGROUND
4733 Inform Modules of the terminal background color to determine if the color set
4734 for dark background or the color set for light background should be used to
4735 color output in case no specific color set is defined with the
4736 \fBMODULES_COLORS\fP variable. Accepted values are \fBdark\fP and
4737 \fBlight\fP\&.
4738 .sp
4739 This environment variable value supersedes the default value set in the
4740 \fBterm_background\fP configuration option. It can be defined with the
4741 \fBconfig\fP sub\-command.
4742 .UNINDENT
4743 .INDENT 0.0
4744 .TP
4745 .B MODULES_TERM_WIDTH
4746 Specifies the number of columns of the output. If set to \fB0\fP, the output
4747 width will be the full terminal width, which is automatically detected by
4748 the module command. Accepted values are integers comprised between 0 and
4749 1000.
4750 .sp
4751 This environment variable value supersedes the default value set in the
4752 \fBterm_width\fP configuration option. It can be defined with the
4753 \fBconfig\fP sub\-command. The \fB\-\-width\fP/\fB\-w\fP command line
4754 switches override this environment variable.
4755 .UNINDENT
4756 .INDENT 0.0
4757 .TP
4758 .B MODULES_UNIQUE_NAME_LOADED
4759 If set to \fB1\fP, allows only one module loaded per module name. A conflict is
4760 raised when loading a module whose name or alternative names are shared by an
4761 already loaded module.
4762 .sp
4763 This environment variable value supersedes the default value set in the
4764 \fBunique_name_loaded\fP configuration option. It can be defined with
4765 the \fBconfig\fP sub\-command.
4766 .UNINDENT
4767 .INDENT 0.0
4768 .TP
4769 .B MODULES_UNLOAD_MATCH_ORDER
4770 When a module unload request matches multiple loaded modules, unload firstly
4771 loaded module or lastly loaded module. Accepted values are \fBreturnfirst\fP
4772 and \fBreturnlast\fP\&.
4773 .sp
4774 This environment variable value supersedes the default value set in the
4775 \fBunload_match_order\fP configuration option. It can be defined with
4776 the \fBconfig\fP sub\-command.
4777 .UNINDENT
4778 .INDENT 0.0
4779 .TP
4780 .B MODULES_VARIANT_SHORTCUT
4781 Specifies the shortcut characters that could be used to specify and report
4782 module variants (see Module variants section). Its value is a
4783 colon\-separated list of variant names associated to a shortcut character
4784 (e.g., \fIvariantname=shortcutchar\fP).
4785 .sp
4786 A variant shortcut must be of one character length and must avoid characters
4787 used for other concerns or in module names or version specifications (i.e.,
4788 \fI[\-+~/@=:,a\-zA\-Z0\-9]\fP).
4789 .sp
4790 If a shortcut is associated to an empty string or an invalid character, this
4791 shortcut definition will be ignored.
4792 .sp
4793 This environment variable value supersedes the default value set in the
4794 \fBvariant_shortcut\fP configuration option. It can be defined with the
4795 \fBconfig\fP sub\-command.
4796 .UNINDENT
4797 .INDENT 0.0
4798 .TP
4799 .B MODULES_VERBOSITY
4800 Defines the verbosity level of the module command. Available verbosity levels
4801 from the least to the most verbose are:
4802 .INDENT 7.0
4803 .IP \(bu 2
4804 \fBsilent\fP: turn off error, warning and informational messages but does not
4805 affect module command output result.
4806 .IP \(bu 2
4807 \fBconcise\fP: enable error and warning messages but disable informational
4808 messages.
4809 .IP \(bu 2
4810 \fBnormal\fP: turn on informational messages, like a report of the additional
4811 module evaluations triggered by loading or unloading modules, aborted
4812 evaluation issues or a report of each module evaluation occurring during a
4813 \fBrestore\fP or \fBsource\fP sub\-commands.
4814 .IP \(bu 2
4815 \fBverbose\fP: add additional informational messages, like a systematic
4816 report of the loading or unloading module evaluations.
4817 .IP \(bu 2
4818 \fBverbose2\fP: report loading or unloading module evaluations of
4819 hidden\-loaded modules, report if loading module is already loaded or if
4820 unloading module is not loaded.
4821 .IP \(bu 2
4822 \fBtrace\fP: provide details on module searches, resolutions, selections and
4823 evaluations.
4824 .IP \(bu 2
4825 \fBdebug\fP: print debugging messages about module command execution.
4826 .IP \(bu 2
4827 \fBdebug2\fP: report \fBmodulecmd.tcl\fP procedure calls in addition to
4828 printing debug messages.
4829 .UNINDENT
4830 .sp
4831 This environment variable value supersedes the default value set in the
4832 \fBverbosity\fP configuration option. It can be defined with the
4833 \fBconfig\fP sub\-command. The \fB\-\-silent\fP, \fB\-\-verbose\fP,
4834 \fB\-\-debug\fP and \fB\-\-trace\fP command line switches override this
4835 environment variable.
4836 .UNINDENT
4837 .INDENT 0.0
4838 .TP
4839 .B MODULES_WA_277
4840 If set to \fB1\fP prior to Modules package initialization, enables workaround
4841 for Tcsh history issue (see \%<https://\:github\:.com/\:envmodules/\:modules/\:issues/\:277>).
4842 This issue leads to erroneous history entries under Tcsh shell. When
4843 workaround is enabled, an alternative \fImodule\fP alias is defined which fixes
4844 the history mechanism issue. However the alternative definition of the
4845 \fImodule\fP alias weakens shell evaluation of the code produced by modulefiles.
4846 Characters with a special meaning for Tcsh shell (like \fB{\fP and \fB}\fP) may
4847 not be used anymore in shell alias definition otherwise the evaluation of the
4848 code produced by modulefiles will return a syntax error.
4849 .sp
4850 This environment variable value supersedes the default value set in the
4851 \fBwa_277\fP configuration option. It can be defined with the
4852 \fBconfig\fP sub\-command.
4853 .sp
4854 To enable this workaround, \fBMODULES_WA_277\fP should be set to \fB1\fP
4855 prior Modules initialization or the \fBwa_277\fP configuration option
4856 should be set to \fB1\fP in the \fBinitrc\fP configuration file.
4857 .UNINDENT
4858 .INDENT 0.0
4859 .TP
4860 .B MODULESHOME
4861 The location of the main Modules package file directory containing module
4862 command initialization scripts, the executable program \fBmodulecmd.tcl\fP,
4863 and a directory containing a collection of main \fImodulefiles\fP\&.
4864 .sp
4865 This environment variable value supersedes the default value set in the
4866 \fBhome\fP configuration option. It can be defined with the
4867 \fBconfig\fP sub\-command.
4868 .UNINDENT
4869 .SH FILES
4870 .sp
4871 \fB@prefix@\fP
4872 .INDENT 0.0
4873 .INDENT 3.5
4874 The \fBMODULESHOME\fP directory.
4875 .UNINDENT
4876 .UNINDENT
4877 .sp
4878 \fB@etcdir@/initrc\fP
4879 .INDENT 0.0
4880 .INDENT 3.5
4881 The configuration file evaluated by \fBmodulecmd.tcl\fP when it initializes
4882 to enable the default modulepaths, load the default modules and set
4883 \fBmodule\fP command configuration.
4884 .sp
4885 \fBinitrc\fP is a modulefile \%<#\:modulefile-5> so it is written as a Tcl script and
4886 defines modulepaths to enable with \fBmodule use\fP \%<#\:mfcmd-module>, modules to
4887 load with \fBmodule load\fP \%<#\:mfcmd-module> and configuration to apply with
4888 \fBmodule config\fP\&. As any modulefile \fBinitrc\fP must begin
4889 with the Modules magic cookie (i.e., \fB#%Module\fP file signature).
4890 .sp
4891 \fBinitrc\fP is optional. When this configuration file is present it is
4892 evaluated after the \fBmodulespath\fP configuration file. See the
4893 Package Initialization section for details.
4894 .UNINDENT
4895 .UNINDENT
4896 .sp
4897 \fB@etcdir@/modulespath\fP
4898 .INDENT 0.0
4899 .INDENT 3.5
4900 The configuration file evaluated by \fBmodulecmd.tcl\fP when it initializes
4901 to enable the default modulepaths. This file contains the list of modulepaths
4902 separated by either newline or colon characters.
4903 .sp
4904 \fBmodulespath\fP is optional. When this configuration file is present it
4905 is evaluated before the \fBinitrc\fP configuration file. See the
4906 Package Initialization section for details.
4907 .UNINDENT
4908 .UNINDENT
4909 .sp
4910 \fB@etcdir@/siteconfig.tcl\fP
4911 .INDENT 0.0
4912 .INDENT 3.5
4913 The site\-specific configuration script of \fBmodulecmd.tcl\fP\&. An
4914 additional configuration script could be defined using the
4915 \fBMODULES_SITECONFIG\fP environment variable. See Site\-specific configuration for detailed information.
4916 .UNINDENT
4917 .UNINDENT
4918 .sp
4919 \fB@etcdir@/rc\fP
4920 .INDENT 0.0
4921 .INDENT 3.5
4922 The system\-wide modules rc file. The location of this file can be changed
4923 using the \fBMODULERCFILE\fP environment variable as described above.
4924 .UNINDENT
4925 .UNINDENT
4926 .sp
4927 \fB$HOME/.modulerc\fP
4928 .INDENT 0.0
4929 .INDENT 3.5
4930 The user specific modules rc file.
4931 .UNINDENT
4932 .UNINDENT
4933 .sp
4934 \fB$HOME/.module\fP
4935 .INDENT 0.0
4936 .INDENT 3.5
4937 The user specific collection directory.
4938 .UNINDENT
4939 .UNINDENT
4940 .sp
4941 \fB@modulefilesdir@\fP
4942 .INDENT 0.0
4943 .INDENT 3.5
4944 The directory for system\-wide \fImodulefiles\fP\&. The location of the directory
4945 can be changed using the \fBMODULEPATH\fP environment variable as
4946 described above.
4947 .UNINDENT
4948 .UNINDENT
4949 .sp
4950 \fB<modulepath>/.modulerc\fP
4951 .INDENT 0.0
4952 .INDENT 3.5
4953 Modulepath\-specific module rc file.
4954 .UNINDENT
4955 .UNINDENT
4956 .sp
4957 \fB<modulepath>/.modulecache\fP
4958 .INDENT 0.0
4959 .INDENT 3.5
4960 Modulepath\-specific module cache file.
4961 .UNINDENT
4962 .UNINDENT
4963 .sp
4964 \fB@libexecdir@/modulecmd.tcl\fP
4965 .INDENT 0.0
4966 .INDENT 3.5
4967 The \fImodulefile\fP interpreter that gets executed upon each invocation
4968 of \fBmodule\fP\&.
4969 .UNINDENT
4970 .UNINDENT
4971 .sp
4972 \fB@initdir@/<shell>\fP
4973 .INDENT 0.0
4974 .INDENT 3.5
4975 The Modules package initialization file sourced into the user\(aqs environment.
4976 .UNINDENT
4977 .UNINDENT
4978 .SH SEE ALSO
4979 .sp
4980 ml \%<#\:ml-1>, modulefile \%<#\:modulefile-5>, envml \%<#\:envml-1>
4981 .SH Copyright
4982 1996-2025, Modules Contributors
4983 .\" End of generated man page.