Debian Codegraph @

doc/build/module.1.in

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