1MODULE(1) Modules MODULE(1)
2
6 module - command interface to the Modules package
7
9 module [switches] [sub-command [sub-command-args]]
10
12 module is a user interface to the Modules package. The Modules package
13 provides for the dynamic modification of the user's environment via
14 modulefiles.
15 Each modulefile contains the information needed to configure the shell
17 for an application. Once the Modules package is initialized, the envi‐
18 ronment can be modified on a per-module basis using the module command
19 which interprets modulefiles. Typically modulefiles instruct the module
20 command to alter or set shell environment variables such as PATH, MAN‐
21 PATH, etc. Modulefiles may be shared by many users on a system and
22 users may have their own set to supplement or replace the shared mod‐
23 ulefiles.
24 The modulefiles are added to and removed from the current environment
26 by the user. The environment changes contained in a modulefile can be
27 summarized through the module command as well. If no arguments are
28 given, a summary of the module usage and sub-commands are shown.
29 The action for the module command to take is described by the sub-com‐
31 mand and its associated arguments.
32 Package Initialization
34 The Modules package and the module command are initialized when a
35 shell-specific initialization script is sourced into the shell. The
36 script creates the module command as either an alias or function and
37 creates Modules environment variables.
38 The module alias or function executes the modulecmd.tcl program located
40 in /usr/share/Modules/libexec and has the shell evaluate the command's
41 output. The first argument to modulecmd.tcl specifies the type of
42 shell.
43 The initialization scripts are kept in /usr/share/Modules/init/<shell>
45 where <shell> is the name of the sourcing shell. For example, a C Shell
46 user sources the /usr/share/Modules/init/csh script. The sh, csh, tcsh,
47 bash, ksh, zsh and fish shells are supported by modulecmd.tcl. In addi‐
48 tion, python, perl, ruby, tcl, cmake, r and lisp "shells" are supported
49 which writes the environment changes to stdout as python, perl, ruby,
50 tcl, lisp, r or cmake code.
51 Initialization may also be performed by calling the autoinit sub-com‐
53 mand of the modulecmd.tcl program. Evaluation into the shell of the
54 result of this command defines the module alias or function.
55 Examples of initialization
57 C Shell initialization (and derivatives):
58 source /usr/share/Modules/init/csh
60 module load modulefile modulefile ...
61 Bourne Shell (sh) (and derivatives):
63 . /usr/share/Modules/init/sh
65 module load modulefile modulefile ...
66 Perl:
68 require "/usr/share/Modules/init/perl.pm";
70 &module('load', 'modulefile', 'modulefile', '...');
71 Python:
73 import os
75 exec(open('/usr/share/Modules/init/python.py').read())
76 module('load', 'modulefile', 'modulefile', '...')
77 Bourne Shell (sh) (and derivatives) with autoinit sub-command:
79 eval "`/usr/share/Modules/libexec/modulecmd.tcl sh autoinit`"
81 Modulecmd startup
83 Upon invocation modulecmd.tcl sources if it exists a site-specific con‐
84 figuration script located in /usr/share/Modules/etc/siteconfig.tcl.
85 This Tcl script enables to supersede any global variable or procedure
86 definition of modulecmd.tcl.
87 Afterward, modulecmd.tcl sources rc files which contain global, user
89 and modulefile specific setups. These files are interpreted as module‐
90 files. See modulefile(4) for detailed information.
91 Upon invocation of modulecmd.tcl module run-command files are sourced
93 in the following order:
94 1. Global RC file as specified by $MODULERCFILE or /usr/share/Mod‐
96 ules/etc/rc. If $MODULERCFILE points to a directory, the modulerc
97 file in this directory is used as global RC file.
98 2. User specific module RC file $HOME/.modulerc
100 3. All .modulerc and .version files found during modulefile seeking.
102 Command line switches
104 The module command accepts command line switches as its first parame‐
105 ter. These may be used to control output format of all information
106 displayed and the module behavior in case of locating and interpreting
107 modulefiles.
108 All switches may be entered either in short or long notation. The fol‐
110 lowing switches are accepted:
111 --help, -h
113 Give some helpful usage information, and terminates the command.
114 --version, -V
116 Lists the current version of the module command. The command then
117 terminates without further processing.
118 --debug, -D
120 Debug mode. Causes module to print debugging messages about its
121 progress.
122 --paginate
124 Pipe all message output into less (or if set, $MODULES_PAGER) if
125 error output stream is a terminal. See also MODULES_PAGER section.
126 --no-pager
128 Do not pipe message output into a pager.
129 --auto
131 On load, unload and switch sub-commands, enable automated module
132 handling mode. See also MODULES_AUTO_HANDLING section.
133 --no-auto
135 On load, unload and switch sub-commands, disable automated module
136 handling mode. See also MODULES_AUTO_HANDLING section.
137 --force, -f
139 On load, unload and switch sub-commands, by-pass any unsatisfied
140 modulefile constraint corresponding to the declared prereq and con‐
141 flict. Which means for instance that a modulefile will be loaded
142 even if it comes in conflict with another loaded modulefile or that
143 a modulefile will be unloaded even if it is required as a prereq by
144 another modulefile.
145 --terse, -t
147 Display avail, list and savelist output in short format.
148 --long, -l
150 Display avail, list and savelist output in long format.
151 --default, -d
153 On avail sub-command, display only the default version of each mod‐
154 ule name. Default version is either the explicitly set default ver‐
155 sion or the highest numerically sorted modulefile if no default ver‐
156 sion set (see Locating Modulefiles section in the modulefile(4) man
157 page).
158 --latest, -L
160 On avail sub-command, display only the highest numerically sorted
161 version of each module name (see Locating Modulefiles section in the
162 modulefile(4) man page).
163 Module Sub-Commands
165 help [modulefile...]
166 Print the usage of each sub-command. If an argument is given, print
167 the Module-specific help information for the modulefile.
168 add modulefile...
170 See load.
171 load [--auto|--no-auto] [-f] modulefile...
173 Load modulefile into the shell environment.
174 rm modulefile...
176 See unload.
177 unload [--auto|--no-auto] [-f] modulefile...
179 Remove modulefile from the shell environment.
180 swap [modulefile1] modulefile2
182 See switch.
183 switch [--auto|--no-auto] [-f] [modulefile1] modulefile2
185 Switch loaded modulefile1 with modulefile2. If modulefile1 is not
186 specified, then it is assumed to be the currently loaded module with
187 the same root name as modulefile2.
188 show modulefile...
190 See display.
191 display modulefile...
193 Display information about one or more modulefiles. The display
194 sub-command will list the full path of the modulefile and the envi‐
195 ronment changes the modulefile will make if loaded. (Note: It will
196 not display any environment changes found within conditional state‐
197 ments.)
198 list [-t|-l]
200 List loaded modules.
201 avail [-d|-L] [-t|-l] [path...]
203 List all available modulefiles in the current MODULEPATH. All direc‐
204 tories in the MODULEPATH are recursively searched for files contain‐
205 ing the modulefile magic cookie. If an argument is given, then each
206 directory in the MODULEPATH is searched for modulefiles whose path‐
207 name, symbolic version-name or alias match the argument. Argument
208 may contain wildcard characters. Multiple versions of an application
209 can be supported by creating a subdirectory for the application con‐
210 taining modulefiles for each version.
211 Symbolic version-names and aliases found in the search are displayed
213 in the result of this sub-command. Symbolic version-names are dis‐
214 played next to the modulefile they are assigned to within parenthe‐
215 sis. Aliases are listed in the MODULEPATH section where they have
216 been defined. To distinguish aliases from modulefiles a @ symbol is
217 added within parenthesis next to their name. Aliases defined through
218 a global or user specific module RC file are listed under the
219 global/user modulerc section.
220 aliases
222 List all available symbolic version-names and aliases in the current
223 MODULEPATH. All directories in the MODULEPATH are recursively
224 searched in the same manner than for the avail sub-command. Only the
225 symbolic version-names and aliases found in the search are dis‐
226 played.
227 use [-a|--append] directory...
229 Prepend one or more directories to the MODULEPATH environment vari‐
230 able. The --append flag will append the directory to MODULEPATH.
231 Reference counter environment variable MODULEPATH_modshare is also
233 set to increase the number of times directory has been added to MOD‐
234 ULEPATH.
235 unuse directory...
237 Remove one or more directories from the MODULEPATH environment vari‐
238 able if reference counter of these directories is equal to 1 or
239 unknown.
240 Reference counter of directory in MODULEPATH denotes the number of
242 times directory has been enabled. When attempting to remove direc‐
243 tory from MODULEPATH, reference counter variable MODULEPATH_modshare
244 is checked and directory is removed only if its relative counter is
245 equal to 1 or not defined. Elsewhere directory is kept and reference
246 counter is decreased by 1.
247 refresh
249 See reload.
250 reload
252 Unload then load all loaded modulefiles.
253 No unload then load is performed and an error is returned if the
255 loaded modulefiles have unsatisfied constraint corresponding to the
256 prereq and conflict they declare.
257 purge
259 Unload all loaded modulefiles.
260 source modulefile...
262 Execute modulefile into the shell environment. modulefile must be
263 specified with a fully qualified path. Once executed modulefile is
264 not marked loaded in shell environment which differ from load
265 sub-command.
266 whatis [modulefile...]
268 Display the information set up by the module-whatis commands inside
269 the specified modulefiles. These specified modulefiles may be
270 expressed using wildcard characters. If no modulefile is specified,
271 all module-whatis lines will be shown.
272 apropos string
274 See search.
275 keyword string
277 See search.
278 search string
280 Seeks through the module-whatis informations of all modulefiles for
281 the specified string. All module-whatis informations matching the
282 string will be displayed. string may contain wildcard characters.
283 test modulefile...
285 Execute and display results of the Module-specific tests for the
286 modulefile.
287 save [collection]
289 Record the currently set MODULEPATH directory list and the currently
290 loaded modulefiles in a collection file under the user's collection
291 directory $HOME/.module. If collection name is not specified, then
292 it is assumed to be the default collection. If collection is a fully
293 qualified path, it is saved at this location rather than under the
294 user's collection directory.
295 If MODULES_COLLECTION_TARGET is set, a suffix equivalent to the
297 value of this variable will be appended to the collection file name.
298 By default, if loaded modulefile corresponds to the default module
300 version, the bare module name is recorded. If MODULES_COLLEC‐
301 TION_PIN_VERSION is set to 1, module version is always recorded even
302 if it is the default version.
303 No collection is recorded and an error is returned if the loaded
305 modulefiles have unsatisfied constraint corresponding to the prereq
306 and conflict they declare.
307 restore [collection]
309 Restore the environment state as defined in collection. If collec‐
310 tion name is not specified, then it is assumed to be the default
311 collection. If collection is a fully qualified path, it is restored
312 from this location rather than from a file under the user's collec‐
313 tion directory. If MODULES_COLLECTION_TARGET is set, a suffix equiv‐
314 alent to the value of this variable is appended to the collection
315 file name to restore.
316 When restoring a collection, the currently set MODULEPATH directory
318 list and the currently loaded modulefiles are unused and unloaded
319 then used and loaded to exactly match the MODULEPATH and loaded mod‐
320 ulefiles lists saved in this collection file. The order of the paths
321 and modulefiles set in collection is preserved when restoring. It
322 means that currently loaded modules are unloaded to get the same
323 LOADEDMODULES root than collection and currently used module paths
324 are unused to get the same MODULEPATH root. Then missing module
325 paths are used and missing modulefiles are loaded.
326 saverm [collection]
328 Delete the collection file under the user's collection directory. If
329 collection name is not specified, then it is assumed to be the
330 default collection. If MODULES_COLLECTION_TARGET is set, a suffix
331 equivalent to the value of this variable will be appended to the
332 collection file name.
333 saveshow [collection]
335 Display the content of collection. If collection name is not speci‐
336 fied, then it is assumed to be the default collection. If collection
337 is a fully qualified path, this location is displayed rather than a
338 collection file under the user's collection directory. If MOD‐
339 ULES_COLLECTION_TARGET is set, a suffix equivalent to the value of
340 this variable will be appended to the collection file name.
341 savelist [-t|-l]
343 List collections that are currently saved under the user's collec‐
344 tion directory. If MODULES_COLLECTION_TARGET is set, only collec‐
345 tions matching the target suffix will be displayed.
346 initadd modulefile...
348 Add modulefile to the shell's initialization file in the user's home
349 directory. The startup files checked (in order) are:
350 C Shell
352 .modules, .cshrc, .csh_variables and .login
353 TENEX C Shell
355 .modules, .tcshrc, .cshrc, .csh_variables and .login
356 Bourne and Korn Shells
358 .modules, .profile
359 GNU Bourne Again Shell
361 .modules, .bash_profile, .bash_login, .profile and .bashrc
362 Z Shell
364 .modules, .zshrc, .zshenv and .zlogin
365 Friendly Interactive Shell
367 .modules, .config/fish/config.fish
368 If a module load line is found in any of these files, the module‐
370 files are appended to any existing list of modulefiles. The module
371 load line must be located in at least one of the files listed above
372 for any of the init sub-commands to work properly. If the module
373 load line is found in multiple shell initialization files, all of
374 the lines are changed.
375 initprepend modulefile...
377 Does the same as initadd but prepends the given modules to the
378 beginning of the list.
379 initrm modulefile...
381 Remove modulefile from the shell's initialization files.
382 initswitch modulefile1 modulefile2
384 Switch modulefile1 with modulefile2 in the shell's initialization
385 files.
386 initlist
388 List all of the modulefiles loaded from the shell's initialization
389 file.
390 initclear
392 Clear all of the modulefiles from the shell's initialization files.
393 path modulefile
395 Print path to modulefile.
396 paths modulefile
398 Print path of available modulefiles matching argument.
399 append-path [-d C|--delim C|--delim=C] [--duplicates] variable value...
401 Append value to environment variable. The variable is a colon, or
402 delimiter, separated list. See append-path in the modulefile(4) man
403 page for further explanation.
404 prepend-path [-d C|--delim C|--delim=C] [--duplicates] variable
406 value...
407 Prepend value to environment variable. The variable is a colon, or
408 delimiter, separated list. See prepend-path in the modulefile(4) man
409 page for further explanation.
410 remove-path [-d C|--delim C|--delim=C] [--index] variable value...
412 Remove value from the colon, or delimiter, separated list in envi‐
413 ronment variable. See remove-path in the modulefile(4) man page for
414 further explanation.
415 is-loaded [modulefile...]
417 Returns a true value if any of the listed modulefiles has been
418 loaded or if any modulefile is loaded in case no argument is pro‐
419 vided. Returns a false value elsewhere. See is-loaded in the module‐
420 file(4) man page for further explanation.
421 is-saved [collection...]
423 Returns a true value if any of the listed collections exists or if
424 any collection exists in case no argument is provided. Returns a
425 false value elsewhere. See is-saved in the modulefile(4) man page
426 for further explanation.
427 is-used [directory...]
429 Returns a true value if any of the listed directories has been
430 enabled in MODULEPATH or if any directory is enabled in case no
431 argument is provided. Returns a false value elsewhere. See is-used
432 in the modulefile(4) man page for further explanation.
433 is-avail modulefile...
435 Returns a true value if any of the listed modulefiles exists in
436 enabled MODULEPATH. Returns a false value elsewhere. See is-avail in
437 the modulefile(4) man page for further explanation.
438 info-loaded modulefile
440 Returns the names of currently loaded modules matching passed mod‐
441 ulefile. Returns an empty string if passed modulefile does not
442 match any loaded modules. See module-info loaded in the module‐
443 file(4) man page for further explanation.
444 Modulefiles
446 modulefiles are written in the Tool Command Language (Tcl) and are
447 interpreted by modulecmd.tcl. modulefiles can use conditional state‐
448 ments. Thus the effect a modulefile will have on the environment may
449 change depending upon the current state of the environment.
450 Environment variables are unset when unloading a modulefile. Thus, it
452 is possible to load a modulefile and then unload it without having the
453 environment variables return to their prior state.
454 Collections
456 Collections describe a sequence of module use then module load commands
457 that are interpreted by modulecmd.tcl to set the user environment as
458 described by this sequence. When a collection is activated, with the
459 restore sub-command, module paths and loaded modules are unused or
460 unloaded if they are not part or if they are not ordered the same way
461 as in the collection.
462 Collections are generated by the save sub-command that dumps the cur‐
464 rent user environment state in terms of module paths and loaded mod‐
465 ules. By default collections are saved under the $HOME/.module direc‐
466 tory.
467 Collections may be valid for a given target if they are suffixed. In
469 this case these collections can only be restored if their suffix corre‐
470 spond to the current value of the MODULES_COLLECTION_TARGET environment
471 variable (see the dedicated section of this topic below).
472
474 The module command exits with 0 if its execution succeed. Elsewhere 1
475 is returned.
476
478 LOADEDMODULES
479 A colon separated list of all loaded modulefiles.
480 MODULEPATH
482 The path that the module command searches when looking for module‐
483 files. Typically, it is set to the master modulefiles directory,
484 /usr/share/Modules/modulefiles, by the initialization script. MOD‐
485 ULEPATH can be set using module use or by the module initialization
486 script to search group or personal modulefile directories before or
487 after the master modulefile directory.
488 Path elements registered in the MODULEPATH environment variable may
490 contain reference to environment variables which are converted to
491 their corresponding value by module command each time it looks at
492 the MODULEPATH value. If an environment variable referred in a path
493 element is not defined, its reference is converted to an empty
494 string.
495 MODULESHOME
497 The location of the master Modules package file directory containing
498 module command initialization scripts, the executable program mod‐
499 ulecmd.tcl, and a directory containing a collection of master mod‐
500 ulefiles.
501 MODULES_AUTO_HANDLING
503 If set to 1, enable automated module handling mode. If set to 0 dis‐
504 able automated module handling mode. Other values are ignored.
505 Automated module handling mode consists in additional actions trig‐
507 gered when loading or unloading a modulefile to satisfy the con‐
508 straints it declares. When loading a modulefile, following actions
509 are triggered:
510 · Requirement Load: load of the modulefiles declared as a prereq of
512 the loading modulefile.
513 · Dependent Reload: reload of the modulefiles declaring a prereq
515 onto loaded modulefile or declaring a prereq onto a modulefile
516 part of this reloading batch.
517 When unloading a modulefile, following actions are triggered:
519 · Dependent Unload: unload of the modulefiles declaring a
521 non-optional prereq onto unloaded modulefile or declaring a
522 non-optional prereq onto a modulefile part of this unloading
523 batch. A prereq modulefile is considered optional if the prereq
524 definition order is made of multiple modulefiles and at least one
525 alternative modulefile is loaded.
526 · Useless Requirement Unload: unload of the prereq modulefiles that
528 have been automatically loaded for either the unloaded modulefile,
529 an unloaded dependent modulefile or a modulefile part of this use‐
530 less requirement unloading batch. Modulefiles are added to this
531 unloading batch only if they are not required by any other loaded
532 modulefiles.
533 · Dependent Reload: reload of the modulefiles declaring a conflict
535 or an optional prereq onto either the unloaded modulefile, an
536 unloaded dependent or an unloaded useless requirement or declaring
537 a prereq onto a modulefile part of this reloading batch.
538 In case a loaded modulefile has some of its declared constraints
540 unsatisfied (pre-required modulefile not loaded or conflicting mod‐
541 ulefile loaded for instance), this loaded modulefile is excluded
542 from the automatic reload actions described above.
543 For the specific case of the switch sub-command, where a modulefile
545 is unloaded to then load another modulefile. Dependent modulefiles
546 to Unload are merged into the Dependent modulefiles to Reload that
547 are reloaded after the load of the switched-to modulefile.
548 Automated module handling mode enablement is defined in the follow‐
550 ing order of preference: --auto/--no-auto command line switches,
551 then MODULES_AUTO_HANDLING environment variable, then the default
552 set in modulecmd.tcl script configuration. Which means MOD‐
553 ULES_AUTO_HANDLING overrides default configuration and
554 --auto/--no-auto command line switches override every other ways to
555 enable or disable this mode.
556 MODULES_CMD
558 The location of the active module command script.
559 MODULES_COLLECTION_PIN_VERSION
561 If set to 1, register exact version number of modulefiles when sav‐
562 ing a collection. Elsewhere modulefile version number is omitted if
563 it corresponds to the implicit or explicitly set default version.
564 MODULES_COLLECTION_TARGET
566 The collection target that determines what collections are valid
567 thus reachable on the current system.
568 Collection directory may sometimes be shared on multiple machines
570 which may use different modules setup. For instance modules users
571 may access with the same HOME directory multiple systems using dif‐
572 ferent OS versions. When it happens a collection made on machine 1
573 may be erroneous on machine 2.
574 When a target is set, only the collections made for that target are
576 available to the restore, savelist, saveshow and saverm sub-com‐
577 mands. Saving collection registers the target footprint by suffixing
578 the collection filename with .$MODULES_COLLECTION_TARGET. Collection
579 target is not involved when collection is specified as file path on
580 the saveshow, restore and save sub-commands.
581 For example, the MODULES_COLLECTION_TARGET variable may be set with
583 results from commands like lsb_release, hostname, dnsdomainname,
584 etc.
585 MODULES_LMALTNAME
587 A colon separated list of the alternative names set through mod‐
588 ule-version and module-alias statements corresponding to all loaded
589 modulefiles. Each element in this list starts by the name of the
590 loaded modulefile followed by all alternative names resolving to it.
591 The loaded modulefile and its alternative names are separated by the
592 ampersand character.
593 This environment variable is intended for module command internal
595 use to get knowledge of the alternative names matching loaded mod‐
596 ulefiles in order to keep environment consistent when conflicts or
597 pre-requirements are set over these alternative designations. It
598 also helps to find a match after modulefiles being loaded when
599 unload, is-loaded or info-loaded actions are run over these names.
600 MODULES_LMCONFLICT
602 A colon separated list of the conflict statements defined by all
603 loaded modulefiles. Each element in this list starts by the name of
604 the loaded modulefile declaring the conflict followed by the name of
605 all modulefiles it declares a conflict with. These loaded module‐
606 files and conflicting modulefile names are separated by the amper‐
607 sand character.
608 This environment variable is intended for module command internal
610 use to get knowledge of the conflicts declared by the loaded module‐
611 files in order to keep environment consistent when a conflicting
612 module is asked for load afterward.
613 MODULES_LMNOTUASKED
615 A colon separated list of all loaded modulefiles that were not
616 explicitly asked for load from the command-line.
617 This environment variable is intended for module command internal
619 use to distinguish the modulefiles that have been loaded automati‐
620 cally from modulefiles that have been asked by users.
621 MODULES_LMPREREQ
623 A colon separated list of the prereq statements defined by all
624 loaded modulefiles. Each element in this list starts by the name of
625 the loaded modulefile declaring the pre-requirement followed by the
626 name of all modulefiles it declares a prereq with. These loaded mod‐
627 ulefiles and pre-required modulefile names are separated by the
628 ampersand character. When a prereq statement is composed of multiple
629 modulefiles, these modulefile names are separated by the pipe char‐
630 acter.
631 This environment variable is intended for module command internal
633 use to get knowledge of the pre-requirement declared by the loaded
634 modulefiles in order to keep environment consistent when a
635 pre-required module is asked for unload afterward.
636 MODULES_PAGER
638 Text viewer for use to paginate message output if error output
639 stream is attached to a terminal. The value of this variable is com‐
640 posed of a pager command name or path eventually followed by com‐
641 mand-line options.
642 Paging command and options are defined for Modules in the following
644 order of preference: MODULES_PAGER environment variable, then the
645 default set in modulecmd.tcl script configuration. Which means MOD‐
646 ULES_PAGER overrides default configuration.
647 If MODULES_PAGER variable is set to an empty string or to the value
649 cat, pager will not be launched.
650 MODULES_RUNENV_<VAR>
652 Value to set to environment variable <VAR> for modulecmd.tcl
653 run-time execution if <VAR> is referred in MODULES_RUN_QUARANTINE.
654 MODULES_RUN_QUARANTINE
656 A space separated list of environment variable names that should be
657 passed indirectly to modulecmd.tcl to protect its run-time environ‐
658 ment from side-effect coming from their current definition.
659 Each variable found in MODULES_RUN_QUARANTINE will have its value
661 emptied or set to the value of the corresponding MOD‐
662 ULES_RUNENV_<VAR> variable when defining modulecmd.tcl run-time
663 environment.
664 Original values of these environment variables set in quarantine are
666 passed to modulecmd.tcl via <VAR>_modquar variables.
667 MODULES_SILENT_SHELL_DEBUG
669 If set to 1, disable any xtrace or verbose debugging property set on
670 current shell session for the duration of either the module command
671 or the module shell initialization script. Only applies to Bourne
672 Shell (sh) and its derivatives.
673 MODULES_USE_COMPAT_VERSION
675 If set to 1 prior to Modules package initialization, enable Modules
676 compatibility version (3.2 release branch) rather main version at
677 initialization scripts running time. Modules package compatibility
678 version should be installed along with main version for this envi‐
679 ronment variable to have any effect.
680 _LMFILES_
682 A colon separated list of the full pathname for all loaded module‐
683 files.
684 <VAR>_modquar
686 Value of environment variable <VAR> passed to modulecmd.tcl in order
687 to restore <VAR> to this value once started.
688 <VAR>_modshare
690 Reference counter variable for path-like variable <VAR>. A colon
691 separated list containing pairs of elements. A pair is formed by a
692 path element followed its usage counter which represents the number
693 of times this path has been enabled in variable <VAR>. A colon sepa‐
694 rates the two parts of the pair.
695
697 /usr/share/Modules
698 The MODULESHOME directory.
699 /usr/share/Modules/etc/rc
701 The system-wide modules rc file. The location of this file can be
702 changed using the MODULERCFILE environment variable as described
703 above.
704 $HOME/.modulerc
706 The user specific modules rc file.
707 $HOME/.module
709 The user specific collection directory.
710 /usr/share/Modules/modulefiles
712 The directory for system-wide modulefiles. The location of the
713 directory can be changed using the MODULEPATH environment variable
714 as described above.
715 /usr/share/Modules/libexec/modulecmd.tcl
717 The modulefile interpreter that gets executed upon each invocation
718 of module.
719 /usr/share/Modules/init/<shell>
721 The Modules package initialization file sourced into the user's
722 environment.
723
725 modulefile(4)
726
728 1996-1999 John L. Furlani & Peter W. Osel, 1998-2017 R.K.Owen,
729 2002-2004 Mark Lakata, 2004-2017 Kent Mein, 2016-2019 Xavier Delaruelle
7304.2.4 2019-04-26 MODULE(1)