Debian Codegraph @

doc/build/INSTALL.txt

raw
1 Installing Modules on Unix
2 **************************
3
4 This document is an overview of building and installing Modules on a
5 Unix system.
6
7
8 Requirements
9 ============
10
11 Modules consists of one Tcl script so to run it from a user shell the
12 only requirement is to have a working version of "tclsh" (version 8.5
13 or later) available on your system. "tclsh" is a part of Tcl
14 (http://www.tcl-lang.org/software/tcltk/).
15
16 To install Modules from a distribution tarball or a clone of the git
17 repository, a build step is there to tailor the "modulecmd.tcl" and
18 the initialization scripts to the chosen installation configuration
19 and create the documentation files. This build step requires the tools
20 to be found on your system:
21
22 * bash
23
24 * make
25
26 * sed
27
28 * runtest
29
30 When also installing Modules Tcl extension library (enabled by
31 default), these additional tools are needed:
32
33 * grep
34
35 * gcc
36
37 * tcl-devel >= 8.5
38
39 When installing from a distribution tarball, documentation is pre-
40 built and scripts to configure Modules Tcl extension library build are
41 already generated. Thus no additional software is required. When
42 installing from a clone of the git repository or from a git archive
43 export, documentation and scripts to prepare for compilation have to
44 be built and the following tools are required:
45
46 * autoconf
47
48 * automake
49
50 * autopoint
51
52 * m4
53
54 * python
55
56 * sphinx >= 1.0
57
58 * gzip
59
60 The following features of Modules rely on external tools. Default tool
61 may be changed or their location on target system may be specified.
62 Alternatively these features may also be disabled.
63
64 +------------------+-------------------------+---------------------------------+
65 | Feature option | Default external tool | Installation options |
66 |==================|=========================|=================================|
67 | pager | "less" | "--with-pager", "--without- |
68 | | | pager" |
69 +------------------+-------------------------+---------------------------------+
70 | logger | "logger" | "--with-logger", "--without- |
71 | | | logger" |
72 +------------------+-------------------------+---------------------------------+
73 | tcl_linter | "nagelfar.tcl" | "--with-tcl-linter", "-- |
74 | | | without-linter" |
75 +------------------+-------------------------+---------------------------------+
76
77
78 Get Modules
79 ===========
80
81 Modules can usually be installed with the package manager of your Unix
82 system. It it is available by default on most Linux distributions, on
83 OS X and FreeBSD either under the name of "modules" or "environment-
84 modules".
85
86 If you want to install Modules from sources, tarballs from all
87 Modules' releases can be retrieved from one of the following link:
88
89 * https://github.com/envmodules/modules/releases/
90
91 * https://sourceforge.net/projects/modules/files/Modules/
92
93 For instance to download then unpack the last release of Modules:
94
95 $ curl -LJO https://github.com/envmodules/modules/releases/download/v5.7.0/modules-5.7.0.tar.gz
96 $ tar xfz modules-5.7.0.tar.gz
97
98
99 Installation instructions
100 =========================
101
102 The simplest way to build and install Modules is:
103
104 $ ./configure
105 $ make
106 $ make install
107
108 Some explanation, step by step:
109
110 1. "cd" to the directory containing the package's source code. Your
111 system must have the above requirements installed to properly build
112 scripts, and documentation if build occurs from a clone of the git
113 repository.
114
115 2. Type "./configure" to adapt the installation for your system. At
116 this step you can choose the installation paths and the features
117 you want to enable in the initialization scripts (see Build and
118 installation options section below for a complete overview of the
119 available options)
120
121 3. Type "make" to adapt scripts to the configuration, build Tcl
122 extension library if enabled and build documentation if working
123 from git repository.
124
125 4. Optionally, type "make test QUICKTEST=1" to run the lightweight
126 version of the non-regression test suite.
127
128 5. Type "make install" to install modulecmd.tcl, initialization
129 scripts and documentation.
130
131 6. Optionally, type "make testinstall" to run the installation test
132 suite.
133
134 7. You can remove the built files from the source code directory by
135 typing "make clean". To also remove the files that "configure"
136 created, type "make distclean".
137
138 A default installation process like described above will install
139 Modules under "/usr/local/Modules". You can change this with the "--
140 prefix" option. By default, "/usr/local/Modules/modulefiles" will be
141 setup as the default directory containing modulefiles. "--
142 modulefilesdir" option enables to change this directory location. For
143 example:
144
145 $ ./configure --prefix=/usr/share/Modules \
146 --modulefilesdir=/etc/modulefiles
147
148 See Build and installation options section to discover all
149 "./configure" option available.
150
151 Note:
152
153 GNU Make is excepted to be used for this build and installation
154 process. On non-Linux systems, the "gmake" should be called instead
155 of "make".
156
157
158 Enable Modules in shells
159 ========================
160
161 Shell initialization scripts should be adapted to enable Modules
162 during their startup. Enabling Modules means defining the "module"
163 shell function and applying its configuration.
164
165 An easy way to achieve that is to make Modules initialization scripts
166 part of the system-wide environment setup in "/etc/profile.d".To do
167 so, make a link in this directory to the profile scripts that can be
168 found in your Modules installation init directory. For instance, if
169 Modules has been installed in "/usr/share/modules":
170
171 $ ln -s /usr/share/modules/init/profile.sh /etc/profile.d/modules.sh
172 $ ln -s /usr/share/modules/init/profile.csh /etc/profile.d/modules.csh
173
174 These profile scripts will automatically adapt to the kind of "sh" or
175 "csh" shell you are running.
176
177 Another approach is to get the Modules initialization script sourced
178 from the shell configuration startup file. For instance following line
179 could be added to the end of the "~/.bashrc" file if running Bash
180 shell:
181
182 . /usr/share/modules/init/bash
183
184 Beware that shells have multiple ways to initialize depending if they
185 are a login shell or not and if they are launched in interactive mode
186 or not.
187
188 Depending on your OS distribution system-wide profile scripts may be
189 ignored when initializing non-interactive shells. This is for instance
190 the case on Debian distribution and its derivatives like Ubuntu. On
191 such system, Modules initialization script should be sourced by shell
192 initialization files to get "module" function defined when executing a
193 command through "ssh" or running a script. Add the following code
194 snippets to the initialization files of the shell you use.
195
196 * For **Bash**, update either system-wide ("/etc/bash.bashrc" on
197 Debian-like systems) or personal ("~/.bashrc") initialization file:
198
199 # enable module command in non-login shells
200 if ! shopt -q login_shell; then
201 . /usr/share/modules/init/bash
202 fi
203
204 * For **Csh**/**Tcsh**, add Modules initialization file into Csh rc
205 directory ("/etc/csh/cshrc.d" on Debian-like systems):
206
207 ln -s /usr/share/modules/init/csh /etc/csh/cshrc.d/modules
208
209 Or update personal ("~/.cshrc") initialization file:
210
211 # enable module command in non-login shells
212 if (! $?loginsh) then
213 source /usr/share/modules/init/csh
214 endif
215
216 * For **Zsh**, update either system-wide ("/etc/zsh/zshenv" on Debian-
217 like systems) or personal ("~/.zshenv") initialization file:
218
219 # enable module command
220 . /usr/share/modules/init/zsh
221
222 * For **Ksh**, update personal ("~/.kshrc") initialization file:
223
224 # enable module command
225 . /usr/share/modules/init/ksh
226
227 * For **Fish**, add Modules initialization file into Fish system-wide
228 config directory ("/etc/fish/conf.d"):
229
230 ln -s /usr/share/modules/init/fish /etc/fish/conf.d/modules.fish
231
232 Or into Fish personal config directory ("~/.config/fish/conf.d"):
233
234 ln -s /usr/share/modules/init/fish ~/.config/fish/conf.d/modules.fish
235
236
237 Configuration
238 =============
239
240 Once installed you should review and adapt the configuration to make
241 it fit your needs. The following steps are provided for example. They
242 are not necessarily mandatory as it depends of the kind of setup you
243 want to achieve.
244
245 1. Define module paths to enable by default. Edit "initrc"
246 configuration file in the directory designated by the "--etcdir"
247 option or edit "modulespath" in the same directory.
248
249 If you use "modulespath" configuration file, add one line
250 mentioning each modulefile directory:
251
252 /path/to/regular/modulefiles
253 /path/to/other/modulefiles
254
255 If you use "initrc" configuration file, add one line mentioning
256 each modulefile directory prefixed by the "module use" command:
257
258 module use /path/to/regular/modulefiles
259 module use /path/to/other/modulefiles
260
261 In case both configuration files "initrc" and "modulespath" are
262 present, Modules initialization process will first evaluate
263 "modulespath" then "initrc".
264
265 By default, the modulepaths specified on the "--with-modulepath"
266 installation option are automatically defined for use in "initrc"
267 (or in "modulespath" if the "--enable-modulespath" installation
268 option has been set).
269
270 Note:
271
272 If you have set "--with-initconf-in" to "initdir" to install the
273 Modules initialization configurations in the configuration
274 directory designated by the "--initdir" option, the configuration
275 files "initrc" and "modulespath" are respectively named
276 "modulerc" and ".modulespath".
277
278 2. Define modulefiles to load by default. Edit "initrc" configuration
279 file. Modulefiles to load cannot be specified in "modulespath"
280 file. Add there all the modulefiles you want to load by default at
281 Modules initialization time.
282
283 Add one line mentioning each modulefile to load prefixed by the
284 "module load" command:
285
286 module load foo
287 module load bar
288
289 By default, the modules specified on the "--with-loadedmodules"
290 installation option are automatically defined for load in "initrc".
291
292 Alternatively, if users have module collections saved in their
293 "HOME" directory, you may prefer restoring their default collection
294 when Modules initializes rather loading the default module list:
295
296 if {[is-saved default]} {
297 module restore
298 } else {
299 module load foo
300 module load bar
301 }
302
303 In fact you can add to the "initrc" configuration file any kind of
304 supported module command, like "module config" commands to tune
305 **module**'s default behaviors. This configuration way is
306 recommended over directly modifying the shell initialization
307 scripts.
308
309 See the Configuration options section to discover all Modules "config"
310 options available, their default value and the installation options
311 linked to them.
312
313 If you go through the above steps you should have a valid setup tuned
314 to your needs. After that you still have to write modulefiles to get
315 something to load and unload in your newly configured Modules setup.
316 In case you want to achieve a specific setup, some additional steps
317 may be required:
318
319 3. In case the configuration you expect cannot be achieved through the
320 "initrc" configuration file, you may review and tune the
321 initialization scripts. These files are located in the directory
322 designated by the "--initdir" option. Beware that these scripts
323 could be overwritten when upgrading to a newer version of Modules,
324 so configuration should be done through the "initrc" file as far as
325 possible.
326
327 4. If you want to alter the way the "modulecmd.tcl" script operates,
328 the "siteconfig.tcl" script may be used. This Tcl file is located
329 in the directory designated by the "--etcdir" option. Every time
330 the **module** command is called, it executes the "modulecmd.tcl"
331 script which in turns sources the "siteconfig.tcl" script during
332 its startup phase. The site-specific configuration script could
333 override default configuration values and more largely could
334 supersede all procedures defined in "modulecmd.tcl" to obtain
335 specific behaviors.
336
337 5. Prior running the module sub-command specified as argument, the
338 "modulecmd.tcl" script evaluates the global run-command files.
339 These files are either the "rc" file in the directory designated by
340 the "--etcdir" option, the file(s) designated in the "MODULERCFILE"
341 environment variable or the user-specific RC file located in
342 "$HOME/.modulerc". The RC files are modulefiles (limited to a
343 subset of the modulefile Tcl commands) that could define global
344 module aliases, virtual modules or module properties such as tags,
345 forbidding rules, etc.
346
347 Note:
348
349 Run-command files are intended to set parameters for modulefiles,
350 not to configure the **module** command itself.
351
352 To learn more about siteconfig and run-command files, see the
353 Modulecmd startup section in module reference manual. You may also
354 look at the available setup recipes to get concrete deployment
355 examples of these files.
356
357
358 Upgrading
359 =========
360
361 In case you want to upgrade a pre-existing Modules installation, it is
362 suggested to:
363
364 1. Backup configuration files stored in *etcdir* (like
365 "siteconfig.tcl" or "initrc");
366
367 2. Remove previous Modules installation;
368
369 3. Install new Modules version;
370
371 4. Review specific configuration of previous installation and adapt
372 configuration files of new version.
373
374 It is advised to look at the different documents describing changes
375 and new features appearing between versions. By reading these
376 documents you will be able to determine the specific configuration
377 options to apply to satisfy your use cases.
378
379 * Changes between versions
380
381 * Release notes
382
383 * New features
384
385 In case you install Modules with the "--enable-versioning" option set,
386 you may be able to install a new version of Modules alongside existing
387 ones (if they also have been installed with this option set).
388
389
390 Build and installation options
391 ==============================
392
393 Options available at the "./configure" installation step are described
394 below. These options enable to choose the installation paths and the
395 features to enable or disable. You can also get a description of these
396 options by typing "./configure --help".
397
398 Fine tuning of the installation directories (the default value for
399 each option is displayed within brackets):
400
401 --bindir=DIR
402
403 Directory for executables reachable by users ["PREFIX/bin"]
404
405 --datarootdir=DIR
406
407 Base directory to set the man and doc directories ["PREFIX/share"]
408
409 --docdir=DIR
410
411 Directory to host documentation other than man pages like README,
412 license file, etc ["DATAROOTDIR/doc"]
413
414 --emacsdatadir=DIR
415
416 Directory to host Emacs addon files ["DATAROOTDIR/emacs/lisp"]
417
418 --etcdir=DIR
419
420 Directory for the executable configuration scripts ["PREFIX/etc"]
421
422 --initdir=DIR
423
424 Directory for the per-shell environment initialization scripts
425 ["PREFIX/init"]
426
427 --libdir=DIR
428
429 Directory for object code libraries like libtclenvmodules.so
430 ["PREFIX/lib"]
431
432 --libexecdir=DIR
433
434 Directory for executables called by other executables like
435 modulecmd.tcl ["PREFIX/libexec"]
436
437 --mandir=DIR
438
439 Directory to host man pages ["DATAROOTDIR/man"]
440
441 --modulefilesdir=DIR
442
443 Directory of main modulefiles also called system modulefiles
444 ["PREFIX/modulefiles"]
445
446 --nagelfardatadir=DIR
447
448 Directory to host Nagelfar linter addon files
449 ["DATAROOTDIR/nagelfar"]
450
451 --prefix=PREFIX
452
453 Installation root directory ["/usr/local/Modules"]
454
455 --vimdatadir=DIR
456
457 Directory to host Vim addon files ["DATAROOTDIR/vim/vimfiles"]
458
459 Optional Features (the default for each option is displayed within
460 parenthesis, to disable an option replace "enable" by "disable" for
461 instance "--disable-set-manpath"):
462
463 --enable-advanced-version-spec
464
465 Activate the advanced module version specifiers which enables to
466 finely select module versions by specifying after the module name a
467 version constraint prefixed by the "@" character. This option also
468 allows to specify module variants. (default=yes)
469
470 This installation option defines the default value of the
471 "advanced_version_spec" configuration option which could be changed
472 after installation with the "config" sub-command.
473
474 --enable-append-binpath
475
476 Append rather prepend binary directory to the PATH environment
477 variable when the "--enable-set-binpath" option is enabled.
478 (default=no)
479
480 --enable-append-manpath
481
482 Append rather prepend man page directory to the MANPATH environment
483 variable when the "--enable-set-manpath" option is enabled.
484 (default=no)
485
486 --enable-append-pythonpath
487
488 Append rather prepend the "env_modules" Python module directory to
489 the PYTHONPATH environment variable when the "--enable-set-
490 pythonpath" option is enabled. (default=no)
491
492 --enable-auto-handling
493
494 Set modulecmd.tcl to automatically apply automated modulefiles
495 handling actions, like loading the pre-requisites of a modulefile
496 when loading this modulefile. (default=yes)
497
498 This installation option defines the default value of the
499 "auto_handling" configuration option which could be changed after
500 installation with the "config" sub-command.
501
502 --enable-avail-indepth
503
504 When performing an "avail" sub-command, include in search results
505 the matching modulefiles and directories and recursively the
506 modulefiles and directories contained in these matching directories
507 when enabled or limit search results to the matching modulefiles
508 and directories found at the depth level expressed by the search
509 query if disabled. (default=yes)
510
511 This installation option defines the default value of the
512 "avail_indepth" configuration option which could be changed after
513 installation with the "config" sub-command.
514
515 --enable-color
516
517 Control if output should be colored by default or not. A value of
518 "yes" equals to the "auto" color mode. "no" equals to the "never"
519 color mode. (default=yes)
520
521 This installation option defines the default value of the "color"
522 configuration option which could be changed after installation with
523 the "config" sub-command.
524
525 --enable-compressed-changelog
526
527 Control if "ChangeLog" documentation file should be installed in a
528 compressed format or not. (default=yes)
529
530 --enable-conflict-unload
531
532 Apply automated unload of conflicting modulefiles when loading a
533 module. (default=no)
534
535 This installation option defines the default value of the
536 "conflict_unload" configuration option which could be changed after
537 installation with the "config" sub-command.
538
539 --enable-doc-install
540
541 Install the documentation files in the documentation directory
542 defined with the "--docdir" option. This feature has no impact on
543 manual pages installation. Disabling documentation file
544 installation is useful in case of installation process handled via
545 a package manager which handles by itself the installation of this
546 kind of documents. (default=yes)
547
548 --enable-emacs-addons
549
550 Install the Emacs addon files in the Emacs addons directory defined
551 with the "--emacsdatadir" option. (default=yes)
552
553 --enable-example-modulefiles
554
555 Install some modulefiles provided as example in the system
556 modulefiles directory defined with the "--modulefilesdir" option.
557 (default=yes)
558
559 --enable-extended-default
560
561 Allow to specify module versions by their starting part, i.e.
562 substring separated from the rest of the version string by a "."
563 character. (default=yes)
564
565 This installation option defines the default value of the
566 "extended_default" configuration option which could be changed
567 after installation with the "config" sub-command.
568
569 --enable-implicit-default
570
571 Define an implicit default version, for modules with none
572 explicitly defined, to select when the name of the module to
573 evaluate is passed without the mention of a specific version. When
574 this option is disabled the name of the module passed for
575 evaluation should be fully qualified elsewhere an error is
576 returned. (default=yes)
577
578 This installation option defines the default value of the
579 "implicit_default" configuration option which could be changed
580 after installation with the "config" sub-command.
581
582 --enable-implicit-requirement
583
584 Implicitly define a prereq or a conflict requirement toward modules
585 specified respectively on "module load" or "module unload" commands
586 in modulefile. (default=yes)
587
588 This installation option defines the default value of the
589 "implicit_requirement" configuration option which could be changed
590 after installation with the "config" sub-command.
591
592 --enable-libtclenvmodules
593
594 Build and install the Modules Tcl extension library which provides
595 optimized Tcl commands for the modulecmd.tcl script. (default=yes)
596
597 --enable-mcookie-version-check
598
599 Enable check of the version specified right after Modules magic
600 cookie (i.e., "#%Module" file signature) in modulefiles, which
601 defines the minimal version of the Modules tool to use in order to
602 evaluate the modulefile. (default=yes)
603
604 This installation option defines the default value of the
605 "mcookie_version_check" configuration option which could be changed
606 after installation with the "config" sub-command.
607
608 --enable-ml
609
610 Define the **ml** command, a handy frontend to the module command,
611 when Modules initializes. (default=yes)
612
613 This installation option defines the default value of the "ml"
614 configuration option which could be changed after installation with
615 the "config" sub-command.
616
617 --enable-modulespath, --enable-dotmodulespath
618
619 Set the module paths defined by "--with-modulepath" option in a
620 "modulespath" file (following C version fashion) within the
621 initialization directory defined by the "--etcdir" option rather
622 than within the "initrc" file. Or respectively, if option "--with-
623 initconf-in" has been set to "initdir", in a ".modulespath" file
624 within the configuration directory defined by the "--initdir"
625 option rather than within the "modulerc" file. (default=no)
626
627 --enable-multilib-support
628
629 Support multilib systems by looking in modulecmd.tcl at an
630 alternative location where to find the Modules Tcl extension
631 library depending on current machine architecture. (default=no)
632
633 --enable-nagelfar-addons
634
635 Install the Nagelfar linter addon files (syntax databases and
636 plugins to lint modulefiles and modulercs) in the Nagelfar addons
637 directory defined with the "--nagelfardatadir" option.
638 (default=yes)
639
640 --enable-new-features
641
642 Enable all new features that are disabled by default due to the
643 substantial behavior changes they imply on Modules 5. This option
644 is equivalent to the cumulative use of "--with-abort-on-
645 error=load:ml:reload:switch", "--enable-conflict-unload" and "--
646 enable-require-via". (default=no)
647
648 --enable-paginate
649
650 Control if output of module command should be piped into a pager by
651 default or not. (default=yes)
652
653 --enable-path-entry-reorder
654
655 Change order of entry in a path-like environment variable, when
656 "prepend-path", "append-path" or "use" target a path entry that is
657 already defined in the environment variable. (default=no)
658
659 This installation option defines the default value of the
660 "path_entry_reorder" configuration option which could be changed
661 after installation with the "config" sub-command.
662
663 --enable-quarantine-support
664
665 Generate code in module function definition to add support for the
666 environment variable quarantine mechanism (default=no)
667
668 This installation option defines the default value of the
669 "quarantine_support" configuration option which could be changed
670 after installation with the "config" sub-command.
671
672 --enable-require-via
673
674 Consider loaded module that enables a modulepath, a requirement of
675 loaded modules stored in this modulepath. (default=no)
676
677 This installation option defines the default value of the
678 "require_via" configuration option which could be changed after
679 installation with the "config" sub-command.
680
681 --enable-set-binpath
682
683 Prepend binary directory defined by the "--bindir" option to the
684 PATH environment variable in the shell initialization scripts.
685 (default=yes)
686
687 --enable-set-manpath
688
689 Prepend man page directory defined by the "--mandir" option to the
690 MANPATH environment variable in the shell initialization scripts.
691 (default=yes)
692
693 --enable-set-pythonpath
694
695 Prepend directory where the "env_modules" Python module is
696 installed (see "--with-pythondir" option) to the PYTHONPATH
697 environment variable in the shell initialization scripts.
698 (default=yes)
699
700 --enable-set-shell-startup
701
702 Set when module function is defined the shell startup file to
703 ensure that the module function is still defined in sub-shells.
704 (default=no)
705
706 This installation option defines the default value of the
707 "set_shell_startup" configuration option which could be changed
708 after installation with the "config" sub-command.
709
710 --enable-silent-shell-debug-support
711
712 Generate code in module function definition to add support for
713 silencing shell debugging properties (default=no)
714
715 This installation option defines the default value of the
716 "silent_shell_debug" configuration option which could be changed
717 after installation with the "config" sub-command.
718
719 --enable-source-cache
720
721 Cache content of files evaluated through *source(n)* Tcl command in
722 modulefile. When same file is sourced multiple times, cached
723 content is reused rather reading file again.
724
725 This installation option defines the default value of the
726 "source_cache" configuration option which could be changed after
727 installation with the "config" sub-command.
728
729 --enable-spider-indepth
730
731 When performing an "spider" sub-command, include in search results
732 the matching modulefiles and directories and recursively the
733 modulefiles and directories contained in these matching directories
734 when enabled or limit search results to the matching modulefiles
735 and directories found at the depth level expressed by the search
736 query if disabled. (default=yes)
737
738 This installation option defines the default value of the
739 "spider_indepth" configuration option which could be changed after
740 installation with the "config" sub-command.
741
742 --enable-versioning
743
744 Append Modules version to installation prefix and deploy a
745 "versions" modulepath shared between all versioning enabled Modules
746 installation. A modulefile corresponding to Modules version is
747 added to the shared modulepath and enables to switch from one
748 Modules version to another. (default=no)
749
750 --enable-unique-name-loaded
751
752 Only allow one module loaded per module name. A conflict is raised
753 when loading a module whose name or alternative names are shared by
754 an already loaded module. (default=no)
755
756 This installation option defines the default value of the
757 "unique_name_loaded" configuration option which could be changed
758 after installation with the "config" sub-command.
759
760 --enable-vim-addons
761
762 Install the Vim addon files in the Vim addons directory defined
763 with the "--vimdatadir" option. (default=yes)
764
765 --enable-wa-277
766
767 Activate workaround for issue #277 related to Tcsh history
768 mechanism which does not cope well with default module alias
769 definition. Note that enabling this workaround solves Tcsh history
770 issue but weakens shell evaluation of the code produced by
771 modulefiles. (default=no)
772
773 This installation option defines the default value of the "wa_277"
774 configuration option which could be changed after installation with
775 the "config" sub-command.
776
777 --enable-windows-support
778
779 Install all required files for Windows platform (**module**, **ml**
780 and **envml** command batch file and "cmd.cmd" initialization
781 script). (default=no)
782
783 Optional Packages (the default for each option is displayed within
784 parenthesis, to disable an option replace "with" by "without" for
785 instance "--without-modulepath"):
786
787 --with-abort-on-error=LIST
788
789 When evaluating multiple modulefiles, if one fails abort evaluation
790 sequence and withdraw already evaluated modulefiles for listed
791 module sub-commands. Sub-commands accepted in LIST are: "load",
792 **ml**, "mod-to-sh", "purge", "reload", "switch", "switch_unload",
793 "try-load" and "unload" (elements in LIST are separated by ":").
794 (default="ml:reload:switch_unload")
795
796 This installation option defines the default value of the
797 "abort_on_error" configuration option which could be changed after
798 installation with the "config" sub-command.
799
800 --with-avail-output=LIST
801
802 Specify the content to report on avail sub-command regular output
803 in addition to the available module names. Elements accepted in
804 LIST are: "modulepath", "alias", "provided-alias", "dirwsym",
805 "indesym", "sym", "tag", "key", "hidden", "variant",
806 "variantifspec" and "via" (elements in LIST are separated by ":").
807 The order of the elements in LIST does not matter.
808 (default="modulepath:alias:dirwsym:sym:tag:variantifspec:key")
809
810 This installation option defines the default value of the
811 "avail_output" configuration option which could be changed after
812 installation with the "config" sub-command.
813
814 --with-avail-terse-output=LIST
815
816 Specify the content to report on avail sub-command terse output in
817 addition addition to the available module names. Elements accepted
818 in LIST are: "modulepath", "alias", "provided-alias", "dirwsym",
819 "indesym", "sym", "tag", "key", "hidden", "variant" and
820 "variantifspec" (elements in LIST are separated by ":"). The order
821 of the elements in LIST does not matter.
822 (default="modulepath:alias:dirwsym:sym:tag:variantifspec")
823
824 This installation option defines the default value of the
825 "avail_terse_output" configuration option which could be changed
826 after installation with the "config" sub-command.
827
828 --with-bashcompletiondir=DIR
829
830 Directory for Bash completion scripts. When this option is not set
831 Bash completion script for Modules is installed in the
832 initialization script directory and is sourced from Modules Bash
833 initialization script. (default=)
834
835 --with-bin-search-path=PATHLIST
836
837 List of paths to look at when searching the location of tools
838 required to build and configure Modules
839 (default="/usr/bin:/bin:/usr/local/bin")
840
841 --with-dark-background-colors=SGRLIST
842
843 Default color set to apply if terminal background color is defined
844 to "dark". SGRLIST follows the same syntax than used in
845 "LS_COLORS". Each element in SGRLIST is an output item associated
846 to a Select Graphic Rendition (SGR) code. Elements in SGRLIST are
847 separated by ":". Output items are designated by keys.
848
849 Items able to be colorized are: highlighted element ("hi"), debug
850 information ("db"), trace information ("tr") tag separator ("se");
851 Error ("er"), warning ("wa"), module error ("me") and info ("in")
852 message prefixes; Modulepath ("mp"), directory ("di"), module alias
853 ("al"), module variant ("va"), module symbolic version ("sy") and
854 module "default" version ("de").
855
856 Module tags can also be colorized. The key to set in the color
857 palette to get a graphical rendering of a tag is the tag name or
858 the tag abbreviation if one is defined for tag. The SGR code
859 applied to a tag name is ignored if an abbreviation is set for this
860 tag thus the SGR code should be defined for this abbreviation to
861 get a graphical rendering. Each basic tag has by default a key set
862 in the color palette, based on its abbreviated string: auto-loaded
863 ("aL"), forbidden ("F"), hidden and hidden-loaded ("H"), loaded
864 ("L"), nearly-forbidden ("nF"), sticky ("S"), super-sticky ("sS"),
865 keep-loaded ("kL") and warning ("W").
866
867 For a complete SGR code reference, see https://en.wikipedia.org/wik
868 i/ANSI_escape_code#Select_Graphic_Rendition_parameters. (default="h
869 i=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp=1;94:di=94:al=96:va=9
870 3:sy=95:de=4:cm=92:aL=100:L=90;47:H=2:F=41:nF=31;43:S=46:sS=44:kL=3
871 0;48;5;109:W=30;43")
872
873 This installation option defines the default value of the "colors"
874 configuration option when "term_background" configuration option
875 equals "dark". "colors" could be changed after installation with
876 the "config" sub-command.
877
878 --with-domainname=BIN
879
880 Name or full path of default domainname program to use to fetch
881 domain name (can be superseded at run-time by environment variable)
882 (default="domainname")
883
884 This installation option and "--with-domainname-opts" define the
885 default value of the "domainname" configuration option which could
886 be changed after installation with the "config" sub-command.
887
888 --with-domainname-opts=OPTLIST
889
890 Settings to apply to default domainname program (default=)
891
892 This installation option and "--with-domainname" define the default
893 value of the "domainname" configuration option which could be
894 changed after installation with the "config" sub-command.
895
896 --with-editor=BIN
897
898 Name or full path of default editor program to use to open
899 modulefile through the "edit" sub-command. (default="vi")
900
901 This installation option defines the default value of the "editor"
902 configuration option which could be changed after installation with
903 the "config" sub-command.
904
905 --with-fishcompletiondir=DIR
906
907 Directory for Fish completion scripts. When this option is not set
908 Fish completion script for Modules is installed in the
909 initialization script directory and is sourced from Modules Fish
910 initialization script. (default=)
911
912 --with-icase=VALUE
913
914 Apply a case insensitive match to module specification on "avail",
915 "whatis" and "paths" sub-commands (when set to "search") or on all
916 module sub-commands and modulefile Tcl commands for the module
917 specification they receive as argument (when set to "always"). Case
918 insensitive match is disabled when this option is set to "never".
919 (default="search")
920
921 This installation option defines the default value of the "icase"
922 configuration option which could be changed after installation with
923 the "config" sub-command.
924
925 --with-initconf-in=VALUE
926
927 Location where to install Modules initialization configuration
928 files. Either "initdir" or "etcdir" (default="etcdir")
929
930 --with-init-envvars=LIST
931
932 Initial values to assign to environment variables before they are
933 modified for the first time. Each entry in LIST must use the format
934 "VARIABLE_NAME=initial_value". Entries are separated by ":".
935
936 This installation option defines the default value of the
937 "init_envvars" configuration option which could be changed after
938 installation with the "config" sub-command.
939
940 --with-light-background-colors=SGRLIST
941
942 Default color set to apply if terminal background color is defined
943 to "light". Expect the same syntax than described for "--with-dark-
944 background-colors". (default="hi=1:db=2:tr=2:se=2:er=31:wa=33:me=35
945 :in=34:mp=1;34:di=34:al=36:va=33:sy=35:de=4:cm=32:aL=107:L=47:H=2:F
946 =101:nF=91;103:S=106:sS=104:kL=48;5;109:W=103")
947
948 This installation option defines the default value of the "colors"
949 configuration option when "term_background" configuration option
950 equals "light". "colors" could be changed after installation with
951 the "config" sub-command.
952
953 --with-list-output=LIST
954
955 Specify the content to report on list sub-command regular output in
956 addition to the loaded module names. Elements accepted in LIST are:
957 "header", "idx", "variant", "alias", "indesym", "sym", "tag",
958 "hidden" and "key" (elements in LIST are separated by ":"). The
959 order of the elements in LIST does not matter.
960 (default="header:idx:variant:sym:tag:key")
961
962 This installation option defines the default value of the
963 "list_output" configuration option which could be changed after
964 installation with the "config" sub-command.
965
966 --with-list-terse-output=LIST
967
968 Specify the content to report on list sub-command terse output in
969 addition to the loaded module names. Elements accepted in LIST are:
970 "header", "idx", "variant", "alias", "indesym", "sym", "tag",
971 "hidden" and "key" (elements in LIST are separated by ":"). The
972 order of the elements in LIST does not matter. (default="header")
973
974 This installation option defines the default value of the
975 "list_terse_output" configuration option which could be changed
976 after installation with the "config" sub-command.
977
978 --with-loadedmodules=MODLIST
979
980 Default modulefiles to load at Modules initialization time. Each
981 modulefile in this list should be separated by ":". Defined value
982 is registered in the "initrc" configuration file or in the
983 "modulerc" file if "--with-initconf-in" is set to "initdir".
984 (default=)
985
986 --with-locked-configs=CONFIGLIST
987
988 Ignore environment variable superseding value for the listed
989 configuration options. Accepted option names in CONFIGLIST are
990 "extra_siteconfig" , "implicit_default", "logged_events" and
991 "logger" (each option name should be separated by whitespace
992 character). (default=)
993
994 This installation option defines the default value of the
995 "locked_configs" configuration option which cannot not be changed
996 after installation.
997
998 --with-logged-events=EVENTLIST
999
1000 Events to log. Accepted event names in EVENTLIST are "auto_eval",
1001 "requested_eval" and "requested_cmd" (each event name in this list
1002 should be separated by ":"). The order of the elements in EVENTLIST
1003 does not matter. (default=)
1004
1005 This installation option defines the default value of the
1006 "logged_events" configuration option which cannot not be changed
1007 after installation.
1008
1009 --with-logger=BIN
1010
1011 Name or full path of default logger program to use to log
1012 information (can be superseded at run-time by environment variable)
1013 (default="logger")
1014
1015 This installation option and "--with-logger-opts" define the
1016 default value of the "logger" configuration option which could be
1017 changed after installation with the "config" sub-command.
1018
1019 --with-logger-opts=OPTLIST
1020
1021 Settings to apply to default logger program (default="-t modules")
1022
1023 This installation option and "--with-logger" define the default
1024 value of the "logger" configuration option which could be changed
1025 after installation with the "config" sub-command.
1026
1027 --with-modulepath=PATHLIST
1028
1029 Default path list to setup as the default modulepaths. Each path in
1030 this list should be separated by ":". Defined value is registered
1031 in the "initrc" or "modulespath" configuration file, depending on
1032 the "--enable-modulespath" option. These files are respectively
1033 called "modulerc" and ".modulespath" if "--with-initconf-in" is set
1034 to "initdir". The path list value is read at initialization time to
1035 populate the MODULEPATH environment variable. By default, this
1036 modulepath is composed of the directory set for the system
1037 modulefiles (default="PREFIX/modulefiles" or
1038 "BASEPREFIX/$MODULE_VERSION/modulefiles" if versioning installation
1039 mode enabled)
1040
1041 --with-moduleshome
1042
1043 Location of the main Modules package file directory
1044 (default="PREFIX")
1045
1046 This installation option defines the default value of the "home"
1047 configuration option which could be changed after installation with
1048 the "config" sub-command.
1049
1050 --with-nearly-forbidden-days=VALUE
1051
1052 Define the number of days a module is considered nearly forbidden
1053 prior reaching its expiry date. VALUE should be an integer
1054 comprised between 0 and 365. (default="14")
1055
1056 This installation option defines the default value of the
1057 "nearly_forbidden_days" configuration option which could be changed
1058 after installation with the "config" sub-command.
1059
1060 --with-pager=BIN
1061
1062 Name or full path of default pager program to use to paginate
1063 informational message output (can be superseded at run-time by
1064 environment variable) (default="less")
1065
1066 This installation option and "--with-pager-opts" define the default
1067 value of the "pager" configuration option which could be changed
1068 after installation with the "config" sub-command.
1069
1070 --with-pager-opts=OPTLIST
1071
1072 Settings to apply to default pager program (default="-eFKRX")
1073
1074 This installation option and "--with-pager" define the default
1075 value of the "pager" configuration option which could be changed
1076 after installation with the "config" sub-command.
1077
1078 --with-python=BIN
1079
1080 Name or full path of Python interpreter command to set as shebang
1081 for helper scripts. (default="python")
1082
1083 --with-pythondir=DIR
1084
1085 Installation directory of the "env_modules" Python module. When
1086 this option is not set, "env_modules.py" is installed in the
1087 initialization script directory. Whatever the installation
1088 directory of this Python module, the "python.py" symbolic link
1089 created in the initialization script directory points to its
1090 location. (default=)
1091
1092 If this option is set to the "site-packages" directory of the
1093 Python installation available on the system, the "env_modules"
1094 module can be imported without requiring the PYTHONPATH environment
1095 variable to be set. In this case the "--disable-set-pythonpath"
1096 option may be used.
1097
1098 --with-quarantine-vars=<VARNAME[=VALUE] ...>
1099
1100 Environment variables to put in quarantine when running the module
1101 command to ensure it a sane execution environment (each variable
1102 should be separated by space character). A value can eventually be
1103 set to a quarantine variable instead of emptying it. (default=)
1104
1105 This installation option defines the default value of the
1106 "MODULES_RUN_QUARANTINE" and "MODULES_RUNENV_<VAR>" environment
1107 variables which could be changed after installation with the
1108 "config" sub-command on "run_quarantine" configuration option.
1109
1110 --with-search-match=VALUE
1111
1112 When searching for a module with "avail" sub-command, match query
1113 string against module name start ("starts_with") or any part of
1114 module name string ("contains"). (default="starts_with")
1115
1116 This installation option defines the default value of the
1117 "search_match" configuration option which could be changed after
1118 installation with the "config" sub-command.
1119
1120 --with-spider-output=LIST
1121
1122 Specify the content to report on spider sub-command regular output
1123 in addition to the available module names. Elements accepted in
1124 LIST are: "modulepath", "alias", "provided-alias", "dirwsym",
1125 "indesym", "sym", "tag", "key", "hidden", "variant",
1126 "variantifspec" and "via" (elements in LIST are separated by ":").
1127 The order of the elements in LIST does not matter.
1128 (default="modulepath:alias:dirwsym:sym:tag:variantifspec:via:key")
1129
1130 This installation option defines the default value of the
1131 "spider_output" configuration option which could be changed after
1132 installation with the "config" sub-command.
1133
1134 --with-spider-terse-output=LIST
1135
1136 Specify the content to report on spider sub-command terse output in
1137 addition addition to the available module names. Elements accepted
1138 in LIST are: "modulepath", "alias", "provided-alias", "dirwsym",
1139 "indesym", "sym", "tag", "key", "hidden", "variant" and
1140 "variantifspec" (elements in LIST are separated by ":"). The order
1141 of the elements in LIST does not matter.
1142 (default="modulepath:alias:dirwsym:sym:tag:variantifspec")
1143
1144 This installation option defines the default value of the
1145 "spider_terse_output" configuration option which could be changed
1146 after installation with the "config" sub-command.
1147
1148 --with-sticky-purge=VALUE
1149
1150 When unloading a sticky or super-sticky module during a module
1151 purge, raise an "error" or emit a "warning" message or be "silent".
1152 (default="error")
1153
1154 This installation option defines the default value of the
1155 "sticky_purge" configuration option which could be changed after
1156 installation with the "config" sub-command.
1157
1158 --with-tag-abbrev=ABBRVLIST
1159
1160 Define the abbreviation to use when reporting each module tag. Each
1161 element in ABBRVLIST is a tag name associated to an abbreviation
1162 string (elements in ABBRVLIST are separated by ":"). (default
1163 ="auto-loaded=aL:loaded=L:hidden=H:hidden-loaded=H:forbidden=F
1164 :nearly-forbidden=nF:sticky=S:super-sticky=sS:keep-
1165 loaded=kL:warning=W")
1166
1167 This installation option defines the default value of the
1168 "tag_abbrev" configuration option which could be changed after
1169 installation with the "config" sub-command.
1170
1171 --with-tag-color-name=TAGLIST
1172
1173 Define the tags whose graphical rendering should be applied over
1174 their name instead of over the name of the module they are attached
1175 to. Each element in TAGLIST is a tag name or abbreviation (elements
1176 in TAGLIST are separated by ":"). (default=)
1177
1178 This installation option defines the default value of the
1179 "tag_color_name" configuration option which could be changed after
1180 installation with the "config" sub-command.
1181
1182 --with-tcl
1183
1184 Directory containing the Tcl configuration script "tclConfig.sh".
1185 Useful to compile Modules Tcl extension library if this file cannot
1186 be automatically found in default locations.
1187
1188 --with-tclinclude
1189
1190 Directory containing the Tcl header files. Useful to compile
1191 Modules Tcl extension library if these headers cannot be
1192 automatically found in default locations.
1193
1194 --with-tclsh=BIN
1195
1196 Name or full path of Tcl interpreter shell (default="tclsh")
1197
1198 --with-tcl-linter=BIN
1199
1200 Name or full path of program to use to lint modulefile through the
1201 "lint" sub-command. (default="nagelfar.tcl")
1202
1203 This installation option and "--with-tcl-linter-opts" define the
1204 default value of the "tcl_linter" configuration option which could
1205 be changed after installation with the "config" sub-command.
1206
1207 --with-tcl-linter-opts=OPTLIST
1208
1209 Settings to apply to Tcl linter program (default=)
1210
1211 This installation option and "--with-tcl-linter" define the default
1212 value of the "tcl_linter" configuration option which could be
1213 changed after installation with the "config" sub-command.
1214
1215 --with-terminal-background=VALUE
1216
1217 The terminal background color that determines the color set to
1218 apply by default between the "dark" background colors or the
1219 "light" background colors (default="dark")
1220
1221 This installation option defines the default value of the
1222 "term_background" configuration option which could be changed after
1223 installation with the "config" sub-command.
1224
1225 --with-unload-match-order=VALUE
1226
1227 When unloading a module if multiple loaded modules match the
1228 request, unload module loaded first ("returnfirst") or module
1229 loaded last ("returnlast") (default="returnlast")
1230
1231 This installation option defines the default value of the
1232 "unload_match_order" configuration option which could be changed
1233 after installation with the "config" sub-command.
1234
1235 --with-variant-shortcut=SHORTCUTLIST
1236
1237 Define the shortcut characters that could be used to specify
1238 variant names. Each element in SHORTCUTLIST is a variant name
1239 associated to a shortcut character (e.g., "foo=%"). Shortcuts
1240 cannot exceed a length of 1 character and cannot be alphanumeric
1241 characters ([A-Za-z0-9]) or characters with already a special
1242 meaning ([+~/@=-]). Elements in SHORTCUTLIST are separated by ":".
1243 (default=)
1244
1245 This installation option defines the default value of the
1246 "variant_shortcut" configuration option which could be changed
1247 after installation with the "config" sub-command.
1248
1249 --with-verbosity=VALUE
1250
1251 Specify default message verbosity. accepted values are "silent",
1252 "concise", "normal", "verbose", "verbose2", "trace", "debug" and
1253 "debug2". (default="normal")
1254
1255 This installation option defines the default value of the
1256 "verbosity" configuration option which could be changed after
1257 installation with the "config" sub-command.
1258
1259 --with-zshcompletiondir=DIR
1260
1261 Directory for Zsh completion scripts. When this option is not set
1262 Zsh completion script for Modules is installed in the
1263 initialization script directory and "FPATH" is set in Zsh
1264 initialization script to point to this location. (default=)
1265
1266
1267 Configuration options
1268 =====================
1269
1270 Options available through the "config" sub-command are described
1271 below. In addition to their default value, the related installation
1272 option, environment variable and command-line switch are listed for
1273 each configuration option. This table also describes if each
1274 configuration option needs to be set prior or during Modules
1275 initialization and if it can be modified after installation.
1276
1277 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1278 | Configuration option | Default value | Related installation option, environment | Set prior or | Cannot be |
1279 | | | variable and command-line switch | during | altered |
1280 | | | | initialization | |
1281 |=====================================|================================================|================================================|================|=============|
1282 | "abort_on_error" | "ml:reload:switch_unload" | "--with-abort-on-error", | | |
1283 | | | "MODULES_ABORT_ON_ERROR" | | |
1284 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1285 | "advanced_version_spec" | "1" | "--enable-advanced-version-spec", | | |
1286 | | | "MODULES_ADVANCED_VERSION_SPEC" | | |
1287 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1288 | "auto_handling" | "1" | "--enable-auto-handling", | | |
1289 | | | "MODULES_AUTO_HANDLING", "--auto", "--no- | | |
1290 | | | auto" | | |
1291 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1292 | "avail_indepth" | "1" | "--enable-avail-indepth", | | |
1293 | | | "MODULES_AVAIL_INDEPTH", "--indepth", "--no- | | |
1294 | | | indepth" | | |
1295 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1296 | "avail_output" | modulepath:alias:dirwsym:sym:tag:variantifspec | "--with-avail-output", "MODULES_AVAIL_OUTPUT", | | |
1297 | | :key | "--output" | | |
1298 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1299 | "avail_terse_output" | modulepath:alias:dirwsym:sym:tag:variantifspec | "--with-avail-terse-output", | | |
1300 | | | "MODULES_AVAIL_TERSE_OUTPUT", "--output" | | |
1301 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1302 | "cache_buffer_bytes" | "32768" | "MODULES_CACHE_BUFFER_BYTES" | | |
1303 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1304 | "cache_expiry_secs" | "0" | "MODULES_CACHE_EXPIRY_SECS" | | |
1305 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1306 | "collection_pin_version" | "0" | "MODULES_COLLECTION_PIN_VERSION" | | |
1307 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1308 | "collection_pin_tag" | "0" | "MODULES_COLLECTION_PIN_TAG" | | |
1309 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1310 | "collection_target" | *Unset by default* | "MODULES_COLLECTION_TARGET" | | |
1311 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1312 | "color" | "auto" | "--enable-color", "MODULES_COLOR", "--color" | | |
1313 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1314 | "colors" | hi=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp | "--with-dark-background-colors", "--with- | | |
1315 | | =1;94:di=94:al=96:va=93: sy=95:de=4:cm=92:aL=1 | light-background-colors", "MODULES_COLORS" | | |
1316 | | 00:L=90;47:H=2:F=41:nF=31;43:S=46:sS=44:kL=30; | | | |
1317 | | 48; 5;109:W=30;43 | | | |
1318 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1319 | "conflict_unload" | "0" | "--enable-conflict-unload", | | |
1320 | | | "MODULES_CONFLICT_UNLOAD" | | |
1321 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1322 | "contact" | "root@localhost" | "MODULECONTACT" | | |
1323 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1324 | "extended_default" | "1" | "--enable-extended-default", | | |
1325 | | | "MODULES_EXTENDED_DEFAULT" | | |
1326 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1327 | "domainname" | "domainname" | "--with-domainname", "--with-domainname-opts", | | |
1328 | | | "MODULES_DOMAINNAME" | | |
1329 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1330 | "editor" | "vi" | "--with-editor", "MODULES_EDITOR" | | |
1331 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1332 | "extra_siteconfig" | *Unset by default* | "MODULES_SITECONFIG" | | |
1333 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1334 | "hide_auto_loaded" | "0" | "MODULES_HIDE_AUTO_LOADED" | | |
1335 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1336 | "home" | "/usr/share/Modules" | "--prefix", "--with-moduleshome", | | |
1337 | | | "MODULESHOME" | | |
1338 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1339 | "icase" | "search" | "--with-icase", "MODULES_ICASE", "--icase" | | |
1340 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1341 | "ignore_cache" | "0" | "MODULES_IGNORE_CACHE", "--ignore-cache" | | |
1342 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1343 | "ignore_cache_subcmds" | *Empty by default* | "MODULES_IGNORE_CACHE_SUBCMDS" | | |
1344 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1345 | "ignore_user_rc" | "0" | "MODULES_IGNORE_USER_RC", "--ignore-user-rc" | | |
1346 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1347 | "ignored_dirs" | "CVS RCS SCCS .svn .git .SYNC .sos" | | | X |
1348 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1349 | "implicit_default" | "1" | "--enable-implicit-default", | | |
1350 | | | "MODULES_IMPLICIT_DEFAULT" | | |
1351 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1352 | "implicit_requirement" | "1" | "--enable-implicit-requirement", | | |
1353 | | | "MODULES_IMPLICIT_REQUIREMENT" | | |
1354 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1355 | "info_extension" | "0" | "MODULES_INFO_EXTENSION" | | |
1356 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1357 | "init_envvars" | *Empty by default* | "--with-init-envvars" "MODULES_INIT_ENVVARS" | | |
1358 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1359 | "linked_envvars" | *Empty by default* | "MODULES_LINKED_ENVVARS" | | |
1360 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1361 | "list_output" | "header:idx:variant:sym:tag:key" | "--with-list-output", "MODULES_LIST_OUTPUT", " | | |
1362 | | | --output" | | |
1363 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1364 | "list_terse_output" | "header" | "--with-list-terse-output", | | |
1365 | | | "MODULES_LIST_TERSE_OUTPUT", "--output" | | |
1366 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1367 | "locked_configs" | *Empty by default* | "--with-locked-configs" | | X |
1368 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1369 | "logged_events" | *Empty by default* | "--with-logged-events", | | |
1370 | | | "MODULES_LOGGED_EVENTS" | | |
1371 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1372 | "logger" | "logger -t modules" | "--with-logger", "--with-logger-opts", | | |
1373 | | | "MODULES_LOGGER" | | |
1374 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1375 | "mcookie_check" | "always" | "MODULES_MCOOKIE_CHECK" | | |
1376 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1377 | "mcookie_version_check" | "1" | "--enable-mcookie-version-check", | | |
1378 | | | "MODULES_MCOOKIE_VERSION_CHECK" | | |
1379 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1380 | "ml" | "1" | "--enable-ml", "MODULES_ML" | X | |
1381 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1382 | "modulepath_ignore" | "1" | "MODULES_MODULEPATH_IGNORE", "--no-modulepath- | | |
1383 | | | ignore" | | |
1384 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1385 | "nearly_forbidden_days" | "14" | "--with-nearly-forbidden-days", | | |
1386 | | | "MODULES_NEARLY_FORBIDDEN_DAYS" | | |
1387 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1388 | "non_exportable_tags" | *Empty by default* | "MODULES_NON_EXPORTABLE_TAGS" | | |
1389 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1390 | "pager" | "less -eFKRX" | "--with-pager", "--with-pager-opts", | | |
1391 | | | "MODULES_PAGER", | | |
1392 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1393 | "paginate" | "1" | "--enable-paginate", "MODULES_PAGINATE", "-- | | |
1394 | | | paginate", "--no-pager" | | |
1395 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1396 | "path_entry_reorder" | "0" | "--enable-path-entry-reorder", | | |
1397 | | | "MODULES_PATH_ENTRY_REORDER" | | |
1398 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1399 | "protected_envvars" | *Unset by default* | "MODULES_PROTECTED_ENVVARS" | | |
1400 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1401 | "quarantine_support" | "0" | "--enable-quarantine-support", | X | |
1402 | | | "MODULES_QUARANTINE_SUPPORT" | | |
1403 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1404 | "rcfile" | *Unset by default* | "MODULERCFILE" | | |
1405 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1406 | "redirect_output" | "1" | "MODULES_REDIRECT_OUTPUT", "--redirect", "-- | | |
1407 | | | no-redirect" | | |
1408 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1409 | "require_via" | "0" | "--enable-require-via", "MODULES_REQUIRE_VIA" | | |
1410 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1411 | "reset_target_state" | "__init__" | "MODULES_RESET_TARGET_STATE", | | |
1412 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1413 | "run_quarantine" | *Empty by default* | "--with-quarantine-vars", | | |
1414 | | | "MODULES_RUN_QUARANTINE" | | |
1415 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1416 | "search_match" | "starts_with" | "--with-search-match", "MODULES_SEARCH_MATCH", | | |
1417 | | | "--contains", "-- starts-with" | | |
1418 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1419 | "set_shell_startup" | "0" | "--enable-set-shell-startup", | X | |
1420 | | | "MODULES_SET_SHELL_STARTUP" | | |
1421 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1422 | "shells_with_ksh_fpath" | *Empty by default* | "MODULES_SHELLS_WITH_KSH_FPATH" | X | |
1423 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1424 | "silent_shell_debug" | "0" | "--enable-silent-shell-debug-support", | X | |
1425 | | | "MODULES_SILENT_SHELL_DEBUG" | | |
1426 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1427 | "siteconfig" | "/etc/environment-modules/siteconfig.tcl" | "--prefix", "--etcdir" | | X |
1428 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1429 | "source_cache" | "0" | "--enable-source-cache", | | |
1430 | | | "MODULES_SOURCE_CACHE" | | |
1431 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1432 | "spider_indepth" | "1" | "--enable-spider-indepth", | | |
1433 | | | "MODULES_SPIDER_INDEPTH", "--indepth", "-- no- | | |
1434 | | | indepth" | | |
1435 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1436 | "spider_output" | modulepath:alias:dirwsym:sym:tag:variantifspec | "--with-spider-output", | | |
1437 | | :via:key | "MODULES_SPIDER_OUTPUT", "--output" | | |
1438 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1439 | "spider_terse_output" | modulepath:alias:dirwsym:sym:tag:variantifspec | "--with-spider-terse-output", | | |
1440 | | | "MODULES_SPIDER_TERSE_OUTPUT", "-- output" | | |
1441 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1442 | "sticky_purge" | "error" | "--with-sticky-purge", "MODULES_STICKY_PURGE" | | |
1443 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1444 | "tag_abbrev" | auto-loaded=aL:loaded=L:hidden=H:hidden- | "--with-tag-abbrev", "MODULES_TAG_ABBREV" | | |
1445 | | loaded=H:forbidden=F:nearly- | | | |
1446 | | forbidden=nF:sticky=S:super-sticky=sS:keep- | | | |
1447 | | loaded=kL:warning=W | | | |
1448 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1449 | "tag_color_name" | *Empty by default* | "--with-tag-color-name", | | |
1450 | | | "MODULES_TAG_COLOR_NAME" | | |
1451 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1452 | "tcl_ext_lib" | "/usr/share/Modules/lib64/libtclenvmodules.so" | | | X |
1453 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1454 | "tcl_linter" | "nagelfar.tcl" | "--with-tcl-linter", "--with-tcl-linter-opts", | | |
1455 | | | "MODULES_TCL_LINTER" | | |
1456 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1457 | "term_background" | "dark" | "--with-terminal-background", | | |
1458 | | | "MODULES_TERM_BACKGROUND" | | |
1459 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1460 | "term_width" | "0" | "MODULES_TERM_WIDTH", "--width" | | |
1461 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1462 | "unique_name_loaded" | "0" | "--enable-unique-name-loaded", | | |
1463 | | | "MODULES_UNIQUE_NAME_LOADED" | | |
1464 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1465 | "unload_match_order" | "returnlast" | "--with-unload-match-order", | | |
1466 | | | "MODULES_UNLOAD_MATCH_ORDER" | | |
1467 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1468 | "variant_shortcut" | *Empty by default* | "--with-variant-shortcut", | | |
1469 | | | "MODULES_VARIANT_SHORTCUT" | | |
1470 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1471 | "verbosity" | "normal" | "--with-verbosity", "MODULES_VERBOSITY", "-- | | |
1472 | | | debug", "--silent", "-- trace", "--verbose" | | |
1473 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+
1474 | "wa_277" | "1" | "--enable-wa-277", "MODULES_WA_277" | X | |
1475 +-------------------------------------+------------------------------------------------+------------------------------------------------+----------------+-------------+