Debian Codegraph @

doc/build/module.1.in

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